This repository contains the Python client library for the Invoiced API.
The Invoiced package can be installed like this:
pip install invoiced
- Python 3.3+
requests
andinflection
libraries
First, you must instantiate a new client
import 'invoiced'
client = invoiced.Client("{API_KEY}")
Then, API calls can be made like this:
# retrieve invoice
invoice = client.Invoice.retrieve("{INVOICE_ID}")
# mark as paid
transaction = client.Transaction.create(
invoice= invoice.id,
amount= invoice.balance,
method= "check")
If you want to use the sandbox API instead then you must set the second argument on the client to True
like this:
import 'invoiced'
client = invoiced.Client("{API_KEY}", True)
The test suite can be ran with python setup.py test
. If you want to capture code coverage too with coverage.py then use python -m coverage run setup.py test
and view the report with python -m coverage report
.