README.md
# InvoiceXpress GEM
[![Gem Version](https://badge.fury.io/rb/invoicexpress.svg)](http://badge.fury.io/rb/invoicexpress) [![Build Status](https://travis-ci.org/weareswat/invoicexpress-gem.svg)](https://travis-ci.org/weareswat/invoicexpress-gem) [![Code Climate](https://codeclimate.com/github/weareswat/invoicexpress-gem/badges/gpa.svg)](https://codeclimate.com/github/weareswat/invoicexpress-gem)
Gem for invoicexpress API at http://invoicexpress.com
Created with Reference: https://invoicexpress.com/api/overview
## Dependencies
Run bundle, the project should need:
* Invoicexpress API Key
* Happymapper
* Faraday
* And pretzels!
## Progress
* Client - 100%
* Sequences - 100%
* Users - 100%
* Invoices - 100%
* Cash Invoices - 100%
* Items - 100%
* Charts - 100%
* Debit Notes - 100%
* Credit Notes - 100%
* Taxes - 100%
* Schedules - 100%
* Sim. Invoices - 100%
* Purch. Orders - 100%
## Tests
* Client - 100%
* Sequences - 100%
* Users - 100%
* Charts - 100%
* Taxes - 100%
* Schedules - 100%
* Invoices - 100%
* Sim. Invoices - 100%
* Credit Notes - 100%
* Purch. Orders - 100%
## Documentation
We've included docs for all methods. Refer to the doc folder and client section.
## Examples
If using from inside a rails project use:
require 'invoicexpress'
client = Invoicexpress::Client.new(
:account_name => "yourusername",
:api_key => "yourapikey"
)
Examples for API are located in the EXAMPLES.md file.