API Documentation
\

\Simplify_InvoiceItem

Base class for all domain objects.

Summary

Methods
Properties
Constants
createInvoiceItem()
deleteInvoiceItem()
findInvoiceItem()
updateInvoiceItem()
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

createInvoiceItem()

createInvoiceItem(array $hash, mixed $authentication) : \InvoiceItem

Creates an Simplify_InvoiceItem object

Parameters

array $hash

a map of parameters; valid keys are:

amount
Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00 required
description
Individual items of an invoice [max length: 1024]
invoice
The ID of the invoice this item belongs to.
product
Product ID this item relates to.
quantity
Quantity of the item. This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999, default: 1]
reference
User defined reference field. [max length: 255]
tax
The tax ID of the tax charge in the invoice item.
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

\InvoiceItem —

a InvoiceItem object.

deleteInvoiceItem()

deleteInvoiceItem(mixed $authentication)

Deletes an Simplify_InvoiceItem 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.

findInvoiceItem()

findInvoiceItem( $id, mixed $authentication) : \InvoiceItem

Retrieve a Simplify_InvoiceItem 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

\InvoiceItem —

a InvoiceItem object

updateInvoiceItem()

updateInvoiceItem(mixed $authentication) : \InvoiceItem

Updates an Simplify_InvoiceItem object.

The properties that can be updated:

amount
Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00 [min value: 1]
description
Individual items of an invoice
quantity
Quantity of the item. This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999]
reference
User defined reference field.
tax
The tax ID of the tax charge in the invoice item.

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

\InvoiceItem —

a InvoiceItem 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.