Invoice Methods

API for Invoice Methods.

invoice.info()

Gets details for the invoice with reference number ref

Parameters:ref (Integer) – The invoice number
Returns:A dictionary with the following keys:
ref
Integer: A unique reference to identify this invoice
amount
Float: The amount for this invoice
currency
String: The currency of this invoice
vat
Float: The VAT for this invoice
status
String: The status of the invoice
proforma
Boolean: Whether this is a proforma
payment_method
String: The payment method of this invoice
items
List of three tuples (Item description, amount, period): The items on the invoice.
date
Date: The date of the invoice
Raises :ApiErrorDoesNotExist if the invoice does not exist.
invoice.list()

Retrieves details for invoices according to the search parameters.

Parameters:
  • date_gte (Date, Optional) – Invoice date on or after
  • date_lte (Date, Optional) – Invoice date on or before
  • status (String, Optional) – The status of the order Acceptable values: ‘NEW’, ‘AWAITING-PAYMENT’, ‘RENEWAL’, ‘REFUND’, ‘CANCELLED’, ‘DONE’, ‘PROCESSING’.
Returns:

list of dictionaries as described in invoice.info(). Empty if no invoices found for the given parameters.

Previous topic

Internal Methods

Next topic

Job Methods

This Page