Xero Accounting API

Cloud accounting software API

developer.xero.com/documentation ↗

Version

3.0.1

OpenAPI

3.0.0

Endpoints

237

Schemas

171

69

Quality

Updated

3 days ago

Finance accounting finance invoicing

Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://api.xero.com/api.xro/2.0

Endpoints

Clear filters

GET POST PUT PATCH DELETE

Accounting 128 endpoints

GET /Accounts Retrieves the full chart of accounts

operationId: Accounting_getFullChartOfAccounts

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element

Responses

200

Success - return response of type Accounts array with 0 to n Account

GET /Accounts

GET /Accounts/{AccountID} Retrieves a single chart of accounts by using a unique account Id

operationId: Accounting_getChartOfAccountsById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
AccountID	path	optional	string	Unique identifier for Account object

Responses

200

Success - return response of type Accounts array with one Account

GET /Accounts/{AccountID}

GET /Accounts/{AccountID}/Attachments Retrieves attachments for a specific accounts by using a unique account Id

operationId: Accounting_getAttachments

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
AccountID	path	optional	string	Unique identifier for Account object

Responses

200

Success - return response of type Attachments array of Attachment

GET /Accounts/{AccountID}/Attachments

GET /Accounts/{AccountID}/Attachments/{AttachmentID} Retrieves a specific attachment from a specific account using a unique attachment Id

operationId: Accounting_getAttachmentById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
AccountID	path	optional	string	Unique identifier for Account object
AttachmentID	path	optional	string	Unique identifier for Attachment object
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Account as binary data

GET /Accounts/{AccountID}/Attachments/{AttachmentID}

GET /Accounts/{AccountID}/Attachments/{FileName} Retrieves an attachment for a specific account by filename

operationId: Accounting_getAttachmentByFilename

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
AccountID	path	optional	string	Unique identifier for Account object
FileName	path	optional	string	Name of the attachment
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Account as binary data

GET /Accounts/{AccountID}/Attachments/{FileName}

GET /BankTransactions Retrieves any spent or received money transactions

operationId: Accounting_getMoneyTransactions

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element
page	query	optional	integer	Up to 100 bank transactions will be returned in a single API call with line items details
unitdp	query	optional	integer	e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Responses

200

Success - return response of type BankTransactions array with 0 to n BankTransaction

GET /BankTransactions

GET /BankTransactions/{BankTransactionID} Retrieves a single spent or received money transaction by using a unique bank transaction Id

operationId: Accounting_getBankTransactionById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BankTransactionID	path	optional	string	Xero generated unique identifier for a bank transaction
unitdp	query	optional	integer	e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Responses

200

Success - return response of type BankTransactions array with a specific BankTransaction

GET /BankTransactions/{BankTransactionID}

GET /BankTransactions/{BankTransactionID}/Attachments Retrieves any attachments from a specific bank transactions

operationId: Accounting_getBankTransactionAttachments

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BankTransactionID	path	optional	string	Xero generated unique identifier for a bank transaction

Responses

200

Success - return response of type Attachments array with 0 to n Attachment

GET /BankTransactions/{BankTransactionID}/Attachments

GET /BankTransactions/{BankTransactionID}/Attachments/{AttachmentID} Retrieves specific attachments from a specific BankTransaction using a unique attachment Id

operationId: Accounting_getAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BankTransactionID	path	optional	string	Xero generated unique identifier for a bank transaction
AttachmentID	path	optional	string	Unique identifier for Attachment object
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for BankTransaction as binary data

GET /BankTransactions/{BankTransactionID}/Attachments/{AttachmentID}

GET /BankTransactions/{BankTransactionID}/Attachments/{FileName} Retrieves a specific attachment from a specific bank transaction by filename

operationId: Accounting_getAttachmentByFileName

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BankTransactionID	path	optional	string	Xero generated unique identifier for a bank transaction
FileName	path	optional	string	Name of the attachment
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for BankTransaction as binary data

GET /BankTransactions/{BankTransactionID}/Attachments/{FileName}

GET /BankTransactions/{BankTransactionID}/History Retrieves history from a specific bank transaction using a unique bank transaction Id

operationId: Accounting_getBankTransactionHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BankTransactionID	path	optional	string	Xero generated unique identifier for a bank transaction

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /BankTransactions/{BankTransactionID}/History

GET /BankTransfers Retrieves all bank transfers

operationId: Accounting_getBankTransfers

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element

Responses

200

Success - return response of BankTransfers array of 0 to N BankTransfer

GET /BankTransfers

GET /BankTransfers/{BankTransferID} Retrieves specific bank transfers by using a unique bank transfer Id

operationId: Accounting_getBankTransferById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BankTransferID	path	optional	string	Xero generated unique identifier for a bank transfer

Responses

200

Success - return response of BankTransfers array with one BankTransfer

GET /BankTransfers/{BankTransferID}

GET /BankTransfers/{BankTransferID}/Attachments Retrieves attachments from a specific bank transfer

operationId: Accounting_getBankTransferAttachments

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BankTransferID	path	optional	string	Xero generated unique identifier for a bank transfer

Responses

200

Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

GET /BankTransfers/{BankTransferID}/Attachments

GET /BankTransfers/{BankTransferID}/Attachments/{AttachmentID} Retrieves a specific attachment from a specific bank transfer using a unique attachment ID

operationId: Accounting_getAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BankTransferID	path	optional	string	Xero generated unique identifier for a bank transfer
AttachmentID	path	optional	string	Unique identifier for Attachment object
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of binary data from the Attachment to a Bank Transfer

GET /BankTransfers/{BankTransferID}/Attachments/{AttachmentID}

GET /BankTransfers/{BankTransferID}/Attachments/{FileName} Retrieves a specific attachment on a specific bank transfer by file name

operationId: Accounting_getSpecificAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BankTransferID	path	optional	string	Xero generated unique identifier for a bank transfer
FileName	path	optional	string	Name of the attachment
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of binary data from the Attachment to a Bank Transfer

GET /BankTransfers/{BankTransferID}/Attachments/{FileName}

GET /BankTransfers/{BankTransferID}/History Retrieves history from a specific bank transfer using a unique bank transfer Id

operationId: Accounting_getBankTransferHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BankTransferID	path	optional	string	Xero generated unique identifier for a bank transfer

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /BankTransfers/{BankTransferID}/History

GET /BatchPayments Retrieves either one or many batch payments for invoices

operationId: Accounting_getBatchPayments

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element

Responses

200

Success - return response of type BatchPayments array of BatchPayment objects

GET /BatchPayments

GET /BatchPayments/{BatchPaymentID} Retrieves a specific batch payment using a unique batch payment Id

operationId: Accounting_getBatchPayment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BatchPaymentID	path	optional	string	Unique identifier for BatchPayment

Responses

200

Success - return response of type BatchPayments array with matching batch payment Id

GET /BatchPayments/{BatchPaymentID}

GET /BatchPayments/{BatchPaymentID}/History Retrieves history from a specific batch payment

operationId: Accounting_getBatchPaymentHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BatchPaymentID	path	optional	string	Unique identifier for BatchPayment

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /BatchPayments/{BatchPaymentID}/History

GET /BrandingThemes Retrieves all the branding themes

