POST /RepeatingInvoices Creates or deletes one or more repeating invoice templates

operationId: Accounting_manageRepeatingInvoices

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
summarizeErrors	query	optional	boolean	If false return 200 OK and mix of successfully created objects and any with validation errors
Idempotency-Key	header	optional	string	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request Body

required

RepeatingInvoices with an array of repeating invoice objects in body of request

application/json

schema RepeatingInvoices

Property	Type	Required
RepeatingInvoices	array	optional
└ ID	string	optional
└ Type	string	optional
└ Total	number	optional
└ Status	string	optional
└ Contact	object	optional
└ Name	string	optional
└ Phones	array	optional
└ PhoneType	string	optional
└ PhoneNumber	string	optional
└ PhoneAreaCode	string	optional
└ PhoneCountryCode	string	optional
└ Website	string	optional
└ Balances	object	optional
└ AccountsPayable	object	optional
└ AccountsReceivable	object	optional
└ Discount	number	optional
└ LastName	string	optional
└ Addresses	array	optional
└ City	string	optional
└ Region	string	optional
└ Country	string	optional
└ PostalCode	string	optional
└ AddressType	string	optional
└ AttentionTo	string	optional
└ AddressLine1	string	optional
└ AddressLine2	string	optional
└ AddressLine3	string	optional
└ AddressLine4	string	optional
└ ContactID	string	optional
└ FirstName	string	optional
└ TaxNumber	string	optional
└ IsCustomer	boolean	optional
└ IsSupplier	boolean	optional
└ Attachments	array	optional
└ Url	string	optional
└ FileName	string	optional
└ MimeType	string	optional
└ AttachmentID	string	optional
└ ContentLength	integer	optional
└ IncludeOnline	boolean	optional
└ EmailAddress	string	optional
└ PaymentTerms	object	optional
└ Bills	object	optional
└ Sales	object	optional
└ AccountNumber	string	optional
└ BatchPayments	object	optional
└ Code	string	optional
└ Details	string	optional
└ Reference	string	optional
└ BankAccountName	string	optional
└ BankAccountNumber	string	optional
└ BrandingTheme	object	optional
└ Name	string	optional
└ Type	string	optional
└ LogoUrl	string	optional
└ SortOrder	integer	optional
└ CreatedDateUTC	string	optional
└ BrandingThemeID	string	optional
└ CompanyNumber	string	optional
└ ContactGroups	array	optional
└ Name	string	optional
└ Status	string	optional
└ Contacts	array	optional
└ ContactGroupID	string	optional
└ …22 more	object	optional
└ Schedule	object	optional
└ Unit	string	optional
└ Period	integer	optional
└ DueDate	integer	optional
└ EndDate	string	optional
└ StartDate	string	optional
└ DueDateType	string	optional
└ NextScheduledDate	string	optional
└ SendCopy	boolean	optional
└ SubTotal	number	optional
└ TotalTax	number	optional
└ LineItems	array	optional
└ Item	object	optional
└ Code	string	optional
└ Name	string	optional
└ ItemID	string	optional
└ TaxType	string	optional
└ ItemCode	string	optional
└ Quantity	number	optional
└ Tracking	array	optional
└ Name	string	optional
└ Option	string	optional
└ TrackingOptionID	string	optional
└ TrackingCategoryID	string	optional
└ AccountID	string	optional
└ TaxAmount	number	optional
└ LineAmount	number	optional
└ LineItemID	string	optional
└ UnitAmount	number	optional
└ AccountCode	string	optional
└ Description	string	optional
└ DiscountRate	number	optional
└ DiscountAmount	number	optional
└ RepeatingInvoiceID	string	optional
└ Reference	string	optional
└ IncludePDF	boolean	optional
└ MarkAsSent	boolean	optional
└ Attachments	array	optional
└ Url	string	optional
└ FileName	string	optional
└ MimeType	string	optional
└ AttachmentID	string	optional
└ ContentLength	integer	optional
└ IncludeOnline	boolean	optional
└ CurrencyCode	string	optional
└ HasAttachments	boolean	optional
└ BrandingThemeID	string	optional
└ LineAmountTypes	string	optional
└ ApprovedForSending	boolean	optional
└ RepeatingInvoiceID	string	optional

