com.simplify.payments.domain

Class Tax

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<java.lang.String,java.lang.Object>

com.simplify.payments.PaymentsMap

com.simplify.payments.PaymentsObject

com.simplify.payments.domain.Tax

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class Tax
extends PaymentsObject

A Tax object.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields inherited from class com.simplify.payments.PaymentsObject

authentication

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Tax()
protected	Tax(java.util.Map m)
protected	Tax(PaymentsObject o)

Method Summary

Modifier and Type	Method and Description
static Tax	create(Authentication auth, java.util.Map map) Creates an Tax object
static Tax	create(java.util.Map map) Creates an Tax object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static Tax	create(java.lang.String publicKey, java.lang.String privateKey, java.util.Map map) Deprecated. As of release 1.1, replaced by create(Authentication, Map)
Tax	delete() Deletes an Tax object.
static Tax	find(Authentication auth, java.lang.String id) Retrieve a Tax object.
static Tax	find(java.lang.String id) Retrieve a Tax object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static Tax	find(java.lang.String publicKey, java.lang.String privateKey, java.lang.String id) Deprecated. As of release 1.1, replaced by find(Authentication, String)
protected java.lang.String	getObjectType()
static ResourceList<Tax>	list() Retrieve Tax objects using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively and the default criteria (max 20, offset 0, default sorting and no filtering).
static ResourceList<Tax>	list(Authentication auth) Retrieve Tax objects using the default criteria (max 20, offset 0, default sorting and no filtering).
static ResourceList<Tax>	list(Authentication auth, java.util.Map criteria) Retrieve Tax objects using the specified criteria.
static ResourceList<Tax>	list(java.util.Map criteria) Retrieve Tax objects using the specified criteria and using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static ResourceList<Tax>	list(java.lang.String publicKey, java.lang.String privateKey) Deprecated. As of release 1.1, replaced by list(Authentication)
static ResourceList<Tax>	list(java.lang.String publicKey, java.lang.String privateKey, java.util.Map criteria) Deprecated. As of release 1.1, replaced by list(Authentication, Map)

Methods inherited from class com.simplify.payments.PaymentsObject

createObject, deleteObject, findObject, getAuthentication, listObjects, listObjects, updateObject

Methods inherited from class com.simplify.payments.PaymentsMap

containsKey, get, normalize, put, remove, set

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Constructor Detail

Tax

protected Tax()

Tax

protected Tax(PaymentsObject o)

Tax

protected Tax(java.util.Map m)

Method Detail

getObjectType

protected java.lang.String getObjectType()

Specified by:

getObjectType in class PaymentsObject

create

public static Tax create(java.util.Map map)
                  throws ApiCommunicationException,
                         AuthenticationException,
                         InvalidRequestException,
                         NotAllowedException,
                         SystemException

Creates an Tax object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

map - a map of parameters, valid keys and types:

java.lang.String label

The label of the tax object. [max length: 255] required

java.lang.String rate

The tax rate. Decimal value up three decimal places. e.g 12.501. [max length: 6] required

Returns:

a Tax object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

@Deprecated
public static Tax create(java.lang.String publicKey,
                                     java.lang.String privateKey,
                                     java.util.Map map)
                              throws ApiCommunicationException,
                                     AuthenticationException,
                                     InvalidRequestException,
                                     NotAllowedException,
                                     SystemException

Deprecated. As of release 1.1, replaced by create(Authentication, Map)

Creates an Tax object

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

map - a map of parameters, valid keys and types:

java.lang.String label

The label of the tax object. [max length: 255] required

java.lang.String rate

The tax rate. Decimal value up three decimal places. e.g 12.501. [max length: 6] required

Returns:

a Tax object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

public static Tax create(Authentication auth,
                         java.util.Map map)
                  throws ApiCommunicationException,
                         AuthenticationException,
                         InvalidRequestException,
                         NotAllowedException,
                         SystemException

Creates an Tax object

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

map - a map of parameters, valid keys and types:

java.lang.String label

The label of the tax object. [max length: 255] required

java.lang.String rate

The tax rate. Decimal value up three decimal places. e.g 12.501. [max length: 6] required

Returns:

a Tax object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

delete

