Payment Invoice object representation

The paymentinvoice object representation and fields are described below.

paymentinvoice was introduced in API version V1

paymentinvoice has not been marked for deprecation

Usages

Payment Invoice

Description

Representation of a payment invoice

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	URN of the payment invoice
owner	company	The owner of the payment invoice	Required on create.
issuedTimestamp	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	The timestamp the invoice was issued (to the remitter)
dueTimestamp	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	The timestamp the invoice is due
updatedTimestamp	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	The timestamp of the last update
currencyCode	A string representation of a enumeration name restricted to the documented values	The payment currency code	Allowed values: AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BRL BSD BTN BWP BYN BYR BZD CAD CDF CHF CLF CLP CNY COP CRC CUC CUP CVE CZK DJF DKK DOP DZD EEK EGP ERN ETB EUR FJD FKP GBP GEL GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS INR IQD IRR ISK JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LTL LVL LYD MAD MDL MGA MKD MMK MNT MOP MRO MRU MUR MVR MWK MXN MXV MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SKK SLE SLL SOS SRD STN STD SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD UYU UZS VEF VES VND VUV WST XAF XCD XOF XPF YER ZAR ZMW ZMK ZWD UNRECOGNIZED
lineItemTax	A string representation of a enumeration name restricted to the documented values	Indicator of whether line item tax is inclusive	Allowed values: EXCLUSIVE INCLUSIVE NO_TAX UNRECOGNIZED
discount	A monetary value expressed with decimal (dependent upon the currency) without the currency symbol e.g. 9.99	The total discount amount applied to the invoice
tax	A monetary value expressed with decimal (dependent upon the currency) without the currency symbol e.g. 9.99	The total amount of tax applied to the invoice
subTotal	A monetary value expressed with decimal (dependent upon the currency) without the currency symbol e.g. 9.99	The sub-total for the invoice
total	A monetary value expressed with decimal (dependent upon the currency) without the currency symbol e.g. 9.99	The total amount payable for the invoice
paid	A monetary value expressed with decimal (dependent upon the currency) without the currency symbol e.g. 9.99	The amount paid to date (if partial payments or credits applied)
fullyPaidTimestamp	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	The timestamp for when the invoice was fully paid
refunded	A monetary value expressed with decimal (dependent upon the currency) without the currency symbol e.g. 9.99	The amount refunded for this invoice if refunds were applied
status	A string representation of a enumeration name restricted to the documented values	The status of the invoice	Allowed values: DRAFT IN_REVIEW AUTHORISED PENDING VOIDED PAID REFUNDED UNRECOGNIZED
recipient	company	The recipient for the invoice (typically the owner for receivable invoices
remitter	company	The remitter (payee) for the invoice
lines	paymentinvoiceline[]	Line items associated with the invoice	Ignored on update.
identifiers	paymentinvoiceidentifier[]	Identifiers associated with the invoice	Ignored on update.