{"id":22495049,"url":"https://github.com/invoiced/invoiced-ruby","last_synced_at":"2025-06-10T16:36:20.146Z","repository":{"id":35521609,"uuid":"39792168","full_name":"Invoiced/invoiced-ruby","owner":"Invoiced","description":"Official Ruby client library for the Invoiced API","archived":false,"fork":false,"pushed_at":"2024-12-24T15:03:29.000Z","size":120,"stargazers_count":4,"open_issues_count":2,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-09T02:36:39.425Z","etag":null,"topics":["api","billing","invoiced","ruby"],"latest_commit_sha":null,"homepage":"https://developer.invoiced.com/api/?ruby","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/Invoiced.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":"2015-07-27T18:56:30.000Z","updated_at":"2024-12-24T15:00:42.000Z","dependencies_parsed_at":"2022-09-08T19:10:51.703Z","dependency_job_id":null,"html_url":"https://github.com/Invoiced/invoiced-ruby","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Invoiced%2Finvoiced-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Invoiced%2Finvoiced-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Invoiced%2Finvoiced-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Invoiced%2Finvoiced-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Invoiced","download_url":"https://codeload.github.com/Invoiced/invoiced-ruby/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Invoiced%2Finvoiced-ruby/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259112368,"owners_count":22807074,"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":["api","billing","invoiced","ruby"],"created_at":"2024-12-06T19:20:58.392Z","updated_at":"2025-06-10T16:36:20.135Z","avatar_url":"https://github.com/Invoiced.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"invoiced-ruby\n========\n\nThis repository contains the Ruby client library for the [Invoiced](https://invoiced.com) API.\n\n[![CI](https://github.com/Invoiced/invoiced-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/Invoiced/invoiced-ruby/actions/workflows/ci.yml)\n[![Coverage Status](https://coveralls.io/repos/Invoiced/invoiced-ruby/badge.svg?branch=master\u0026service=github)](https://coveralls.io/github/Invoiced/invoiced-ruby?branch=master)\n[![Gem Version](https://badge.fury.io/rb/invoiced.svg)](https://badge.fury.io/rb/invoiced)\n\n## Installing\n\nThe Invoiced gem can be installed liked this:\n\n```\ngem install invoiced\n```\n\nIt can be added to your Gemfile:\n\n```\nsource 'https://rubygems.org'\n\ngem 'invoiced'\n```\n\n## Requirements\n\n- Ruby 2.3+\n- `rest_client` gem\n- `jwt` gem\n\n## Usage\n\nFirst, you must instantiate a new client\n\n```ruby\nrequire 'invoiced'\n\ninvoiced = Invoiced::Client.new(\"{API_KEY}\")\n```\n\nThen, API calls can be made like this:\n```ruby\n# retrieve invoice\ninvoice = invoiced.Invoice.retrieve(\"{INVOICE_ID}\")\n\n# mark as paid\npayment = invoiced.Payment.create(\n    :amount =\u003e invoice.balance,\n    :method =\u003e \"check\",\n    :applied_to =\u003e [\n        {\n            :type =\u003e \"invoice\",\n            :invoice =\u003e invoice.id,\n            :amount =\u003e invoice.balance\n        }\n    ])\n```\n\nIf you want to use the sandbox API instead then you must set the second argument on the client to `true` like this:\n\n```ruby\nrequire 'invoiced'\n\ninvoiced = Invoiced::Client.new(\"{API_KEY}\", true)\n```\n\n## Developing\n\nThe gem can be built with:\n\n```\ngem build invoiced.gemspec\n```\n\nThe test suite can be ran with `rake test`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finvoiced%2Finvoiced-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finvoiced%2Finvoiced-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finvoiced%2Finvoiced-ruby/lists"}