com.simplify.payments.domain

Class Invoice

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

All Implemented Interfaces:

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

public class Invoice
extends PaymentsObject

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

Method Summary

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

Invoice

protected Invoice()

Invoice

protected Invoice(PaymentsObject o)

Invoice

protected Invoice(java.util.Map m)

Method Detail

getObjectType

protected java.lang.String getObjectType()

Specified by:

getObjectType in class PaymentsObject

create

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

Creates an Invoice 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:

payments.command.api.APIAddressCommand billingAddress

The name and address of the person who supplied the goods or services.

java.lang.String billingAddress.city

Billing address city of the location where the goods or services were supplied. [max length: 255, min length: 2]

java.lang.String billingAddress.country

Billing address country of the location where the goods or services were supplied. [max length: 2, min length: 2]

java.lang.String billingAddress.line1

Billing address line 1 of the location where the goods or services were supplied. [max length: 255]

java.lang.String billingAddress.line2

Billing address line 2 of the location where the goods or services were supplied. [max length: 255]

java.lang.String billingAddress.name

Billing address name of the location where the goods or services were supplied. Will use the customer name if not provided. [max length: 255]

java.lang.String billingAddress.state

Billing address state of the location where the goods or services were supplied. [max length: 255]

java.lang.String billingAddress.zip

Billing address zip of the location where the goods or services were supplied. [max length: 32]

payments.command.api.APIAddressCommand businessAddress

The name and address of the business that is sending the invoice.

java.lang.String businessAddress.city

Address city of the business that is sending the invoice. [max length: 255, min length: 2]

java.lang.String businessAddress.country

Address country of the business that is sending the invoice. [max length: 2, min length: 2]

java.lang.String businessAddress.line1

Address line 1 of the business that is sending the invoice. [max length: 255]

java.lang.String businessAddress.line2

Address line 2 of the business that is sending the invoice. [max length: 255]

java.lang.String businessAddress.name

The name of the business that is sending the invoice. [max length: 255]

java.lang.String businessAddress.state

Address state of the business that is sending the invoice. [max length: 255]

java.lang.String businessAddress.zip

Address zip of the business that is sending the invoice. [max length: 32]

java.lang.String currency

Currency code (ISO-4217). Must match the currency associated with your account. [max length: 3, min length: 3]

java.lang.String customer

The customer ID of the customer we are invoicing. This is optional if invoiceToCopy or a name and email are provided

java.lang.String customerTaxNo

The tax number or VAT id of the person to whom the goods or services were supplied. [max length: 255]

java.lang.String discountRate

The discount percent as a decimal e.g. 12.5. This is used to calculate the discount amount which is subtracted from the total amount due before any tax is applied. [max length: 6]

java.lang.Long dueDate

The date invoice payment is due. If a late fee is provided this will be added to the invoice total is the due date has past.

java.lang.String email

The email of the customer we are invoicing. This is optional if customer or invoiceToCopy is provided. A new customer will be created using the the name and email.

java.lang.String invoiceId

User defined invoice id. If not provided the system will generate a numeric id. [max length: 255]

java.lang.String invoiceLanguage

The language in which invoice will be displayed. [max length: 5, min length: 5]

java.lang.String invoiceToCopy

The id of an existing invoice to be copied. This is optional if customer or a name and email are provided

payments.command.api.APIInvoiceItemCreateCommand items

The set of invoice items.

java.lang.Long items.amount

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

java.lang.String items.description

The description of the invoice item. [max length: 1024]

java.lang.String items.invoice

The ID of the invoice this item belongs to.

java.lang.String items.product

The product this invoice item refers to.

java.lang.Long items.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 items.reference

User defined reference field. [max length: 255]

java.lang.String items.tax

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

java.lang.Long lateFee

The late fee amount that will be added to the invoice total is the due date is past due. Value provided must be in the smallest unit of your currency. Example: 100 = $1.00

java.lang.String memo

A memo that is displayed to the customer on the invoice payment screen. [max length: 4000]

java.lang.String name

The name of the customer we are invoicing. This is optional if customer or invoiceToCopy is provided. A new customer will be created using the the name and email. [max length: 50, min length: 2]

java.lang.String note

This field can be used to store a note that is not displayed to the customer. [max length: 4000]

java.lang.String reference

User defined reference field. [max length: 40]

payments.command.api.APIAddressCommand shippingAddress

The name and address of the location where the goods or services were supplied.

java.lang.String shippingAddress.city

Address city of the location where the goods or services were supplied. [max length: 255, min length: 2]

java.lang.String shippingAddress.country

Address country of the location where the goods or services were supplied. [max length: 2, min length: 2]

java.lang.String shippingAddress.line1

Address line 1 of the location where the goods or services were supplied. [max length: 255]

java.lang.String shippingAddress.line2

Address line 2 of the location where the goods or services were supplied. [max length: 255]

java.lang.String shippingAddress.name

Address name of the location where the goods or services were supplied. [max length: 255]

java.lang.String shippingAddress.state

Address state of the location where the goods or services were supplied. [max length: 255]

java.lang.String shippingAddress.zip

Address zip of the location where the goods or services were supplied. [max length: 32]

java.lang.Long suppliedDate

The date on which the goods or services were supplied.

java.lang.String taxNo

The tax number or VAT id of the person who supplied the goods or services. [max length: 255]

java.lang.String type

The type of invoice. One of WEB or MOBILE. [valid values: WEB, MOBILE, default: WEB]

Returns:

a Invoice object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

@Deprecated
public static Invoice 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 Invoice 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:

payments.command.api.APIAddressCommand billingAddress

The name and address of the person who supplied the goods or services.

java.lang.String billingAddress.city

Billing address city of the location where the goods or services were supplied. [max length: 255, min length: 2]

java.lang.String billingAddress.country

Billing address country of the location where the goods or services were supplied. [max length: 2, min length: 2]

java.lang.String billingAddress.line1

Billing address line 1 of the location where the goods or services were supplied. [max length: 255]

java.lang.String billingAddress.line2

Billing address line 2 of the location where the goods or services were supplied. [max length: 255]

java.lang.String billingAddress.name

Billing address name of the location where the goods or services were supplied. Will use the customer name if not provided. [max length: 255]

java.lang.String billingAddress.state

Billing address state of the location where the goods or services were supplied. [max length: 255]

java.lang.String billingAddress.zip

Billing address zip of the location where the goods or services were supplied. [max length: 32]

payments.command.api.APIAddressCommand businessAddress

The name and address of the business that is sending the invoice.

java.lang.String businessAddress.city

Address city of the business that is sending the invoice. [max length: 255, min length: 2]

java.lang.String businessAddress.country

Address country of the business that is sending the invoice. [max length: 2, min length: 2]

java.lang.String businessAddress.line1

Address line 1 of the business that is sending the invoice. [max length: 255]

java.lang.String businessAddress.line2

Address line 2 of the business that is sending the invoice. [max length: 255]

java.lang.String businessAddress.name

The name of the business that is sending the invoice. [max length: 255]

java.lang.String businessAddress.state

Address state of the business that is sending the invoice. [max length: 255]

java.lang.String businessAddress.zip

Address zip of the business that is sending the invoice. [max length: 32]

java.lang.String currency

Currency code (ISO-4217). Must match the currency associated with your account. [max length: 3, min length: 3]

java.lang.String customer

The customer ID of the customer we are invoicing. This is optional if invoiceToCopy or a name and email are provided

java.lang.String customerTaxNo

The tax number or VAT id of the person to whom the goods or services were supplied. [max length: 255]

java.lang.String discountRate

The discount percent as a decimal e.g. 12.5. This is used to calculate the discount amount which is subtracted from the total amount due before any tax is applied. [max length: 6]

java.lang.Long dueDate

The date invoice payment is due. If a late fee is provided this will be added to the invoice total is the due date has past.

java.lang.String email

The email of the customer we are invoicing. This is optional if customer or invoiceToCopy is provided. A new customer will be created using the the name and email.

java.lang.String invoiceId

User defined invoice id. If not provided the system will generate a numeric id. [max length: 255]

java.lang.String invoiceLanguage

The language in which invoice will be displayed. [max length: 5, min length: 5]

java.lang.String invoiceToCopy

The id of an existing invoice to be copied. This is optional if customer or a name and email are provided

payments.command.api.APIInvoiceItemCreateCommand items

The set of invoice items.

java.lang.Long items.amount

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

java.lang.String items.description

The description of the invoice item. [max length: 1024]

java.lang.String items.invoice

The ID of the invoice this item belongs to.

java.lang.String items.product

The product this invoice item refers to.

java.lang.Long items.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 items.reference

User defined reference field. [max length: 255]

java.lang.String items.tax

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

java.lang.Long lateFee

The late fee amount that will be added to the invoice total is the due date is past due. Value provided must be in the smallest unit of your currency. Example: 100 = $1.00

java.lang.String memo

A memo that is displayed to the customer on the invoice payment screen. [max length: 4000]

java.lang.String name

The name of the customer we are invoicing. This is optional if customer or invoiceToCopy is provided. A new customer will be created using the the name and email. [max length: 50, min length: 2]

java.lang.String note

This field can be used to store a note that is not displayed to the customer. [max length: 4000]

java.lang.String reference

User defined reference field. [max length: 40]

payments.command.api.APIAddressCommand shippingAddress

The name and address of the location where the goods or services were supplied.

java.lang.String shippingAddress.city

Address city of the location where the goods or services were supplied. [max length: 255, min length: 2]

java.lang.String shippingAddress.country

Address country of the location where the goods or services were supplied. [max length: 2, min length: 2]

java.lang.String shippingAddress.line1

Address line 1 of the location where the goods or services were supplied. [max length: 255]

java.lang.String shippingAddress.line2

Address line 2 of the location where the goods or services were supplied. [max length: 255]

java.lang.String shippingAddress.name

Address name of the location where the goods or services were supplied. [max length: 255]

java.lang.String shippingAddress.state

Address state of the location where the goods or services were supplied. [max length: 255]

java.lang.String shippingAddress.zip

Address zip of the location where the goods or services were supplied. [max length: 32]

java.lang.Long suppliedDate

The date on which the goods or services were supplied.

java.lang.String taxNo

The tax number or VAT id of the person who supplied the goods or services. [max length: 255]

java.lang.String type

The type of invoice. One of WEB or MOBILE. [valid values: WEB, MOBILE, default: WEB]

Returns:

a Invoice object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

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

Creates an Invoice 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:

payments.command.api.APIAddressCommand billingAddress

The name and address of the person who supplied the goods or services.

java.lang.String billingAddress.city

Billing address city of the location where the goods or services were supplied. [max length: 255, min length: 2]

java.lang.String billingAddress.country

Billing address country of the location where the goods or services were supplied. [max length: 2, min length: 2]

java.lang.String billingAddress.line1

Billing address line 1 of the location where the goods or services were supplied. [max length: 255]

java.lang.String billingAddress.line2

Billing address line 2 of the location where the goods or services were supplied. [max length: 255]

java.lang.String billingAddress.name

Billing address name of the location where the goods or services were supplied. Will use the customer name if not provided. [max length: 255]

java.lang.String billingAddress.state

Billing address state of the location where the goods or services were supplied. [max length: 255]

java.lang.String billingAddress.zip

Billing address zip of the location where the goods or services were supplied. [max length: 32]

payments.command.api.APIAddressCommand businessAddress

The name and address of the business that is sending the invoice.

java.lang.String businessAddress.city

Address city of the business that is sending the invoice. [max length: 255, min length: 2]

java.lang.String businessAddress.country

Address country of the business that is sending the invoice. [max length: 2, min length: 2]

java.lang.String businessAddress.line1

Address line 1 of the business that is sending the invoice. [max length: 255]

java.lang.String businessAddress.line2

Address line 2 of the business that is sending the invoice. [max length: 255]

java.lang.String businessAddress.name

The name of the business that is sending the invoice. [max length: 255]