Responses

200

Success - return response of type RepeatingInvoices array with newly created RepeatingInvoice

400

A failed request due to validation error

POST /RepeatingInvoices

PUT /RepeatingInvoices Creates one or more repeating invoice templates

operationId: Accounting_createRepeatingInvoices

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
summarizeErrors	query	optional	boolean	If false return 200 OK and mix of successfully created objects and any with validation errors
Idempotency-Key	header	optional	string	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request Body

required

RepeatingInvoices with an array of repeating invoice objects in body of request

application/json

schema RepeatingInvoices

Property	Type	Required
RepeatingInvoices	array	optional
└ ID	string	optional
└ Type	string	optional
└ Total	number	optional
└ Status	string	optional
└ Contact	object	optional
└ Name	string	optional
└ Phones	array	optional
└ PhoneType	string	optional
└ PhoneNumber	string	optional
└ PhoneAreaCode	string	optional
└ PhoneCountryCode	string	optional
└ Website	string	optional
└ Balances	object	optional
└ AccountsPayable	object	optional
└ AccountsReceivable	object	optional
└ Discount	number	optional
└ LastName	string	optional
└ Addresses	array	optional
└ City	string	optional
└ Region	string	optional
└ Country	string	optional
└ PostalCode	string	optional
└ AddressType	string	optional
└ AttentionTo	string	optional
└ AddressLine1	string	optional
└ AddressLine2	string	optional
└ AddressLine3	string	optional
└ AddressLine4	string	optional
└ ContactID	string	optional
└ FirstName	string	optional
└ TaxNumber	string	optional
└ IsCustomer	boolean	optional
└ IsSupplier	boolean	optional
└ Attachments	array	optional
└ Url	string	optional
└ FileName	string	optional
└ MimeType	string	optional
└ AttachmentID	string	optional
└ ContentLength	integer	optional
└ IncludeOnline	boolean	optional
└ EmailAddress	string	optional
└ PaymentTerms	object	optional
└ Bills	object	optional
└ Sales	object	optional
└ AccountNumber	string	optional
└ BatchPayments	object	optional
└ Code	string	optional
└ Details	string	optional
└ Reference	string	optional
└ BankAccountName	string	optional
└ BankAccountNumber	string	optional
└ BrandingTheme	object	optional
└ Name	string	optional
└ Type	string	optional
└ LogoUrl	string	optional
└ SortOrder	integer	optional
└ CreatedDateUTC	string	optional
└ BrandingThemeID	string	optional
└ CompanyNumber	string	optional
└ ContactGroups	array	optional
└ Name	string	optional
└ Status	string	optional
└ Contacts	array	optional
└ ContactGroupID	string	optional
└ …22 more	object	optional
└ Schedule	object	optional
└ Unit	string	optional
└ Period	integer	optional
└ DueDate	integer	optional
└ EndDate	string	optional
└ StartDate	string	optional
└ DueDateType	string	optional
└ NextScheduledDate	string	optional
└ SendCopy	boolean	optional
└ SubTotal	number	optional
└ TotalTax	number	optional
└ LineItems	array	optional
└ Item	object	optional
└ Code	string	optional
└ Name	string	optional
└ ItemID	string	optional
└ TaxType	string	optional
└ ItemCode	string	optional
└ Quantity	number	optional
└ Tracking	array	optional
└ Name	string	optional
└ Option	string	optional
└ TrackingOptionID	string	optional
└ TrackingCategoryID	string	optional
└ AccountID	string	optional
└ TaxAmount	number	optional
└ LineAmount	number	optional
└ LineItemID	string	optional
└ UnitAmount	number	optional
└ AccountCode	string	optional
└ Description	string	optional
└ DiscountRate	number	optional
└ DiscountAmount	number	optional
└ RepeatingInvoiceID	string	optional
└ Reference	string	optional
└ IncludePDF	boolean	optional
└ MarkAsSent	boolean	optional
└ Attachments	array	optional
└ Url	string	optional
└ FileName	string	optional
└ MimeType	string	optional
└ AttachmentID	string	optional
└ ContentLength	integer	optional
└ IncludeOnline	boolean	optional
└ CurrencyCode	string	optional
└ HasAttachments	boolean	optional
└ BrandingThemeID	string	optional
└ LineAmountTypes	string	optional
└ ApprovedForSending	boolean	optional
└ RepeatingInvoiceID	string	optional

