API Documentation
\

\Simplify_Tax

Base class for all domain objects.

Summary

Methods
Properties
Constants
createTax()
deleteTax()
listTax()
findTax()
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

createTax()

createTax(array $hash, mixed $authentication) : \Tax

Creates an Simplify_Tax object

Parameters

array $hash

a map of parameters; valid keys are:

label
The label of the tax object. [max length: 255] required
rate
The tax rate. Decimal value up three decimal places. e.g 12.501. [max length: 6] required
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

\Tax —

a Tax object.

deleteTax()

deleteTax(mixed $authentication)

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

listTax()

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

Retrieve Simplify_Tax 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 Tax objects and the total number of Tax objects available for the given criteria.

findTax()

findTax( $id, mixed $authentication) : \Tax

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

\Tax —

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