Official Python client library for the Invoiced API
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
invoiced
.coveragerc
.gitignore
.travis.yml
LICENSE
LONG_DESCRIPTION.rst
MANIFEST.in
README.md
setup.py

README.md

invoiced-python

This repository contains the Python client library for the Invoiced API.

Build Status Coverage Status

Installing

The Invoiced package can be installed like this:

pip install invoiced

Requirements

  • Python 3.3+
  • requests and inflection libraries

Usage

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)

Developing

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.

Contributions must pass the Flake8 code linter.