java.lang.String businessAddress.state

Address state of the business that is sending the invoice. [max length: 255]

java.lang.String businessAddress.zip

Address zip of the business that is sending the invoice. [max length: 32]

java.lang.String currency

Currency code (ISO-4217). Must match the currency associated with your account. [max length: 3, min length: 3]

java.lang.String customer

The customer ID of the customer we are invoicing. This is optional if invoiceToCopy or a name and email are provided

java.lang.String customerTaxNo

The tax number or VAT id of the person to whom the goods or services were supplied. [max length: 255]

java.lang.String discountRate

The discount percent as a decimal e.g. 12.5. This is used to calculate the discount amount which is subtracted from the total amount due before any tax is applied. [max length: 6]

java.lang.Long dueDate

The date invoice payment is due. If a late fee is provided this will be added to the invoice total is the due date has past.

java.lang.String email

The email of the customer we are invoicing. This is optional if customer or invoiceToCopy is provided. A new customer will be created using the the name and email.

java.lang.String invoiceId

User defined invoice id. If not provided the system will generate a numeric id. [max length: 255]

java.lang.String invoiceLanguage

The language in which invoice will be displayed. [max length: 5, min length: 5]

java.lang.String invoiceToCopy

The id of an existing invoice to be copied. This is optional if customer or a name and email are provided

payments.command.api.APIInvoiceItemCreateCommand items

The set of invoice items.

java.lang.Long items.amount

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

java.lang.String items.description

The description of the invoice item. [max length: 1024]

java.lang.String items.invoice

The ID of the invoice this item belongs to.

java.lang.String items.product

The product this invoice item refers to.

java.lang.Long items.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 items.reference

User defined reference field. [max length: 255]

java.lang.String items.tax

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

java.lang.Long lateFee

The late fee amount that will be added to the invoice total is the due date is past due. Value provided must be in the smallest unit of your currency. Example: 100 = $1.00

java.lang.String memo

A memo that is displayed to the customer on the invoice payment screen. [max length: 4000]

java.lang.String name

The name of the customer we are invoicing. This is optional if customer or invoiceToCopy is provided. A new customer will be created using the the name and email. [max length: 50, min length: 2]

java.lang.String note

This field can be used to store a note that is not displayed to the customer. [max length: 4000]

java.lang.String reference

User defined reference field. [max length: 40]

payments.command.api.APIAddressCommand shippingAddress

The name and address of the location where the goods or services were supplied.

java.lang.String shippingAddress.city

Address city of the location where the goods or services were supplied. [max length: 255, min length: 2]

java.lang.String shippingAddress.country

Address country of the location where the goods or services were supplied. [max length: 2, min length: 2]

java.lang.String shippingAddress.line1

Address line 1 of the location where the goods or services were supplied. [max length: 255]

java.lang.String shippingAddress.line2

Address line 2 of the location where the goods or services were supplied. [max length: 255]

java.lang.String shippingAddress.name

Address name of the location where the goods or services were supplied. [max length: 255]

java.lang.String shippingAddress.state

Address state of the location where the goods or services were supplied. [max length: 255]

java.lang.String shippingAddress.zip

Address zip of the location where the goods or services were supplied. [max length: 32]

java.lang.Long suppliedDate

The date on which the goods or services were supplied.

java.lang.String taxNo

The tax number or VAT id of the person who supplied the goods or services. [max length: 255]

java.lang.String type

The type of invoice. One of WEB or MOBILE. [valid values: WEB, MOBILE, default: WEB]

Returns:

a Invoice object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

delete

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

Deletes an Invoice object.

Returns:

a Invoice object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

list

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

Retrieve Invoice 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 Invoice objects and the total number of Invoice objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

@Deprecated
public static ResourceList<Invoice> 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 Invoice 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 Invoice objects and the total number of Invoice objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

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

Retrieve Invoice 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 Invoice objects and the total number of Invoice objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

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

