POST /Payments

Default value: "application/json"

Xero identifier for Tenant

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

A boolean to indicate if a contact has an validation errors

Default value: false

Number of invoice or credit note you are applying payment to e.g.INV-4003

The information to appear on the supplier's bank account

Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types

Possible values:

• "Inclusive"
• "Exclusive"
• "NoTax"

The date the prepayment is created YYYY-MM-DD

See Payments

See Prepayment Types

Possible values:

• "APPREPAYMENT"
• "RECEIVE-PREPAYMENT"
• "SPEND-PREPAYMENT"
• "ARPREPAYMENT"

The total of the prepayment(subtotal + total tax)

The total tax on the prepayment

Returns Invoice number field. Reference field isn't available.

See Prepayment Line Items

LineItem Quantity

LineItem Unit Amount

The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated is not correct.

See Accounts

The Xero identifier for a Repeating Invoice

LineItem unique ID

Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a element that contains at least 1 character

The tax type from TaxRates

The type of taxability

Possible values:

• "NOT_APPLICABLE"
• "EXEMPT"
• "PART_TAXABLE"
• "TAXABLE"
• "NON_TAXABLE"

An array of tax components defined for this line item

The unique ID number of this component

The name of the jurisdiction

The type of the jurisdiction

Possible values:

• "SYSGST/USSPECIAL"
• "SYSGST/USCOUNTRY"
• "SYSGST/USCOUNTY"
• "SYSGST/USSTATE"
• "SYSGST/USCITY"

The amount of the tax

The amount that is taxable

The amount that is not taxable

The percentage of the tax

The amount that is exempt

The state assigned number of the jurisdiction

Name identifying the region within the country

If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount

The associated account ID related to this line item

The ID of the sales tax code

See Items

Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements.

The Xero identifier for a tracking category

The name of the tracking category

See Tracking Options

The Xero identifier for a tracking category option

Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts.

Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts

UTC timestamp of last update to the prepayment

The subtotal of the prepayment excluding taxes

The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used

See Prepayment Status Codes

Possible values:

• "AUTHORISED"
• "PAID"
• "VOIDED"

The amount of applied to an invoice

See Attachments

Length of the file content

Include the file with the online invoice

Unique ID for the file

Type of file

URL to the file on xero.com

Name of the file

The remaining credit balance on the prepayment

See Allocations

the amount being applied to the invoice

the date the allocation is applied YYYY-MM-DD.

Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types

Possible values:

• "Inclusive"
• "Exclusive"
• "NoTax"

The date the overpayment is created YYYY-MM-DD

See Payments

See Overpayment Types

Possible values:

• "RECEIVE-OVERPAYMENT"
• "AROVERPAYMENT"
• "SPEND-OVERPAYMENT"

The total of the overpayment (subtotal + total tax)

The total tax on the overpayment

See Overpayment Line Items

LineItem Quantity

LineItem Unit Amount

The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated is not correct.

See Accounts

The Xero identifier for a Repeating Invoice

LineItem unique ID

Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a element that contains at least 1 character

The tax type from TaxRates

The type of taxability

Possible values:

• "NOT_APPLICABLE"
• "EXEMPT"
• "PART_TAXABLE"
• "TAXABLE"
• "NON_TAXABLE"

An array of tax components defined for this line item

The unique ID number of this component

The name of the jurisdiction

The type of the jurisdiction

Possible values:

• "SYSGST/USSPECIAL"
• "SYSGST/USCOUNTRY"
• "SYSGST/USCOUNTY"
• "SYSGST/USSTATE"
• "SYSGST/USCITY"

The amount of the tax

The amount that is taxable

The amount that is not taxable

The percentage of the tax

The amount that is exempt

The state assigned number of the jurisdiction

Name identifying the region within the country

If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount

The associated account ID related to this line item

The ID of the sales tax code

See Items

Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements.

The Xero identifier for a tracking category

The name of the tracking category

See Tracking Options

The Xero identifier for a tracking category option

Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts.

Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts

UTC timestamp of last update to the overpayment

The subtotal of the overpayment excluding taxes

The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used

See Overpayment Status Codes

Possible values:

• "AUTHORISED"
• "PAID"
• "VOIDED"

Xero generated unique identifier

The amount of applied to an invoice

See Attachments

Length of the file content

Include the file with the online invoice

Unique ID for the file

Type of file

URL to the file on xero.com

Name of the file

The remaining credit balance on the overpayment

See Allocations

Bank account number of contact

Website address for contact (read only)

Full name of contact/organisation (max length = 255)

The default sales tracking categories for contacts

The default purchase tracking category name for contacts

The default sales tracking category name for contacts

The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

Possible values:

• "INCLUSIVE"
• "NONE"
• "EXCLUSIVE"

The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)

The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Last name of contact person (max length = 255)

true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact.

The default purchases tracking categories for contacts

The default purchase tracking category name for contacts

The default sales tracking category name for contacts

UTC timestamp of last update to contact

Name of branding theme

Xero identifier

Always INVOICE

Possible values:

• "INVOICE"

The location of the image file used as the logo on this branding theme

Integer – ranked order of branding theme. The default branding theme has a value of 0

UTC timestamp of creation date of branding theme

true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact.

The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

Possible values:

• "INCLUSIVE"
• "NONE"
• "EXCLUSIVE"

Displays array of attachments from the API

Length of the file content

Include the file with the online invoice

Unique ID for the file

Type of file

URL to the file on xero.com

Name of the file

The default purchases account code for contacts

Xero identifier

The tax type from TaxRates

Current status of a contact – see contact status types

Possible values:

• "ARCHIVED"
• "ACTIVE"
• "GDPRREQUEST"

Store certain address types for a contact – see address types

max length = 255

define the type of address

Possible values:

• "STREET"
• "POBOX"

max length = 255

max length = 500

max length = 255

max length = 50, [A-Z], [a-z] only

max length = 500

max length = 500

max length = 500

max length = 50

Status of object

Company registration number (max length = 50)

Store certain phone types for a contact – see phone types

