\Simplify_Invoice

Base class for all domain objects.

Summary

Methods
Properties
Constants
createInvoice()
deleteInvoice()
listInvoice()
findInvoice()
updateInvoice()
setAll()
getProperties()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$properties
N/A

Properties

$properties

$properties

Methods

createInvoice()

createInvoice(array $hash, mixed $authentication) : \Invoice

Creates an Simplify_Invoice object

Parameters

array $hash

a map of parameters; valid keys are:

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]
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.<i/>

Returns

\Invoice —

a Invoice object.

deleteInvoice()

deleteInvoice(mixed $authentication)

Deletes an Simplify_Invoice object.

Parameters

mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

listInvoice()

listInvoice( $criteria, mixed $authentication) : \ResourceList

Retrieve Simplify_Invoice objects.

Parameters

$criteria
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\ResourceList —

a ResourceList object that holds the list of Invoice objects and the total number of Invoice objects available for the given criteria.

findInvoice()

findInvoice( $id, mixed $authentication) : \Invoice

Retrieve a Simplify_Invoice object from the API

Parameters

$id
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\Invoice —

a Invoice object

updateInvoice()

updateInvoice(mixed $authentication) : \Invoice

Updates an Simplify_Invoice object.

The properties that can be updated:

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]

Parameters

mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\Invoice —

a Invoice object.

setAll()

setAll(mixed $hash)

Updates the object's properties with the values in the specified map.

Parameters

mixed $hash

array Map of values to set.

getProperties()

getProperties() : array

Returns the object's properties as a map.

Returns

array —

map of properties.