* amount Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00USD [min value: -9999900, max value: 9999900] 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.
* @param $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.
* @return InvoiceItem a InvoiceItem object.
*/
static public function createInvoiceItem($hash, $authentication = null) {
$args = func_get_args();
$authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
$instance = new Simplify_InvoiceItem();
$instance->setAll($hash);
$object = Simplify_PaymentsApi::createObject($instance, $authentication);
return $object;
}
/**
* Deletes an Simplify_InvoiceItem object.
*
* @param $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.
*
* @return true
*/
public function deleteInvoiceItem($authentication = null) {
$args = func_get_args();
$authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
$obj = Simplify_PaymentsApi::deleteObject($this, $authentication);
$this->properties = null;
return true;
}
/**
* Retrieve a Simplify_InvoiceItem object from the API
*
* @param string id the id of the InvoiceItem object to retrieve
* @param $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.
* @return InvoiceItem a InvoiceItem object
*/
static public function findInvoiceItem($id, $authentication = null) {
$args = func_get_args();
$authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2);
$val = new Simplify_InvoiceItem();
$val->id = $id;
$obj = Simplify_PaymentsApi::findObject($val, $authentication);
return $obj;
}
/**
* 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.00USD [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.
* @param $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.
* @return InvoiceItem a InvoiceItem object.
*/
public function updateInvoiceItem($authentication = null) {
$args = func_get_args();
$authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1);
$object = Simplify_PaymentsApi::updateObject($this, $authentication);
return $object;
}
/**
* @ignore
*/
public function getClazz() {
return "InvoiceItem";
}
}