Xero: Accounting schemas (part 1)

← Accounting operations · All schemas

Create a new currency for a Xero organisation — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
Code	Model	Optional	Expand Create a new currency for a Xero organisation — request body — body Code
Description	string	Optional	Name of Currency

Referenced models: Create a new currency for a Xero organisation — request body — body Code

Create a new currency for a Xero organisation — request body — body Code

Field	Type	Presence	Description and constraints
$	string	Root	3 letter alpha code for the currency – see list of currency codes One of: 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, STD, STN, 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

Create a new currency for a Xero organisation — response body

Field	Type	Presence	Description and constraints
$	object	Root
Currencies	array	Optional
Currencies[]	Model	Each item	Expand Create a new currency for a Xero organisation — response body — Currencies item

Referenced models: Create a new currency for a Xero organisation — response body — Currencies item

Create a new currency for a Xero organisation — response body — Currencies item

Field	Type	Presence	Description and constraints
$	object	Root
Code	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code
Description	string	Optional	Name of Currency

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Currency Code

Create tracking categories — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
Name	string	Optional	The name of the tracking category e.g. Department, Region (max length = 100) Maximum length: 100
Option	string	Optional	The option name of the tracking option e.g. East, West (max length = 100) Maximum length: 100
Options	array	Optional	See Tracking Options
Options[]	Model	Each item	Expand Creates options for a specific tracking category — request body — body
Status	string	Optional	The status of a tracking category One of: ACTIVE, ARCHIVED, DELETED
TrackingCategoryID	string	Optional	The Xero identifier for a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 Format: uuid
TrackingOptionID	string	Optional	The Xero identifier for a tracking option e.g. dc54c220-0140-495a-b925-3246adc0075f Format: uuid

Referenced models: Creates options for a specific tracking category — request body — body

Create tracking categories — response body

Field	Type	Presence	Description and constraints
$	object	Root
TrackingCategories	array	Optional
TrackingCategories[]	Model	Each item	Expand Create tracking categories — response body — Tracking Categories item

Referenced models: Create tracking categories — response body — Tracking Categories item

Create tracking categories — response body — Tracking Categories item

Field	Type	Presence	Description and constraints
$	object	Root
Name	string	Optional	The name of the tracking category e.g. Department, Region (max length = 100) Maximum length: 100
Option	string	Optional	The option name of the tracking option e.g. East, West (max length = 100) Maximum length: 100
Options	array	Optional	See Tracking Options
Options[]	Model	Each item	Expand Creates options for a specific tracking category — response body — Options item
Status	string	Optional	The status of a tracking category Known values: ACTIVE, ARCHIVED, DELETED
TrackingCategoryID	string	Optional	The Xero identifier for a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 Format: uuid
TrackingOptionID	string	Optional	The Xero identifier for a tracking option e.g. dc54c220-0140-495a-b925-3246adc0075f Format: uuid

Referenced models: Creates options for a specific tracking category — response body — Options item

Creates a bank transfer — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
BankTransfers	array	Optional
BankTransfers[]	Model	Each item	Expand Creates a bank transfer — request body — body Bank Transfers item

Referenced models: Creates a bank transfer — request body — body Bank Transfers item

Creates a bank transfer — request body — body Bank Transfers item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	number	Required within parent	amount of the transaction Format: double
BankTransferID	string	Optional	The identifier of the Bank Transfer Format: uuid Read only: true
CreatedDateUTC	string	Optional	UTC timestamp of creation date of bank transfer Read only: true
CurrencyRate	number	Optional	The currency rate Format: double Read only: true
Date	string	Optional	The date of the Transfer YYYY-MM-DD
FromBankAccount	Model	Required within parent	Expand Creates a new chart of accounts — request body — body
FromBankTransactionID	string	Optional	The Bank Transaction ID for the source account Format: uuid Read only: true
FromIsReconciled	boolean	Optional	The Bank Transaction boolean to show if it is reconciled for the source account Default: false
FromTracking	array	Optional	Optional Tracking Category for the source account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account.
FromTracking[]	Model	Each item	Expand Creates a bank transfer — response body — Bank Transfers item To Tracking item
HasAttachments	boolean	Optional	Boolean to indicate if a Bank Transfer has an attachment Default: false Read only: true
Reference	string	Optional	Reference for the transactions.
Status	string	Optional	AUTHORISED or DELETED (read-only). New bank transfers will have a status of AUTHORISED. One of: AUTHORISED, DELETED Read only: true
ToBankAccount	Model	Required within parent	Expand Creates a new chart of accounts — request body — body
ToBankTransactionID	string	Optional	The Bank Transaction ID for the destination account Format: uuid Read only: true
ToIsReconciled	boolean	Optional	The Bank Transaction boolean to show if it is reconciled for the destination account Default: false
ToTracking	array	Optional	Optional Tracking Category for the destination account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account.
ToTracking[]	Model	Each item	Expand Creates a bank transfer — response body — Bank Transfers item To Tracking item
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Creates a new chart of accounts — request body — body, Creates a bank transfer — response body — Bank Transfers item To Tracking item, Retrieves journals — response body — Warnings item

Creates a bank transfer — response body

Field	Type	Presence	Description and constraints
$	object	Root
BankTransfers	array	Optional
BankTransfers[]	Model	Each item	Expand Creates a bank transfer — response body — Bank Transfers item

Referenced models: Creates a bank transfer — response body — Bank Transfers item

Creates a bank transfer — response body — Bank Transfers item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	JSON	Required within parent
Amount (anyOf 1)	number	Alternative	amount of the transaction Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
BankTransferID	string	Optional	The identifier of the Bank Transfer Format: uuid Read only: true
CreatedDateUTC	string	Optional	UTC timestamp of creation date of bank transfer Read only: true
CurrencyRate	JSON	Optional
CurrencyRate (anyOf 1)	number	Alternative	The currency rate Format: double Read only: true
CurrencyRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Date	string	Optional	The date of the Transfer YYYY-MM-DD
FromBankAccount	Model	Required within parent	Expand Deletes a chart of accounts — response body — Accounts item
FromBankTransactionID	string	Optional	The Bank Transaction ID for the source account Format: uuid Read only: true
FromIsReconciled	boolean	Optional	The Bank Transaction boolean to show if it is reconciled for the source account Default: false
FromTracking	array	Optional	Optional Tracking Category for the source account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account.
FromTracking[]	Model	Each item	Expand Creates a bank transfer — response body — Bank Transfers item To Tracking item
HasAttachments	boolean	Optional	Boolean to indicate if a Bank Transfer has an attachment Default: false Read only: true
Reference	string	Optional	Reference for the transactions.
Status	string	Optional	AUTHORISED or DELETED (read-only). New bank transfers will have a status of AUTHORISED. Known values: AUTHORISED, DELETED Read only: true
ToBankAccount	Model	Required within parent	Expand Deletes a chart of accounts — response body — Accounts item
ToBankTransactionID	string	Optional	The Bank Transaction ID for the destination account Format: uuid Read only: true
ToIsReconciled	boolean	Optional	The Bank Transaction boolean to show if it is reconciled for the destination account Default: false
ToTracking	array	Optional	Optional Tracking Category for the destination account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account.
ToTracking[]	Model	Each item	Expand Creates a bank transfer — response body — Bank Transfers item To Tracking item
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Deletes a chart of accounts — response body — Accounts item, Creates a bank transfer — response body — Bank Transfers item To Tracking item, Retrieves journals — response body — Warnings item

Creates a bank transfer — response body — Bank Transfers item To Tracking item

Field	Type	Presence	Description and constraints
$	object	Root
Name	string	Optional	The name of the tracking category Maximum length: 100 Read only: true
Option	string	Optional	See Tracking Options Read only: true
TrackingCategoryID	string	Required within parent	The Xero identifier for a tracking category Format: uuid
TrackingOptionID	string	Required within parent	The Xero identifier for a tracking category option Format: uuid

Creates a contact group — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
ContactGroups	array	Optional
ContactGroups[]	Model	Each item	Expand Creates a contact group — request body — body Contact Groups item

Referenced models: Creates a contact group — request body — body Contact Groups item

Creates a contact group — request body — body Contact Groups item

Field	Type	Presence	Description and constraints
$	object	Root
ContactGroupID	string	Optional	The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9 Format: uuid
Contacts	array	Optional	The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL.
Contacts[]	Model	Each item	Expand Creates contacts to a specific contact group — request body — body Contacts item
Name	string	Optional	The Name of the contact group. Required when creating a new contact group
Status	string	Optional	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. One of: ACTIVE, DELETED

Referenced models: Creates contacts to a specific contact group — request body — body Contacts item

Creates a contact group — response body

Field	Type	Presence	Description and constraints
$	object	Root
ContactGroups	array	Optional
ContactGroups[]	Model	Each item	Expand Creates a contact group — response body — Contact Groups item

Referenced models: Creates a contact group — response body — Contact Groups item

Creates a contact group — response body — Contact Groups item

