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

Class Invoice

source code

domain.Domain --+
                |
               Invoice

A Invoice object.

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

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

Static Methods [hide private]
 
create(params, *auth_args)
Creates an Invoice object
source code
 
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]

create(params, *auth_args)
Static Method

source code 

Creates an Invoice object

Parameters:
  • params - a dict of parameters; valid keys are:
    • currency: Currency code (ISO-4217). Must match the currency associated with your account. [max length: 3, min length: 3, default: USD]
    • customer: The customer ID of the customer we are invoicing. This is optional is a name and email are provided
    • discountRate: The discount percent as a decimal e.g. 12.5. This is used to calculate the discount amount which is subtracted from the total amount due before any tax is applied. [max length: 6]
    • dueDate: The date invoice payment is due. If a late fee is provided this will be added to the invoice total is the due date has past.
    • email: The email of the customer we are invoicing. This is optional if a customer id is provided. A new customer will be created using the the name and email.
    • invoiceId: User defined invoice id. If not provided the system will generate a numeric id. [max length: 255]
    • items => amount: Amount of the invoice item (the smallest unit of your currency). Example: 100 = $1.00USD [min value: 1, max value: 9999900] required
    • items => description: The description of the invoice item. [max length: 1024]
    • items => invoice: The ID of the invoice this item belongs to.
    • items => product: The product this invoice item refers to. required
    • items => quantity: Quantity of the item. This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999, default: 1]
    • items => reference: User defined reference field. [max length: 255]
    • items => tax: The tax ID of the tax charge in the invoice item.
    • lateFee: The late fee amount that will be added to the invoice total is the due date is past due. Value provided must be in the smallest unit of your currency. Example: 100 = $1.00USD [max value: 9999900]
    • memo: A memo that is displayed to the customer on the invoice payment screen. [max length: 4000]
    • name: The name of the customer we are invoicing. This is optional if a customer id is provided. A new customer will be created using the the name and email. [max length: 50, min length: 2]
    • note: This field can be used to store a note that is not displayed to the customer. [max length: 4000]
    • reference: User defined reference field. [max length: 255]
    • shippingAddressLine1: Address Line 1 where the product should be shipped. [max length: 255]
    • shippingAddressLine2: Address Line 2 where the product should be shipped. [max length: 255]
    • shippingCity: City where the product should be shipped. [max length: 255, min length: 2]
    • shippingCountry: Country where the product should be shipped. [max length: 2, min length: 2]
    • shippingState: State where the product should be shipped. [max length: 2, min length: 2]
    • shippingZip: ZIP code where the product should be shipped. [max length: 9, min length: 5]
    • type: The type of invoice. One of WEB or MOBILE. [valid values: WEB, MOBILE, default: WEB]
  • 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.
  • private_api_key - Private key to use for the API call. If None, the value of simplify.private_key will be used.
Returns:
a Invoice object

delete(self, *auth_args)

source code 

Delete this object

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.

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. [max value: 50, 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 dueDate datePaid customer status.
  • 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:

  • datePaid This is the date the invoice was PAID in UTC millis.
  • discountRate The discount percent as a decimal e.g. 12.5. This is used to calculate the discount amount which is subtracted from the total amount due before any tax is applied. [max length: 6]
  • dueDate The date invoice payment is due. If a late fee is provided this will be added to the invoice total is the due date has past.
  • items => amount Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00USD [min value: 1, max value: 9999900] (required)
  • items => description The description of the invoice item. [max length: 1024]
  • items => invoice The ID of the invoice this item belongs to.
  • items => product The Id of the product this item refers to. (required)
  • items => quantity Quantity of the item. This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999, default: 1]
  • items => reference User defined reference field. [max length: 255]
  • items => tax The tax ID of the tax charge in the invoice item.
  • lateFee The late fee amount that will be added to the invoice total is the due date is past due. Value provided must be in the smallest unit of your currency. Example: 100 = $1.00USD
  • memo A memo that is displayed to the customer on the invoice payment screen. [max length: 4000]
  • note This field can be used to store a note that is not displayed to the customer. [max length: 4000]
  • payment The ID of the payment. Use this ID to query the /payment API. [max length: 255]
  • reference User defined reference field. [max length: 255]
  • shippingAddressLine1 The shipping address line 1 for the product. [max length: 255]
  • shippingAddressLine2 The shipping address line 2 for the product. [max length: 255]
  • shippingCity The shipping city for the product. [max length: 255, min length: 2]
  • shippingCountry The shipping country for the product. [max length: 2, min length: 2]
  • shippingState The shipping state for the product. [max length: 2, min length: 2]
  • shippingZip The shipping ZIP code for the product. [max length: 9, min length: 5]
  • status New status of the invoice.
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.