com.simplify.payments.domain

Class InvoiceItem

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

All Implemented Interfaces:

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

public class InvoiceItem
extends PaymentsObject

A InvoiceItem 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	InvoiceItem()
protected	InvoiceItem(java.util.Map m)
protected	InvoiceItem(PaymentsObject o)

Method Summary

Modifier and Type	Method and Description
static InvoiceItem	create(Authentication auth, java.util.Map map) Creates an InvoiceItem object
static InvoiceItem	create(java.util.Map map) Creates an InvoiceItem object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static InvoiceItem	create(java.lang.String publicKey, java.lang.String privateKey, java.util.Map map) Deprecated. As of release 1.1, replaced by create(Authentication, Map)
InvoiceItem	delete() Deletes an InvoiceItem object.
static InvoiceItem	find(Authentication auth, java.lang.String id) Retrieve a InvoiceItem object.
static InvoiceItem	find(java.lang.String id) Retrieve a InvoiceItem object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static InvoiceItem	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()
InvoiceItem	update() Updates an InvoiceItem object.

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

InvoiceItem

protected InvoiceItem()

InvoiceItem

protected InvoiceItem(PaymentsObject o)

InvoiceItem

protected InvoiceItem(java.util.Map m)

Method Detail

getObjectType

protected java.lang.String getObjectType()

Specified by:

getObjectType in class PaymentsObject

create

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

Creates an InvoiceItem 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.Long amount

Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00 required

java.lang.String description

Individual items of an invoice [max length: 1024]

java.lang.String invoice

The ID of the invoice this item belongs to.

java.lang.String product

Product ID this item relates to.

java.lang.Long quantity

Quantity of the item. This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999, default: 1]

java.lang.String reference

User defined reference field. [max length: 255]

java.lang.String tax

The tax ID of the tax charge in the invoice item.

Returns:

a InvoiceItem object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

@Deprecated
public static InvoiceItem 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 InvoiceItem 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.Long amount

Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00 required

java.lang.String description

Individual items of an invoice [max length: 1024]

java.lang.String invoice

The ID of the invoice this item belongs to.

java.lang.String product

Product ID this item relates to.

java.lang.Long quantity

Quantity of the item. This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999, default: 1]

java.lang.String reference

User defined reference field. [max length: 255]

java.lang.String tax

The tax ID of the tax charge in the invoice item.

Returns:

a InvoiceItem object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

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

Creates an InvoiceItem 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.Long amount

Amount of the invoice item in the smallest unit of your currency. Example: 100 = $1.00 required

java.lang.String description

Individual items of an invoice [max length: 1024]

java.lang.String invoice

The ID of the invoice this item belongs to.

java.lang.String product

Product ID this item relates to.

java.lang.Long quantity

Quantity of the item. This total amount of the invoice item is the amount * quantity. [min value: 1, max value: 999999, default: 1]

java.lang.String reference

User defined reference field. [max length: 255]

java.lang.String tax

The tax ID of the tax charge in the invoice item.

Returns:

a InvoiceItem object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

delete

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

Deletes an InvoiceItem object.

Returns:

a InvoiceItem object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

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

Retrieve a InvoiceItem 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 InvoiceItem object to retrieve

Returns:

a InvoiceItem object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

@Deprecated
public static InvoiceItem 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 InvoiceItem 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 InvoiceItem object to retrieve

Returns:

a InvoiceItem object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

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

Retrieve a InvoiceItem 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 InvoiceItem object to retrieve

Returns:

a InvoiceItem object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

update

public InvoiceItem update()
                   throws ApiCommunicationException,
                          AuthenticationException,
                          InvalidRequestException,
                          ObjectNotFoundException,
                          NotAllowedException,
                          SystemException

Updates an InvoiceItem object. The properties that can be updated:

• amount
• description
• quantity
• reference
• tax

Returns:

a InvoiceItem object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException