Xero: Accounting schemas (part 3)

← Accounting operations · All schemas

Retrieves users — response body

Field	Type	Presence	Description and constraints
$	object	Root
Users	array	Optional
Users[]	Model	Each item	Expand Retrieves users — response body — Users item

Referenced models: Retrieves users — response body — Users item

Retrieves users — response body — Users item

Field	Type	Presence	Description and constraints
$	object	Root
EmailAddress	string	Optional	Email address of user
FirstName	string	Optional	First name of user
IsSubscriber	boolean	Optional	Boolean to indicate if user is the subscriber
LastName	string	Optional	Last name of user
OrganisationRole	string	Optional	User role that defines permissions in Xero and via API (READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, etc) Known values: READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, MANAGEDCLIENT, CASHBOOKCLIENT, UNKNOWN, REMOVED
UpdatedDateUTC	string	Optional	Timestamp of last change to user Read only: true
UserID	string	Optional	Xero identifier Format: uuid

Sends a copy of a specific invoice to related contact via email — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
Status	string	Optional	Need at least one field to create an empty JSON payload

Sets the chart of accounts, the conversion date and conversion balances — request body — body

Field	Type	Presence	Description and constraints
$	JSON	Root
Accounts	array	Optional
Accounts[]	Model	Each item	Expand Creates a new chart of accounts — request body — body
ConversionBalances	array	Optional	Balance supplied for each account that has a value as at the conversion date.
ConversionBalances[]	Model	Each item	Expand Sets the chart of accounts, the conversion date and conversion balances — request body — body Conversion Balances item
ConversionDate	Model	Optional	Expand Sets the chart of accounts, the conversion date and conversion balances — request body — body Conversion Date

Referenced models: Creates a new chart of accounts — request body — body, Sets the chart of accounts, the conversion date and conversion balances — request body — body Conversion Balances item, Sets the chart of accounts, the conversion date and conversion balances — request body — body Conversion Date

Sets the chart of accounts, the conversion date and conversion balances — request body — body Conversion Balances item

Field	Type	Presence	Description and constraints
$	object	Root	Balance supplied for each account that has a value as at the conversion date.
AccountCode	string	Optional	The account code for a account
Balance	number	Optional	The opening balances of the account. Debits are positive, credits are negative values Format: double
BalanceDetails	array	Optional
BalanceDetails[]	Model	Each item	Expand Sets the chart of accounts, the conversion date and conversion balances — request body — body Conversion Balances item Balance Details item

Referenced models: Sets the chart of accounts, the conversion date and conversion balances — request body — body Conversion Balances item Balance Details item

Sets the chart of accounts, the conversion date and conversion balances — request body — body Conversion Balances item Balance Details item

Field	Type	Presence	Description and constraints
$	object	Root	An array to specify multiple currency balances of an account
Balance	number	Optional	The opening balances of the account. Debits are positive, credits are negative values Format: double
CurrencyCode	string	Optional	The currency of the balance (Not required for base currency)
CurrencyRate	number	Optional	(Optional) Exchange rate to base currency when money is spent or received. If not specified, XE rate for the day is applied Format: double

Sets the chart of accounts, the conversion date and conversion balances — request body — body Conversion Date

Field	Type	Presence	Description and constraints
$	object	Root	The date when the organisation starts using Xero
Month	integer	Optional	The month the organisation starts using Xero. Value is an integer between 1 and 12
Year	integer	Optional	The year the organisation starts using Xero. Value is an integer greater than 2006

Sets the chart of accounts, the conversion date and conversion balances — response body

Field	Type	Presence	Description and constraints
$	JSON	Root
ImportSummary	Model	Optional	Expand Sets the chart of accounts, the conversion date and conversion balances — response body — Import Summary

Referenced models: Sets the chart of accounts, the conversion date and conversion balances — response body — Import Summary

Sets the chart of accounts, the conversion date and conversion balances — response body — Import Summary

Field	Type	Presence	Description and constraints
$	object	Root	A summary of the import from setup endpoint
Accounts	Model	Optional	Expand Sets the chart of accounts, the conversion date and conversion balances — response body — Import Summary Accounts
Organisation	Model	Optional	Expand Sets the chart of accounts, the conversion date and conversion balances — response body — Import Summary Organisation

Referenced models: Sets the chart of accounts, the conversion date and conversion balances — response body — Import Summary Organisation, Sets the chart of accounts, the conversion date and conversion balances — response body — Import Summary Accounts

Sets the chart of accounts, the conversion date and conversion balances — response body — Import Summary Accounts

Field	Type	Presence	Description and constraints
$	object	Root	A summary of the accounts changes
Deleted	JSON	Optional
Deleted (anyOf 1)	integer	Alternative	The number of accounts deleted Format: int32
Deleted (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Errored	JSON	Optional
Errored (anyOf 1)	integer	Alternative	The number of accounts that had an error Format: int32
Errored (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Locked	JSON	Optional
Locked (anyOf 1)	integer	Alternative	The number of locked accounts Format: int32
Locked (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
New	JSON	Optional
New (anyOf 1)	integer	Alternative	The number of new accounts created Format: int32
New (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
NewOrUpdated	JSON	Optional
NewOrUpdated (anyOf 1)	integer	Alternative	The number of new or updated accounts Format: int32
NewOrUpdated (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Present	boolean	Optional
System	JSON	Optional
System (anyOf 1)	integer	Alternative	The number of system accounts Format: int32
System (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Total	JSON	Optional
Total (anyOf 1)	integer	Alternative	The total number of accounts in the org Format: int32
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Updated	JSON	Optional
Updated (anyOf 1)	integer	Alternative	The number of accounts updated Format: int32
Updated (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Sets the chart of accounts, the conversion date and conversion balances — response body — Import Summary Organisation

Field	Type	Presence	Description and constraints
$	object	Root
Present	boolean	Optional

Updates a chart of accounts — request body — body

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

Referenced models: Creates a new chart of accounts — request body — body

Updates a single spent or received money transaction — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
BankTransactions	array	Optional
BankTransactions[]	Model	Each item	Expand Updates a single spent or received money transaction — request body — body Bank Transactions 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, Updates a single spent or received money transaction — request body — body Bank Transactions item, Retrieves journals — response body — Warnings item

Updates a single spent or received money transaction — request body — body Bank Transactions item

Field	Type	Presence	Description and constraints
$	object	Root
BankAccount	Model	Required within parent	Expand Creates a new chart of accounts — request body — body
BankTransactionID	string	Optional	Xero generated unique identifier for bank transaction 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
CurrencyRate	number	Optional	Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments. Format: double
Date	string	Optional	Date of transaction – YYYY-MM-DD
HasAttachments	boolean	Optional	Boolean to indicate if a bank transaction has an attachment Default: false Read only: true
IsReconciled	boolean	Optional	Boolean to show if transaction is reconciled
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	Required within parent	See LineItems
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 for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT Format: uuid Read only: true
PrepaymentID	string	Optional	Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT Format: uuid Read only: true
Reference	string	Optional	Reference for the transaction. Only supported for SPEND and RECEIVE transactions.
Status	string	Optional	See Bank Transaction Status Codes One of: AUTHORISED, DELETED, VOIDED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
SubTotal	number	Optional	Total of bank transaction excluding taxes Format: double
Total	number	Optional	Total of bank transaction tax inclusive Format: double
TotalTax	number	Optional	Total tax on bank transaction Format: double
Type	string	Required within parent	See Bank Transaction Types One of: RECEIVE, RECEIVE-OVERPAYMENT, RECEIVE-PREPAYMENT, SPEND, SPEND-OVERPAYMENT, SPEND-PREPAYMENT, RECEIVE-TRANSFER, SPEND-TRANSFER
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
Url	string	Optional	URL link to a source document – shown as “Go to App Name”
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, Create a new currency for a Xero organisation — request body — body Code, 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, Retrieves journals — response body — Warnings item

Updates a specific batch payment for invoices and credit notes — accounting delete Batch Payment By Url Param — request body — body

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

Updates a specific batch payment for invoices and credit notes — accounting delete Batch Payment — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
BatchPaymentID	string	Required within parent	The Xero generated unique identifier for the bank transaction (read-only) Format: uuid
Status	string	Required within parent	The status of the batch payment. Default: DELETED

Updates a specific draft expense claim receipts — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
Receipts	array	Optional
Receipts[]	Model	Each item	Expand Updates a specific draft expense claim receipts — request body — body Receipts item

Referenced models: Updates a specific draft expense claim receipts — request body — body Receipts item

Updates a specific draft expense claim receipts — request body — body Receipts item

Field	Type	Presence	Description and constraints
$	object	Root
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
Contact	Model	Optional	Expand Creates contacts to a specific contact group — request body — body Contacts item
Date	string	Optional	Date of receipt – YYYY-MM-DD
HasAttachments	boolean	Optional	boolean to indicate if a receipt 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
LineItems[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item
ReceiptID	string	Optional	Xero generated unique identifier for receipt Format: uuid
ReceiptNumber	string	Optional	Xero generated sequence number for receipt in current claim for a given user Read only: true
Reference	string	Optional	Additional reference number
Status	string	Optional	Current status of receipt – see status types One of: DRAFT, SUBMITTED, AUTHORISED, DECLINED, VOIDED
SubTotal	number	Optional	Total of receipt excluding taxes Format: double
Total	number	Optional	Total of receipt tax inclusive (i.e. SubTotal + TotalTax) Format: double
TotalTax	number	Optional	Total tax on receipt Format: double
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
Url	string	Optional	URL link to a source document – shown as “Go to [appName]” in the Xero app Read only: true
User	Model	Optional	Expand Updates a specific draft expense claim receipts — request body — body Receipts item User
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: 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 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, Retrieves journals — response body — Warnings item

Updates a specific draft expense claim receipts — request body — body Receipts item User

Field	Type	Presence	Description and constraints
$	object	Root
EmailAddress	string	Optional	Email address of user
FirstName	string	Optional	First name of user
IsSubscriber	boolean	Optional	Boolean to indicate if user is the subscriber
LastName	string	Optional	Last name of user
OrganisationRole	string	Optional	User role that defines permissions in Xero and via API (READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, etc) One of: READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, MANAGEDCLIENT, CASHBOOKCLIENT, UNKNOWN, REMOVED
UpdatedDateUTC	string	Optional	Timestamp of last change to user Read only: true
UserID	string	Optional	Xero identifier Format: uuid

Updates a specific draft expense claim receipts — response body

Field	Type	Presence	Description and constraints
$	object	Root
Receipts	array	Optional
Receipts[]	Model	Each item	Expand Updates a specific draft expense claim receipts — response body — Receipts item

Referenced models: Updates a specific draft expense claim receipts — response body — Receipts item

Updates a specific draft expense claim receipts — response body — Receipts item

Field	Type	Presence	Description and constraints
$	object	Root
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
Contact	Model	Optional	Expand Creates contacts to a specific contact group — response body — Contacts item
Date	string	Optional	Date of receipt – YYYY-MM-DD
HasAttachments	boolean	Optional	boolean to indicate if a receipt 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 Known values: Exclusive, Inclusive, NoTax
LineItems	array	Optional
LineItems[]	Model	Each item	Expand Deletes an Allocation from a Prepayment — response body — Invoice Line Items item
ReceiptID	string	Optional	Xero generated unique identifier for receipt Format: uuid
ReceiptNumber	string	Optional	Xero generated sequence number for receipt in current claim for a given user Read only: true
Reference	string	Optional	Additional reference number
Status	string	Optional	Current status of receipt – see status types Known values: DRAFT, SUBMITTED, AUTHORISED, DECLINED, VOIDED
SubTotal	JSON	Optional
SubTotal (anyOf 1)	number	Alternative	Total of receipt excluding taxes Format: double
SubTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Total	JSON	Optional
Total (anyOf 1)	number	Alternative	Total of receipt tax inclusive (i.e. SubTotal + TotalTax) Format: double
Total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalTax	JSON	Optional
TotalTax (anyOf 1)	number	Alternative	Total tax on receipt Format: double
TotalTax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
Url	string	Optional	URL link to a source document – shown as “Go to [appName]” in the Xero app Read only: true
User	Model	Optional	Expand Retrieves users — response body — Users item
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: Retrieves users — response body — Users item, create Contact Attachment By File Name — response body — Attachments item, Creates contacts to a specific contact group — response body — Contacts item, Deletes an Allocation from a Prepayment — response body — Invoice Line Items item, Retrieves journals — response body — Warnings item

Updates a specific item — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
Items	array	Optional
Items[]	Model	Each item	Expand Updates a specific item — request body — body Items item

Referenced models: Updates a specific item — request body — body Items item

Updates a specific item — request body — body Items item

Field	Type	Presence	Description and constraints
$	object	Root
Code	string	Required within parent	User defined item code (max length = 30) Maximum length: 30
Description	string	Optional	The sales description of the item (max length = 4000) Maximum length: 4000
InventoryAssetAccountCode	string	Optional	The inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item
IsPurchased	boolean	Optional	Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled.
IsSold	boolean	Optional	Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled.
IsTrackedAsInventory	boolean	Optional	True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set.
ItemID	string	Optional	The Xero identifier for an Item Format: uuid
Name	string	Optional	The name of the item (max length = 50) Maximum length: 50
PurchaseDescription	string	Optional	The purchase description of the item (max length = 4000) Maximum length: 4000
PurchaseDetails	Model	Optional	Expand Updates a specific item — request body — body Items item Sales Details
QuantityAvailable	number	Optional	The quantity of the item available. This is equal to `QuantityOnHand` - `QuantityOnBackOrder`. This value will be negative if `QuantityOnBackOrder` is greater than 0. Format: double Read only: true
QuantityOnBackOrder	number	Optional	The quantity of the item on backorder. This will be 0 if `QuantityOnHand` is greater than 0. Format: double Read only: true
QuantityOnHand	number	Optional	The quantity of the item on hand. This will be 0 if `QuantityOnBackOrder` is greater than 0. Format: double
SalesDetails	Model	Optional	Expand Updates a specific item — request body — body Items item Sales Details
StatusAttributeString	string	Optional	Status of object
TotalCostPool	number	Optional	The value of the item on hand. Calculated using average cost accounting. Format: double
UpdatedDateUTC	string	Optional	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, Updates a specific item — request body — body Items item Sales Details

Updates a specific item — request body — body Items item Sales Details

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	Default account code to be used for purchased/sale. Not applicable to the purchase details of tracked items
COGSAccountCode	string	Optional	Cost of goods sold account. Only applicable to the purchase details of tracked items.
TaxType	string	Optional	The tax type from TaxRates
UnitPrice	number	Optional	Unit Price of the item. By default UnitPrice is rounded to two decimal places. You can use 4 decimal places by adding the unitdp=4 querystring parameter to your request. Format: double

Updates a specific linked transactions (billable expenses) — request body — body

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

Referenced models: Creates linked transactions (billable expenses) — request body — body

Updates a specific manual journal — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
ManualJournals	array	Optional
ManualJournals[]	Model	Each item	Expand Updates a specific manual journal — request body — body Manual Journals 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, Updates a specific manual journal — request body — body Manual Journals item, Retrieves journals — response body — Warnings item

Updates a specific manual journal — request body — body Manual Journals item

Field	Type	Presence	Description and constraints
$	object	Root
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
Date	string	Optional	Date journal was posted – YYYY-MM-DD
HasAttachments	boolean	Optional	Boolean to indicate if a manual journal has an attachment Default: false Read only: true
JournalLines	array	Optional	See JournalLines
JournalLines[]	Model	Each item	Expand Updates a specific manual journal — request body — body Manual Journals item Journal Lines 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
ManualJournalID	string	Optional	The Xero identifier for a Manual Journal Format: uuid
Narration	string	Required within parent	Description of journal being posted
ShowOnCashBasisReports	boolean	Optional	Boolean – default is true if not specified
Status	string	Optional	See Manual Journal Status Codes One of: DRAFT, POSTED, DELETED, VOIDED, ARCHIVED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
UpdatedDateUTC	string	Optional	Last modified date UTC format 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: Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item, Updates a specific manual journal — request body — body Manual Journals item Journal Lines item, Retrieves journals — response body — Warnings item

Updates a specific manual journal — request body — body Manual Journals item Journal Lines item

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	See Accounts
AccountID	string	Optional	See Accounts Format: uuid
Description	string	Optional	Description for journal line
IsBlank	boolean	Optional	is the line blank
LineAmount	number	Optional	total for line. Debits are positive, credits are negative value Format: double
TaxAmount	number	Optional	The calculated tax amount based on the TaxType and LineAmount Format: double
TaxType	string	Optional	The tax type from TaxRates
Tracking	array	Optional	Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements.
Tracking[]	Model	Each item	Expand Create tracking categories — request body — body

Referenced models: Create tracking categories — request body — body

Updates a specific payment for invoices and credit notes — request body — body

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

Updates a specific purchase order — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
PurchaseOrders	array	Optional
PurchaseOrders[]	Model	Each item	Expand Updates a specific purchase order — request body — body Purchase Orders 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, Retrieves journals — response body — Warnings item, Updates a specific purchase order — request body — body Purchase Orders item

Updates a specific purchase order — request body — body Purchase Orders item

Field	Type	Presence	Description and constraints
$	object	Root
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
AttentionTo	string	Optional	The person that the delivery is going to
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
CurrencyRate	number	Optional	The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used. Format: double
Date	string	Optional	Date purchase order was 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
DeliveryAddress	string	Optional	The address the goods are to be delivered to
DeliveryDate	string	Optional	Date the goods are to be delivered – YYYY-MM-DD
DeliveryInstructions	string	Optional	A free text feild for instructions (500 characters max)
ExpectedArrivalDate	string	Optional	The date the goods are expected to arrive.
HasAttachments	boolean	Optional	boolean to indicate if a purchase order 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 LineItems
LineItems[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Line Items item
PurchaseOrderID	string	Optional	Xero generated unique identifier for purchase order Format: uuid
PurchaseOrderNumber	string	Optional	Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)
Reference	string	Optional	Additional reference number
SentToContact	boolean	Optional	Boolean to set whether the purchase order should be marked as “sent”. This can be set only on purchase orders that have been approved or billed
Status	string	Optional	See Purchase Order Status Codes One of: DRAFT, SUBMITTED, AUTHORISED, BILLED, DELETED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
SubTotal	number	Optional	Total of purchase order excluding taxes Format: double Read only: true
Telephone	string	Optional	The phone number for the person accepting the delivery
Total	number	Optional	Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax) Format: double Read only: true
TotalDiscount	number	Optional	Total of discounts applied on the purchase order line items Format: double Read only: true
TotalTax	number	Optional	Total tax on purchase order Format: double Read only: true
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
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 Invoice Line Items item, Retrieves journals — response body — Warnings item

Updates a specific quote — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
Quotes	array	Optional
Quotes[]	Model	Each item	Expand Updates a specific quote — request body — body Quotes item

Referenced models: Updates a specific quote — request body — body Quotes item

Updates a specific quote — request body — body Quotes item

Field	Type	Presence	Description and constraints
$	object	Root
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
CurrencyRate	number	Optional	The currency rate for a multicurrency quote Format: double
Date	string	Optional	Date quote 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
DateString	string	Optional	Date the quote was issued (YYYY-MM-DD)
ExpiryDate	string	Optional	Date the quote expires – YYYY-MM-DD.
ExpiryDateString	string	Optional	Date the quote expires – YYYY-MM-DD.
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types See Quote 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
QuoteID	string	Optional	QuoteID GUID is automatically generated and is returned after create or GET. Format: uuid
QuoteNumber	string	Optional	Unique alpha numeric code identifying a quote (Max Length = 255) Maximum length: 255
Reference	string	Optional	Additional reference number Maximum length: 4000
Status	string	Optional	The status of the quote. One of: DRAFT, SENT, DECLINED, ACCEPTED, INVOICED, DELETED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
SubTotal	number	Optional	Total of quote excluding taxes. Format: double Read only: true
Summary	string	Optional	Summary text for the quote Maximum length: 3000
Terms	string	Optional	Terms of the quote Maximum length: 4000
Title	string	Optional	Title text for the quote Maximum length: 100
Total	number	Optional	Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts Format: double Read only: true
TotalDiscount	number	Optional	Total of discounts applied on the quote line items Format: double Read only: true
TotalTax	number	Optional	Total tax on quote Format: double Read only: true
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, 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, Retrieves journals — response body — Warnings item

Updates a specific sales invoices or purchase bills — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
Invoices	array	Optional
Invoices[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice
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 Invoice, Retrieves journals — response body — Warnings item

Updates tax rates — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
TaxRates	array	Optional
TaxRates[]	Model	Each item	Expand Updates tax rates — request body — body Tax Rates item

Referenced models: Updates tax rates — request body — body Tax Rates item

Updates tax rates — request body — body Tax Rates item

Field	Type	Presence	Description and constraints
$	object	Root
CanApplyToAssets	boolean	Optional	Boolean to describe if tax rate can be used for asset accounts i.e. true,false Read only: true
CanApplyToEquity	boolean	Optional	Boolean to describe if tax rate can be used for equity accounts i.e true,false Read only: true
CanApplyToExpenses	boolean	Optional	Boolean to describe if tax rate can be used for expense accounts i.e. true,false Read only: true
CanApplyToLiabilities	boolean	Optional	Boolean to describe if tax rate can be used for liability accounts i.e. true,false Read only: true
CanApplyToRevenue	boolean	Optional	Boolean to describe if tax rate can be used for revenue accounts i.e. true,false Read only: true
DisplayTaxRate	number	Optional	Tax Rate (decimal to 4dp) e.g 12.5000 Format: double Read only: true
EffectiveRate	number	Optional	Effective Tax Rate (decimal to 4dp) e.g 12.5000 Format: double Read only: true
Name	string	Optional	Name of tax rate
ReportTaxType	string	Optional	See ReportTaxTypes One of: AVALARA, BASEXCLUDED, CAPITALSALESOUTPUT, CAPITALEXPENSESINPUT, ECOUTPUT, ECOUTPUTSERVICES, ECINPUT, ECACQUISITIONS, EXEMPTEXPENSES, EXEMPTINPUT, EXEMPTOUTPUT, GSTONIMPORTS, INPUT, INPUTTAXED, MOSSSALES, NONE, NONEOUTPUT, OUTPUT, PURCHASESINPUT, SALESOUTPUT, EXEMPTCAPITAL, EXEMPTEXPORT, CAPITALEXINPUT, GSTONCAPIMPORTS, GSTONCAPITALIMPORTS, REVERSECHARGES, PAYMENTS, INVOICE, CASH, ACCRUAL, FLATRATECASH, FLATRATEACCRUAL, ACCRUALS, TXCA, SRCAS, DSOUTPUT, BLINPUT2, EPINPUT, IMINPUT2, MEINPUT, IGDSINPUT2, ESN33OUTPUT, OPINPUT, OSOUTPUT, TXN33INPUT, TXESSINPUT, TXREINPUT, TXPETINPUT, NRINPUT, ES33OUTPUT, ZERORATEDINPUT, ZERORATEDOUTPUT, DRCHARGESUPPLY, DRCHARGE, CAPINPUT, CAPIMPORTS, IMINPUT, INPUT2, CIUINPUT, SRINPUT, OUTPUT2, SROUTPUT, CAPOUTPUT, SROUTPUT2, CIUOUTPUT, ZROUTPUT, ZREXPORT, ACC28PLUS, ACCUPTO28, OTHEROUTPUT, SHOUTPUT, ZRINPUT, BADDEBT, OTHERINPUT, BADDEBTRELIEF, IGDSINPUT3, SROVR, TOURISTREFUND, TXRCN33, TXRCRE, TXRCESS, TXRCTS, CAPEXINPUT, UNDEFINED, CAPEXOUTPUT, ZEROEXPOUTPUT, GOODSIMPORT, NONEINPUT, NOTREPORTED, SROVRRS, SROVRLVG, SRLVG, IM, IMESS, IMN33, IMRE, BADDEBTRECOVERY, USSALESTAX, BLINPUT3
Status	string	Optional	See Status Codes One of: ACTIVE, DELETED, ARCHIVED, PENDING
TaxComponents	array	Optional	See TaxComponents
TaxComponents[]	Model	Each item	Expand Updates tax rates — request body — body Tax Rates item Tax Components item
TaxType	string	Optional	The tax type

Referenced models: Updates tax rates — request body — body Tax Rates item Tax Components item

Updates tax rates — request body — body Tax Rates item Tax Components item

Field	Type	Presence	Description and constraints
$	object	Root
IsCompound	boolean	Optional	Boolean to describe if Tax rate is compounded.
IsNonRecoverable	boolean	Optional	Boolean to describe if tax rate is non-recoverable. Non-recoverable rates are only applicable to Canadian organisations
Name	string	Optional	Name of Tax Component
Rate	number	Optional	Tax Rate (up to 4dp) Format: double

Updates tax rates — response body

Field	Type	Presence	Description and constraints
$	object	Root
TaxRates	array	Optional
TaxRates[]	Model	Each item	Expand Updates tax rates — response body — Tax Rates item

Referenced models: Updates tax rates — response body — Tax Rates item

Updates tax rates — response body — Tax Rates item

Field	Type	Presence	Description and constraints
$	object	Root
CanApplyToAssets	boolean	Optional	Boolean to describe if tax rate can be used for asset accounts i.e. true,false Read only: true
CanApplyToEquity	boolean	Optional	Boolean to describe if tax rate can be used for equity accounts i.e true,false Read only: true
CanApplyToExpenses	boolean	Optional	Boolean to describe if tax rate can be used for expense accounts i.e. true,false Read only: true
CanApplyToLiabilities	boolean	Optional	Boolean to describe if tax rate can be used for liability accounts i.e. true,false Read only: true
CanApplyToRevenue	boolean	Optional	Boolean to describe if tax rate can be used for revenue accounts i.e. true,false Read only: true
DisplayTaxRate	JSON	Optional
DisplayTaxRate (anyOf 1)	number	Alternative	Tax Rate (decimal to 4dp) e.g 12.5000 Format: double Read only: true
DisplayTaxRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
EffectiveRate	JSON	Optional
EffectiveRate (anyOf 1)	number	Alternative	Effective Tax Rate (decimal to 4dp) e.g 12.5000 Format: double Read only: true
EffectiveRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Name	string	Optional	Name of tax rate
ReportTaxType	string	Optional	See ReportTaxTypes Known values: AVALARA, BASEXCLUDED, CAPITALSALESOUTPUT, CAPITALEXPENSESINPUT, ECOUTPUT, ECOUTPUTSERVICES, ECINPUT, ECACQUISITIONS, EXEMPTEXPENSES, EXEMPTINPUT, EXEMPTOUTPUT, GSTONIMPORTS, INPUT, INPUTTAXED, MOSSSALES, NONE, NONEOUTPUT, OUTPUT, PURCHASESINPUT, SALESOUTPUT, EXEMPTCAPITAL, EXEMPTEXPORT, CAPITALEXINPUT, GSTONCAPIMPORTS, GSTONCAPITALIMPORTS, REVERSECHARGES, PAYMENTS, INVOICE, CASH, ACCRUAL, FLATRATECASH, FLATRATEACCRUAL, ACCRUALS, TXCA, SRCAS, DSOUTPUT, BLINPUT2, EPINPUT, IMINPUT2, MEINPUT, IGDSINPUT2, ESN33OUTPUT, OPINPUT, OSOUTPUT, TXN33INPUT, TXESSINPUT, TXREINPUT, TXPETINPUT, NRINPUT, ES33OUTPUT, ZERORATEDINPUT, ZERORATEDOUTPUT, DRCHARGESUPPLY, DRCHARGE, CAPINPUT, CAPIMPORTS, IMINPUT, INPUT2, CIUINPUT, SRINPUT, OUTPUT2, SROUTPUT, CAPOUTPUT, SROUTPUT2, CIUOUTPUT, ZROUTPUT, ZREXPORT, ACC28PLUS, ACCUPTO28, OTHEROUTPUT, SHOUTPUT, ZRINPUT, BADDEBT, OTHERINPUT, BADDEBTRELIEF, IGDSINPUT3, SROVR, TOURISTREFUND, TXRCN33, TXRCRE, TXRCESS, TXRCTS, CAPEXINPUT, UNDEFINED, CAPEXOUTPUT, ZEROEXPOUTPUT, GOODSIMPORT, NONEINPUT, NOTREPORTED, SROVRRS, SROVRLVG, SRLVG, IM, IMESS, IMN33, IMRE, BADDEBTRECOVERY, USSALESTAX, BLINPUT3
Status	string	Optional	See Status Codes Known values: ACTIVE, DELETED, ARCHIVED, PENDING
TaxComponents	array	Optional	See TaxComponents
TaxComponents[]	Model	Each item	Expand Updates tax rates — response body — Tax Rates item Tax Components item
TaxType	string	Optional	The tax type

Referenced models: Updates tax rates — response body — Tax Rates item Tax Components item

Updates tax rates — response body — Tax Rates item Tax Components item

Field	Type	Presence	Description and constraints
$	object	Root
IsCompound	boolean	Optional	Boolean to describe if Tax rate is compounded.
IsNonRecoverable	boolean	Optional	Boolean to describe if tax rate is non-recoverable. Non-recoverable rates are only applicable to Canadian organisations
Name	string	Optional	Name of Tax Component
Rate	JSON	Optional
Rate (anyOf 1)	number	Alternative	Tax Rate (up to 4dp) Format: double
Rate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

create Contact Attachment By File Name — response body

Field	Type	Presence	Description and constraints
$	object	Root
Attachments	array	Optional
Attachments[]	Model	Each item	Expand create Contact Attachment By File Name — response body — Attachments item

Referenced models: create Contact Attachment By File Name — response body — Attachments item

create Contact Attachment By File Name — response body — Attachments item

Field	Type	Presence	Description and constraints
$	object	Root
AttachmentID	string	Optional	Unique ID for the file Format: uuid
ContentLength	JSON	Optional
ContentLength (anyOf 1)	integer	Alternative	Length of the file content
ContentLength (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
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