Possible values:

• "DEFAULT"
• "OFFICE"
• "DDI"
• "MOBILE"
• "FAX"

max length = 50

max length = 10

max length = 20

Bank details for use on a batch payment stored with each contact

First name of contact person (max length = 255)

The default sales account code for contacts

This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero.

The tax type from TaxRates

3 letter alpha code for the currency – see list of currency codes

Possible values:

• "ISK"
• "JMD"
• "LTL"
• "SVC"
• "SAR"
• "EEK"
• "TTD"
• "SBD"
• "SHP"
• "GBP"
• "TRY"
• "MOP"
• "INR"
• "MAD"
• "CUP"
• "CLF"
• "SRD"
• "SZL"
• "IRR"
• "CHF"
• "EUR"
• "KZT"
• "ALL"
• "MZN"
• "CDF"
• "BZD"
• "KES"
• "AOA"
• "NGN"
• "SEK"
• "BND"
• "UYU"
• "BRL"
• "YER"
• "ANG"
• "BYR"
• "MRO"
• "DJF"
• "LSL"
• "BBD"
• "MGA"
• "VND"
• "DOP"
• "TJS"
• "FJD"
• "BGN"
• "TWD"
• "QAR"
• "VES"
• "CNY"
• "AUD"
• "ZMW"
• "WST"
• "MDL"
• "KHR"
• "NZD"
• "AMD"
• "AZN"
• "TZS"
• "GIP"
• "AED"
• "AFN"
• "DZD"
• "PKR"
• "KYD"
• "AWG"
• "BSD"
• "PEN"
• "XAF"
• "NAD"
• "ZWD"
• "BTN"
• "KRW"
• "NPR"
• "FKP"
• "TND"
• "LVL"
• "MWK"
• "JOD"
• "LRD"
• "RSD"
• "SCR"
• "HUF"
• "IDR"
• "LAK"
• "UAH"
• "ZAR"
• "OMR"
• "PGK"
• "SLL"
• "MVR"
• "USD"
• "MXV"
• "MKD"
• "COP"
• "CAD"
• "KMF"
• "MXN"
• "PYG"
• "XCD"
• "STD"
• "IQD"
• "TOP"
• "VEF"
• "VUV"
• "SOS"
• "CVE"
• "CUC"
• "KGS"
• "TMT"
• "THB"
• "BOB"
• "UZS"
• "BYN"
• "SKK"
• "ILS"
• "PLN"
• "RON"
• "BHD"
• "BIF"
• "SLE"
• "XPF"
• "ARS"
• "GTQ"
• "RUB"
• "HKD"
• "ZMK"
• "RWF"
• "BDT"
• "ETB"
• "LYD"
• "JPY"
• "SGD"
• "STN"
• "MNT"
• "NIO"
• "GEL"
• "MUR"
• "NOK"
• "ERN"
• "SYP"
• "MYR"
• "DKK"
• "HRK"
• "CLP"
• "GNF"
• "GMD"
• "BAM"
• "HTG"
• "LBP"
• "PHP"
• "EGP"
• "SDG"
• "CRC"
• "CZK"
• "KWD"
• "KPW"
• "GHS"
• "GYD"
• "LKR"
• "BMD"
• "BWP"
• "MRU"
• "PAB"
• "UGX"
• "MMK"
• "XOF"
• "HNL"

A boolean to indicate if a contact has an validation errors

Default value: false

A user defined account number. This can be updated via the API and the Xero UI (max length = 50)

The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only)

Store XeroNetworkKey for contacts.

The default discount rate for the contact (read only)

ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber.

Displays validation errors returned from the API

Validation error message

Email address of contact person (umlauts not supported) (max length = 255)

A boolean to indicate if a contact has an attachment

Default value: false

Day of Month (0-31)

Possible values:

• "DAYSAFTERBILLMONTH"
• "OFCURRENTMONTH"
• "DAYSAFTERBILLDATE"
• "OFFOLLOWINGMONTH"

Day of Month (0-31)

Possible values:

• "DAYSAFTERBILLMONTH"
• "OFCURRENTMONTH"
• "DAYSAFTERBILLDATE"
• "OFFOLLOWINGMONTH"

Displays which contact groups a contact is included in

The Name of the contact group. Required when creating a new contact group

The Status of a contact group. To delete a contact group update the status to DELETED. Only contact groups with a status of ACTIVE are returned on GETs.

Possible values:

• "DELETED"
• "ACTIVE"

The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9

The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL.

See contact persons

boolean to indicate whether contact should be included on emails with invoices etc.

Email address of person

Last name of person

First name of person

boolean to indicate if a overpayment has an attachment

Default value: false

3 letter alpha code for the currency – see list of currency codes

Possible values:

