{"id":16055664,"url":"https://github.com/morgoth/centrum_faktur","last_synced_at":"2025-08-28T20:31:26.547Z","repository":{"id":56843368,"uuid":"1895596","full_name":"morgoth/centrum_faktur","owner":"morgoth","description":"Ruby client for Centrum Faktur API","archived":false,"fork":false,"pushed_at":"2013-05-11T21:18:47.000Z","size":147,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-15T07:41:41.389Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/morgoth/centrum_faktur","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/morgoth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-06-14T17:10:07.000Z","updated_at":"2021-06-03T10:13:48.000Z","dependencies_parsed_at":"2022-09-09T05:40:12.138Z","dependency_job_id":null,"html_url":"https://github.com/morgoth/centrum_faktur","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morgoth%2Fcentrum_faktur","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morgoth%2Fcentrum_faktur/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morgoth%2Fcentrum_faktur/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morgoth%2Fcentrum_faktur/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/morgoth","download_url":"https://codeload.github.com/morgoth/centrum_faktur/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231297092,"owners_count":18354598,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-09T02:21:22.441Z","updated_at":"2024-12-26T00:42:25.180Z","avatar_url":"https://github.com/morgoth.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Centrum Faktur\n\nRuby client for [Centrum Faktur API](http://centrumfaktur.pl/api/)\n\n## Installation\n\n```\ngem install centrum_faktur\n```\n## Usage\n\nRequest returns Array or Hash, where keys are strings.\nWhen other format than `json` (default) or `yaml` is specified, response is not parsed.\nSo for `xml` and `pickle` requests, string is returned.\n\n```ruby\nrequire \"centrum_faktur\"\nclient = CentrumFaktur::Client.new(login: \"your_login\", password: \"your-password\", subdomain: \"your-subodomain\")\n```\n\n``` ruby\nclient.invoice.show(\"/api/1.0/invoices/1/\", format: :xml)\n```\n\nWriting invoice to pdf can be done as follows:\n\n``` ruby\nFile.open(\"my-invoice.pdf\", \"w\") { |file| file.write(client.invoice.show(\"/api/1.0/invoices/1/\", format: :pdf)) }\n```\n\nAll params that respond to `strftime` (i.e. Date, Time) will be normalized to format\nrequired by API, that is: `\"YYYY-MM-DD\"`\n\n### Account\n\nOnly listing accounts is supported via API\n\n``` ruby\nclient.account.list\n```\n\n### Comment\n\nListing all comments:\n\n``` ruby\nclient.comment.list\n```\n\nOr listing comments for given resource:\n\n``` ruby\nclient.comment.list(\"/api/1.0/estimates/1/comments/\")\n```\n\nCreating comment:\n\nYou must pass path to resource comment and required attributes:\n\n``` ruby\nclient.comment.create(\"/api/1.0/estimates/1/comments/\", {body: \"cool\", is_public: false})\n```\n\n### Estimate\n\nListing all estimates:\n\n``` ruby\nclient.estimate.list\n```\n\nMonitoring estimate changes (with optional filter param):\n\n``` ruby\nclient.estimate.list_updates(updated_since: \"2012-01-12\")\n```\n\nCreating estimate (check required attributes in API description):\n\n``` ruby\nclient.estimate.create({})\n```\n\nUpdating estimate:\n\n``` ruby\nclient.estimate.update(\"/api/1.0/estimates/1/\", {})\n```\n\nRemoving estimate:\n\n``` ruby\nclient.estimate.destroy(\"/api/1.0/estimates/1/\")\n```\n\n### Invoice\n\nListing all invoices:\n\n``` ruby\nclient.invoice.list\n```\n\nMonitoring invoice changes:\n\n``` ruby\nclient.invoice.list_updates\n```\n\nDisplaying invoice:\n\n``` ruby\nclient.invoice.show(\"/api/1.0/invoices/1/\")\n```\n\nCreating invoice (check required attributes in API description):\n\n``` ruby\nclient.invoice.create({})\n```\n\nUpdating invoice:\n\n``` ruby\nclient.invoice.update(\"/api/1.0/invoices/1/\", {})\n```\n\nRemoving invoice:\n\n``` ruby\nclient.invoice.destroy(\"/api/1.0/invoices/1/\")\n```\n\n### User ###\n\nOnly listing users is supported via API\n\n``` ruby\nclient.user.list\n```\n\n## Continuous Integration\n[![Build Status](https://api.travis-ci.org/morgoth/centrum_faktur.png)](https://travis-ci.org/morgoth/centrum_faktur)\n\n## Copyright\n\nCreated during development for [Ragnarson](http://ragnarson.com/)\n\nCopyright © Wojciech Wnętrzak. See LICENSE for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorgoth%2Fcentrum_faktur","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmorgoth%2Fcentrum_faktur","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorgoth%2Fcentrum_faktur/lists"}