Responses

200

Success - return response of type RepeatingInvoices array with newly created RepeatingInvoice

400

A failed request due to validation error

PUT /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}

POST /RepeatingInvoices/{RepeatingInvoiceID} Deletes a specific repeating invoice template

operationId: Accounting_deleteRepeatingInvoiceTemplate

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
Idempotency-Key	header	optional	string	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
RepeatingInvoiceID	path	optional	string	Unique identifier for a Repeating Invoice

Request Body

required

application/json

schema RepeatingInvoices

Property	Type	Required
RepeatingInvoices	array	optional
└ ID	string	optional
└ Type	string	optional
└ Total	number	optional
└ Status	string	optional
└ Contact	object	optional
└ Name	string	optional
└ Phones	array	optional
└ PhoneType	string	optional
└ PhoneNumber	string	optional
└ PhoneAreaCode	string	optional
└ PhoneCountryCode	string	optional
└ Website	string	optional
└ Balances	object	optional
└ AccountsPayable	object	optional
└ AccountsReceivable	object	optional
└ Discount	number	optional
└ LastName	string	optional
└ Addresses	array	optional
└ City	string	optional
└ Region	string	optional
└ Country	string	optional
└ PostalCode	string	optional
└ AddressType	string	optional
└ AttentionTo	string	optional
└ AddressLine1	string	optional
└ AddressLine2	string	optional
└ AddressLine3	string	optional
└ AddressLine4	string	optional
└ ContactID	string	optional
└ FirstName	string	optional
└ TaxNumber	string	optional
└ IsCustomer	boolean	optional
└ IsSupplier	boolean	optional
└ Attachments	array	optional
└ Url	string	optional
└ FileName	string	optional
└ MimeType	string	optional
└ AttachmentID	string	optional
└ ContentLength	integer	optional
└ IncludeOnline	boolean	optional
└ EmailAddress	string	optional
└ PaymentTerms	object	optional
└ Bills	object	optional
└ Sales	object	optional
└ AccountNumber	string	optional
└ BatchPayments	object	optional
└ Code	string	optional
└ Details	string	optional
└ Reference	string	optional
└ BankAccountName	string	optional
└ BankAccountNumber	string	optional
└ BrandingTheme	object	optional
└ Name	string	optional
└ Type	string	optional
└ LogoUrl	string	optional
└ SortOrder	integer	optional
└ CreatedDateUTC	string	optional
└ BrandingThemeID	string	optional
└ CompanyNumber	string	optional
└ ContactGroups	array	optional
└ Name	string	optional
└ Status	string	optional
└ Contacts	array	optional
└ ContactGroupID	string	optional
└ …22 more	object	optional
└ Schedule	object	optional
└ Unit	string	optional
└ Period	integer	optional
└ DueDate	integer	optional
└ EndDate	string	optional
└ StartDate	string	optional
└ DueDateType	string	optional
└ NextScheduledDate	string	optional
└ SendCopy	boolean	optional
└ SubTotal	number	optional
└ TotalTax	number	optional
└ LineItems	array	optional
└ Item	object	optional
└ Code	string	optional
└ Name	string	optional
└ ItemID	string	optional
└ TaxType	string	optional
└ ItemCode	string	optional
└ Quantity	number	optional
└ Tracking	array	optional
└ Name	string	optional
└ Option	string	optional
└ TrackingOptionID	string	optional
└ TrackingCategoryID	string	optional
└ AccountID	string	optional
└ TaxAmount	number	optional
└ LineAmount	number	optional
└ LineItemID	string	optional
└ UnitAmount	number	optional
└ AccountCode	string	optional
└ Description	string	optional
└ DiscountRate	number	optional
└ DiscountAmount	number	optional
└ RepeatingInvoiceID	string	optional
└ Reference	string	optional
└ IncludePDF	boolean	optional
└ MarkAsSent	boolean	optional
└ Attachments	array	optional
└ Url	string	optional
└ FileName	string	optional
└ MimeType	string	optional
└ AttachmentID	string	optional
└ ContentLength	integer	optional
└ IncludeOnline	boolean	optional
└ CurrencyCode	string	optional
└ HasAttachments	boolean	optional
└ BrandingThemeID	string	optional
└ LineAmountTypes	string	optional
└ ApprovedForSending	boolean	optional
└ RepeatingInvoiceID	string	optional

Responses

200

Success - return response of type RepeatingInvoices array with deleted Invoice

400

A failed request due to validation error

POST /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}

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

operationId: Accounting_updateRepeatingInvoiceAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
Idempotency-Key	header	optional	string	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
RepeatingInvoiceID	path	optional	string	Unique identifier for a Repeating Invoice
FileName	path	optional	string	Name of the attachment

Request Body

required

Byte array of file in body of request

application/octet-stream

schema AccountingUpdateRepeatingInvoiceAttachmentRequest

string

Responses

200

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

400

A failed request due to validation error

POST /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}

PUT /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} Creates an attachment from a specific repeating invoices by file name

operationId: Accounting_createRepeatingInvoiceAttachment

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
Idempotency-Key	header	optional	string	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
RepeatingInvoiceID	path	optional	string	Unique identifier for a Repeating Invoice
FileName	path	optional	string	Name of the attachment

Request Body

required

Byte array of file in body of request

application/octet-stream

schema AccountingCreateRepeatingInvoiceAttachmentRequest

string

Responses

200

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

400

A failed request due to validation error

PUT /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

PUT /RepeatingInvoices/{RepeatingInvoiceID}/History Creates a history record for a specific repeating invoice

operationId: Accounting_createHistoryRecord

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
Idempotency-Key	header	optional	string	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
RepeatingInvoiceID	path	optional	string	Unique identifier for a Repeating Invoice

Request Body

HistoryRecords containing an array of HistoryRecord objects in body of request

application/json

schema HistoryRecords

Property	Type	Required
HistoryRecords	array	optional
└ User	string	optional
└ Changes	string	optional
└ DateUTC	string	optional
└ Details	string	optional

Responses

200

Success - return response of type HistoryRecords array of HistoryRecord objects

400

A failed request due to validation error

PUT /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}

POST /Setup Sets the chart of accounts, the conversion date and conversion balances

operationId: Accounting_setConversionDetails

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
Idempotency-Key	header	optional	string	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request Body

required

Object including an accounts array, a conversion balances array and a conversion date object in body of request

application/json

schema Setup

Responses

200

Success - returns a summary of the chart of accounts updates

POST /Setup

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

POST /TaxRates Updates tax rates

operationId: Accounting_updateTaxRates

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
Idempotency-Key	header	optional	string	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request Body

required

application/json

schema TaxRates

Property	Type	Required
TaxRates	array	optional
└ Name	string	optional
└ Status	string	optional
└ TaxType	string	optional
└ EffectiveRate	number	optional
└ ReportTaxType	string	optional
└ TaxComponents	array	optional
└ Name	string	optional
└ Rate	number	optional
└ IsCompound	boolean	optional
└ IsNonRecoverable	boolean	optional
└ DisplayTaxRate	number	optional
└ CanApplyToAssets	boolean	optional
└ CanApplyToEquity	boolean	optional
└ CanApplyToRevenue	boolean	optional
└ CanApplyToExpenses	boolean	optional
└ CanApplyToLiabilities	boolean	optional

Responses

200

Success - return response of type TaxRates array updated TaxRate

400

A failed request due to validation error

POST /TaxRates

PUT /TaxRates Creates one or more tax rates

operationId: Accounting_updateTaxRates

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
Idempotency-Key	header	optional	string	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request Body

required

TaxRates array with TaxRate object in body of request

application/json

schema TaxRates

Property	Type	Required
TaxRates	array	optional
└ Name	string	optional
└ Status	string	optional
└ TaxType	string	optional
└ EffectiveRate	number	optional
└ ReportTaxType	string	optional
└ TaxComponents	array	optional
└ Name	string	optional
└ Rate	number	optional
└ IsCompound	boolean	optional
└ IsNonRecoverable	boolean	optional
└ DisplayTaxRate	number	optional
└ CanApplyToAssets	boolean	optional
└ CanApplyToEquity	boolean	optional
└ CanApplyToRevenue	boolean	optional
└ CanApplyToExpenses	boolean	optional
└ CanApplyToLiabilities	boolean	optional

Responses

200

Success - return response of type TaxRates array newly created TaxRate

400

A failed request due to validation error

PUT /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

PUT /TrackingCategories Create tracking categories

operationId: Accounting_createTrackingCategories

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
Idempotency-Key	header	optional	string	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request Body

required

TrackingCategory object in body of request

application/json

schema TrackingCategory

Property	Type	Required
Name	string	optional
Option	string	optional
Status	string	optional
Options	array	optional
└ Name	string	optional
└ Status	string	optional
└ TrackingOptionID	string	optional
└ TrackingCategoryID	string	optional
TrackingOptionID	string	optional
TrackingCategoryID	string	optional

Responses

200

Success - return response of type TrackingCategories array of newly created TrackingCategory

400

A failed request due to validation error

PUT /TrackingCategories

DELETE /TrackingCategories/{TrackingCategoryID} Deletes a specific tracking category

operationId: Accounting_deleteTrackingCategory

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 deleted TrackingCategory

400

A failed request due to validation error

DELETE /TrackingCategories/{TrackingCategoryID}

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}

POST /TrackingCategories/{TrackingCategoryID} Updates a specific tracking category

operationId: Accounting_updateTrackingCategory

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
Idempotency-Key	header	optional	string	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
TrackingCategoryID	path	optional	string	Unique identifier for a TrackingCategory

Request Body

required

application/json

schema TrackingCategory

Property	Type	Required
Name	string	optional
Option	string	optional
Status	string	optional
Options	array	optional
└ Name	string	optional
└ Status	string	optional
└ TrackingOptionID	string	optional
└ TrackingCategoryID	string	optional
TrackingOptionID	string	optional
TrackingCategoryID	string	optional

Responses

200

Success - return response of type TrackingCategories array of updated TrackingCategory

400

A failed request due to validation error

POST /TrackingCategories/{TrackingCategoryID}

PUT /TrackingCategories/{TrackingCategoryID}/Options Creates options for a specific tracking category

operationId: Accounting_createOptions

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
Idempotency-Key	header	optional	string	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
TrackingCategoryID	path	optional	string	Unique identifier for a TrackingCategory

Request Body

required

TrackingOption object in body of request

application/json

schema TrackingOption

Property	Type	Required
Name	string	optional
Status	string	optional
TrackingOptionID	string	optional
TrackingCategoryID	string	optional

Responses

200

Success - return response of type TrackingOptions array of options for a specified category

400

A failed request due to validation error

PUT /TrackingCategories/{TrackingCategoryID}/Options

DELETE /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID} Deletes a specific option for a specific tracking category

operationId: Accounting_deleteTrackingOption

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
TrackingOptionID	path	optional	string	Unique identifier for a Tracking Option

Responses

200

Success - return response of type TrackingOptions array of remaining options for a specified category

400

A failed request due to validation error

DELETE /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}

POST /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID} Updates a specific option for a specific tracking category

operationId: Accounting_updateTrackingOption

Parameters

Name	In	Required	Type	Description
xero-tenant-id	header	optional	string	Xero identifier for Tenant
Idempotency-Key	header	optional	string	This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
TrackingCategoryID	path	optional	string	Unique identifier for a TrackingCategory
TrackingOptionID	path	optional	string	Unique identifier for a Tracking Option

Request Body

required

application/json

schema TrackingOption

Property	Type	Required
Name	string	optional
Status	string	optional
TrackingOptionID	string	optional
TrackingCategoryID	string	optional

Responses

200

Success - return response of type TrackingOptions array of options for a specified category

400

A failed request due to validation error

POST /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}

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}

Accounting 37 endpoints

Parameters

Request Body

Responses

Parameters

Request Body

Responses

Parameters

Responses

Parameters

Request Body

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Request Body

Responses

Parameters

Request Body

Responses

Parameters

Responses

Parameters

Request Body

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Request Body

Responses

Parameters

Responses

Parameters

Request Body

Responses

Parameters

Request Body

Responses

Parameters

Responses

Parameters

Responses

Parameters

Request Body

Responses

Parameters

Responses

Parameters

Responses

Parameters

Request Body

Responses

Parameters

Request Body

Responses

Parameters