Field	Type	Presence	Description and constraints
$	object	Root
ContactGroupID	string	Optional	The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9 Format: uuid
Contacts	array	Optional	The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL.
Contacts[]	Model	Each item	Expand Creates contacts to a specific contact group — response body — Contacts item
Name	string	Optional	The Name of the contact group. Required when creating a new contact group
Status	string	Optional	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. Known values: ACTIVE, DELETED

Referenced models: Creates contacts to a specific contact group — response body — Contacts item

Creates a new chart of accounts — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
AccountID	string	Optional	The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9 Format: uuid
AddToWatchlist	boolean	Optional	Boolean – describes whether the account is shown in the watchlist widget on the dashboard
BankAccountNumber	string	Optional	For bank accounts only (Account Type BANK)
BankAccountType	string	Optional	For bank accounts only. See Bank Account types One of: BANK, CREDITCARD, PAYPAL, NONE,
Class	string	Optional	See Account Class Types One of: ASSET, EQUITY, EXPENSE, LIABILITY, REVENUE Read only: true
Code	string	Optional	Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)
CurrencyCode	Model	Optional	Expand Create a new currency for a Xero organisation — request body — body Code
Description	string	Optional	Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)
EnablePaymentsToAccount	boolean	Optional	Boolean – describes whether account can have payments applied to it
HasAttachments	boolean	Optional	boolean to indicate if an account has an attachment (read only) Default: false Read only: true
Name	string	Optional	Name of account (max length = 150) Maximum length: 150
ReportingCode	string	Optional	Shown if set
ReportingCodeName	string	Optional	Shown if set Read only: true
ShowInExpenseClaims	boolean	Optional	Boolean – describes whether account code is available for use with expense claims
Status	string	Optional	Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes One of: ACTIVE, ARCHIVED, DELETED
SystemAccount	string	Optional	If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null. One of: DEBTORS, CREDITORS, BANKCURRENCYGAIN, GST, GSTONIMPORTS, HISTORICAL, REALISEDCURRENCYGAIN, RETAINEDEARNINGS, ROUNDING, TRACKINGTRANSFERS, UNPAIDEXPCLM, UNREALISEDCURRENCYGAIN, WAGEPAYABLES, CISASSETS, CISASSET, CISLABOUR, CISLABOUREXPENSE, CISLABOURINCOME, CISLIABILITY, CISMATERIALS, Read only: true
TaxType	string	Optional	The tax type from taxRates
Type	string	Optional	See Account Types One of: BANK, CURRENT, CURRLIAB, DEPRECIATN, DIRECTCOSTS, EQUITY, EXPENSE, FIXED, INVENTORY, LIABILITY, NONCURRENT, OTHERINCOME, OVERHEADS, PREPAYMENT, REVENUE, SALES, TERMLIAB, PAYG
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Create a new currency for a Xero organisation — request body — body Code, Retrieves journals — response body — Warnings item

Creates a new credit note — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
CreditNotes	array	Optional
CreditNotes[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Credit Note
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Creates a new credit note — request body — body pagination

Referenced models: Creates a new credit note — request body — body pagination, Creates a single payment for invoice or credit notes — request body — body Credit Note, Retrieves journals — response body — Warnings item

Creates a new credit note — request body — body pagination

Field	Type	Presence	Description and constraints
$	object	Root
itemCount	integer	Optional
page	integer	Optional
pageCount	integer	Optional
pageSize	integer	Optional

Creates a new credit note — response body

Field	Type	Presence	Description and constraints
$	object	Root
CreditNotes	array	Optional
CreditNotes[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Credit Note
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Retrieves prepayments — response body — pagination

Referenced models: Retrieves prepayments — response body — pagination, Deletes an Allocation from a Prepayment — response body — Credit Note, Retrieves journals — response body — Warnings item

Creates a payment service — response body

Field	Type	Presence	Description and constraints
$	object	Root
PaymentServices	array	Optional
PaymentServices[]	Model	Each item	Expand Creates a payment service — response body — Payment Services item

Referenced models: Creates a payment service — response body — Payment Services item

Creates a payment service — response body — Payment Services item

Field	Type	Presence	Description and constraints
$	JSON	Root
PayNowText	string	Optional	The text displayed on the Pay Now button in Xero Online Invoicing. If this is not set it will default to Pay by credit card
PaymentServiceID	string	Optional	Xero identifier Format: uuid
PaymentServiceName	string	Optional	Name of payment service
PaymentServiceType	string	Optional	This will always be CUSTOM for payment services created via the API.
PaymentServiceUrl	string	Optional	The custom payment URL
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Retrieves journals — response body — Warnings item

Creates a single payment for invoice or credit notes — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
Account	Model	Optional	Expand Creates a new chart of accounts — request body — body
Amount	number	Optional	The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00 Format: double
BankAccountNumber	string	Optional	The suppliers bank account number the payment is being made to
BankAmount	number	Optional	The amount of the payment in the currency of the bank account. Format: double
BatchPayment	Model	Optional	Expand Creates a single payment for invoice or credit notes — request body — body Batch Payment
BatchPaymentID	string	Optional	Present if the payment was created as part of a batch. Format: uuid
Code	string	Optional	Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value)
CreditNote	Model	Optional	Expand Creates a single payment for invoice or credit notes — request body — body Credit Note
CreditNoteNumber	string	Optional	Number of invoice or credit note you are applying payment to e.g. INV-4003
CurrencyRate	number	Optional	Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500 Format: double
Date	string	Optional	Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
Details	string	Optional	The information to appear on the supplier's bank account
HasAccount	boolean	Optional	A boolean to indicate if a contact has an validation errors Default: false
HasValidationErrors	boolean	Optional	A boolean to indicate if a contact has an validation errors Default: false
Invoice	Model	Optional	Expand Creates a single payment for invoice or credit notes — request body — body Invoice
InvoiceNumber	string	Optional	Number of invoice or credit note you are applying payment to e.g.INV-4003
IsReconciled	boolean	Optional	An optional parameter for the payment. A boolean indicating whether you would like the payment to be created as reconciled when using PUT, or whether a payment has been reconciled when using GET
Overpayment	Model	Optional	Expand Creates a single payment for invoice or credit notes — request body — body Overpayment
Particulars	string	Optional	The suppliers bank account number the payment is being made to
PaymentID	string	Optional	The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 Format: uuid
PaymentType	string	Optional	See Payment Types. One of: ACCRECPAYMENT, ACCPAYPAYMENT, ARCREDITPAYMENT, APCREDITPAYMENT, AROVERPAYMENTPAYMENT, ARPREPAYMENTPAYMENT, APPREPAYMENTPAYMENT, APOVERPAYMENTPAYMENT Read only: true
Prepayment	Model	Optional	Expand Creates a single payment for invoice or credit notes — request body — body Prepayment
Reference	string	Optional	An optional description for the payment e.g. Direct Debit
Status	string	Optional	The status of the payment. One of: AUTHORISED, DELETED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
UpdatedDateUTC	string	Optional	UTC timestamp of last update to the payment Read only: true
UpdatedDateUTCString	string	Optional	UTC ISO-8601 formatted timestamp of last update to the payment Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Creates a new chart of accounts — request body — body, Creates a single payment for invoice or credit notes — request body — body Batch Payment, Creates a single payment for invoice or credit notes — request body — body Credit Note, Creates a single payment for invoice or credit notes — request body — body Invoice, Retrieves journals — response body — Warnings item, Creates a single payment for invoice or credit notes — request body — body Overpayment, Creates a single payment for invoice or credit notes — request body — body Prepayment

Creates a single payment for invoice or credit notes — request body — body Batch Payment

Field	Type	Presence	Description and constraints
$	object	Root
Account	Model	Optional	Expand Creates a new chart of accounts — request body — body
Amount	number	Optional	The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00 Format: double
BatchPaymentID	string	Optional	The Xero generated unique identifier for the bank transaction (read-only) Format: uuid Read only: true
Code	string	Optional	(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. Maximum length: 12
Date	string	Optional	Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
DateString	string	Optional	Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
Details	string	Optional	(Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18
IsReconciled	boolean	Optional	Booelan that tells you if the batch payment has been reconciled (read-only) Read only: true
Narrative	string	Optional	(UK Only) Only shows on the statement line in Xero. Max length =18 Maximum length: 18
Particulars	string	Optional	(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. Maximum length: 12
Payments	array	Optional	An array of payments
Payments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body
Reference	string	Optional	(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. Maximum length: 255
Status	string	Optional	AUTHORISED or DELETED (read-only). New batch payments will have a status of AUTHORISED. It is not possible to delete batch payments via the API. One of: AUTHORISED, DELETED Read only: true
TotalAmount	number	Optional	The total of the payments that make up the batch (read-only) Format: double Read only: true
Type	string	Optional	PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only) One of: PAYBATCH, RECBATCH Read only: true
UpdatedDateUTC	string	Optional	UTC timestamp of last update to the payment Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Creates a new chart of accounts — request body — body, Retrieves journals — response body — Warnings item, Creates a single payment for invoice or credit notes — request body — body

Creates a single payment for invoice or credit notes — request body — body Credit Note

Field	Type	Presence	Description and constraints
$	object	Root
Allocations	array	Optional	See Allocations
Allocations[]	Model	Each item	Expand Creates allocation for a specific credit note — request body — body Allocations item
AppliedAmount	number	Optional	The amount of applied to an invoice Format: double
BrandingThemeID	string	Optional	See BrandingThemes Format: uuid
CISDeduction	number	Optional	CIS deduction for UK contractors Format: double Read only: true
CISRate	number	Optional	CIS Deduction rate for the organisation Format: double Read only: true
Contact	Model	Optional	Expand Creates contacts to a specific contact group — request body — body Contacts item
CreditNoteID	string	Optional	Xero generated unique identifier Format: uuid
CreditNoteNumber	string	Optional	ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)
CurrencyCode	Model	Optional	Expand Create a new currency for a Xero organisation — request body — body Code The specified currency code
CurrencyRate	number	Optional	The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used Format: double
Date	string	Optional	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
DueDate	string	Optional	Date invoice is due – YYYY-MM-DD
FullyPaidOnDate	string	Optional	Date when credit note was fully paid(UTC format)
HasAttachments	boolean	Optional	boolean to indicate if a credit note has an attachment Default: false
HasErrors	boolean	Optional	A boolean to indicate if a credit note has an validation errors Default: false
InvoiceAddresses	array	Optional	An array of addresses used to auto calculate sales tax
InvoiceAddresses[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Invoice Addresses item
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types One of: Exclusive, Inclusive, NoTax
LineItems	array	Optional	See Invoice Line Items
LineItems[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item
Payments	array	Optional	See Payments
Payments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body
Reference	string	Optional	ACCRECCREDIT only – additional reference number
RemainingCredit	number	Optional	The remaining credit balance on the Credit Note Format: double
SentToContact	boolean	Optional	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
Status	string	Optional	See Credit Note Status Codes One of: DRAFT, SUBMITTED, DELETED, AUTHORISED, PAID, VOIDED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
SubTotal	number	Optional	The subtotal of the credit note excluding taxes Format: double
Total	number	Optional	The total of the Credit Note(subtotal + total tax) Format: double
TotalTax	number	Optional	The total tax on the credit note Format: double
Type	string	Optional	See Credit Note Types One of: ACCPAYCREDIT, ACCRECCREDIT
UpdatedDateUTC	string	Optional	UTC timestamp of last update to the credit note Read only: true
UpdatedDateUTCString	string	Optional	UTC ISO-8601 formatted timestamp of last update to the credit note Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Create a new currency for a Xero organisation — request body — body Code, Creates allocation for a specific credit note — request body — body Allocations item, Creates contacts to a specific contact group — request body — body Contacts item, Creates a single payment for invoice or credit notes — request body — body Invoice Invoice Addresses item, Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item, Retrieves journals — response body — Warnings item, Creates a single payment for invoice or credit notes — request body — body

Creates a single payment for invoice or credit notes — request body — body Invoice

Field	Type	Presence	Description and constraints
$	object	Root
AmountCredited	number	Optional	Sum of all credit notes, over-payments and pre-payments applied to invoice Format: double Read only: true
AmountDue	number	Optional	Amount remaining to be paid on invoice Format: double Read only: true
AmountPaid	number	Optional	Sum of payments received for invoice Format: double Read only: true
Attachments	array	Optional	Displays array of attachments from the API
Attachments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item
BrandingThemeID	string	Optional	See BrandingThemes Format: uuid
CISDeduction	number	Optional	CIS deduction for UK contractors Format: double Read only: true
CISRate	number	Optional	CIS Deduction rate for the organisation Format: double Read only: true
Contact	Model	Optional	Expand Creates contacts to a specific contact group — request body — body Contacts item
CreditNotes	array	Optional	Details of credit notes that have been applied to an invoice Read only: true
CreditNotes[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Credit Note
CurrencyCode	Model	Optional	Expand Create a new currency for a Xero organisation — request body — body Code
CurrencyRate	number	Optional	The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6]) Format: double
Date	string	Optional	Date invoice was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation
DueDate	string	Optional	Date invoice is due – YYYY-MM-DD
EnteredTotal	number	Optional	The total amount as originally entered for the invoice, before any RoundingAmount adjustment is applied. Only applies to ACCPAY and ACCREC invoices, and only if this opt-in capability has been enabled for your organisation. Can only be set while the invoice is DRAFT; once the invoice is no longer DRAFT this reflects Total. This field is only settable and only returned via the Create and Update endpoints (POST/PUT) and when retrieving a single invoice by ID (GET by ID) – it is not returned when listing invoices (GET) Format: double
ExpectedPaymentDate	string	Optional	Shown on sales invoices (Accounts Receivable) when this has been set
FullyPaidOnDate	string	Optional	The date the invoice was fully paid. Only returned on fully paid invoices Read only: true
HasAttachments	boolean	Optional	boolean to indicate if an invoice has an attachment Default: false Read only: true
HasErrors	boolean	Optional	A boolean to indicate if a invoice has an validation errors Default: false
InvoiceAddresses	array	Optional	An array of addresses used to auto calculate sales tax
InvoiceAddresses[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Invoice Addresses item
InvoiceID	string	Optional	Xero generated unique identifier for invoice Format: uuid
InvoiceNumber	string	Optional	ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255) Maximum length: 255
IsDiscounted	boolean	Optional	boolean to indicate if an invoice has a discount Read only: true
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types One of: Exclusive, Inclusive, NoTax
LineItems	array	Optional	See LineItems
LineItems[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item
Overpayments	array	Optional	See Overpayments Read only: true
Overpayments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Overpayment
Payments	array	Optional	See Payments Read only: true
Payments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body
PlannedPaymentDate	string	Optional	Shown on bills (Accounts Payable) when this has been set
Prepayments	array	Optional	See Prepayments Read only: true
Prepayments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Prepayment
Reference	string	Optional	ACCREC only – additional reference number
RepeatingInvoiceID	string	Optional	Xero generated unique identifier for repeating invoices Format: uuid
RoundingAmount	number	Optional	An optional rounding adjustment added to SubTotal + TotalTax to give Total (i.e. Total = SubTotal + TotalTax + RoundingAmount). Only applies to ACCPAY and ACCREC invoices, and only if this opt-in capability has been enabled for your organisation. Not validated while the invoice is DRAFT. For SUBMITTED and AUTHORISED invoices, RoundingAmount is only applied when SubTotal, TotalTax and Total are all supplied together, and must be between -0.10 and 0.10 – values outside this range are rejected with a validation error (on DRAFT invoices, an out-of-range value is ignored instead). This field is only settable and only returned via the Create and Update endpoints (POST/PUT) and when retrieving a single invoice by ID (GET by ID) – it is not returned when listing invoices (GET) Format: double
SentToContact	boolean	Optional	Boolean to set whether the invoice in the Xero app should be marked as “sent”. This can be set only on invoices that have been approved
Status	string	Optional	See Invoice Status Codes One of: DRAFT, SUBMITTED, DELETED, AUTHORISED, PAID, VOIDED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
SubTotal	number	Optional	Total of invoice excluding taxes. Calculated automatically by Xero from the invoice's line items. Only for ACCPAY and ACCREC invoices, where this opt-in capability is enabled for your organisation, can SubTotal be supplied on write – on a SUBMITTED or AUTHORISED invoice supplied together with TotalTax and Total, it is validated against the calculated line item totals (see RoundingAmount); it is ignored in all other cases. This write behaviour, and the returned value reflecting it, only applies to the Create and Update endpoints (POST/PUT) and to retrieving a single invoice by ID (GET by ID) – it does not apply when listing invoices (GET) Format: double
Total	number	Optional	Total of Invoice tax inclusive (i.e. SubTotal + TotalTax + RoundingAmount). Calculated automatically by Xero from the invoice's line items. Only for ACCPAY and ACCREC invoices, where this opt-in capability is enabled for your organisation, can Total be supplied on write – on a SUBMITTED or AUTHORISED invoice supplied together with SubTotal and TotalTax, it is validated against the calculated line item totals plus RoundingAmount; in all other cases this will be ignored if it does not equal the sum of the LineAmounts. This write behaviour, and the returned value reflecting it, only applies to the Create and Update endpoints (POST/PUT) and to retrieving a single invoice by ID (GET by ID) – it does not apply when listing invoices (GET) Format: double
TotalDiscount	number	Optional	Total of discounts applied on the invoice line items Format: double Read only: true
TotalTax	number	Optional	Total tax on invoice. Calculated automatically by Xero from the invoice's line items. Only for ACCPAY and ACCREC invoices, where this opt-in capability is enabled for your organisation, can TotalTax be supplied on write – on a SUBMITTED or AUTHORISED invoice supplied together with SubTotal and Total, it is validated against the calculated line item totals (see RoundingAmount); it is ignored in all other cases. This write behaviour, and the returned value reflecting it, only applies to the Create and Update endpoints (POST/PUT) and to retrieving a single invoice by ID (GET by ID) – it does not apply when listing invoices (GET) Format: double
Type	string	Optional	See Invoice Types One of: ACCPAY, ACCPAYCREDIT, APOVERPAYMENT, APPREPAYMENT, ACCREC, ACCRECCREDIT, AROVERPAYMENT, ARPREPAYMENT
UpdatedDateUTC	string	Optional	UTC timestamp of last update to the invoice Read only: true
UpdatedDateUTCString	string	Optional	UTC ISO-8601 formatted timestamp of last update to the invoice Read only: true
Url	string	Optional	URL link to a source document – shown as “Go to [appName]” in the Xero app
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Create a new currency for a Xero organisation — request body — body Code, Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item, Creates contacts to a specific contact group — request body — body Contacts item, Creates a single payment for invoice or credit notes — request body — body Credit Note, Creates a single payment for invoice or credit notes — request body — body Invoice Invoice Addresses item, Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item, Retrieves journals — response body — Warnings item, Creates a single payment for invoice or credit notes — request body — body Overpayment, Creates a single payment for invoice or credit notes — request body — body, Creates a single payment for invoice or credit notes — request body — body Prepayment

Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item

Field	Type	Presence	Description and constraints
$	object	Root
AttachmentID	string	Optional	Unique ID for the file Format: uuid
ContentLength	integer	Optional	Length of the file content
FileName	string	Optional	Name of the file
IncludeOnline	boolean	Optional	Include the file with the online invoice
MimeType	string	Optional	Type of file
Url	string	Optional	URL to the file on xero.com

Creates a single payment for invoice or credit notes — request body — body Invoice Invoice Addresses item

Field	Type	Presence	Description and constraints
$	object	Root
AddressLine1	string	Optional	First line of a physical address
AddressLine2	string	Optional	Second line of a physical address
AddressLine3	string	Optional	Third line of a physical address
AddressLine4	string	Optional	Fourth line of a physical address
City	string	Optional	City of a physical address
Country	string	Optional	Country of a physical address
InvoiceAddressType	string	Optional	Indicates whether the address is defined as origin (FROM) or destination (TO) One of: FROM, TO
PostalCode	string	Optional	Postal code of a physical address
Region	string	Optional	Region or state of a physical address

Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	See Accounts
AccountID	string	Optional	The associated account ID related to this line item Format: uuid
Description	string	Optional	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 <Description> element that contains at least 1 character
DiscountAmount	number	Optional	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. Format: double
DiscountRate	number	Optional	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 Format: double
Item	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Item
ItemCode	string	Optional	See Items
LineAmount	number	Optional	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 Format: double
LineItemID	string	Optional	LineItem unique ID Format: uuid
Quantity	number	Optional	LineItem Quantity Format: double
RepeatingInvoiceID	string	Optional	The Xero identifier for a Repeating Invoice Format: uuid
SalesTaxCodeId	number	Optional	The ID of the sales tax code
TaxAmount	number	Optional	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 <TaxAmount> is not correct. Format: double
TaxBreakdown	array	Optional	An array of tax components defined for this line item
TaxBreakdown[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item Tax Breakdown item
TaxType	string	Optional	The tax type from TaxRates
Taxability	string	Optional	The type of taxability One of: TAXABLE, NON_TAXABLE, EXEMPT, PART_TAXABLE, NOT_APPLICABLE
Tracking	array	Optional	Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements.
Tracking[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Tracking item
UnitAmount	number	Optional	LineItem Unit Amount Format: double

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item Tracking item, Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item Tax Breakdown item

Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item Tax Breakdown item

Field	Type	Presence	Description and constraints
$	object	Root
ExemptAmount	number	Optional	The amount that is exempt
JurisdictionRegion	string	Optional	Name identifying the region within the country
Name	string	Optional	The name of the jurisdiction
NonTaxableAmount	number	Optional	The amount that is not taxable
StateAssignedNo	string	Optional	The state assigned number of the jurisdiction
TaxAmount	number	Optional	The amount of the tax
TaxComponentId	string	Optional	The unique ID number of this component Format: uuid
TaxPercentage	number	Optional	The percentage of the tax
TaxableAmount	number	Optional	The amount that is taxable
Type	string	Optional	The type of the jurisdiction One of: SYSGST/USCOUNTRY, SYSGST/USSTATE, SYSGST/USCOUNTY, SYSGST/USCITY, SYSGST/USSPECIAL

Creates a single payment for invoice or credit notes — request body — body Overpayment

Field	Type	Presence	Description and constraints
$	object	Root
Allocations	array	Optional	See Allocations
Allocations[]	Model	Each item	Expand Creates allocation for a specific credit note — request body — body Allocations item
AppliedAmount	number	Optional	The amount of applied to an invoice Format: double
Attachments	array	Optional	See Attachments
Attachments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item
Contact	Model	Optional	Expand Creates contacts to a specific contact group — request body — body Contacts item
CurrencyCode	Model	Optional	Expand Create a new currency for a Xero organisation — request body — body Code
CurrencyRate	number	Optional	The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used Format: double
Date	string	Optional	The date the overpayment is created YYYY-MM-DD
HasAttachments	boolean	Optional	boolean to indicate if a overpayment has an attachment Default: false Read only: true
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types One of: Exclusive, Inclusive, NoTax
LineItems	array	Optional	See Overpayment Line Items
LineItems[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item
OverpaymentID	string	Optional	Xero generated unique identifier Format: uuid
Payments	array	Optional	See Payments
Payments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body
Reference	string	Optional	An optional description for Overpayment
RemainingCredit	number	Optional	The remaining credit balance on the overpayment Format: double
Status	string	Optional	See Overpayment Status Codes One of: AUTHORISED, PAID, VOIDED
SubTotal	number	Optional	The subtotal of the overpayment excluding taxes Format: double
Total	number	Optional	The total of the overpayment (subtotal + total tax) Format: double
TotalTax	number	Optional	The total tax on the overpayment Format: double
Type	string	Optional	See Overpayment Types One of: RECEIVE-OVERPAYMENT, SPEND-OVERPAYMENT, AROVERPAYMENT
UpdatedDateUTC	string	Optional	UTC timestamp of last update to the overpayment Read only: true
UpdatedDateUTCString	string	Optional	UTC ISO-8601 formatted timestamp of last update to the overpayment Read only: true

Referenced models: Create a new currency for a Xero organisation — request body — body Code, Creates allocation for a specific credit note — request body — body Allocations item, Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item, Creates contacts to a specific contact group — request body — body Contacts item, Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item, Creates a single payment for invoice or credit notes — request body — body

Creates a single payment for invoice or credit notes — request body — body Prepayment

Field	Type	Presence	Description and constraints
$	object	Root
Allocations	array	Optional	See Allocations
Allocations[]	Model	Each item	Expand Creates allocation for a specific credit note — request body — body Allocations item
AppliedAmount	number	Optional	The amount of applied to an invoice Format: double
Attachments	array	Optional	See Attachments
Attachments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item
BrandingThemeID	string	Optional	The unique identifier of the branding template applied to a receive prepayment Format: uuid Read only: true
Contact	Model	Optional	Expand Creates contacts to a specific contact group — request body — body Contacts item
CurrencyCode	Model	Optional	Expand Create a new currency for a Xero organisation — request body — body Code
CurrencyRate	number	Optional	The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used Format: double
Date	string	Optional	The date the prepayment is created YYYY-MM-DD
HasAttachments	boolean	Optional	boolean to indicate if a prepayment has an attachment Default: false Read only: true
InvoiceNumber	string	Optional	Returns Invoice number for prepayment receive document only. Read only: true
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types One of: Exclusive, Inclusive, NoTax
LineItems	array	Optional	See Prepayment Line Items
LineItems[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item
Payments	array	Optional	See Payments
Payments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body
PrepaymentID	string	Optional	Xero generated unique identifier Format: uuid
Reference	string	Optional	Returns Invoice number field. Reference field isn't available. Read only: true
RemainingCredit	number	Optional	The remaining credit balance on the prepayment Format: double
Status	string	Optional	See Prepayment Status Codes One of: AUTHORISED, PAID, VOIDED
SubTotal	number	Optional	The subtotal of the prepayment excluding taxes Format: double
Total	number	Optional	The total of the prepayment(subtotal + total tax) Format: double
TotalTax	number	Optional	The total tax on the prepayment Format: double
Type	string	Optional	See Prepayment Types One of: RECEIVE-PREPAYMENT, SPEND-PREPAYMENT, ARPREPAYMENT, APPREPAYMENT
UpdatedDateUTC	string	Optional	UTC timestamp of last update to the prepayment Read only: true
UpdatedDateUTCString	string	Optional	UTC ISO-8601 formatted timestamp of last update to the prepayment Read only: true

Referenced models: Create a new currency for a Xero organisation — request body — body Code, Creates allocation for a specific credit note — request body — body Allocations item, Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item, Creates contacts to a specific contact group — request body — body Contacts item, Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item, Creates a single payment for invoice or credit notes — request body — body

Creates allocation for a specific credit note — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
Allocations	array	Optional
Allocations[]	Model	Each item	Expand Creates allocation for a specific credit note — request body — body Allocations item

Referenced models: Creates allocation for a specific credit note — request body — body Allocations item

Creates allocation for a specific credit note — request body — body Allocations item

Field	Type	Presence	Description and constraints
$	object	Root
AllocationID	string	Optional	Xero generated unique identifier Format: uuid
Amount	number	Required within parent	the amount being applied to the invoice Format: double
CreditNote	Model	Optional	Expand Creates a single payment for invoice or credit notes — request body — body Credit Note
Date	string	Required within parent	the date the allocation is applied YYYY-MM-DD.
Invoice	Model	Required within parent	Expand Creates a single payment for invoice or credit notes — request body — body Invoice
IsDeleted	boolean	Optional	A flag that returns true when the allocation is succesfully deleted Read only: true
Overpayment	Model	Optional	Expand Creates a single payment for invoice or credit notes — request body — body Overpayment
Prepayment	Model	Optional	Expand Creates a single payment for invoice or credit notes — request body — body Prepayment
StatusAttributeString	string	Optional	A string to indicate if a invoice status
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Creates a single payment for invoice or credit notes — request body — body Credit Note, Creates a single payment for invoice or credit notes — request body — body Invoice, Retrieves journals — response body — Warnings item, Creates a single payment for invoice or credit notes — request body — body Overpayment, Creates a single payment for invoice or credit notes — request body — body Prepayment

Creates allocation for a specific credit note — response body

Field	Type	Presence	Description and constraints
$	object	Root
Allocations	array	Optional
Allocations[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body

Referenced models: Deletes an Allocation from a Prepayment — response body

Creates contacts to a specific contact group — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
Contacts	array	Optional
Contacts[]	Model	Each item	Expand Creates contacts to a specific contact group — request body — body Contacts item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Creates a new credit note — request body — body pagination

Referenced models: Creates a new credit note — request body — body pagination, Creates contacts to a specific contact group — request body — body Contacts item, Retrieves journals — response body — Warnings item

Creates contacts to a specific contact group — request body — body Contacts item

Field	Type	Presence	Description and constraints
$	object	Root
AccountNumber	string	Optional	A user defined account number. This can be updated via the API and the Xero UI (max length = 50) Maximum length: 50
AccountsPayableTaxType	string	Optional	The tax type from TaxRates
AccountsReceivableTaxType	string	Optional	The tax type from TaxRates
Addresses	array	Optional	Store certain address types for a contact – see address types
Addresses[]	Model	Each item	Expand Creates contacts to a specific contact group — request body — body Contacts item Addresses item
Attachments	array	Optional	Displays array of attachments from the API
Attachments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item
Balances	Model	Optional	Expand Creates contacts to a specific contact group — request body — body Contacts item Balances
BankAccountDetails	string	Optional	Bank account number of contact
BatchPayments	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item Batch Payments
BrandingTheme	Model	Optional	Expand Creates contacts to a specific contact group — request body — body Contacts item Branding Theme
CompanyNumber	string	Optional	Company registration number (max length = 50) Maximum length: 50
ContactGroups	array	Optional	Displays which contact groups a contact is included in
ContactGroups[]	Model	Each item	Expand Creates a contact group — request body — body Contact Groups item
ContactID	string	Optional	Xero identifier Format: uuid
ContactNumber	string	Optional	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. Maximum length: 50
ContactPersons	array	Optional	See contact persons
ContactPersons[]	Model	Each item	Expand Creates contacts to a specific contact group — response body — Contacts item Contact Persons item
ContactStatus	string	Optional	Current status of a contact – see contact status types One of: ACTIVE, ARCHIVED, GDPRREQUEST
DefaultCurrency	Model	Optional	Expand Create a new currency for a Xero organisation — request body — body Code
Discount	number	Optional	The default discount rate for the contact (read only) Format: double Read only: true
EmailAddress	string	Optional	Email address of contact person (umlauts not supported) (max length = 255) Maximum length: 255
FirstName	string	Optional	First name of contact person (max length = 255) Maximum length: 255
HasAttachments	boolean	Optional	A boolean to indicate if a contact has an attachment Default: false
HasValidationErrors	boolean	Optional	A boolean to indicate if a contact has an validation errors Default: false
IsCustomer	boolean	Optional	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.
IsSupplier	boolean	Optional	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.
LastName	string	Optional	Last name of contact person (max length = 255) Maximum length: 255
MergedToContactID	string	Optional	ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber. Format: uuid
Name	string	Optional	Full name of contact/organisation (max length = 255) Maximum length: 255
PaymentTerms	Model	Optional	Expand Creates contacts to a specific contact group — request body — body Contacts item Payment Terms
Phones	array	Optional	Store certain phone types for a contact – see phone types
Phones[]	Model	Each item	Expand Creates contacts to a specific contact group — request body — body Contacts item Phones item
PurchasesDefaultAccountCode	string	Optional	The default purchases account code for contacts
PurchasesDefaultLineAmountType	string	Optional	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. One of: INCLUSIVE, EXCLUSIVE, NONE
PurchasesTrackingCategories	array	Optional	The default purchases tracking categories for contacts
PurchasesTrackingCategories[]	Model	Each item	Expand Creates contacts to a specific contact group — response body — Contacts item Sales Tracking Categories item
SalesDefaultAccountCode	string	Optional	The default sales account code for contacts
SalesDefaultLineAmountType	string	Optional	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. One of: INCLUSIVE, EXCLUSIVE, NONE
SalesTrackingCategories	array	Optional	The default sales tracking categories for contacts
SalesTrackingCategories[]	Model	Each item	Expand Creates contacts to a specific contact group — response body — Contacts item Sales Tracking Categories item
StatusAttributeString	string	Optional	Status of object
TaxNumber	string	Optional	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) Maximum length: 50
TaxNumberType	string	Optional	Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers One of: SSN, EIN, ITIN, ATIN
TrackingCategoryName	string	Optional	The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
TrackingCategoryOption	string	Optional	The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
UpdatedDateUTC	string	Optional	UTC timestamp of last update to contact Read only: true
ValidationErrors	array	Optional	Displays validation errors returned from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Website	string	Optional	Website address for contact (read only) Read only: true
XeroNetworkKey	string	Optional	Store XeroNetworkKey for contacts.

Referenced models: Create a new currency for a Xero organisation — request body — body Code, Creates contacts to a specific contact group — request body — body Contacts item Addresses item, Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item, Creates contacts to a specific contact group — request body — body Contacts item Balances, Creates contacts to a specific contact group — response body — Contacts item Batch Payments, Creates contacts to a specific contact group — request body — body Contacts item Branding Theme, Creates a contact group — request body — body Contact Groups item, Creates contacts to a specific contact group — response body — Contacts item Contact Persons item, Creates contacts to a specific contact group — response body — Contacts item Sales Tracking Categories item, Retrieves journals — response body — Warnings item, Creates contacts to a specific contact group — request body — body Contacts item Payment Terms, Creates contacts to a specific contact group — request body — body Contacts item Phones item

Creates contacts to a specific contact group — request body — body Contacts item Addresses item

Field	Type	Presence	Description and constraints
$	object	Root
AddressLine1	string	Optional	max length = 500 Maximum length: 500
AddressLine2	string	Optional	max length = 500 Maximum length: 500
AddressLine3	string	Optional	max length = 500 Maximum length: 500
AddressLine4	string	Optional	max length = 500 Maximum length: 500
AddressType	string	Optional	define the type of address One of: POBOX, STREET
AttentionTo	string	Optional	max length = 255 Maximum length: 255
City	string	Optional	max length = 255 Maximum length: 255
Country	string	Optional	max length = 50, [A-Z], [a-z] only Maximum length: 50
PostalCode	string	Optional	max length = 50 Maximum length: 50
Region	string	Optional	max length = 255 Maximum length: 255

Creates contacts to a specific contact group — request body — body Contacts item Balances

Field	Type	Presence	Description and constraints
$	object	Root	The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only)
AccountsPayable	Model	Optional	Expand Creates contacts to a specific contact group — request body — body Contacts item Balances Accounts Payable
AccountsReceivable	Model	Optional	Expand Creates contacts to a specific contact group — request body — body Contacts item Balances Accounts Payable

Referenced models: Creates contacts to a specific contact group — request body — body Contacts item Balances Accounts Payable

Creates contacts to a specific contact group — request body — body Contacts item Balances Accounts Payable

Field	Type	Presence	Description and constraints
$	object	Root
Outstanding	number	Optional	Format: double
Overdue	number	Optional	Format: double

Creates contacts to a specific contact group — request body — body Contacts item Branding Theme

Field	Type	Presence	Description and constraints
$	object	Root
BrandingThemeID	string	Optional	Xero identifier Format: uuid
CreatedDateUTC	string	Optional	UTC timestamp of creation date of branding theme Read only: true
LogoUrl	string	Optional	The location of the image file used as the logo on this branding theme
Name	string	Optional	Name of branding theme
SortOrder	integer	Optional	Integer – ranked order of branding theme. The default branding theme has a value of 0
Type	string	Optional	Always INVOICE One of: INVOICE

Creates contacts to a specific contact group — request body — body Contacts item Payment Terms

Field	Type	Presence	Description and constraints
$	object	Root
Bills	Model	Optional	Expand Creates contacts to a specific contact group — request body — body Contacts item Payment Terms Bills
Sales	Model	Optional	Expand Creates contacts to a specific contact group — request body — body Contacts item Payment Terms Bills

Referenced models: Creates contacts to a specific contact group — request body — body Contacts item Payment Terms Bills

Creates contacts to a specific contact group — request body — body Contacts item Payment Terms Bills

Field	Type	Presence	Description and constraints
$	object	Root
Day	integer	Optional	Day of Month (0-31)
Type	string	Optional	One of: DAYSAFTERBILLDATE, DAYSAFTERBILLMONTH, OFCURRENTMONTH, OFFOLLOWINGMONTH

Creates contacts to a specific contact group — request body — body Contacts item Phones item

Field	Type	Presence	Description and constraints
$	object	Root
PhoneAreaCode	string	Optional	max length = 10 Maximum length: 10
PhoneCountryCode	string	Optional	max length = 20 Maximum length: 20
PhoneNumber	string	Optional	max length = 50 Maximum length: 50
PhoneType	string	Optional	One of: DEFAULT, DDI, MOBILE, FAX, OFFICE

Creates contacts to a specific contact group — response body

Field	Type	Presence	Description and constraints
$	object	Root
Contacts	array	Optional
Contacts[]	Model	Each item	Expand Creates contacts to a specific contact group — response body — Contacts item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Retrieves prepayments — response body — pagination

Referenced models: Retrieves prepayments — response body — pagination, Creates contacts to a specific contact group — response body — Contacts item, Retrieves journals — response body — Warnings item

Creates contacts to a specific contact group — response body — Contacts item

Field	Type	Presence	Description and constraints
$	object	Root
AccountNumber	string	Optional	A user defined account number. This can be updated via the API and the Xero UI (max length = 50) Maximum length: 50
AccountsPayableTaxType	string	Optional	The tax type from TaxRates
AccountsReceivableTaxType	string	Optional	The tax type from TaxRates
Addresses	array	Optional	Store certain address types for a contact – see address types
Addresses[]	Model	Each item	Expand Creates contacts to a specific contact group — response body — Contacts item Addresses item
Attachments	array	Optional	Displays array of attachments from the API
Attachments[]	Model	Each item	Expand create Contact Attachment By File Name — response body — Attachments item
Balances	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item Balances
BankAccountDetails	string	Optional	Bank account number of contact
BatchPayments	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item Batch Payments
BrandingTheme	Model	Optional	Expand Retrieves all the branding themes — response body — Branding Themes item
CompanyNumber	string	Optional	Company registration number (max length = 50) Maximum length: 50
ContactGroups	array	Optional	Displays which contact groups a contact is included in
ContactGroups[]	Model	Each item	Expand Creates a contact group — response body — Contact Groups item
ContactID	string	Optional	Xero identifier Format: uuid
ContactNumber	string	Optional	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. Maximum length: 50
ContactPersons	array	Optional	See contact persons
ContactPersons[]	Model	Each item	Expand Creates contacts to a specific contact group — response body — Contacts item Contact Persons item
ContactStatus	string	Optional	Current status of a contact – see contact status types Known values: ACTIVE, ARCHIVED, GDPRREQUEST
DefaultCurrency	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code
Discount	JSON	Optional
Discount (anyOf 1)	number	Alternative	The default discount rate for the contact (read only) Format: double Read only: true
Discount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
EmailAddress	string	Optional	Email address of contact person (umlauts not supported) (max length = 255) Maximum length: 255
FirstName	string	Optional	First name of contact person (max length = 255) Maximum length: 255
HasAttachments	boolean	Optional	A boolean to indicate if a contact has an attachment Default: false
HasValidationErrors	boolean	Optional	A boolean to indicate if a contact has an validation errors Default: false
IsCustomer	boolean	Optional	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.
IsSupplier	boolean	Optional	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.
LastName	string	Optional	Last name of contact person (max length = 255) Maximum length: 255
MergedToContactID	string	Optional	ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber. Format: uuid
Name	string	Optional	Full name of contact/organisation (max length = 255) Maximum length: 255
PaymentTerms	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item Payment Terms
Phones	array	Optional	Store certain phone types for a contact – see phone types
Phones[]	Model	Each item	Expand Creates contacts to a specific contact group — response body — Contacts item Phones item
PurchasesDefaultAccountCode	string	Optional	The default purchases account code for contacts
PurchasesDefaultLineAmountType	string	Optional	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. Known values: INCLUSIVE, EXCLUSIVE, NONE
PurchasesTrackingCategories	array	Optional	The default purchases tracking categories for contacts
PurchasesTrackingCategories[]	Model	Each item	Expand Creates contacts to a specific contact group — response body — Contacts item Sales Tracking Categories item
SalesDefaultAccountCode	string	Optional	The default sales account code for contacts
SalesDefaultLineAmountType	string	Optional	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. Known values: INCLUSIVE, EXCLUSIVE, NONE
SalesTrackingCategories	array	Optional	The default sales tracking categories for contacts
SalesTrackingCategories[]	Model	Each item	Expand Creates contacts to a specific contact group — response body — Contacts item Sales Tracking Categories item
StatusAttributeString	string	Optional	Status of object
TaxNumber	string	Optional	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) Maximum length: 50
TaxNumberType	string	Optional	Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers Known values: SSN, EIN, ITIN, ATIN
TrackingCategoryName	string	Optional	The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
TrackingCategoryOption	string	Optional	The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
UpdatedDateUTC	string	Optional	UTC timestamp of last update to contact Read only: true
ValidationErrors	array	Optional	Displays validation errors returned from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Website	string	Optional	Website address for contact (read only) Read only: true
XeroNetworkKey	string	Optional	Store XeroNetworkKey for contacts.

Referenced models: Creates contacts to a specific contact group — response body — Contacts item Batch Payments, Creates contacts to a specific contact group — response body — Contacts item Contact Persons item, Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, Creates contacts to a specific contact group — response body — Contacts item Addresses item, create Contact Attachment By File Name — response body — Attachments item, Creates contacts to a specific contact group — response body — Contacts item Balances, Retrieves all the branding themes — response body — Branding Themes item, Creates a contact group — response body — Contact Groups item, Creates contacts to a specific contact group — response body — Contacts item Payment Terms, Creates contacts to a specific contact group — response body — Contacts item Phones item, Creates contacts to a specific contact group — response body — Contacts item Sales Tracking Categories item, Retrieves journals — response body — Warnings item

Creates contacts to a specific contact group — response body — Contacts item Addresses item

Field	Type	Presence	Description and constraints
$	object	Root
AddressLine1	string	Optional	max length = 500 Maximum length: 500
AddressLine2	string	Optional	max length = 500 Maximum length: 500
AddressLine3	string	Optional	max length = 500 Maximum length: 500
AddressLine4	string	Optional	max length = 500 Maximum length: 500
AddressType	string	Optional	define the type of address Known values: POBOX, STREET
AttentionTo	string	Optional	max length = 255 Maximum length: 255
City	string	Optional	max length = 255 Maximum length: 255
Country	string	Optional	max length = 50, [A-Z], [a-z] only Maximum length: 50
PostalCode	string	Optional	max length = 50 Maximum length: 50
Region	string	Optional	max length = 255 Maximum length: 255

Creates contacts to a specific contact group — response body — Contacts item Balances

Field	Type	Presence	Description and constraints
$	object	Root	The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only)
AccountsPayable	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item Balances Accounts Payable
AccountsReceivable	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item Balances Accounts Payable

Referenced models: Creates contacts to a specific contact group — response body — Contacts item Balances Accounts Payable

Creates contacts to a specific contact group — response body — Contacts item Balances Accounts Payable

Field	Type	Presence	Description and constraints
$	object	Root
Outstanding	JSON	Optional
Outstanding (anyOf 1)	number	Alternative	Format: double
Outstanding (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Overdue	JSON	Optional
Overdue (anyOf 1)	number	Alternative	Format: double
Overdue (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Creates contacts to a specific contact group — response body — Contacts item Batch Payments

Field	Type	Presence	Description and constraints
$	JSON	Root	Bank details for use on a batch payment stored with each contact
BankAccountName	string	Optional	Name of bank for use with Batch Payments
BankAccountNumber	string	Optional	Bank account number for use with Batch Payments
Code	string	Optional	(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. Maximum length: 12
Details	string	Optional	(Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18
Reference	string	Optional	(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. Maximum length: 12

Creates contacts to a specific contact group — response body — Contacts item Contact Persons item

Field	Type	Presence	Description and constraints
$	object	Root
EmailAddress	string	Optional	Email address of person
FirstName	string	Optional	First name of person
IncludeInEmails	boolean	Optional	boolean to indicate whether contact should be included on emails with invoices etc.
LastName	string	Optional	Last name of person

Creates contacts to a specific contact group — response body — Contacts item Payment Terms

Field	Type	Presence	Description and constraints
$	object	Root
Bills	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item Payment Terms Bills
Sales	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item Payment Terms Bills

Referenced models: Creates contacts to a specific contact group — response body — Contacts item Payment Terms Bills

Creates contacts to a specific contact group — response body — Contacts item Payment Terms Bills

Field	Type	Presence	Description and constraints
$	object	Root
Day	JSON	Optional
Day (anyOf 1)	integer	Alternative	Day of Month (0-31)
Day (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Type	string	Optional	Known values: DAYSAFTERBILLDATE, DAYSAFTERBILLMONTH, OFCURRENTMONTH, OFFOLLOWINGMONTH

Creates contacts to a specific contact group — response body — Contacts item Phones item

Field	Type	Presence	Description and constraints
$	object	Root
PhoneAreaCode	string	Optional	max length = 10 Maximum length: 10
PhoneCountryCode	string	Optional	max length = 20 Maximum length: 20
PhoneNumber	string	Optional	max length = 50 Maximum length: 50
PhoneType	string	Optional	Known values: DEFAULT, DDI, MOBILE, FAX, OFFICE

Creates contacts to a specific contact group — response body — Contacts item Sales Tracking Categories item

Field	Type	Presence	Description and constraints
$	object	Root
TrackingCategoryName	string	Optional	The default sales tracking category name for contacts
TrackingOptionName	string	Optional	The default purchase tracking category name for contacts

Creates expense claims — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
ExpenseClaims	array	Optional
ExpenseClaims[]	Model	Each item	Expand Creates expense claims — request body — body Expense Claims item

Referenced models: Creates expense claims — request body — body Expense Claims item

Creates expense claims — request body — body Expense Claims item

Field	Type	Presence	Description and constraints
$	object	Root
AmountDue	number	Optional	The amount due to be paid for an expense claim Format: double Read only: true
AmountPaid	number	Optional	The amount still to pay for an expense claim Format: double Read only: true
ExpenseClaimID	string	Optional	Xero generated unique identifier for an expense claim Format: uuid
PaymentDueDate	string	Optional	The date when the expense claim is due to be paid YYYY-MM-DD Read only: true
Payments	array	Optional	See Payments
Payments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body
ReceiptID	string	Optional	The Xero identifier for the Receipt e.g. e59a2c7f-1306-4078-a0f3-73537afcbba9 Format: uuid
Receipts	array	Optional
Receipts[]	Model	Each item	Expand Updates a specific draft expense claim receipts — request body — body Receipts item
ReportingDate	string	Optional	The date the expense claim will be reported in Xero YYYY-MM-DD Read only: true
Status	string	Optional	Current status of an expense claim – see status types One of: SUBMITTED, AUTHORISED, PAID, VOIDED, DELETED
Total	number	Optional	The total of an expense claim being paid Format: double Read only: true
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
User	Model	Optional	Expand Updates a specific draft expense claim receipts — request body — body Receipts item User

Referenced models: Updates a specific draft expense claim receipts — request body — body Receipts item User, Creates a single payment for invoice or credit notes — request body — body, Updates a specific draft expense claim receipts — request body — body Receipts item

Creates expense claims — response body

Field	Type	Presence	Description and constraints
$	object	Root
ExpenseClaims	array	Optional
ExpenseClaims[]	Model	Each item	Expand Creates expense claims — response body — Expense Claims item

Referenced models: Creates expense claims — response body — Expense Claims item

Creates expense claims — response body — Expense Claims item

Field	Type	Presence	Description and constraints
$	object	Root
AmountDue	JSON	Optional
AmountDue (anyOf 1)	number	Alternative	The amount due to be paid for an expense claim Format: double Read only: true
AmountDue (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
AmountPaid	JSON	Optional
AmountPaid (anyOf 1)	number	Alternative	The amount still to pay for an expense claim Format: double Read only: true
AmountPaid (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ExpenseClaimID	string	Optional	Xero generated unique identifier for an expense claim Format: uuid
PaymentDueDate	string	Optional	The date when the expense claim is due to be paid YYYY-MM-DD Read only: true
Payments	array	Optional	See Payments
Payments[]	Model	Each item	Expand Retrieves payments for invoices and credit notes — response body — Payments item
ReceiptID	string	Optional	The Xero identifier for the Receipt e.g. e59a2c7f-1306-4078-a0f3-73537afcbba9 Format: uuid
Receipts	array	Optional
Receipts[]	Model	Each item	Expand Updates a specific draft expense claim receipts — response body — Receipts item
ReportingDate	string	Optional	The date the expense claim will be reported in Xero YYYY-MM-DD Read only: true
Status	string	Optional	Current status of an expense claim – see status types Known values: SUBMITTED, AUTHORISED, PAID, VOIDED, DELETED
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	The total of an expense claim being paid Format: double Read only: true
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
User	Model	Optional	Expand Retrieves users — response body — Users item

Referenced models: Retrieves users — response body — Users item, Retrieves payments for invoices and credit notes — response body — Payments item, Updates a specific draft expense claim receipts — response body — Receipts item

Creates linked transactions (billable expenses) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
ContactID	string	Optional	Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED. Format: uuid
LinkedTransactionID	string	Optional	The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9 Format: uuid
SourceLineItemID	string	Optional	The line item identifier from the source transaction. Format: uuid
SourceTransactionID	string	Optional	Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice Format: uuid
SourceTransactionTypeCode	string	Optional	The Type of the source tranasction. This will be ACCPAY if the linked transaction was created from an invoice and SPEND if it was created from a bank transaction. One of: ACCPAY, SPEND
Status	string	Optional	Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED. One of: APPROVED, DRAFT, ONDRAFT, BILLED, VOIDED
TargetLineItemID	string	Optional	The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID. Format: uuid
TargetTransactionID	string	Optional	Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice Format: uuid
Type	string	Optional	This will always be BILLABLEEXPENSE. More types may be added in future. One of: BILLABLEEXPENSE
UpdatedDateUTC	string	Optional	The last modified date in UTC format Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Retrieves journals — response body — Warnings item

Creates linked transactions (billable expenses) — response body

Field	Type	Presence	Description and constraints
$	object	Root
LinkedTransactions	array	Optional
LinkedTransactions[]	Model	Each item	Expand Creates linked transactions (billable expenses) — response body — Linked Transactions item

Referenced models: Creates linked transactions (billable expenses) — response body — Linked Transactions item

Creates linked transactions (billable expenses) — response body — Linked Transactions item

Field	Type	Presence	Description and constraints
$	object	Root
ContactID	string	Optional	Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED. Format: uuid
LinkedTransactionID	string	Optional	The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9 Format: uuid
SourceLineItemID	string	Optional	The line item identifier from the source transaction. Format: uuid
SourceTransactionID	string	Optional	Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice Format: uuid
SourceTransactionTypeCode	string	Optional	The Type of the source tranasction. This will be ACCPAY if the linked transaction was created from an invoice and SPEND if it was created from a bank transaction. Known values: ACCPAY, SPEND
Status	string	Optional	Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED. Known values: APPROVED, DRAFT, ONDRAFT, BILLED, VOIDED
TargetLineItemID	string	Optional	The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID. Format: uuid
TargetTransactionID	string	Optional	Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice Format: uuid
Type	string	Optional	This will always be BILLABLEEXPENSE. More types may be added in future. Known values: BILLABLEEXPENSE
UpdatedDateUTC	string	Optional	The last modified date in UTC format Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Retrieves journals — response body — Warnings item

Creates multiple payments for invoices or credit notes — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
Payments	array	Optional
Payments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Creates a new credit note — request body — body pagination

Referenced models: Creates a new credit note — request body — body pagination, Retrieves journals — response body — Warnings item, Creates a single payment for invoice or credit notes — request body — body

Creates one or many batch payments for invoices — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
BatchPayments	array	Optional
BatchPayments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Batch Payment

Referenced models: Creates a single payment for invoice or credit notes — request body — body Batch Payment

Creates one or many batch payments for invoices — response body

Field	Type	Presence	Description and constraints
$	object	Root
BatchPayments	array	Optional
BatchPayments[]	Model	Each item	Expand Creates one or many batch payments for invoices — response body — Batch Payments item

Referenced models: Creates one or many batch payments for invoices — response body — Batch Payments item

Creates one or many batch payments for invoices — response body — Batch Payments item

Field	Type	Presence	Description and constraints
$	object	Root
Account	Model	Optional	Expand Deletes a chart of accounts — response body — Accounts item
Amount	JSON	Optional
Amount (anyOf 1)	number	Alternative	The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00 Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
BatchPaymentID	string	Optional	The Xero generated unique identifier for the bank transaction (read-only) Format: uuid Read only: true
Code	string	Optional	(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. Maximum length: 12
Date	string	Optional	Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
DateString	string	Optional	Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
Details	string	Optional	(Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18
IsReconciled	boolean	Optional	Booelan that tells you if the batch payment has been reconciled (read-only) Read only: true
Narrative	string	Optional	(UK Only) Only shows on the statement line in Xero. Max length =18 Maximum length: 18
Particulars	string	Optional	(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. Maximum length: 12
Payments	array	Optional	An array of payments
Payments[]	Model	Each item	Expand Retrieves payments for invoices and credit notes — response body — Payments item
Reference	string	Optional	(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. Maximum length: 255
Status	string	Optional	AUTHORISED or DELETED (read-only). New batch payments will have a status of AUTHORISED. It is not possible to delete batch payments via the API. Known values: AUTHORISED, DELETED Read only: true
TotalAmount	JSON	Optional
TotalAmount (anyOf 1)	number	Alternative	The total of the payments that make up the batch (read-only) Format: double Read only: true
TotalAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Type	string	Optional	PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only) Known values: PAYBATCH, RECBATCH Read only: true
UpdatedDateUTC	string	Optional	UTC timestamp of last update to the payment Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Deletes a chart of accounts — response body — Accounts item, Retrieves payments for invoices and credit notes — response body — Payments item, Retrieves journals — response body — Warnings item

Creates options for a specific tracking category — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
Name	string	Optional	The name of the tracking option e.g. Marketing, East (max length = 100) Maximum length: 100
Status	string	Optional	The status of a tracking option One of: ACTIVE, ARCHIVED, DELETED
TrackingCategoryID	string	Optional	Filter by a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 Format: uuid
TrackingOptionID	string	Optional	The Xero identifier for a tracking option e.g. ae777a87-5ef3-4fa0-a4f0-d10e1f13073a Format: uuid

Creates options for a specific tracking category — response body

Field	Type	Presence	Description and constraints
$	object	Root
Options	array	Optional
Options[]	Model	Each item	Expand Creates options for a specific tracking category — response body — Options item

Referenced models: Creates options for a specific tracking category — response body — Options item

Creates options for a specific tracking category — response body — Options item

Field	Type	Presence	Description and constraints
$	object	Root
Name	string	Optional	The name of the tracking option e.g. Marketing, East (max length = 100) Maximum length: 100
Status	string	Optional	The status of a tracking option Known values: ACTIVE, ARCHIVED, DELETED
TrackingCategoryID	string	Optional	Filter by a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 Format: uuid
TrackingOptionID	string	Optional	The Xero identifier for a tracking option e.g. ae777a87-5ef3-4fa0-a4f0-d10e1f13073a Format: uuid

Deletes a chart of accounts — response body

Field	Type	Presence	Description and constraints
$	object	Root
Accounts	array	Optional
Accounts[]	Model	Each item	Expand Deletes a chart of accounts — response body — Accounts item

Referenced models: Deletes a chart of accounts — response body — Accounts item

Deletes a chart of accounts — response body — Accounts item

Field	Type	Presence	Description and constraints
$	object	Root
AccountID	string	Optional	The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9 Format: uuid
AddToWatchlist	boolean	Optional	Boolean – describes whether the account is shown in the watchlist widget on the dashboard
BankAccountNumber	string	Optional	For bank accounts only (Account Type BANK)
BankAccountType	string	Optional	For bank accounts only. See Bank Account types Known values: BANK, CREDITCARD, PAYPAL, NONE, "" (empty string)
Class	string	Optional	See Account Class Types Known values: ASSET, EQUITY, EXPENSE, LIABILITY, REVENUE Read only: true
Code	string	Optional	Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)
CurrencyCode	Model	Optional	Expand Deletes an Allocation from a Prepayment — response body — Invoice Currency Code
Description	string	Optional	Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)
EnablePaymentsToAccount	boolean	Optional	Boolean – describes whether account can have payments applied to it
HasAttachments	boolean	Optional	boolean to indicate if an account has an attachment (read only) Default: false Read only: true
Name	string	Optional	Name of account (max length = 150) Maximum length: 150
ReportingCode	string	Optional	Shown if set
ReportingCodeName	string	Optional	Shown if set Read only: true
ShowInExpenseClaims	boolean	Optional	Boolean – describes whether account code is available for use with expense claims
Status	string	Optional	Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes Known values: ACTIVE, ARCHIVED, DELETED
SystemAccount	string	Optional	If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null. Known values: DEBTORS, CREDITORS, BANKCURRENCYGAIN, GST, GSTONIMPORTS, HISTORICAL, REALISEDCURRENCYGAIN, RETAINEDEARNINGS, ROUNDING, TRACKINGTRANSFERS, UNPAIDEXPCLM, UNREALISEDCURRENCYGAIN, WAGEPAYABLES, CISASSETS, CISASSET, CISLABOUR, CISLABOUREXPENSE, CISLABOURINCOME, CISLIABILITY, CISMATERIALS, "" (empty string) Read only: true
TaxType	string	Optional	The tax type from taxRates
Type	string	Optional	See Account Types Known values: BANK, CURRENT, CURRLIAB, DEPRECIATN, DIRECTCOSTS, EQUITY, EXPENSE, FIXED, INVENTORY, LIABILITY, NONCURRENT, OTHERINCOME, OVERHEADS, PREPAYMENT, REVENUE, SALES, TERMLIAB, PAYG
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Deletes an Allocation from a Prepayment — response body — Invoice Currency Code, Retrieves journals — response body — Warnings item

Deletes a specific bank transfer — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
Status	string	Required within parent	The status of the bank transfer. Default: DELETED

Deletes a specific repeating invoice template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
RepeatingInvoices	array	Optional
RepeatingInvoices[]	Model	Each item	Expand Deletes a specific repeating invoice template — request body — body Repeating Invoices item

Referenced models: Deletes a specific repeating invoice template — request body — body Repeating Invoices item

Deletes a specific repeating invoice template — request body — body Repeating Invoices item

Field	Type	Presence	Description and constraints
$	object	Root
ApprovedForSending	boolean	Optional	Boolean to indicate whether the invoice has been approved for sending Default: false
Attachments	array	Optional	Displays array of attachments from the API
Attachments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item
BrandingThemeID	string	Optional	See BrandingThemes Format: uuid
Contact	Model	Optional	Expand Creates contacts to a specific contact group — request body — body Contacts item
CurrencyCode	Model	Optional	Expand Create a new currency for a Xero organisation — request body — body Code
HasAttachments	boolean	Optional	Boolean to indicate if an invoice has an attachment Default: false Read only: true
ID	string	Optional	Xero generated unique identifier for repeating invoice template Format: uuid
IncludePDF	boolean	Optional	Boolean to indicate whether to include PDF attachment Default: false
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types One of: Exclusive, Inclusive, NoTax
LineItems	array	Optional	See LineItems
LineItems[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item
MarkAsSent	boolean	Optional	Boolean to indicate whether the invoice in the Xero app displays as "sent" Default: false
Reference	string	Optional	ACCREC only – additional reference number
RepeatingInvoiceID	string	Optional	Xero generated unique identifier for repeating invoice template Format: uuid
Schedule	Model	Optional	Expand Deletes a specific repeating invoice template — request body — body Repeating Invoices item Schedule
SendCopy	boolean	Optional	Boolean to indicate whether a copy is sent to sender's email Default: false
Status	string	Optional	One of the following - DRAFT or AUTHORISED – See Invoice Status Codes One of: DRAFT, AUTHORISED, DELETED
SubTotal	number	Optional	Total of invoice excluding taxes Format: double
Total	number	Optional	Total of Invoice tax inclusive (i.e. SubTotal + TotalTax) Format: double
TotalTax	number	Optional	Total tax on invoice Format: double
Type	string	Optional	See Invoice Types One of: ACCPAY, ACCREC

Referenced models: Create a new currency for a Xero organisation — request body — body Code, Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item, Creates contacts to a specific contact group — request body — body Contacts item, Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item, Deletes a specific repeating invoice template — request body — body Repeating Invoices item Schedule

Deletes a specific repeating invoice template — request body — body Repeating Invoices item Schedule

Field	Type	Presence	Description and constraints
$	object	Root
DueDate	integer	Optional	Integer used with due date type e.g 20 (of following month), 31 (of current month)
DueDateType	string	Optional	the payment terms One of: DAYSAFTERBILLDATE, DAYSAFTERBILLMONTH, DAYSAFTERINVOICEDATE, DAYSAFTERINVOICEMONTH, OFCURRENTMONTH, OFFOLLOWINGMONTH
EndDate	string	Optional	Invoice end date – only returned if the template has an end date set
NextScheduledDate	string	Optional	The calendar date of the next invoice in the schedule to be generated
Period	integer	Optional	Integer used with the unit e.g. 1 (every 1 week), 2 (every 2 months)
StartDate	string	Optional	Date the first invoice of the current version of the repeating schedule was generated (changes when repeating invoice is edited)
Unit	string	Optional	One of the following - WEEKLY or MONTHLY One of: WEEKLY, MONTHLY