operationId: Accounting_getBrandingThemes

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant

Responses

200

Success - return response of type BrandingThemes

GET /BrandingThemes

GET /BrandingThemes/{BrandingThemeID} Retrieves a specific branding theme using a unique branding theme Id

operationId: Accounting_getBrandingThemeById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BrandingThemeID	path	optional	string	Unique identifier for a Branding Theme

Responses

200

Success - return response of type BrandingThemes with one BrandingTheme

GET /BrandingThemes/{BrandingThemeID}

GET /BrandingThemes/{BrandingThemeID}/PaymentServices Retrieves the payment services for a specific branding theme

operationId: Accounting_getPaymentServices

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BrandingThemeID	path	optional	string	Unique identifier for a Branding Theme

Responses

200

Success - return response of type PaymentServices array with 0 to N PaymentService

GET /BrandingThemes/{BrandingThemeID}/PaymentServices

GET /Budgets Retrieve a list of budgets

operationId: Accounting_getBudgetsList

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
IDs	query	optional	string	Filter by BudgetID. Allows you to retrieve a specific individual budget.
DateTo	query	optional	string	Filter by start date
DateFrom	query	optional	string	Filter by end date

Responses

200

Success - return response of type Budgets array with 0 to N Budgets

GET /Budgets

GET /Budgets/{BudgetID} Retrieves a specific budget, which includes budget lines

operationId: Accounting_getBudget

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
BudgetID	path	optional	string	Unique identifier for Budgets
DateTo	query	optional	string	Filter by start date
DateFrom	query	optional	string	Filter by end date

Responses

200

Success - return response of type Invoices array with specified Invoices

GET /Budgets/{BudgetID}

GET /ContactGroups Retrieves the contact Id and name of each contact group

operationId: Accounting_getContactGroupDetails

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element

Responses

200

Success - return response of type Contact Groups array of Contact Group

GET /ContactGroups

GET /ContactGroups/{ContactGroupID} Retrieves a specific contact group by using a unique contact group Id

operationId: Accounting_getContactGroupById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ContactGroupID	path	optional	string	Unique identifier for a Contact Group

Responses

200

Success - return response of type Contact Groups array with a specific Contact Group

GET /ContactGroups/{ContactGroupID}

GET /Contacts Retrieves all contacts in a Xero organisation

operationId: Accounting_listContacts

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element
IDs	query	optional	array	Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.
page	query	optional	integer	e.g. page=1 - Up to 100 contacts will be returned in a single API call.
includeArchived	query	optional	boolean	e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response
summaryOnly	query	optional	boolean	Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
searchTerm	query	optional	string	Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.

Responses

200

Success - return response of type Contacts array with 0 to N Contact

GET /Contacts

GET /Contacts/{ContactID} Retrieves a specific contacts in a Xero organisation using a unique contact Id

operationId: Accounting_getContactById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ContactID	path	optional	string	Unique identifier for a Contact

Responses

200

Success - return response of type Contacts array with a unique Contact

GET /Contacts/{ContactID}

GET /Contacts/{ContactID}/Attachments Retrieves attachments for a specific contact in a Xero organisation

operationId: Accounting_getContactAttachments

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ContactID	path	optional	string	Unique identifier for a Contact

Responses

200

Success - return response of type Attachments array with 0 to N Attachment

GET /Contacts/{ContactID}/Attachments

GET /Contacts/{ContactID}/Attachments/{AttachmentID} Retrieves a specific attachment from a specific contact using a unique attachment Id

operationId: Accounting_getSpecificAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ContactID	path	optional	string	Unique identifier for a Contact
AttachmentID	path	optional	string	Unique identifier for Attachment object
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Contact as binary data

GET /Contacts/{ContactID}/Attachments/{AttachmentID}

GET /Contacts/{ContactID}/Attachments/{FileName} Retrieves a specific attachment from a specific contact by file name

operationId: Accounting_getAttachmentByFileName

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ContactID	path	optional	string	Unique identifier for a Contact
FileName	path	optional	string	Name of the attachment
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Contact as binary data

GET /Contacts/{ContactID}/Attachments/{FileName}

GET /Contacts/{ContactID}/CISSettings Retrieves CIS settings for a specific contact in a Xero organisation

operationId: Accounting_getCisSettings

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ContactID	path	optional	string	Unique identifier for a Contact

Responses

200

Success - return response of type CISSettings for a specific Contact

GET /Contacts/{ContactID}/CISSettings

GET /Contacts/{ContactID}/History Retrieves history records for a specific contact

operationId: Accounting_getContactHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ContactID	path	optional	string	Unique identifier for a Contact

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /Contacts/{ContactID}/History

GET /Contacts/{ContactNumber} Retrieves a specific contact by contact number in a Xero organisation

operationId: Accounting_getContactByNumber

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ContactNumber	path	required	string	This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50).

Responses

200

Success - return response of type Contacts array with a unique Contact

GET /Contacts/{ContactNumber}

GET /CreditNotes Retrieves any credit notes

operationId: Accounting_getCreditNotes

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element
page	query	optional	integer	e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note
unitdp	query	optional	integer	e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Responses

200

Success - return response of type Credit Notes array of CreditNote

GET /CreditNotes

GET /CreditNotes/{CreditNoteID} Retrieves a specific credit note using a unique credit note Id

operationId: Accounting_getCreditNoteById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
CreditNoteID	path	optional	string	Unique identifier for a Credit Note
unitdp	query	optional	integer	e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Responses

200

Success - return response of type Credit Notes array with a unique CreditNote

GET /CreditNotes/{CreditNoteID}

GET /CreditNotes/{CreditNoteID}/Attachments Retrieves attachments for a specific credit notes

operationId: Accounting_getCreditNoteAttachments

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
CreditNoteID	path	optional	string	Unique identifier for a Credit Note

Responses

200

Success - return response of type Attachments array with all Attachment for specific Credit Note

GET /CreditNotes/{CreditNoteID}/Attachments

GET /CreditNotes/{CreditNoteID}/Attachments/{AttachmentID} Retrieves a specific attachment from a specific credit note using a unique attachment Id

operationId: Accounting_getCreditNoteAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
CreditNoteID	path	optional	string	Unique identifier for a Credit Note
AttachmentID	path	optional	string	Unique identifier for Attachment object
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Credit Note as binary data

GET /CreditNotes/{CreditNoteID}/Attachments/{AttachmentID}

GET /CreditNotes/{CreditNoteID}/Attachments/{FileName} Retrieves a specific attachment on a specific credit note by file name

operationId: Accounting_getSpecificAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
CreditNoteID	path	optional	string	Unique identifier for a Credit Note
FileName	path	optional	string	Name of the attachment
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Credit Note as binary data

GET /CreditNotes/{CreditNoteID}/Attachments/{FileName}

GET /CreditNotes/{CreditNoteID}/History Retrieves history records of a specific credit note

operationId: Accounting_getCreditNoteHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
CreditNoteID	path	optional	string	Unique identifier for a Credit Note

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /CreditNotes/{CreditNoteID}/History

GET /CreditNotes/{CreditNoteID}/pdf Retrieves credit notes as PDF files

operationId: Accounting_getCreditNotePdf

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
CreditNoteID	path	optional	string	Unique identifier for a Credit Note

Responses

200

Success - return response of binary data from the Attachment to a Credit Note

GET /CreditNotes/{CreditNoteID}/pdf

GET /Currencies Retrieves currencies for your Xero organisation

operationId: Accounting_getCurrencies

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element

Responses

200

Success - return response of type Currencies array with all Currencies

GET /Currencies

GET /Employees Retrieves employees used in Xero payrun

operationId: Accounting_getPayrunEmployees

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element

Responses

200

Success - return response of type Employees array with all Employee

GET /Employees

GET /Employees/{EmployeeID} Retrieves a specific employee used in Xero payrun using a unique employee Id

operationId: Accounting_getEmployeeById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
EmployeeID	path	optional	string	Unique identifier for a Employee

Responses

200

Success - return response of type Employees array with specified Employee

GET /Employees/{EmployeeID}

GET /ExpenseClaims Retrieves expense claims

operationId: Accounting_getExpenseClaims

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element

Responses

200

Success - return response of type ExpenseClaims array with all ExpenseClaims

GET /ExpenseClaims

GET /ExpenseClaims/{ExpenseClaimID} Retrieves a specific expense claim using a unique expense claim Id

operationId: Accounting_getExpenseClaimById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ExpenseClaimID	path	optional	string	Unique identifier for a ExpenseClaim

Responses

200

Success - return response of type ExpenseClaims array with specified ExpenseClaim

GET /ExpenseClaims/{ExpenseClaimID}

GET /ExpenseClaims/{ExpenseClaimID}/History Retrieves history records of a specific expense claim

operationId: Accounting_getExpenseClaimHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ExpenseClaimID	path	optional	string	Unique identifier for a ExpenseClaim

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /ExpenseClaims/{ExpenseClaimID}/History

GET /InvoiceReminders/Settings Retrieves invoice reminder settings

operationId: Accounting_getInvoiceReminderSettings

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant

Responses

200

Success - return response of Invoice Reminders

GET /InvoiceReminders/Settings

GET /Invoices Retrieves sales invoices or purchase bills

operationId: Accounting_getSalesInvoices

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element
IDs	query	optional	array	Filter by a comma-separated list of InvoicesIDs.
InvoiceNumbers	query	optional	array	Filter by a comma-separated list of InvoiceNumbers.
ContactIDs	query	optional	array	Filter by a comma-separated list of ContactIDs.
Statuses	query	optional	array	Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
page	query	optional	integer	e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice
includeArchived	query	optional	boolean	e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response
createdByMyApp	query	optional	boolean	When set to true you’ll only retrieve Invoices created by your app
unitdp	query	optional	integer	e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
summaryOnly	query	optional	boolean	Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.

Responses

200

Success - return response of type Invoices array with all Invoices

GET /Invoices

GET /Invoices/{InvoiceID} Retrieves a specific sales invoice or purchase bill using a unique invoice Id

operationId: Accounting_getInvoiceById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
InvoiceID	path	optional	string	Unique identifier for an Invoice
unitdp	query	optional	integer	e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Responses

200

Success - return response of type Invoices array with specified Invoices

GET /Invoices/{InvoiceID}

GET /Invoices/{InvoiceID}/Attachments Retrieves attachments for a specific invoice or purchase bill

operationId: Accounting_getInvoiceAttachments

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
InvoiceID	path	optional	string	Unique identifier for an Invoice

Responses

200

Success - return response of type Attachments array of Attachments for specified Invoices

GET /Invoices/{InvoiceID}/Attachments

GET /Invoices/{InvoiceID}/Attachments/{AttachmentID} Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id

operationId: Accounting_getAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
InvoiceID	path	optional	string	Unique identifier for an Invoice
AttachmentID	path	optional	string	Unique identifier for Attachment object
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Invoice as binary data

GET /Invoices/{InvoiceID}/Attachments/{AttachmentID}

GET /Invoices/{InvoiceID}/Attachments/{FileName} Retrieves an attachment from a specific invoice or purchase bill by filename

operationId: Accounting_getAttachmentByFileName

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
InvoiceID	path	optional	string	Unique identifier for an Invoice
FileName	path	optional	string	Name of the attachment
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Invoice as binary data

GET /Invoices/{InvoiceID}/Attachments/{FileName}

GET /Invoices/{InvoiceID}/History Retrieves history records for a specific invoice

operationId: Accounting_getInvoiceHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
InvoiceID	path	optional	string	Unique identifier for an Invoice

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /Invoices/{InvoiceID}/History

GET /Invoices/{InvoiceID}/OnlineInvoice Retrieves a URL to an online invoice

operationId: Accounting_getOnlineInvoiceUrl

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
InvoiceID	path	optional	string	Unique identifier for an Invoice

Responses

200

Success - return response of type OnlineInvoice array with one OnlineInvoice

GET /Invoices/{InvoiceID}/OnlineInvoice

GET /Invoices/{InvoiceID}/pdf Retrieves invoices or purchase bills as PDF files

operationId: Accounting_getInvoicePdf

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
InvoiceID	path	optional	string	Unique identifier for an Invoice

Responses

200

Success - return response of byte array pdf version of specified Invoices

GET /Invoices/{InvoiceID}/pdf

GET /Items Retrieves items

operationId: Accounting_getItems

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element
unitdp	query	optional	integer	e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Responses

200

Success - return response of type Items array with all Item

GET /Items

GET /Items/{ItemID} Retrieves a specific item using a unique item Id

operationId: Accounting_getItemById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ItemID	path	optional	string	Unique identifier for an Item
unitdp	query	optional	integer	e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Responses

200

Success - return response of type Items array with specified Item

GET /Items/{ItemID}

GET /Items/{ItemID}/History Retrieves history for a specific item

operationId: Accounting_getItemHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ItemID	path	optional	string	Unique identifier for an Item

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /Items/{ItemID}/History

GET /Journals Retrieves journals

operationId: Accounting_getJournals

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
offset	query	optional	integer	Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned
paymentsOnly	query	optional	boolean	Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default.

Responses

200

Success - return response of type Journals array with all Journals

GET /Journals

GET /Journals/{JournalID} Retrieves a specific journal using a unique journal Id.

operationId: Accounting_getJournalById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
JournalID	path	optional	string	Unique identifier for a Journal

Responses

200

Success - return response of type Journals array with specified Journal

GET /Journals/{JournalID}

GET /Journals/{JournalNumber} Retrieves a specific journal using a unique journal number.

operationId: Accounting_getJournalByNumber

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
JournalNumber	path	optional	integer	Number of a Journal

Responses

200

Success - return response of type Journals array with specified Journal

GET /Journals/{JournalNumber}

GET /LinkedTransactions Retrieves linked transactions (billable expenses)

operationId: Accounting_getLinkedTransactions

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
page	query	optional	integer	Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1.
LinkedTransactionID	query	optional	string	The Xero identifier for an Linked Transaction
SourceTransactionID	query	optional	string	Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice
ContactID	query	optional	string	Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer.
Status	query	optional	string	Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status
TargetTransactionID	query	optional	string	Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice

Responses

200

Success - return response of type LinkedTransactions array with all LinkedTransaction

GET /LinkedTransactions

GET /LinkedTransactions/{LinkedTransactionID} Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id

operationId: Accounting_getLinkedTransaction

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
LinkedTransactionID	path	optional	string	Unique identifier for a LinkedTransaction

Responses

200

Success - return response of type LinkedTransactions array with a specified LinkedTransaction

GET /LinkedTransactions/{LinkedTransactionID}

GET /ManualJournals Retrieves manual journals

operationId: Accounting_getManualJournals

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element
page	query	optional	integer	e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment

Responses

200

Success - return response of type ManualJournals array with a all ManualJournals

GET /ManualJournals

GET /ManualJournals/{ManualJournalID} Retrieves a specific manual journal

operationId: Accounting_getManualJournal

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ManualJournalID	path	optional	string	Unique identifier for a ManualJournal

Responses

200

Success - return response of type ManualJournals array with a specified ManualJournals

GET /ManualJournals/{ManualJournalID}

GET /ManualJournals/{ManualJournalID}/Attachments Retrieves attachment for a specific manual journal

operationId: Accounting_getManualJournalAttachments

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ManualJournalID	path	optional	string	Unique identifier for a ManualJournal

Responses

200

Success - return response of type Attachments array with all Attachments for a ManualJournals

GET /ManualJournals/{ManualJournalID}/Attachments

GET /ManualJournals/{ManualJournalID}/Attachments/{AttachmentID} Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id

operationId: Accounting_getAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ManualJournalID	path	optional	string	Unique identifier for a ManualJournal
AttachmentID	path	optional	string	Unique identifier for Attachment object
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Manual Journal as binary data

GET /ManualJournals/{ManualJournalID}/Attachments/{AttachmentID}

GET /ManualJournals/{ManualJournalID}/Attachments/{FileName} Retrieves a specific attachment from a specific manual journal by file name

operationId: Accounting_getSpecificAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ManualJournalID	path	optional	string	Unique identifier for a ManualJournal
FileName	path	optional	string	Name of the attachment
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Manual Journal as binary data

GET /ManualJournals/{ManualJournalID}/Attachments/{FileName}

GET /ManualJournals/{ManualJournalID}/History Retrieves history for a specific manual journal

operationId: Accounting_getManualJournalHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ManualJournalID	path	optional	string	Unique identifier for a ManualJournal

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /ManualJournals/{ManualJournalID}/History

GET /Organisation Retrieves Xero organisation details

operationId: Accounting_getOrganisationDetails

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant

Responses

200

Success - return response of type Organisation array with all Organisation

GET /Organisation

GET /Organisation/Actions Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.

operationId: Accounting_getOrganisationActions

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant

Responses

200

Success - return response of type Actions array with all key actions

GET /Organisation/Actions

GET /Organisation/{OrganisationID}/CISSettings Retrieves the CIS settings for the Xero organistaion.

operationId: Accounting_getCisSettings

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
OrganisationID	path	optional	string	The unique Xero identifier for an organisation

Responses

200

Success - return response of type Organisation array with specified Organisation

GET /Organisation/{OrganisationID}/CISSettings

GET /Overpayments Retrieves overpayments

operationId: Accounting_getOverpayments

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element
page	query	optional	integer	e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
unitdp	query	optional	integer	e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Responses

200

Success - return response of type Overpayments array with all Overpayments

GET /Overpayments

GET /Overpayments/{OverpaymentID} Retrieves a specific overpayment using a unique overpayment Id

operationId: Accounting_getOverpaymentById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
OverpaymentID	path	optional	string	Unique identifier for a Overpayment

Responses

200

Success - return response of type Overpayments array with specified Overpayments

GET /Overpayments/{OverpaymentID}

GET /Overpayments/{OverpaymentID}/History Retrieves history records of a specific overpayment

operationId: Accounting_getOverpaymentHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
OverpaymentID	path	optional	string	Unique identifier for a Overpayment

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /Overpayments/{OverpaymentID}/History

GET /PaymentServices Retrieves payment services

operationId: Accounting_getPaymentServices

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant

Responses

200

Success - return response of type PaymentServices array for all PaymentService

GET /PaymentServices

GET /Payments Retrieves payments for invoices and credit notes

operationId: Accounting_getPaymentsForInvoicesAndCreditNotes

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element
page	query	optional	integer	Up to 100 payments will be returned in a single API call

Responses

200

Success - return response of type Payments array for all Payments

GET /Payments

GET /Payments/{PaymentID} Retrieves a specific payment for invoices and credit notes using a unique payment Id

operationId: Accounting_getPaymentById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
PaymentID	path	optional	string	Unique identifier for a Payment

Responses

200

Success - return response of type Payments array for specified Payment

GET /Payments/{PaymentID}

GET /Payments/{PaymentID}/History Retrieves history records of a specific payment

operationId: Accounting_getPaymentHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
PaymentID	path	optional	string	Unique identifier for a Payment

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /Payments/{PaymentID}/History

GET /Prepayments Retrieves prepayments

operationId: Accounting_getPrepayments

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element
page	query	optional	integer	e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment
unitdp	query	optional	integer	e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Responses

200

Success - return response of type Prepayments array for all Prepayment

GET /Prepayments

GET /Prepayments/{PrepaymentID} Allows you to retrieve a specified prepayments

operationId: Accounting_getPrepayment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
PrepaymentID	path	optional	string	Unique identifier for a PrePayment

Responses

200

Success - return response of type Prepayments array for a specified Prepayment

GET /Prepayments/{PrepaymentID}

GET /Prepayments/{PrepaymentID}/History Retrieves history record for a specific prepayment

operationId: Accounting_getPrepaymentHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
PrepaymentID	path	optional	string	Unique identifier for a PrePayment

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /Prepayments/{PrepaymentID}/History

GET /PurchaseOrders Retrieves purchase orders

operationId: Accounting_getPurchaseOrders

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
Status	query	optional	string	Filter by purchase order status
DateFrom	query	optional	string	Filter by purchase order date (e.g. GET https://…/PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
DateTo	query	optional	string	Filter by purchase order date (e.g. GET https://…/PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
order	query	optional	string	Order by an any element
page	query	optional	integer	To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.

Responses

200

Success - return response of type PurchaseOrder array of all PurchaseOrder

GET /PurchaseOrders

GET /PurchaseOrders/{PurchaseOrderID} Retrieves a specific purchase order using a unique purchase order Id

operationId: Accounting_getPurchaseOrderById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
PurchaseOrderID	path	optional	string	Unique identifier for an Purchase Order

Responses

200

Success - return response of type PurchaseOrder array for specified PurchaseOrder

GET /PurchaseOrders/{PurchaseOrderID}

GET /PurchaseOrders/{PurchaseOrderID}/Attachments Retrieves attachments for a specific purchase order

operationId: Accounting_getPurchaseOrderAttachments

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
PurchaseOrderID	path	optional	string	Unique identifier for an Purchase Order

Responses

200

Success - return response of type Attachments array of Purchase Orders

GET /PurchaseOrders/{PurchaseOrderID}/Attachments

GET /PurchaseOrders/{PurchaseOrderID}/Attachments/{AttachmentID} Retrieves specific attachment for a specific purchase order using a unique attachment Id

operationId: Accounting_getAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
PurchaseOrderID	path	optional	string	Unique identifier for an Purchase Order
AttachmentID	path	optional	string	Unique identifier for Attachment object
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Account as binary data

GET /PurchaseOrders/{PurchaseOrderID}/Attachments/{AttachmentID}

GET /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName} Retrieves a specific attachment for a specific purchase order by filename

operationId: Accounting_getAttachmentByFileName

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
PurchaseOrderID	path	optional	string	Unique identifier for an Purchase Order
FileName	path	optional	string	Name of the attachment
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Purchase Order as binary data

GET /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}

GET /PurchaseOrders/{PurchaseOrderID}/History Retrieves history for a specific purchase order

operationId: Accounting_getPurchaseOrderHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
PurchaseOrderID	path	optional	string	Unique identifier for an Purchase Order

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /PurchaseOrders/{PurchaseOrderID}/History

GET /PurchaseOrders/{PurchaseOrderID}/pdf Retrieves specific purchase order as PDF files using a unique purchase order Id

operationId: Accounting_getPurchaseOrderPdf

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
PurchaseOrderID	path	optional	string	Unique identifier for an Purchase Order

Responses

200

Success - return response of byte array pdf version of specified Purchase Orders

GET /PurchaseOrders/{PurchaseOrderID}/pdf

GET /PurchaseOrders/{PurchaseOrderNumber} Retrieves a specific purchase order using purchase order number

operationId: Accounting_getPurchaseOrderByNumber

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
PurchaseOrderNumber	path	required	string	Unique identifier for a PurchaseOrder

Responses

200

Success - return response of type PurchaseOrder array for specified PurchaseOrder

GET /PurchaseOrders/{PurchaseOrderNumber}

GET /Quotes Retrieves sales quotes

operationId: Accounting_getSalesQuotes

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
DateFrom	query	optional	string	Filter for quotes after a particular date
DateTo	query	optional	string	Filter for quotes before a particular date
ExpiryDateFrom	query	optional	string	Filter for quotes expiring after a particular date
ExpiryDateTo	query	optional	string	Filter for quotes before a particular date
ContactID	query	optional	string	Filter for quotes belonging to a particular contact
Status	query	optional	string	Filter for quotes of a particular Status
page	query	optional	integer	e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote
order	query	optional	string	Order by an any element
QuoteNumber	query	optional	string	Filter by quote number (e.g. GET https://…/Quotes?QuoteNumber=QU-0001)

Responses

200

Success - return response of type quotes array with all quotes

GET /Quotes

GET /Quotes/{QuoteID} Retrieves a specific quote using a unique quote Id

operationId: Accounting_getQuoteById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
QuoteID	path	optional	string	Unique identifier for an Quote

Responses

200

Success - return response of type Quotes array with specified Quote

GET /Quotes/{QuoteID}

GET /Quotes/{QuoteID}/Attachments Retrieves attachments for a specific quote

operationId: Accounting_getQuoteAttachments

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
QuoteID	path	optional	string	Unique identifier for an Quote

Responses

200

Success - return response of type Attachments array of Attachment

GET /Quotes/{QuoteID}/Attachments

GET /Quotes/{QuoteID}/Attachments/{AttachmentID} Retrieves a specific attachment from a specific quote using a unique attachment Id

operationId: Accounting_getSpecificAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
QuoteID	path	optional	string	Unique identifier for an Quote
AttachmentID	path	optional	string	Unique identifier for Attachment object
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Quote as binary data

GET /Quotes/{QuoteID}/Attachments/{AttachmentID}

GET /Quotes/{QuoteID}/Attachments/{FileName} Retrieves a specific attachment from a specific quote by filename

operationId: Accounting_getQuoteAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
QuoteID	path	optional	string	Unique identifier for an Quote
FileName	path	optional	string	Name of the attachment
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Quote as binary data

GET /Quotes/{QuoteID}/Attachments/{FileName}

GET /Quotes/{QuoteID}/History Retrieves history records of a specific quote

operationId: Accounting_getQuoteHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
QuoteID	path	optional	string	Unique identifier for an Quote

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /Quotes/{QuoteID}/History

GET /Quotes/{QuoteID}/pdf Retrieves a specific quote as a PDF file using a unique quote Id

operationId: Accounting_getQuotePdf

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
QuoteID	path	optional	string	Unique identifier for an Quote

Responses

200

Success - return response of byte array pdf version of specified Quotes

GET /Quotes/{QuoteID}/pdf

GET /Receipts Retrieves draft expense claim receipts for any user

operationId: Accounting_getDraftExpenseClaimsReceipts

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element
unitdp	query	optional	integer	e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Responses

200

Success - return response of type Receipts array for all Receipt

GET /Receipts

GET /Receipts/{ReceiptID} Retrieves a specific draft expense claim receipt by using a unique receipt Id

operationId: Accounting_getSpecificDraftExpenseClaimReceiptByReceiptId

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ReceiptID	path	optional	string	Unique identifier for a Receipt
unitdp	query	optional	integer	e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Responses

200

Success - return response of type Receipts array for a specified Receipt

GET /Receipts/{ReceiptID}

GET /Receipts/{ReceiptID}/Attachments Retrieves attachments for a specific expense claim receipt

operationId: Accounting_getReceiptAttachments

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ReceiptID	path	optional	string	Unique identifier for a Receipt

Responses

200

Success - return response of type Attachments array of Attachments for a specified Receipt

GET /Receipts/{ReceiptID}/Attachments

GET /Receipts/{ReceiptID}/Attachments/{AttachmentID} Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id

operationId: Accounting_getExpenseClaimsAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ReceiptID	path	optional	string	Unique identifier for a Receipt
AttachmentID	path	optional	string	Unique identifier for Attachment object
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Receipt as binary data

GET /Receipts/{ReceiptID}/Attachments/{AttachmentID}

GET /Receipts/{ReceiptID}/Attachments/{FileName} Retrieves a specific attachment from a specific expense claim receipts by file name

operationId: Accounting_getSpecificAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ReceiptID	path	optional	string	Unique identifier for a Receipt
FileName	path	optional	string	Name of the attachment
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Receipt as binary data

GET /Receipts/{ReceiptID}/Attachments/{FileName}

GET /Receipts/{ReceiptID}/History Retrieves a history record for a specific receipt

operationId: Accounting_getReceiptHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ReceiptID	path	optional	string	Unique identifier for a Receipt

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /Receipts/{ReceiptID}/History

GET /RepeatingInvoices Retrieves repeating invoices

operationId: Accounting_getRepeatingInvoices

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element

Responses

200

Success - return response of type Repeating Invoices array for all Repeating Invoice

GET /RepeatingInvoices

GET /RepeatingInvoices/{RepeatingInvoiceID} Retrieves a specific repeating invoice by using a unique repeating invoice Id

operationId: Accounting_getRepeatingInvoiceById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
RepeatingInvoiceID	path	optional	string	Unique identifier for a Repeating Invoice

Responses

200

Success - return response of type Repeating Invoices array with a specified Repeating Invoice

GET /RepeatingInvoices/{RepeatingInvoiceID}

GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments Retrieves attachments from a specific repeating invoice

operationId: Accounting_getRepeatingInvoiceAttachments

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
RepeatingInvoiceID	path	optional	string	Unique identifier for a Repeating Invoice

Responses

200

Success - return response of type Attachments array with all Attachments for a specified Repeating Invoice

GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments

GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID} Retrieves a specific attachment from a specific repeating invoice

operationId: Accounting_getSpecificAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
RepeatingInvoiceID	path	optional	string	Unique identifier for a Repeating Invoice
AttachmentID	path	optional	string	Unique identifier for Attachment object
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Repeating Invoice as binary data

GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID}

GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} Retrieves a specific attachment from a specific repeating invoices by file name

operationId: Accounting_getRepeatingInvoiceAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
RepeatingInvoiceID	path	optional	string	Unique identifier for a Repeating Invoice
FileName	path	optional	string	Name of the attachment
contentType	header	optional	string	The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Responses

200

Success - return response of attachment for Repeating Invoice as binary data

GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}

GET /RepeatingInvoices/{RepeatingInvoiceID}/History Retrieves history record for a specific repeating invoice

operationId: Accounting_getRepeatingInvoiceHistory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
RepeatingInvoiceID	path	optional	string	Unique identifier for a Repeating Invoice

Responses

200

Success - return response of HistoryRecords array of 0 to N HistoryRecord

GET /RepeatingInvoices/{RepeatingInvoiceID}/History

GET /Reports Retrieves a list of the organistaions unique reports that require a uuid to fetch

operationId: Accounting_getUniqueReportsByUuid

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant

Responses

200

Success - return response of type ReportWithRows

GET /Reports

GET /Reports/AgedPayablesByContact Retrieves report for aged payables by contact

operationId: Accounting_getAgedPayablesByContact

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
contactId	query	required	string	Unique identifier for a Contact
date	query	optional	string	The date of the Aged Payables By Contact report
fromDate	query	optional	string	filter by the from date of the report e.g. 2021-02-01
toDate	query	optional	string	filter by the to date of the report e.g. 2021-02-28

Responses

200

Success - return response of type ReportWithRows

GET /Reports/AgedPayablesByContact

GET /Reports/AgedReceivablesByContact Retrieves report for aged receivables by contact

operationId: Accounting_getAgedReceivablesByContact

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
contactId	query	required	string	Unique identifier for a Contact
date	query	optional	string	The date of the Aged Receivables By Contact report
fromDate	query	optional	string	filter by the from date of the report e.g. 2021-02-01
toDate	query	optional	string	filter by the to date of the report e.g. 2021-02-28

Responses

200

Success - return response of type ReportWithRows

GET /Reports/AgedReceivablesByContact

GET /Reports/BalanceSheet Retrieves report for balancesheet

operationId: Accounting_getBalanceSheetReport

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
date	query	optional	string	The date of the Balance Sheet report
periods	query	optional	integer	The number of periods for the Balance Sheet report
timeframe	query	optional	string	The period size to compare to (MONTH, QUARTER, YEAR)
trackingOptionID1	query	optional	string	The tracking option 1 for the Balance Sheet report
trackingOptionID2	query	optional	string	The tracking option 2 for the Balance Sheet report
standardLayout	query	optional	boolean	The standard layout boolean for the Balance Sheet report
paymentsOnly	query	optional	boolean	return a cash basis for the Balance Sheet report

Responses

200

Success - return response of type ReportWithRows

GET /Reports/BalanceSheet

GET /Reports/BankSummary Retrieves report for bank summary

operationId: Accounting_getBankSummary

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
fromDate	query	optional	string	filter by the from date of the report e.g. 2021-02-01
toDate	query	optional	string	filter by the to date of the report e.g. 2021-02-28

Responses

200

Success - return response of type ReportWithRows

GET /Reports/BankSummary

GET /Reports/BudgetSummary Retrieves report for budget summary

operationId: Accounting_getBudgetSummaryReport

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
date	query	optional	string	The date for the Bank Summary report e.g. 2018-03-31
periods	query	optional	integer	The number of periods to compare (integer between 1 and 12)
timeframe	query	optional	integer	The period size to compare to (1=month, 3=quarter, 12=year)

Responses

200

success- return a Report with Rows object

GET /Reports/BudgetSummary

GET /Reports/ExecutiveSummary Retrieves report for executive summary

operationId: Accounting_getExecutiveSummaryReport

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
date	query	optional	string	The date for the Bank Summary report e.g. 2018-03-31

Responses

200

Success - return response of type ReportWithRows

GET /Reports/ExecutiveSummary

GET /Reports/ProfitAndLoss Retrieves report for profit and loss

operationId: Accounting_getProfitAndLossReport

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
fromDate	query	optional	string	filter by the from date of the report e.g. 2021-02-01
toDate	query	optional	string	filter by the to date of the report e.g. 2021-02-28
periods	query	optional	integer	The number of periods to compare (integer between 1 and 12)
timeframe	query	optional	string	The period size to compare to (MONTH, QUARTER, YEAR)
trackingCategoryID	query	optional	string	The trackingCategory 1 for the ProfitAndLoss report
trackingCategoryID2	query	optional	string	The trackingCategory 2 for the ProfitAndLoss report
trackingOptionID	query	optional	string	The tracking option 1 for the ProfitAndLoss report
trackingOptionID2	query	optional	string	The tracking option 2 for the ProfitAndLoss report
standardLayout	query	optional	boolean	Return the standard layout for the ProfitAndLoss report
paymentsOnly	query	optional	boolean	Return cash only basis for the ProfitAndLoss report

Responses

200

Success - return response of type ReportWithRows

GET /Reports/ProfitAndLoss

GET /Reports/TenNinetyNine Retrieve reports for 1099

operationId: Accounting_get1099Reports

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
reportYear	query	optional	string	The year of the 1099 report

Responses

200

Success - return response of type Reports

GET /Reports/TenNinetyNine

GET /Reports/TrialBalance Retrieves report for trial balance

operationId: Accounting_getTrialBalanceReport

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
date	query	optional	string	The date for the Trial Balance report e.g. 2018-03-31
paymentsOnly	query	optional	boolean	Return cash only basis for the Trial Balance report

Responses

200

Success - return response of type ReportWithRows

GET /Reports/TrialBalance

GET /Reports/{ReportID} Retrieves a specific report using a unique ReportID

operationId: Accounting_getReportByReportId

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
ReportID	path	required	string	Unique identifier for a Report

Responses

200

Success - return response of type ReportWithRows

GET /Reports/{ReportID}

GET /TaxRates Retrieves tax rates

operationId: Accounting_getTaxRates

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element

Responses

200

Success - return response of type TaxRates array with TaxRates

GET /TaxRates

GET /TaxRates/{TaxType} Retrieves a specific tax rate according to given TaxType code

operationId: Accounting_getTaxRateByType

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
TaxType	path	optional	string	A valid TaxType code

Responses

200

Success - return response of type TaxRates array with one TaxRate

GET /TaxRates/{TaxType}

GET /TrackingCategories Retrieves tracking categories and options

operationId: Accounting_getTrackingCategoriesOptions

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element
includeArchived	query	optional	boolean	e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response

Responses

200

Success - return response of type TrackingCategories array of TrackingCategory

GET /TrackingCategories

GET /TrackingCategories/{TrackingCategoryID} Retrieves specific tracking categories and options using a unique tracking category Id

operationId: Accounting_getTrackingCategoriesById

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
TrackingCategoryID	path	optional	string	Unique identifier for a TrackingCategory

Responses

200

Success - return response of type TrackingCategories array of specified TrackingCategory

GET /TrackingCategories/{TrackingCategoryID}

GET /Users Retrieves users

operationId: Accounting_getUsers

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
If-Modified-Since	header	optional	string	Only records created or modified since this timestamp will be returned
where	query	optional	string	Filter by an any element
order	query	optional	string	Order by an any element

Responses

200

Success - return response of type Users array of all User

GET /Users

GET /Users/{UserID} Retrieves a specific user

operationId: Accounting_getSpecificUser

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
UserID	path	optional	string	Unique identifier for a User

Responses

200

Success - return response of type Users array of specified User

GET /Users/{UserID}

Load more endpoints

Schemas

object Account

{
  "type": "object",
  "properties": {
    "Code": {
      "type": "string",
      "example": 4400,
      "description": "Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)"
    },
    "Name": {
      "type": "string",
      "example": "Food Sales",
      "maxLength": 150,
      "description": "Name of account (max length = 150)"
    },
    "Type": {
      "$ref": "#/components/schemas/AccountType",
      "type": "string"
    },
    "Class": {
      "enum": [
        "ASSET",
        "EQUITY",
        "EXPENSE",
        "LIABILITY",
        "REVENUE"
      ],
      "type": "string",
      "readOnly": true,
      "description": "See Account Class Types"
    },
    "Status": {
      "enum": [
        "ACTIVE",
        "ARCHIVED",
        "DELETED"
      ],
      "type": "string",
      "description": "Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes"
    },
    "TaxType": {
      "type": "string",
      "description": "The tax type from taxRates"
    },
    "AccountID": {
      "type": "string",
      "format": "uuid",
      "example": "00000000-0000-0000-0000-000000000000",
      "description": "The Xero identifier for an account – specified as a string following  the endpoint name   e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9"
    },
    "Description": {
      "type": "string",
      "description": "Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)"
    },
    "CurrencyCode": {
      "$ref": "#/components/schemas/CurrencyCode",
      "type": "string"
    },
    "ReportingCode": {
      "type": "string",
      "description": "Shown if set"
    },
    "SystemAccount": {
      "enum": [
        "DEBTORS",
        "CREDITORS",
        "BANKCURRENCYGAIN",
        "GST",
        "GSTONIMPORTS",
        "HISTORICAL",
        "REALISEDCURRENCYGAIN",
        "RETAINEDEARNINGS",
        "ROUNDING",
        "TRACKINGTRANSFERS",
        "UNPAIDEXPCLM",
        "UNREALISEDCURRENCYGAIN",
        "WAGEPAYABLES",
        "CISASSETS",
        "CISASSET",
        "CISLABOUR",
        "CISLABOUREXPENSE",
        "CISLABOURINCOME",
        "CISLIABILITY",
        "CISMATERIALS",
        ""
      ],
      "type": "string",
      "readOnly": true,
      "description": "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."
    },
    "AddToWatchlist": {
      "type": "boolean",
      "description": "Boolean – describes whether the account is shown in the watchlist widget on the dashboard"
    },
    "HasAttachments": {
      "type": "boolean",
      "default": "false",
      "example": false,
      "readOnly": true,
      "description": "boolean to indicate if an account has an attachment (read only)"
    },
    "UpdatedDateUTC": {
      "type": "string",
      "example": "/Date(1573755038314)/",
      "readOnly": true,
      "description": "Last modified date UTC format",
      "x-is-msdate-time": true
    },
    "BankAccountType": {
      "enum": [
        "BANK",
        "CREDITCARD",
        "PAYPAL",
        "NONE",
        ""
      ],
      "type": "string",
      "description": "For bank accounts only. See Bank Account types"
    },
    "ValidationErrors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "description": "Displays array of validation error messages from the API"
    },
    "BankAccountNumber": {
      "type": "string",
      "description": "For bank accounts only (Account Type BANK)"
    },
    "ReportingCodeName": {
      "type": "string",
      "readOnly": true,
      "description": "Shown if set"
    },
    "ShowInExpenseClaims": {
      "type": "boolean",
      "description": "Boolean – describes whether account code is available for use with expense claims"
    },
    "EnablePaymentsToAccount": {
      "type": "boolean",
      "description": "Boolean – describes whether account can have payments applied to it"
    }
  },
  "externalDocs": {
    "url": "http://developer.xero.com/documentation/api/accounts/"
  }
}

string AccountType

{
  "enum": [
    "BANK",
    "CURRENT",
    "CURRLIAB",
    "DEPRECIATN",
    "DIRECTCOSTS",
    "EQUITY",
    "EXPENSE",
    "FIXED",
    "INVENTORY",
    "LIABILITY",
    "NONCURRENT",
    "OTHERINCOME",
    "OVERHEADS",
    "PREPAYMENT",
    "REVENUE",
    "SALES",
    "TERMLIAB",
    "PAYG"
  ],
  "type": "string",
  "description": "See Account Types"
}

string AccountingCreateAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingCreateAttachmentRequest1

{
  "type": "string",
  "format": "byte"
}

string AccountingCreateBankTransactionAttachmentByFilenameRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingCreatePurchaseOrderAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingCreateQuoteAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingCreateReceiptAttachmentByFileNameRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingCreateRepeatingInvoiceAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingCreateSpecificAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingGetAttachment200Response

{
  "type": "string",
  "format": "binary"
}

string AccountingGetAttachmentByFileName200Response

{
  "type": "string",
  "format": "binary"
}

string AccountingGetAttachmentByFileNameResponse

{
  "type": "string",
  "format": "binary"
}

string AccountingGetAttachmentByFilenameResponse

{
  "type": "string",
  "format": "binary"
}

string AccountingGetAttachmentByIdResponse

{
  "type": "string",
  "format": "binary"
}

string AccountingGetAttachmentResponse

{
  "type": "string",
  "format": "binary"
}

string AccountingGetCreditNoteAttachmentResponse

{
  "type": "string",
  "format": "binary"
}

string AccountingGetCreditNotePdfResponse

{
  "type": "string",
  "format": "binary"
}

string AccountingGetExpenseClaimsAttachmentResponse

{
  "type": "string",
  "format": "binary"
}

string AccountingGetInvoicePdfResponse

{
  "type": "string",
  "format": "binary"
}

string AccountingGetPurchaseOrderPdfResponse

{
  "type": "string",
  "format": "binary"
}

string AccountingGetQuoteAttachmentResponse

{
  "type": "string",
  "format": "binary"
}

string AccountingGetQuotePdfResponse

{
  "type": "string",
  "format": "binary"
}

string AccountingGetRepeatingInvoiceAttachmentResponse

{
  "type": "string",
  "format": "binary"
}

string AccountingGetSpecificAttachment200Response

{
  "type": "string",
  "format": "binary"
}

string AccountingGetSpecificAttachmentResponse

{
  "type": "string",
  "format": "binary"
}

string AccountingUpdateAttachmentByFilenameRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingUpdateAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingUpdateAttachmentsByFileNameRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingUpdateBankTransactionAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingUpdateBankTransferAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingUpdateCreditNoteAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingUpdatePurchaseOrderAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingUpdateQuoteAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingUpdateRepeatingInvoiceAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingUpdateSpecificAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingUpdateSpecificAttachmentRequest1

{
  "type": "string",
  "format": "byte"
}

string AccountingUploadAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

string AccountingUploadAttachmentRequest1

{
  "type": "string",
  "format": "byte"
}

string AccountingUploadBankTransferAttachmentRequest

{
  "type": "string",
  "format": "byte"
}

object Accounts

{
  "type": "object",
  "properties": {
    "Accounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Account"
      }
    }
  },
  "x-isObjectArray": true
}

object AccountsPayable

{
  "type": "object",
  "properties": {
    "Overdue": {
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "Outstanding": {
      "type": "number",
      "format": "double",
      "x-is-money": true
    }
  }
}

object AccountsReceivable

{
  "type": "object",
  "properties": {
    "Overdue": {
      "type": "number",
      "format": "double",
      "x-is-money": true
    },
    "Outstanding": {
      "type": "number",
      "format": "double",
      "x-is-money": true
    }
  }
}

object Action

{
  "properties": {
    "Name": {
      "type": "string",
      "example": "UseMulticurrency",
      "description": "Name of the actions for this organisation"
    },
    "Status": {
      "enum": [
        "ALLOWED",
        "NOT-ALLOWED"
      ],
      "type": "string",
      "description": "Status of the action for this organisation"
    }
  },
  "externalDocs": {
    "url": "http://developer.xero.com/documentation/api/organisation/"
  }
}

object Actions

{
  "type": "object",
  "properties": {
    "Actions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Action"
      }
    }
  },
  "x-isObjectArray": true
}

object Address

{
  "type": "object",
  "properties": {
    "City": {
      "type": "string",
      "maxLength": 255,
      "description": "max length = 255"
    },
    "Region": {
      "type": "string",
      "maxLength": 255,
      "description": "max length = 255"
    },
    "Country": {
      "type": "string",
      "maxLength": 50,
      "description": "max length = 50, [A-Z], [a-z] only"
    },
    "PostalCode": {
      "type": "string",
      "maxLength": 50,
      "description": "max length = 50"
    },
    "AddressType": {
      "enum": [
        "POBOX",
        "STREET"
      ],
      "type": "string",
      "description": "define the type of address"
    },
    "AttentionTo": {
      "type": "string",
      "maxLength": 255,
      "description": "max length = 255"
    },
    "AddressLine1": {
      "type": "string",
      "maxLength": 500,
      "description": "max length = 500"
    },
    "AddressLine2": {
      "type": "string",
      "maxLength": 500,
      "description": "max length = 500"
    },
    "AddressLine3": {
      "type": "string",
      "maxLength": 500,
      "description": "max length = 500"
    },
    "AddressLine4": {
      "type": "string",
      "maxLength": 500,
      "description": "max length = 500"
    }
  },
  "externalDocs": {
    "url": "http://developer.xero.com/documentation/api/types"
  }
}

object AddressForOrganisation

{
  "type": "object",
  "properties": {
    "City": {
      "type": "string",
      "maxLength": 255,
      "description": "max length = 255"
    },
    "Region": {
      "type": "string",
      "maxLength": 255,
      "description": "max length = 255"
    },
    "Country": {
      "type": "string",
      "maxLength": 50,
      "description": "max length = 50, [A-Z], [a-z] only"
    },
    "PostalCode": {
      "type": "string",
      "maxLength": 50,
      "description": "max length = 50"
    },
    "AddressType": {
      "enum": [
        "POBOX",
        "STREET",
        "DELIVERY"
      ],
      "type": "string",
      "description": "define the type of address"
    },
    "AttentionTo": {
      "type": "string",
      "maxLength": 255,
      "description": "max length = 255"
    },
    "AddressLine1": {
      "type": "string",
      "maxLength": 500,
      "description": "max length = 500"
    },
    "AddressLine2": {
      "type": "string",
      "maxLength": 500,
      "description": "max length = 500"
    },
    "AddressLine3": {
      "type": "string",
      "maxLength": 500,
      "description": "max length = 500"
    },
    "AddressLine4": {
      "type": "string",
      "maxLength": 500,
      "description": "max length = 500"
    }
  },
  "externalDocs": {
    "url": "http://developer.xero.com/documentation/api/types"
  }
}

object Allocation

{
  "type": "object",
  "required": [
    "Amount",
    "Invoice",
    "Date"
  ],
  "properties": {
    "Date": {
      "type": "string",
      "description": "the date the allocation is applied YYYY-MM-DD.",
      "x-is-msdate": true
    },
    "Amount": {
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "description": "the amount being applied to the invoice"
    },
    "Invoice": {
      "$ref": "#/components/schemas/Invoice"
    },
    "IsDeleted": {
      "type": "boolean",
      "readOnly": true,
      "description": "A flag that returns true when the allocation is succesfully deleted"
    },
    "CreditNote": {
      "$ref": "#/components/schemas/CreditNote"
    },
    "Prepayment": {
      "$ref": "#/components/schemas/Prepayment"
    },
    "Overpayment": {
      "$ref": "#/components/schemas/Overpayment"
    },
    "AllocationID": {
      "type": "string",
      "format": "uuid",
      "description": "Xero generated unique identifier"
    },
    "ValidationErrors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "description": "Displays array of validation error messages from the API"
    },
    "StatusAttributeString": {
      "type": "string",
      "description": "A string to indicate if a invoice status"
    }
  },
  "externalDocs": {
    "url": "http://developer.xero.com/documentation/api/prepayments/"
  }
}

object Allocations

{
  "type": "object",
  "properties": {
    "Allocations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Allocation"
      }
    }
  },
  "x-isObjectArray": true
}

object Attachment

{
  "type": "object",
  "properties": {
    "Url": {
      "type": "string",
      "example": "https://api.xero.com/api.xro/2.0/Accounts/da962997-a8bd-4dff-9616-01cdc199283f/Attachments/sample5.jpg",
      "description": "URL to the file on xero.com"
    },
    "FileName": {
      "type": "string",
      "example": "xero-dev.jpg",
      "description": "Name of the file"
    },
    "MimeType": {
      "type": "string",
      "example": "image/jpg",
      "description": "Type of file"
    },
    "AttachmentID": {
      "type": "string",
      "format": "uuid",
      "example": "00000000-0000-0000-0000-000000000000",
      "description": "Unique ID for the file"
    },
    "ContentLength": {
      "type": "integer",
      "description": "Length of the file content"
    },
    "IncludeOnline": {
      "type": "boolean",
      "description": "Include the file with the online invoice"
    }
  },
  "externalDocs": {
    "url": "http://developer.xero.com/documentation/api/attachments/"
  }
}

Load more schemas

Versions

Version	Endpoints	Schemas	Ingested	Status
3.0.1	237	171	2026-05-11	current
3.0.1	237	171	2026-04-16