Retrieve Invoice 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 invoice Id
filter.amount	Filter by the invoice amount (in the smallest unit of your currency)
filter.text	Filter by the name of the invoice
filter.dateCreatedMin*	Filter by the minimum created date you are searching for - Date in UTC millis
filter.dateCreatedMax*	Filter by the maximum created date you are searching for - Date in UTC millis
filter.datePaidMin*	Filter by the minimum invoice paid date you are searching for - Date in UTC millis
filter.datePaidMax*	Filter by the maximum invoice paid date you are searching for - Date in UTC millis
filter.status	Filter by the status of the invoice
filter.statuses	Filter by multiple statuses of different invoices
filter.customer	Filter using the Id of the customer linked to the invoice
filter.type	Filter by the invoice type
filter.types	Filter by multiple invoice types
filter.invoiceId	Filter by the user defined invoice id
filter.reference	Filter by the invoice reference text

^*The filters datePaidMin and datePaidMax can be used in the same filter if you want to search between the two dates. The same is for dateCreatedMin/dateCreatedMax.

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 invoiceDate dueDate datePaid customer status dateCreated .

Returns:

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

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Invoice> 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 Invoice 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 invoice Id
filter.amount	Filter by the invoice amount (in the smallest unit of your currency)
filter.text	Filter by the name of the invoice
filter.dateCreatedMin*	Filter by the minimum created date you are searching for - Date in UTC millis
filter.dateCreatedMax*	Filter by the maximum created date you are searching for - Date in UTC millis
filter.datePaidMin*	Filter by the minimum invoice paid date you are searching for - Date in UTC millis
filter.datePaidMax*	Filter by the maximum invoice paid date you are searching for - Date in UTC millis
filter.status	Filter by the status of the invoice
filter.statuses	Filter by multiple statuses of different invoices
filter.customer	Filter using the Id of the customer linked to the invoice
filter.type	Filter by the invoice type
filter.types	Filter by multiple invoice types
filter.invoiceId	Filter by the user defined invoice id
filter.reference	Filter by the invoice reference text

^*The filters datePaidMin and datePaidMax can be used in the same filter if you want to search between the two dates. The same is for dateCreatedMin/dateCreatedMax.

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 invoiceDate dueDate datePaid customer status dateCreated .

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 Invoice objects and the total number of Invoice objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

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

Retrieve Invoice 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 invoice Id
filter.amount	Filter by the invoice amount (in the smallest unit of your currency)
filter.text	Filter by the name of the invoice
filter.dateCreatedMin*	Filter by the minimum created date you are searching for - Date in UTC millis
filter.dateCreatedMax*	Filter by the maximum created date you are searching for - Date in UTC millis
filter.datePaidMin*	Filter by the minimum invoice paid date you are searching for - Date in UTC millis
filter.datePaidMax*	Filter by the maximum invoice paid date you are searching for - Date in UTC millis
filter.status	Filter by the status of the invoice
filter.statuses	Filter by multiple statuses of different invoices
filter.customer	Filter using the Id of the customer linked to the invoice
filter.type	Filter by the invoice type
filter.types	Filter by multiple invoice types
filter.invoiceId	Filter by the user defined invoice id
filter.reference	Filter by the invoice reference text

^*The filters datePaidMin and datePaidMax can be used in the same filter if you want to search between the two dates. The same is for dateCreatedMin/dateCreatedMax.

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 invoiceDate dueDate datePaid customer status dateCreated .

Returns:

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

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

find

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

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

Returns:

a Invoice object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

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

Returns:

a Invoice object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

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

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

Returns:

a Invoice object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

update

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

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

• billingAddress
• city
• country
• line1
• line2
• name
• state
• zip
• businessAddress
• city
• country
• line1
• line2
• name
• state
• zip
• currency
• customerTaxNo
• datePaid
• discountRate
• dueDate
• email
• invoiceId
• invoiceLanguage
• items
• amount (required)
• description
• invoice
• product
• quantity
• reference
• tax
• lateFee
• memo
• name
• note
• payment
• reference
• sendMail (required)
• shippingAddress
• city
• country
• line1
• line2
• name
• state
• zip
• status
• suppliedDate
• taxNo

Returns:

a Invoice object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException