Simplify Node.js API Docs

API Docs for:
Show:

Invoice Class

Defined in: simplify.js:1159

This is a Simplify domain object. In order to get access to a domain object, a client needs to be created. The client is then used to invoke the different methods e.g.

var client = Simplify.getClient({
                            publicKey: 'YOUR_PUBLIC_API_KEY',
                            privateKey: 'YOUR_PRIVATE_API_KEY'
                        });
                        
                        client.invoice.METHOD_NAME(params, function(error, data){
                            if(error){
                                // handle the error
                            }
                        
                            // Awesome...no error, handle the data
                        });

Constructor

Invoice

(
  • appKeys
)

Defined in simplify.js:1159

Parameters:

  • appKeys Object

    Object containing the public & private API keys

Item Index

Methods

Methods

create

(
  • params
  • callback
)

Defined in simplify.js:1185

Function to create a Invoice object.

Parameters:

  • params Object

    A map of parameters in which to create the Invoice from.

    Valid parameters include:

    • billingAddress.city : Billing address city of the location where the goods or services were supplied. [max length: 255, min length: 2]
    • billingAddress.country : Billing address country of the location where the goods or services were supplied. [max length: 2, min length: 2]
    • billingAddress.line1 : Billing address line 1 of the location where the goods or services were supplied. [max length: 255]
    • billingAddress.line2 : Billing address line 2 of the location where the goods or services were supplied. [max length: 255]
    • billingAddress.name : Billing address name of the location where the goods or services were supplied. Will use the customer name if not provided. [max length: 255]
    • billingAddress.state : Billing address state of the location where the goods or services were supplied. [max length: 255]
    • billingAddress.zip : Billing address zip of the location where the goods or services were supplied. [max length: 32]
    • businessAddress.city : Address city of the business that is sending the invoice. [max length: 255, min length: 2]
    • businessAddress.country : Address country of the business that is sending the invoice. [max length: 2, min length: 2]
    • businessAddress.line1 : Address line 1 of the business that is sending the invoice. [max length: 255]
    • businessAddress.line2 : Address line 2 of the business that is sending the invoice. [max length: 255]
    • businessAddress.name : The name of the business that is sending the invoice. [max length: 255]
    • businessAddress.state : Address state of the business that is sending the invoice. [max length: 255]
    • businessAddress.zip : Address zip of the business that is sending the invoice. [max length: 32]
    • currency : Currency code (ISO-4217). Must match the currency associated with your account. [max length: 3, min length: 3]
    • customer : The customer ID of the customer we are invoicing. This is optional if invoiceToCopy or a name and email are provided
    • customerTaxNo : The tax number or VAT id of the person to whom the goods or services were supplied. [max length: 255]
    • 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 customer or invoiceToCopy 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]
    • invoiceLanguage : The language in which invoice will be displayed. [max length: 5, min length: 5]
    • invoiceToCopy : The id of an existing invoice to be copied. This is optional if customer or a name and email are provided
    • items.amount : Amount of the invoice item (the smallest unit of your currency). Example: 100 = $1.00 (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.
    • 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.00
    • 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 customer or invoiceToCopy 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: 40]
    • shippingAddress.city : Address city of the location where the goods or services were supplied. [max length: 255, min length: 2]
    • shippingAddress.country : Address country of the location where the goods or services were supplied. [max length: 2, min length: 2]
    • shippingAddress.line1 : Address line 1 of the location where the goods or services were supplied. [max length: 255]
    • shippingAddress.line2 : Address line 2 of the location where the goods or services were supplied. [max length: 255]
    • shippingAddress.name : Address name of the location where the goods or services were supplied. [max length: 255]
    • shippingAddress.state : Address state of the location where the goods or services were supplied. [max length: 255]
    • shippingAddress.zip : Address zip of the location where the goods or services were supplied. [max length: 32]
    • suppliedDate : The date on which the goods or services were supplied.
    • taxNo : The tax number or VAT id of the person who supplied the goods or services. [max length: 255]
    • type : The type of invoice. One of WEB or MOBILE. [valid values: WEB, MOBILE, default: WEB]

    NOTE: Any parameters with a sub-parameter (e.g. param.subParam) need to be nested when passed as an argument in e.g.

    {
                                                    param: {
                                                    subParam1: 'value', 
                                                    subParam2: 'value'
                                                }
                                            }
  • callback Function

    A function to handle success/error responses from the API.
    The function takes 2 parameters, the first is an error object. This is null if no error occurs. The second parameter is the response data. This is null if an error occurs.

delete

(
  • A
  • callback
)

Defined in simplify.js:1255

Function to delete a Invoice object.

Parameters:

  • A Object

    string ID of the Invoice to delete.

  • callback Function

    A function to handle success/error responses from the API.
    The function takes 2 parameters, the first is an error object. This is null if no error occurs. The second parameter is the response data. This is null if an error occurs.

find

(
  • id
  • callback
)

Defined in simplify.js:1301

Function to retrieve a Invoice object from the API.

Parameters:

  • id String

    The ID of the Invoice to retrieve

  • callback Function

    A function to handle success/error responses from the API.
    The function takes 2 parameters, the first is an error object. This is null if no error occurs. The second parameter is the response data. This is null if an error occurs.

list

(
  • params
  • callback
)

Defined in simplify.js:1272

Function to retrieve a list Invoice objects.

