Package simplify :: Class Invoice
[hide private]
[frames] | no frames]

Class Invoice

source code

domain.Domain --+
                |
               Invoice

A Invoice object.

Instance Methods [hide private]
 
update(self, *auth_args)
Updates this object
source code

Inherited from domain.Domain: __getitem__, __init__, __str__, class_name, to_dict

Static Methods [hide private]
 
list(criteria=None, *auth_args)
Retrieve Invoice objects.
source code
 
find(object_id, *auth_args)
Retrieve a Invoice object from the API
source code
Method Details [hide private]

list(criteria=None, *auth_args)
Static Method

source code 

Retrieve Invoice objects.

Parameters:
  • criteria - a dict of parameters; valid keys are:
    • filter Filters to apply to the list.
    • max Allows up to a max of 50 list items to return. default:20
    • offset Used in paging of the list. This is the start offset of the page. default:0
    • sorting Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: id invoiceDate customer amount processedDate.
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.
Returns:
an object which contains the list of Invoice objects in the <code>list</code> property and the total number of objects available for the given criteria in the <code>total</code> property.

find(object_id, *auth_args)
Static Method

source code 

Retrieve a Invoice object from the API

Parameters:
  • object_id - ID of object to retrieve
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.
Returns:
a Invoice object

update(self, *auth_args)

source code 

Updates this object

The properties that can be updated:

  • status Status of the invoice. Examples: OPEN = Invoice has not been processed and can have invoice items added to it. PAID = Invoice has been paid. UNPAID = Invoice was not paid when the card was processed. System will try up to 5 times to process the card. (required)
Parameters:
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.
Returns:
a Invoice object.