Skip to content

lmmendes/invoicexpress_rest-rb

Repository files navigation

InvoiceXpress Rest

Maintainability Test Coverage Build Status

A InvoiceXpress (https://invoicexpress.com) API wrapper (for API version 2.0 REST)

Install

gem install invoicexpress-rest

Examples

Configuration

# You can set Invoicexpress configuration at class level like so
Invoicexpress.configure do |c|
  c.api_key   = ENV['INVOICE_EXPRESS_API_KEY']
  c.account_name = ENV['INVOICE_EXPRESS_ACCOUNT_NAME']
end

# Or configure each instance independently
@client = Invoicexpress.new(
  api_key: ENV['INVOICE_EXPRES_API_KEY']
  account_name: ENV['INVOICE_EXPRESS_ACCOUNT_NAME']
)

Invoices

# This method returns all invoices.
@client.invoices.all()

Bug reports and other issues

Help and Docs

Contributing

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Send me a pull request. Bonus points for topic branches.

License

invoicexpress-rest is free software distributed under the terms of the MIT license reproduced here.

About

A simple ruby client for InvoiceXpress REST API

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published