Parameters:

  • params Object

    A map of parameters in which to define the Invoice list from.

    Valid parameters include:

    • filter :
      filter.idFilter by the invoice Id
      filter.amountFilter by the invoice amount (in the smallest unit of your currency)
      filter.textFilter by the name of the invoice
      filter.dateCreatedMinFilter by the minimum created date you are searching for - Date in UTC millis
      filter.dateCreatedMaxFilter by the maximum created date you are searching for - Date in UTC millis
      filter.datePaidMinFilter by the minimum invoice paid date you are searching for - Date in UTC millis
      filter.datePaidMaxFilter by the maximum invoice paid date you are searching for - Date in UTC millis
      filter.statusFilter by the status of the invoice
      filter.statusesFilter by multiple statuses of different invoices
      filter.customerFilter using the Id of the customer linked to the invoice
      filter.typeFilter by the invoice type
      filter.typesFilter by multiple invoice types
      filter.invoiceIdFilter by the user defined invoice id
      filter.referenceFilter by the invoice reference text

      *The filters datePaidMin and datePaidMax can be used in the same filter if you want to search between the two dates. The same is for dateCreatedMin/dateCreatedMax.
    • max : Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
    • offset : Used in paging of the list. This is the start offset of the page. [min value: 0, 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
      • dateCreated

    NOTE: Any parameters with a sub-parameter (e.g. param.subParam) need to be nested when passed as an argument in e.g.

    {
                                                    param: {
                                                    subParam1: 'value', 
                                                    subParam2: 'value'
                                                }
                                            }
  • callback Function

    A function to handle success/error responses from the API.
    The function takes 2 parameters, the first is an error object. This is null if no error occurs. The second parameter is the response data. This is null if an error occurs.

update

(
  • params
  • callback
)

Defined in simplify.js:1318

Function to update a Invoice object.

Parameters:

  • params Object

    A map of parameters on which to update the Invoice object.

    Valid parameters include:

    • id : A string ID of the Invoice object to update
    • billingAddress.city : Billing address city of the location where the goods or services were supplied. [max length: 255, min length: 2]
    • billingAddress.country : Billing address country of the location where the goods or services were supplied. [max length: 2, min length: 2]
    • billingAddress.line1 : Billing address line 1 of the location where the goods or services were supplied. [max length: 255]
    • billingAddress.line2 : Billing address line 2 of the location where the goods or services were supplied. [max length: 255]
    • billingAddress.name : Billing address name of the location where the goods or services were supplied. [max length: 255]
    • billingAddress.state : Billing address state of the location where the goods or services were supplied. [max length: 255]
    • billingAddress.zip : Billing address zip of the location where the goods or services were supplied. [max length: 32]
    • businessAddress.city : Business address city of the business that is sending the invoice. [max length: 255, min length: 2]
    • businessAddress.country : Business address country of the business that is sending the invoice. [max length: 2, min length: 2]
    • businessAddress.line1 : Business address line 1 of the business that is sending the invoice. [max length: 255]
    • businessAddress.line2 : Business address line 2 of the business that is sending the invoice. [max length: 255]
    • businessAddress.name : Business address name of the business that is sending the invoice. [max length: 255]
    • businessAddress.state : Business address state of the business that is sending the invoice. [max length: 255]
    • businessAddress.zip : Business address zip of the business that is sending the invoice. [max length: 32]
    • currency : Currency code (ISO-4217). Must match the currency associated with your account. [max length: 3, min length: 3]
    • customerTaxNo : The tax number or VAT id of the person to whom the goods or services were supplied. [max length: 255]
    • 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.
    • email : The email of the customer we are invoicing. This is optional if customer or invoiceToCopy 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]
    • invoiceLanguage : The language in which invoice will be displayed. [max length: 5, min length: 5]
    • items.amount : Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00 (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.
    • 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.00
    • 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 customer or invoiceToCopy 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]
    • 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]
    • sendMail : Boolean flag. If true the invoice will be sent to the customer if the invoice is in an OPEN state. [default: false] (REQUIRED)
    • shippingAddress.city : Address city of the location where the goods or services were supplied. [max length: 255, min length: 2]
    • shippingAddress.country : Address country of the location where the goods or services were supplied. [max length: 2, min length: 2]
    • shippingAddress.line1 : Address line 1 of the location where the goods or services were supplied. [max length: 255]
    • shippingAddress.line2 : Address line 2 of the location where the goods or services were supplied. [max length: 255]
    • shippingAddress.name : Address name of the location where the goods or services were supplied. [max length: 255]
    • shippingAddress.state : Address state of the location where the goods or services were supplied. [max length: 255]
    • shippingAddress.zip : Address zip of the location where the goods or services were supplied. [max length: 32]
    • status : New status of the invoice.
    • suppliedDate : The date on which the goods or services were supplied.
    • taxNo : The tax number or VAT id of the person who supplied the goods or services. [max length: 255]

    NOTE: Any parameters with a sub-parameter (e.g. param.subParam) need to be nested when passed as an argument in e.g.

    {
                                                    param: {
                                                    subParam1: 'value', 
                                                    subParam2: 'value'
                                                }
                                            }
  • callback Function

    A function to handle success/error responses from the API.
    The function takes 2 parameters, the first is an error object. This is null if no error occurs. The second parameter is the response data. This is null if an error occurs.