• "ISK"
• "JMD"
• "LTL"
• "SVC"
• "SAR"
• "EEK"
• "TTD"
• "SBD"
• "SHP"
• "GBP"
• "TRY"
• "MOP"
• "INR"
• "MAD"
• "CUP"
• "CLF"
• "SRD"
• "SZL"
• "IRR"
• "CHF"
• "EUR"
• "KZT"
• "ALL"
• "MZN"
• "CDF"
• "BZD"
• "KES"
• "AOA"
• "NGN"
• "SEK"
• "BND"
• "UYU"
• "BRL"
• "YER"
• "ANG"
• "BYR"
• "MRO"
• "DJF"
• "LSL"
• "BBD"
• "MGA"
• "VND"
• "DOP"
• "TJS"
• "FJD"
• "BGN"
• "TWD"
• "QAR"
• "VES"
• "CNY"
• "AUD"
• "ZMW"
• "WST"
• "MDL"
• "KHR"
• "NZD"
• "AMD"
• "AZN"
• "TZS"
• "GIP"
• "AED"
• "AFN"
• "DZD"
• "PKR"
• "KYD"
• "AWG"
• "BSD"
• "PEN"
• "XAF"
• "NAD"
• "ZWD"
• "BTN"
• "KRW"
• "NPR"
• "FKP"
• "TND"
• "LVL"
• "MWK"
• "JOD"
• "LRD"
• "RSD"
• "SCR"
• "HUF"
• "IDR"
• "LAK"
• "UAH"
• "ZAR"
• "OMR"
• "PGK"
• "SLL"
• "MVR"
• "USD"
• "MXV"
• "MKD"
• "COP"
• "CAD"
• "KMF"
• "MXN"
• "PYG"
• "XCD"
• "STD"
• "IQD"
• "TOP"
• "VEF"
• "VUV"
• "SOS"
• "CVE"
• "CUC"
• "KGS"
• "TMT"
• "THB"
• "BOB"
• "UZS"
• "BYN"
• "SKK"
• "ILS"
• "PLN"
• "RON"
• "BHD"
• "BIF"
• "SLE"
• "XPF"
• "ARS"
• "GTQ"
• "RUB"
• "HKD"
• "ZMK"
• "RWF"
• "BDT"
• "ETB"
• "LYD"
• "JPY"
• "SGD"
• "STN"
• "MNT"
• "NIO"
• "GEL"
• "MUR"
• "NOK"
• "ERN"
• "SYP"
• "MYR"
• "DKK"
• "HRK"
• "CLP"
• "GNF"
• "GMD"
• "BAM"
• "HTG"
• "LBP"
• "PHP"
• "EGP"
• "SDG"
• "CRC"
• "CZK"
• "KWD"
• "KPW"
• "GHS"
• "GYD"
• "LKR"
• "BMD"
• "BWP"
• "MRU"
• "PAB"
• "UGX"
• "MMK"
• "XOF"
• "HNL"

A string to indicate if a invoice status

Displays array of validation error messages from the API

Validation error message

A flag that returns true when the allocation is succesfully deleted

Xero generated unique identifier

A boolean to indicate if a credit note has an validation errors

Default value: false

See Payments

The total of the Credit Note(subtotal + total tax)

Date when credit note was fully paid(UTC format)

An array of addresses used to auto calculate sales tax

City of a physical address

Second line of a physical address

Region or state of a physical address

Country of a physical address

First line of a physical address

Indicates whether the address is defined as origin (FROM) or destination (TO)

Possible values:

• "FROM"
• "TO"

Fourth line of a physical address

Third line of a physical address

Postal code of a physical address

UTC timestamp of last update to the credit note

The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used

The remaining credit balance on the Credit Note

See Allocations

Bank account number of contact

Website address for contact (read only)

Full name of contact/organisation (max length = 255)

The default sales tracking categories for contacts

The default purchase tracking category name for contacts

The default sales tracking category name for contacts

The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

Possible values:

• "INCLUSIVE"
• "NONE"
• "EXCLUSIVE"

The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)

The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Last name of contact person (max length = 255)

true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact.

The default purchases tracking categories for contacts

The default purchase tracking category name for contacts

The default sales tracking category name for contacts

UTC timestamp of last update to contact

Name of branding theme

Xero identifier

Always INVOICE

Possible values:

• "INVOICE"

The location of the image file used as the logo on this branding theme

Integer – ranked order of branding theme. The default branding theme has a value of 0

UTC timestamp of creation date of branding theme

true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact.

The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

Possible values:

• "INCLUSIVE"
• "NONE"
• "EXCLUSIVE"

Displays array of attachments from the API

Length of the file content

Include the file with the online invoice

Unique ID for the file

Type of file

URL to the file on xero.com

Name of the file

The default purchases account code for contacts

Xero identifier

The tax type from TaxRates

Current status of a contact – see contact status types

Possible values:

• "ARCHIVED"
• "ACTIVE"
• "GDPRREQUEST"

Store certain address types for a contact – see address types

max length = 255

define the type of address

Possible values:

• "STREET"
• "POBOX"

max length = 255

max length = 500

max length = 255

max length = 50, [A-Z], [a-z] only

max length = 500

max length = 500

max length = 500

max length = 50

Status of object

Company registration number (max length = 50)

Store certain phone types for a contact – see phone types

Possible values:

• "DEFAULT"
• "OFFICE"
• "DDI"
• "MOBILE"
• "FAX"

max length = 50

max length = 10

max length = 20

Bank details for use on a batch payment stored with each contact

First name of contact person (max length = 255)

The default sales account code for contacts

This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero.

The tax type from TaxRates

3 letter alpha code for the currency – see list of currency codes

Possible values:

• "ISK"
• "JMD"
• "LTL"
• "SVC"
• "SAR"
• "EEK"
• "TTD"
• "SBD"
• "SHP"
• "GBP"
• "TRY"
• "MOP"
• "INR"
• "MAD"
• "CUP"
• "CLF"
• "SRD"
• "SZL"
• "IRR"
• "CHF"
• "EUR"
• "KZT"
• "ALL"
• "MZN"
• "CDF"
• "BZD"
• "KES"
• "AOA"
• "NGN"
• "SEK"
• "BND"
• "UYU"
• "BRL"
• "YER"
• "ANG"
• "BYR"
• "MRO"
• "DJF"
• "LSL"
• "BBD"
• "MGA"
• "VND"
• "DOP"
• "TJS"
• "FJD"
• "BGN"
• "TWD"
• "QAR"
• "VES"
• "CNY"
• "AUD"
• "ZMW"
• "WST"
• "MDL"
• "KHR"
• "NZD"
• "AMD"
• "AZN"
• "TZS"
• "GIP"
• "AED"
• "AFN"
• "DZD"
• "PKR"
• "KYD"
• "AWG"
• "BSD"
• "PEN"
• "XAF"
• "NAD"
• "ZWD"
• "BTN"
• "KRW"
• "NPR"
• "FKP"
• "TND"
• "LVL"
• "MWK"
• "JOD"
• "LRD"
• "RSD"
• "SCR"
• "HUF"
• "IDR"
• "LAK"
• "UAH"
• "ZAR"
• "OMR"
• "PGK"
• "SLL"
• "MVR"
• "USD"
• "MXV"
• "MKD"
• "COP"
• "CAD"
• "KMF"
• "MXN"
• "PYG"
• "XCD"
• "STD"
• "IQD"
• "TOP"
• "VEF"
• "VUV"
• "SOS"
• "CVE"
• "CUC"
• "KGS"
• "TMT"
• "THB"
• "BOB"
• "UZS"
• "BYN"
• "SKK"
• "ILS"
• "PLN"
• "RON"
• "BHD"
• "BIF"
• "SLE"
• "XPF"
• "ARS"
• "GTQ"
• "RUB"
• "HKD"
• "ZMK"
• "RWF"
• "BDT"
• "ETB"
• "LYD"
• "JPY"
• "SGD"
• "STN"
• "MNT"
• "NIO"
• "GEL"
• "MUR"
• "NOK"
• "ERN"
• "SYP"
• "MYR"
• "DKK"
• "HRK"
• "CLP"
• "GNF"
• "GMD"
• "BAM"
• "HTG"
• "LBP"
• "PHP"
• "EGP"
• "SDG"
• "CRC"
• "CZK"
• "KWD"
• "KPW"
• "GHS"
• "GYD"
• "LKR"
• "BMD"
• "BWP"
• "MRU"
• "PAB"
• "UGX"
• "MMK"
• "XOF"
• "HNL"

A boolean to indicate if a contact has an validation errors

Default value: false

A user defined account number. This can be updated via the API and the Xero UI (max length = 50)

The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only)

Store XeroNetworkKey for contacts.

The default discount rate for the contact (read only)

ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber.

Displays validation errors returned from the API

Validation error message

Email address of contact person (umlauts not supported) (max length = 255)

A boolean to indicate if a contact has an attachment

Default value: false

Day of Month (0-31)

Possible values:

• "DAYSAFTERBILLMONTH"
• "OFCURRENTMONTH"
• "DAYSAFTERBILLDATE"
• "OFFOLLOWINGMONTH"

Day of Month (0-31)

Possible values:

• "DAYSAFTERBILLMONTH"
• "OFCURRENTMONTH"
• "DAYSAFTERBILLDATE"
• "OFFOLLOWINGMONTH"

Displays which contact groups a contact is included in

The Name of the contact group. Required when creating a new contact group

The Status of a contact group. To delete a contact group update the status to DELETED. Only contact groups with a status of ACTIVE are returned on GETs.

Possible values:

• "DELETED"
• "ACTIVE"

The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9

The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL.

See contact persons

boolean to indicate whether contact should be included on emails with invoices etc.

Email address of person

Last name of person

First name of person

3 letter alpha code for the currency – see list of currency codes

Possible values:

• "ISK"
• "JMD"
• "LTL"
• "SVC"
• "SAR"
• "EEK"
• "TTD"
• "SBD"
• "SHP"
• "GBP"
• "TRY"
• "MOP"
• "INR"
• "MAD"
• "CUP"
• "CLF"
• "SRD"
• "SZL"
• "IRR"
• "CHF"
• "EUR"
• "KZT"
• "ALL"
• "MZN"
• "CDF"
• "BZD"
• "KES"
• "AOA"
• "NGN"
• "SEK"
• "BND"
• "UYU"
• "BRL"
• "YER"
• "ANG"
• "BYR"
• "MRO"
• "DJF"
• "LSL"
• "BBD"
• "MGA"
• "VND"
• "DOP"
• "TJS"
• "FJD"
• "BGN"
• "TWD"
• "QAR"
• "VES"
• "CNY"
• "AUD"
• "ZMW"
• "WST"
• "MDL"
• "KHR"
• "NZD"
• "AMD"
• "AZN"
• "TZS"
• "GIP"
• "AED"
• "AFN"
• "DZD"
• "PKR"
• "KYD"
• "AWG"
• "BSD"
• "PEN"
• "XAF"
• "NAD"
• "ZWD"
• "BTN"
• "KRW"
• "NPR"
• "FKP"
• "TND"
• "LVL"
• "MWK"
• "JOD"
• "LRD"
• "RSD"
• "SCR"
• "HUF"
• "IDR"
• "LAK"
• "UAH"
• "ZAR"
• "OMR"
• "PGK"
• "SLL"
• "MVR"
• "USD"
• "MXV"
• "MKD"
• "COP"
• "CAD"
• "KMF"
• "MXN"
• "PYG"
• "XCD"
• "STD"
• "IQD"
• "TOP"
• "VEF"
• "VUV"
• "SOS"
• "CVE"
• "CUC"
• "KGS"
• "TMT"
• "THB"
• "BOB"
• "UZS"
• "BYN"
• "SKK"
• "ILS"
• "PLN"
• "RON"
• "BHD"
• "BIF"
• "SLE"
• "XPF"
• "ARS"
• "GTQ"
• "RUB"
• "HKD"
• "ZMK"
• "RWF"
• "BDT"
• "ETB"
• "LYD"
• "JPY"
• "SGD"
• "STN"
• "MNT"
• "NIO"
• "GEL"
• "MUR"
• "NOK"
• "ERN"
• "SYP"
• "MYR"
• "DKK"
• "HRK"
• "CLP"
• "GNF"
• "GMD"
• "BAM"
• "HTG"
• "LBP"
• "PHP"
• "EGP"
• "SDG"
• "CRC"
• "CZK"
• "KWD"
• "KPW"
• "GHS"
• "GYD"
• "LKR"
• "BMD"
• "BWP"
• "MRU"
• "PAB"
• "UGX"
• "MMK"
• "XOF"
• "HNL"

Xero generated unique identifier

Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types

Possible values:

• "Inclusive"
• "Exclusive"
• "NoTax"

The date the credit note is issued YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation

CIS deduction for UK contractors

Boolean to set whether the credit note in the Xero app should be marked as “sent”. This can be set only on credit notes that have been approved

Displays array of warning messages from the API

Validation error message

See Credit Note Types

Possible values:

• "ACCPAYCREDIT"
• "ACCRECCREDIT"

A string to indicate if a invoice status

Date invoice is due – YYYY-MM-DD

CIS Deduction rate for the organisation

The total tax on the credit note

ACCRECCREDIT only – additional reference number

See Invoice Line Items

LineItem Quantity

LineItem Unit Amount

The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated is not correct.

See Accounts

The Xero identifier for a Repeating Invoice

LineItem unique ID

Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a element that contains at least 1 character

The tax type from TaxRates

The type of taxability

Possible values:

• "NOT_APPLICABLE"
• "EXEMPT"
• "PART_TAXABLE"
• "TAXABLE"
• "NON_TAXABLE"

An array of tax components defined for this line item

The unique ID number of this component

The name of the jurisdiction

The type of the jurisdiction

Possible values:

• "SYSGST/USSPECIAL"
• "SYSGST/USCOUNTRY"
• "SYSGST/USCOUNTY"
• "SYSGST/USSTATE"
• "SYSGST/USCITY"

The amount of the tax

The amount that is taxable

The amount that is not taxable

The percentage of the tax

The amount that is exempt

The state assigned number of the jurisdiction

Name identifying the region within the country

If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount

The associated account ID related to this line item

The ID of the sales tax code

See Items

Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements.

The Xero identifier for a tracking category

The name of the tracking category

See Tracking Options

The Xero identifier for a tracking category option

Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts.

Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts

The subtotal of the credit note excluding taxes

See Credit Note Status Codes

Possible values:

• "DELETED"
• "AUTHORISED"
• "SUBMITTED"
• "DRAFT"
• "PAID"
• "VOIDED"

See BrandingThemes

The amount of applied to an invoice

Displays array of validation error messages from the API

Validation error message

boolean to indicate if a credit note has an attachment

Default value: false

ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)

Bank account number of contact

Website address for contact (read only)

Full name of contact/organisation (max length = 255)

The default sales tracking categories for contacts

The default purchase tracking category name for contacts

The default sales tracking category name for contacts

The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

Possible values:

• "INCLUSIVE"
• "NONE"
• "EXCLUSIVE"

The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)

The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Last name of contact person (max length = 255)

true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact.

The default purchases tracking categories for contacts

The default purchase tracking category name for contacts

The default sales tracking category name for contacts

UTC timestamp of last update to contact

Name of branding theme

Xero identifier

Always INVOICE

Possible values:

• "INVOICE"

The location of the image file used as the logo on this branding theme

Integer – ranked order of branding theme. The default branding theme has a value of 0

UTC timestamp of creation date of branding theme

true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact.

The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

Possible values:

• "INCLUSIVE"
• "NONE"
• "EXCLUSIVE"

Displays array of attachments from the API

Length of the file content

Include the file with the online invoice

Unique ID for the file

Type of file

URL to the file on xero.com

Name of the file

The default purchases account code for contacts

Xero identifier

The tax type from TaxRates

Current status of a contact – see contact status types

Possible values:

• "ARCHIVED"
• "ACTIVE"
• "GDPRREQUEST"

Store certain address types for a contact – see address types

max length = 255

define the type of address

Possible values:

• "STREET"
• "POBOX"

max length = 255

max length = 500

max length = 255

max length = 50, [A-Z], [a-z] only

max length = 500

max length = 500

max length = 500

max length = 50

Status of object

Company registration number (max length = 50)

Store certain phone types for a contact – see phone types

Possible values:

• "DEFAULT"
• "OFFICE"
• "DDI"
• "MOBILE"
• "FAX"

max length = 50

max length = 10

max length = 20

Bank details for use on a batch payment stored with each contact

First name of contact person (max length = 255)

The default sales account code for contacts

This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero.

The tax type from TaxRates

3 letter alpha code for the currency – see list of currency codes

Possible values:

• "ISK"
• "JMD"
• "LTL"
• "SVC"
• "SAR"
• "EEK"
• "TTD"
• "SBD"
• "SHP"
• "GBP"
• "TRY"
• "MOP"
• "INR"
• "MAD"
• "CUP"
• "CLF"
• "SRD"
• "SZL"
• "IRR"
• "CHF"
• "EUR"
• "KZT"
• "ALL"
• "MZN"
• "CDF"
• "BZD"
• "KES"
• "AOA"
• "NGN"
• "SEK"
• "BND"
• "UYU"
• "BRL"
• "YER"
• "ANG"
• "BYR"
• "MRO"
• "DJF"
• "LSL"
• "BBD"
• "MGA"
• "VND"
• "DOP"
• "TJS"
• "FJD"
• "BGN"
• "TWD"
• "QAR"
• "VES"
• "CNY"
• "AUD"
• "ZMW"
• "WST"
• "MDL"
• "KHR"
• "NZD"
• "AMD"
• "AZN"
• "TZS"
• "GIP"
• "AED"
• "AFN"
• "DZD"
• "PKR"
• "KYD"
• "AWG"
• "BSD"
• "PEN"
• "XAF"
• "NAD"
• "ZWD"
• "BTN"
• "KRW"
• "NPR"
• "FKP"
• "TND"
• "LVL"
• "MWK"
• "JOD"
• "LRD"
• "RSD"
• "SCR"
• "HUF"
• "IDR"
• "LAK"
• "UAH"
• "ZAR"
• "OMR"
• "PGK"
• "SLL"
• "MVR"
• "USD"
• "MXV"
• "MKD"
• "COP"
• "CAD"
• "KMF"
• "MXN"
• "PYG"
• "XCD"
• "STD"
• "IQD"
• "TOP"
• "VEF"
• "VUV"
• "SOS"
• "CVE"
• "CUC"
• "KGS"
• "TMT"
• "THB"
• "BOB"
• "UZS"
• "BYN"
• "SKK"
• "ILS"
• "PLN"
• "RON"
• "BHD"
• "BIF"
• "SLE"
• "XPF"
• "ARS"
• "GTQ"
• "RUB"
• "HKD"
• "ZMK"
• "RWF"
• "BDT"
• "ETB"
• "LYD"
• "JPY"
• "SGD"
• "STN"
• "MNT"
• "NIO"
• "GEL"
• "MUR"
• "NOK"
• "ERN"
• "SYP"
• "MYR"
• "DKK"
• "HRK"
• "CLP"
• "GNF"
• "GMD"
• "BAM"
• "HTG"
• "LBP"
• "PHP"
• "EGP"
• "SDG"
• "CRC"
• "CZK"
• "KWD"
• "KPW"
• "GHS"
• "GYD"
• "LKR"
• "BMD"
• "BWP"
• "MRU"
• "PAB"
• "UGX"
• "MMK"
• "XOF"
• "HNL"

A boolean to indicate if a contact has an validation errors

Default value: false

A user defined account number. This can be updated via the API and the Xero UI (max length = 50)

The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only)

Store XeroNetworkKey for contacts.

The default discount rate for the contact (read only)

ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber.

Displays validation errors returned from the API

Validation error message

Email address of contact person (umlauts not supported) (max length = 255)

A boolean to indicate if a contact has an attachment

Default value: false

Day of Month (0-31)

Possible values:

• "DAYSAFTERBILLMONTH"
• "OFCURRENTMONTH"
• "DAYSAFTERBILLDATE"
• "OFFOLLOWINGMONTH"

Day of Month (0-31)

Possible values:

• "DAYSAFTERBILLMONTH"
• "OFCURRENTMONTH"
• "DAYSAFTERBILLDATE"
• "OFFOLLOWINGMONTH"

Displays which contact groups a contact is included in

The Name of the contact group. Required when creating a new contact group

The Status of a contact group. To delete a contact group update the status to DELETED. Only contact groups with a status of ACTIVE are returned on GETs.

Possible values:

• "DELETED"
• "ACTIVE"

The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9

The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL.

See contact persons

boolean to indicate whether contact should be included on emails with invoices etc.

Email address of person

Last name of person

First name of person

boolean to indicate if a prepayment has an attachment

Default value: false

3 letter alpha code for the currency – see list of currency codes

Possible values:

• "ISK"
• "JMD"
• "LTL"
• "SVC"
• "SAR"
• "EEK"
• "TTD"
• "SBD"
• "SHP"
• "GBP"
• "TRY"
• "MOP"
• "INR"
• "MAD"
• "CUP"
• "CLF"
• "SRD"
• "SZL"
• "IRR"
• "CHF"
• "EUR"
• "KZT"
• "ALL"
• "MZN"
• "CDF"
• "BZD"
• "KES"
• "AOA"
• "NGN"
• "SEK"
• "BND"
• "UYU"
• "BRL"
• "YER"
• "ANG"
• "BYR"
• "MRO"
• "DJF"
• "LSL"
• "BBD"
• "MGA"
• "VND"
• "DOP"
• "TJS"
• "FJD"
• "BGN"
• "TWD"
• "QAR"
• "VES"
• "CNY"
• "AUD"
• "ZMW"
• "WST"
• "MDL"
• "KHR"
• "NZD"
• "AMD"
• "AZN"
• "TZS"
• "GIP"
• "AED"
• "AFN"
• "DZD"
• "PKR"
• "KYD"
• "AWG"
• "BSD"
• "PEN"
• "XAF"
• "NAD"
• "ZWD"
• "BTN"
• "KRW"
• "NPR"
• "FKP"
• "TND"
• "LVL"
• "MWK"
• "JOD"
• "LRD"
• "RSD"
• "SCR"
• "HUF"
• "IDR"
• "LAK"
• "UAH"
• "ZAR"
• "OMR"
• "PGK"
• "SLL"
• "MVR"
• "USD"
• "MXV"
• "MKD"
• "COP"
• "CAD"
• "KMF"
• "MXN"
• "PYG"
• "XCD"
• "STD"
• "IQD"
• "TOP"
• "VEF"
• "VUV"
• "SOS"
• "CVE"
• "CUC"
• "KGS"
• "TMT"
• "THB"
• "BOB"
• "UZS"
• "BYN"
• "SKK"
• "ILS"
• "PLN"
• "RON"
• "BHD"
• "BIF"
• "SLE"
• "XPF"
• "ARS"
• "GTQ"
• "RUB"
• "HKD"
• "ZMK"
• "RWF"
• "BDT"
• "ETB"
• "LYD"
• "JPY"
• "SGD"
• "STN"
• "MNT"
• "NIO"
• "GEL"
• "MUR"
• "NOK"
• "ERN"
• "SYP"
• "MYR"
• "DKK"
• "HRK"
• "CLP"
• "GNF"
• "GMD"
• "BAM"
• "HTG"
• "LBP"
• "PHP"
• "EGP"
• "SDG"
• "CRC"
• "CZK"
• "KWD"
• "KPW"
• "GHS"
• "GYD"
• "LKR"
• "BMD"
• "BWP"
• "MRU"
• "PAB"
• "UGX"
• "MMK"
• "XOF"
• "HNL"

Xero generated unique identifier

Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types

Possible values:

• "Inclusive"
• "Exclusive"
• "NoTax"

The date the overpayment is created YYYY-MM-DD

See Payments

See Overpayment Types

Possible values:

• "RECEIVE-OVERPAYMENT"
• "AROVERPAYMENT"
• "SPEND-OVERPAYMENT"

The total of the overpayment (subtotal + total tax)

The total tax on the overpayment

See Overpayment Line Items

LineItem Quantity

LineItem Unit Amount

The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated is not correct.

See Accounts

The Xero identifier for a Repeating Invoice

LineItem unique ID

Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a element that contains at least 1 character

The tax type from TaxRates

The type of taxability

Possible values:

• "NOT_APPLICABLE"
• "EXEMPT"
• "PART_TAXABLE"
• "TAXABLE"
• "NON_TAXABLE"

An array of tax components defined for this line item

The unique ID number of this component

The name of the jurisdiction

The type of the jurisdiction

Possible values:

• "SYSGST/USSPECIAL"
• "SYSGST/USCOUNTRY"
• "SYSGST/USCOUNTY"
• "SYSGST/USSTATE"
• "SYSGST/USCITY"

The amount of the tax

The amount that is taxable

The amount that is not taxable

The percentage of the tax

The amount that is exempt

The state assigned number of the jurisdiction

Name identifying the region within the country

If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount

The associated account ID related to this line item

The ID of the sales tax code

See Items

Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 elements.

The Xero identifier for a tracking category

The name of the tracking category

See Tracking Options

The Xero identifier for a tracking category option

Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts.

Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts

UTC timestamp of last update to the overpayment

The subtotal of the overpayment excluding taxes

The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used

See Overpayment Status Codes

Possible values:

• "AUTHORISED"
• "PAID"
• "VOIDED"

Xero generated unique identifier

The amount of applied to an invoice

See Attachments

Length of the file content

Include the file with the online invoice

Unique ID for the file

Type of file

URL to the file on xero.com

Name of the file

The remaining credit balance on the overpayment

See Allocations

Bank account number of contact

Website address for contact (read only)

Full name of contact/organisation (max length = 255)

The default sales tracking categories for contacts

The default purchase tracking category name for contacts

The default sales tracking category name for contacts

The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

Possible values:

• "INCLUSIVE"
• "NONE"
• "EXCLUSIVE"

The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)

The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Last name of contact person (max length = 255)

true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact.

The default purchases tracking categories for contacts

The default purchase tracking category name for contacts

The default sales tracking category name for contacts

UTC timestamp of last update to contact

Name of branding theme

Xero identifier

Always INVOICE

Possible values:

• "INVOICE"

The location of the image file used as the logo on this branding theme

Integer – ranked order of branding theme. The default branding theme has a value of 0

UTC timestamp of creation date of branding theme

true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact.

The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

Possible values:

• "INCLUSIVE"
• "NONE"
• "EXCLUSIVE"

Displays array of attachments from the API

Length of the file content

Include the file with the online invoice

Unique ID for the file

Type of file

URL to the file on xero.com

Name of the file

The default purchases account code for contacts

Xero identifier

The tax type from TaxRates

Current status of a contact – see contact status types

Possible values:

• "ARCHIVED"
• "ACTIVE"
• "GDPRREQUEST"

Store certain address types for a contact – see address types

max length = 255

define the type of address

Possible values:

• "STREET"
• "POBOX"

max length = 255

max length = 500

max length = 255

max length = 50, [A-Z], [a-z] only

max length = 500

max length = 500

max length = 500

max length = 50

Status of object

Company registration number (max length = 50)

Store certain phone types for a contact – see phone types

Possible values:

• "DEFAULT"
• "OFFICE"
• "DDI"
• "MOBILE"
• "FAX"

max length = 50

max length = 10

max length = 20

Bank details for use on a batch payment stored with each contact

First name of contact person (max length = 255)

The default sales account code for contacts

This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero.

The tax type from TaxRates

3 letter alpha code for the currency – see list of currency codes

Possible values:

• "ISK"
• "JMD"
• "LTL"
• "SVC"
• "SAR"
• "EEK"
• "TTD"
• "SBD"
• "SHP"
• "GBP"
• "TRY"
• "MOP"
• "INR"
• "MAD"
• "CUP"
• "CLF"
• "SRD"
• "SZL"
• "IRR"
• "CHF"
• "EUR"
• "KZT"
• "ALL"
• "MZN"
• "CDF"
• "BZD"
• "KES"
• "AOA"
• "NGN"
• "SEK"
• "BND"
• "UYU"
• "BRL"
• "YER"
• "ANG"
• "BYR"
• "MRO"
• "DJF"
• "LSL"
• "BBD"
• "MGA"
• "VND"
• "DOP"
• "TJS"
• "FJD"
• "BGN"
• "TWD"
• "QAR"
• "VES"
• "CNY"
• "AUD"
• "ZMW"
• "WST"
• "MDL"
• "KHR"
• "NZD"
• "AMD"
• "AZN"
• "TZS"
• "GIP"
• "AED"
• "AFN"
• "DZD"
• "PKR"
• "KYD"
• "AWG"
• "BSD"
• "PEN"
• "XAF"
• "NAD"
• "ZWD"
• "BTN"
• "KRW"
• "NPR"
• "FKP"
• "TND"
• "LVL"
• "MWK"
• "JOD"
• "LRD"
• "RSD"
• "SCR"
• "HUF"
• "IDR"
• "LAK"
• "UAH"
• "ZAR"
• "OMR"
• "PGK"
• "SLL"
• "MVR"
• "USD"
• "MXV"
• "MKD"
• "COP"
• "CAD"
• "KMF"
• "MXN"
• "PYG"
• "XCD"
• "STD"
• "IQD"
• "TOP"
• "VEF"
• "VUV"
• "SOS"
• "CVE"
• "CUC"
• "KGS"
• "TMT"
• "THB"
• "BOB"
• "UZS"
• "BYN"
• "SKK"
• "ILS"
• "PLN"
• "RON"
• "BHD"
• "BIF"
• "SLE"
• "XPF"
• "ARS"
• "GTQ"
• "RUB"
• "HKD"
• "ZMK"
• "RWF"
• "BDT"
• "ETB"
• "LYD"
• "JPY"
• "SGD"
• "STN"
• "MNT"
• "NIO"
• "GEL"
• "MUR"
• "NOK"
• "ERN"
• "SYP"
• "MYR"
• "DKK"
• "HRK"
• "CLP"
• "GNF"
• "GMD"
• "BAM"
• "HTG"
• "LBP"
• "PHP"
• "EGP"
• "SDG"
• "CRC"
• "CZK"
• "KWD"
• "KPW"
• "GHS"
• "GYD"
• "LKR"
• "BMD"
• "BWP"
• "MRU"
• "PAB"
• "UGX"
• "MMK"
• "XOF"
• "HNL"

A boolean to indicate if a contact has an validation errors

Default value: false

A user defined account number. This can be updated via the API and the Xero UI (max length = 50)

The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only)

Store XeroNetworkKey for contacts.

The default discount rate for the contact (read only)

ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber.

Displays validation errors returned from the API

Validation error message

Email address of contact person (umlauts not supported) (max length = 255)

A boolean to indicate if a contact has an attachment

Default value: false

Day of Month (0-31)

Possible values:

• "DAYSAFTERBILLMONTH"
• "OFCURRENTMONTH"
• "DAYSAFTERBILLDATE"
• "OFFOLLOWINGMONTH"

Day of Month (0-31)

Possible values:

• "DAYSAFTERBILLMONTH"
• "OFCURRENTMONTH"
• "DAYSAFTERBILLDATE"
• "OFFOLLOWINGMONTH"

Displays which contact groups a contact is included in

The Name of the contact group. Required when creating a new contact group

The Status of a contact group. To delete a contact group update the status to DELETED. Only contact groups with a status of ACTIVE are returned on GETs.

Possible values:

• "DELETED"
• "ACTIVE"

The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9

The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL.

See contact persons

boolean to indicate whether contact should be included on emails with invoices etc.

Email address of person

Last name of person

First name of person

boolean to indicate if a overpayment has an attachment

Default value: false

3 letter alpha code for the currency – see list of currency codes

Possible values:

• "ISK"
• "JMD"
• "LTL"
• "SVC"
• "SAR"
• "EEK"
• "TTD"
• "SBD"
• "SHP"
• "GBP"
• "TRY"
• "MOP"
• "INR"
• "MAD"
• "CUP"
• "CLF"
• "SRD"
• "SZL"
• "IRR"
• "CHF"
• "EUR"
• "KZT"
• "ALL"
• "MZN"
• "CDF"
• "BZD"
• "KES"
• "AOA"
• "NGN"
• "SEK"
• "BND"
• "UYU"
• "BRL"
• "YER"
• "ANG"
• "BYR"
• "MRO"
• "DJF"
• "LSL"
• "BBD"
• "MGA"
• "VND"
• "DOP"
• "TJS"
• "FJD"
• "BGN"
• "TWD"
• "QAR"
• "VES"
• "CNY"
• "AUD"
• "ZMW"
• "WST"
• "MDL"
• "KHR"
• "NZD"
• "AMD"
• "AZN"
• "TZS"
• "GIP"
• "AED"
• "AFN"
• "DZD"
• "PKR"
• "KYD"
• "AWG"
• "BSD"
• "PEN"
• "XAF"
• "NAD"
• "ZWD"
• "BTN"
• "KRW"
• "NPR"
• "FKP"
• "TND"
• "LVL"
• "MWK"
• "JOD"
• "LRD"
• "RSD"
• "SCR"
• "HUF"
• "IDR"
• "LAK"
• "UAH"
• "ZAR"
• "OMR"
• "PGK"
• "SLL"
• "MVR"
• "USD"
• "MXV"
• "MKD"
• "COP"
• "CAD"
• "KMF"
• "MXN"
• "PYG"
• "XCD"
• "STD"
• "IQD"
• "TOP"
• "VEF"
• "VUV"
• "SOS"
• "CVE"
• "CUC"
• "KGS"
• "TMT"
• "THB"
• "BOB"
• "UZS"
• "BYN"
• "SKK"
• "ILS"
• "PLN"
• "RON"
• "BHD"
• "BIF"
• "SLE"
• "XPF"
• "ARS"
• "GTQ"
• "RUB"
• "HKD"
• "ZMK"
• "RWF"
• "BDT"
• "ETB"
• "LYD"
• "JPY"
• "SGD"
• "STN"
• "MNT"
• "NIO"
• "GEL"
• "MUR"
• "NOK"
• "ERN"
• "SYP"
• "MYR"
• "DKK"
• "HRK"
• "CLP"
• "GNF"
• "GMD"
• "BAM"
• "HTG"
• "LBP"
• "PHP"
• "EGP"
• "SDG"
• "CRC"
• "CZK"
• "KWD"
• "KPW"
• "GHS"
• "GYD"
• "LKR"
• "BMD"
• "BWP"
• "MRU"
• "PAB"
• "UGX"
• "MMK"
• "XOF"
• "HNL"

Total of discounts applied on the invoice line items

A boolean to indicate if a invoice has an validation errors

Default value: false

Shown on bills (Accounts Payable) when this has been set

URL link to a source document – shown as “Go to [appName]” in the Xero app

ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255)

See Payments

boolean to indicate if an invoice has a discount

Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts

Xero generated unique identifier for repeating invoices

The date the invoice was fully paid. Only returned on fully paid invoices

An array of addresses used to auto calculate sales tax

City of a physical address

Second line of a physical address

Region or state of a physical address

Country of a physical address

First line of a physical address

Indicates whether the address is defined as origin (FROM) or destination (TO)

Possible values:

• "FROM"
• "TO"

Fourth line of a physical address

Third line of a physical address

Postal code of a physical address

See Overpayments

Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types

Possible values:

• "Inclusive"
• "Exclusive"
• "NoTax"

The date the overpayment is created YYYY-MM-DD

See Payments

See Overpayment Types

Possible values:

• "RECEIVE-OVERPAYMENT"
• "AROVERPAYMENT"
• "SPEND-OVERPAYMENT"

The total of the overpayment (subtotal + total tax)

The total tax on the overpayment

See Overpayment Line Items

LineItem Quantity

LineItem Unit Amount

The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated is not correct.

See Accounts

The Xero identifier for a Repeating Invoice

LineItem unique ID

Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a element that contains at least 1 character

The tax type from TaxRates

The type of taxability

Possible values:

• "NOT_APPLICABLE"
• "EXEMPT"
• "PART_TAXABLE"
• "TAXABLE"
• "NON_TAXABLE"

An array of tax components defined for this line item

The unique ID number of this component

The name of the jurisdiction

The type of the jurisdiction

Possible values:

• "SYSGST/USSPECIAL"
• "SYSGST/USCOUNTRY"
• "SYSGST/USCOUNTY"
• "SYSGST/USSTATE"
• "SYSGST/USCITY"

The amount of the tax