public Tax delete()
           throws ApiCommunicationException,
                  AuthenticationException,
                  InvalidRequestException,
                  ObjectNotFoundException,
                  NotAllowedException,
                  SystemException

Deletes an Tax object.

Returns:

a Tax object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

list

public static ResourceList<Tax> list()
                              throws ApiCommunicationException,
                                     AuthenticationException,
                                     InvalidRequestException,
                                     NotAllowedException,
                                     SystemException

Retrieve Tax objects using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively and the default criteria (max 20, offset 0, default sorting and no filtering).

Returns:

a ResourceList object which holds the list of Tax objects and the total number of Tax objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

@Deprecated
public static ResourceList<Tax> list(java.lang.String publicKey,
                                                 java.lang.String privateKey)
                                          throws ApiCommunicationException,
                                                 AuthenticationException,
                                                 InvalidRequestException,
                                                 NotAllowedException,
                                                 SystemException

Deprecated. As of release 1.1, replaced by list(Authentication)

Retrieve Tax objects using the default criteria (max 20, offset 0, default sorting and no filtering).

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

Returns:

a ResourceList object which holds the list of Tax objects and the total number of Tax objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Tax> list(Authentication auth)
                              throws ApiCommunicationException,
                                     AuthenticationException,
                                     InvalidRequestException,
                                     NotAllowedException,
                                     SystemException

Retrieve Tax objects using the default criteria (max 20, offset 0, default sorting and no filtering).

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

Returns:

a ResourceList object which holds the list of Tax objects and the total number of Tax objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Tax> list(java.util.Map criteria)
                              throws ApiCommunicationException,
                                     AuthenticationException,
                                     InvalidRequestException,
                                     NotAllowedException,
                                     SystemException

Retrieve Tax objects using the specified criteria and using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

filter.id	Filter by the Id of the tax
filter.label	Filter by the label(name) of the tax

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map 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 label .

Returns:

a ResourceList object which holds the list of Tax objects and the total number of Tax objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Tax> list(java.lang.String publicKey,
                                     java.lang.String privateKey,
                                     java.util.Map criteria)
                              throws ApiCommunicationException,
                                     AuthenticationException,
                                     InvalidRequestException,
                                     NotAllowedException,
                                     SystemException

Deprecated. As of release 1.1, replaced by list(Authentication, Map)

Retrieve Tax objects using the specified criteria.

Parameters:

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

filter.id	Filter by the Id of the tax
filter.label	Filter by the label(name) of the tax

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map 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 label .

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

Returns:

a ResourceList object which holds the list of Tax objects and the total number of Tax objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Tax> list(Authentication auth,
                                     java.util.Map criteria)
                              throws ApiCommunicationException,
                                     AuthenticationException,
                                     InvalidRequestException,
                                     NotAllowedException,
                                     SystemException

Retrieve Tax objects using the specified criteria.

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

filter.id	Filter by the Id of the tax
filter.label	Filter by the label(name) of the tax

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map 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 label .

Returns:

a ResourceList object which holds the list of Tax objects and the total number of Tax objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

find

public static Tax find(java.lang.String id)
                throws ApiCommunicationException,
                       AuthenticationException,
                       InvalidRequestException,
                       ObjectNotFoundException,
                       NotAllowedException,
                       SystemException

Retrieve a Tax object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

id - the id of the Tax object to retrieve

Returns:

a Tax object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

@Deprecated
public static Tax find(java.lang.String publicKey,
                                   java.lang.String privateKey,
                                   java.lang.String id)
                            throws ApiCommunicationException,
                                   AuthenticationException,
                                   InvalidRequestException,
                                   ObjectNotFoundException,
                                   NotAllowedException,
                                   SystemException

Deprecated. As of release 1.1, replaced by find(Authentication, String)

Retrieve a Tax object.

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

id - the id of the Tax object to retrieve

Returns:

a Tax object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

public static Tax find(Authentication auth,
                       java.lang.String id)
                throws ApiCommunicationException,
                       AuthenticationException,
                       InvalidRequestException,
                       ObjectNotFoundException,
                       NotAllowedException,
                       SystemException

Retrieve a Tax object.

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

id - the id of the Tax object to retrieve

Returns:

a Tax object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException