Xero Accounting API
Xero Accounting API endpoints from Xero
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Xero Accounting API endpoints from Xero
Endpoints 235
Accounting
- GETRetrieves the full chart of accounts
/Accounts?where=Status=="ACTIVE" AND Type=="BANK"&order=Name ASC - PUTCreates a new chart of accounts
/Accounts - GETRetrieves a single chart of accounts by using a unique account Id
/Accounts/:AccountID - POSTUpdates a chart of accounts
/Accounts/:AccountID - DELETEDeletes a chart of accounts
/Accounts/:AccountID - GETRetrieves attachments for a specific accounts by using a unique account Id
/Accounts/:AccountID/Attachments - GETRetrieves a specific attachment from a specific account using a unique attachment Id
/Accounts/:AccountID/Attachments/:AttachmentID - GETRetrieves an attachment for a specific account by filename
/Accounts/:AccountID/Attachments/:FileName - PUTCreates an attachment on a specific account
/Accounts/:AccountID/Attachments/:FileName - POSTUpdates attachment on a specific account by filename
/Accounts/:AccountID/Attachments/:FileName - GETRetrieves either one or many batch payments for invoices
/BatchPayments?where=Status=="AUTHORISED"&order=Date ASC - PUTCreates one or many batch payments for invoices
/BatchPayments?summarizeErrors=true - POSTUpdates a specific batch payment for invoices and credit notes
/BatchPayments - GETRetrieves a specific batch payment using a unique batch payment Id
/BatchPayments/:BatchPaymentID - POSTUpdates a specific batch payment for invoices and credit notes
/BatchPayments/:BatchPaymentID - GETRetrieves history from a specific batch payment
/BatchPayments/:BatchPaymentID/History - PUTCreates a history record for a specific batch payment
/BatchPayments/:BatchPaymentID/History - GETRetrieves any spent or received money transactions
/BankTransactions?where=Status=="AUTHORISED"&order=Type ASC&page=1&unitdp=4&pageSize=100&References="Ref1", "Ref2" - PUTCreates one or more spent or received money transaction
/BankTransactions?summarizeErrors=true&unitdp=4 - POSTUpdates or creates one or more spent or received money transaction
/BankTransactions?summarizeErrors=true&unitdp=4 - GETRetrieves a single spent or received money transaction by using a unique bank transaction Id
/BankTransactions/:BankTransactionID?unitdp=4 - POSTUpdates a single spent or received money transaction
/BankTransactions/:BankTransactionID?unitdp=4 - GETRetrieves any attachments from a specific bank transactions
/BankTransactions/:BankTransactionID/Attachments - GETRetrieves specific attachments from a specific BankTransaction using a unique attachment Id
/BankTransactions/:BankTransactionID/Attachments/:AttachmentID - GETRetrieves a specific attachment from a specific bank transaction by filename
/BankTransactions/:BankTransactionID/Attachments/:FileName - PUTCreates an attachment for a specific bank transaction by filename
/BankTransactions/:BankTransactionID/Attachments/:FileName - POSTUpdates a specific attachment from a specific bank transaction by filename
/BankTransactions/:BankTransactionID/Attachments/:FileName - GETRetrieves history from a specific bank transaction using a unique bank transaction Id
/BankTransactions/:BankTransactionID/History - PUTCreates a history record for a specific bank transactions
/BankTransactions/:BankTransactionID/History - GETRetrieves all bank transfers
/BankTransfers?where=HasAttachments==true&order=Amount ASC&includeDeleted=true - PUTCreates a bank transfer
/BankTransfers - POSTDeletes one or more bank transfers
/BankTransfers?summarizeErrors=true - GETRetrieves specific bank transfers by using a unique bank transfer Id
/BankTransfers/:BankTransferID - POSTDeletes a specific bank transfer
/BankTransfers/:BankTransferID - GETRetrieves attachments from a specific bank transfer
/BankTransfers/:BankTransferID/Attachments - GETRetrieves a specific attachment from a specific bank transfer using a unique attachment ID
/BankTransfers/:BankTransferID/Attachments/:AttachmentID - GETRetrieves a specific attachment on a specific bank transfer by file name
/BankTransfers/:BankTransferID/Attachments/:FileName - PUTcreateBankTransferAttachmentByFileName
/BankTransfers/:BankTransferID/Attachments/:FileName - POSTupdateBankTransferAttachmentByFileName
/BankTransfers/:BankTransferID/Attachments/:FileName - GETRetrieves history from a specific bank transfer using a unique bank transfer Id
/BankTransfers/:BankTransferID/History - PUTCreates a history record for a specific bank transfer
/BankTransfers/:BankTransferID/History - GETRetrieves all the branding themes
/BrandingThemes - GETRetrieves a specific branding theme using a unique branding theme Id
/BrandingThemes/:BrandingThemeID - GETRetrieves the payment services for a specific branding theme
/BrandingThemes/:BrandingThemeID/PaymentServices - POSTCreates a new custom payment service for a specific branding theme
/BrandingThemes/:BrandingThemeID/PaymentServices - GETRetrieve a list of budgets
/Budgets?IDs="00000000-0000-0000-0000-000000000000"&DateTo=2019-10-31&DateFrom=2019-10-31 - GETRetrieves a specific budget, which includes budget lines
/Budgets/:BudgetID?DateTo=2019-10-31&DateFrom=2019-10-31 - GETRetrieves all contacts in a Xero organisation
/Contacts?where=ContactStatus=="ACTIVE"&order=Name ASC&IDs="00000000-0000-0000-0000-000000000000"&page=1&includeArchived=true&summaryOnly=true&searchTerm=Joe Bloggs&pageSize=100 - PUTCreates multiple contacts (bulk) in a Xero organisation
/Contacts?summarizeErrors=true - POSTUpdates or creates one or more contacts in a Xero organisation
/Contacts?summarizeErrors=true - GETRetrieves a specific contact by contact number in a Xero organisation
/Contacts/:ContactNumber - GETRetrieves a specific contacts in a Xero organisation using a unique contact Id
/Contacts/:ContactID - POSTUpdates a specific contact in a Xero organisation
/Contacts/:ContactID - GETRetrieves attachments for a specific contact in a Xero organisation
/Contacts/:ContactID/Attachments - GETRetrieves a specific attachment from a specific contact using a unique attachment Id
/Contacts/:ContactID/Attachments/:AttachmentID - GETRetrieves a specific attachment from a specific contact by file name
/Contacts/:ContactID/Attachments/:FileName - PUTcreateContactAttachmentByFileName
/Contacts/:ContactID/Attachments/:FileName - POSTupdateContactAttachmentByFileName
/Contacts/:ContactID/Attachments/:FileName - GETRetrieves CIS settings for a specific contact in a Xero organisation
/Contacts/:ContactID/CISSettings - GETRetrieves history records for a specific contact
/Contacts/:ContactID/History - PUTCreates a new history record for a specific contact
/Contacts/:ContactID/History - GETRetrieves the contact Id and name of each contact group
/ContactGroups?where=Status=="ACTIVE"&order=Name ASC - PUTCreates a contact group
/ContactGroups - GETRetrieves a specific contact group by using a unique contact group Id
/ContactGroups/:ContactGroupID - POSTUpdates a specific contact group
/ContactGroups/:ContactGroupID - PUTCreates contacts to a specific contact group
/ContactGroups/:ContactGroupID/Contacts - DELETEDeletes all contacts from a specific contact group
/ContactGroups/:ContactGroupID/Contacts - DELETEDeletes a specific contact from a contact group using a unique contact Id
/ContactGroups/:ContactGroupID/Contacts/:ContactID - GETRetrieves any credit notes
/CreditNotes?where=Status=="DRAFT"&order=CreditNoteNumber ASC&page=1&unitdp=4&pageSize=100 - PUTCreates a new credit note
/CreditNotes?summarizeErrors=true&unitdp=4 - POSTUpdates or creates one or more credit notes
/CreditNotes?summarizeErrors=true&unitdp=4 - GETRetrieves a specific credit note using a unique credit note Id
/CreditNotes/:CreditNoteID?unitdp=4 - POSTUpdates a specific credit note
/CreditNotes/:CreditNoteID?unitdp=4 - GETRetrieves attachments for a specific credit notes
/CreditNotes/:CreditNoteID/Attachments - GETRetrieves a specific attachment from a specific credit note using a unique attachment Id
/CreditNotes/:CreditNoteID/Attachments/:AttachmentID - GETRetrieves a specific attachment on a specific credit note by file name
/CreditNotes/:CreditNoteID/Attachments/:FileName - PUTCreates an attachment for a specific credit note
/CreditNotes/:CreditNoteID/Attachments/:FileName?IncludeOnline=true - POSTUpdates attachments on a specific credit note by file name
/CreditNotes/:CreditNoteID/Attachments/:FileName - GETRetrieves credit notes as PDF files
/CreditNotes/:CreditNoteID/pdf - PUTCreates allocation for a specific credit note
/CreditNotes/:CreditNoteID/Allocations?summarizeErrors=true - DELETEDeletes an Allocation from a Credit Note
/CreditNotes/:CreditNoteID/Allocations/:AllocationID - GETRetrieves history records of a specific credit note
/CreditNotes/:CreditNoteID/History - PUTRetrieves history records of a specific credit note
/CreditNotes/:CreditNoteID/History - GETRetrieves currencies for your Xero organisation
/Currencies?where=Code=="USD"&order=Code ASC - PUTCreate a new currency for a Xero organisation
/Currencies - GETRetrieves expense claims
/ExpenseClaims?where=Status=="SUBMITTED"&order=Status ASC - PUTCreates expense claims
/ExpenseClaims - GETRetrieves a specific expense claim using a unique expense claim Id
/ExpenseClaims/:ExpenseClaimID - POSTUpdates a specific expense claims
/ExpenseClaims/:ExpenseClaimID - GETRetrieves history records of a specific expense claim
/ExpenseClaims/:ExpenseClaimID/History - PUTCreates a history record for a specific expense claim
/ExpenseClaims/:ExpenseClaimID/History - GETRetrieves sales invoices or purchase bills
/Invoices?where=Status=="DRAFT"&order=InvoiceNumber ASC&IDs="00000000-0000-0000-0000-000000000000"&InvoiceNumbers="INV-001", "INV-002"&ContactIDs="00000000-0000-0000-0000-000000000000"&Statuses="DRAFT", "SUBMITTED"&page=1&includeArchived=true&createdByMyApp=false&unitdp=4&summaryOnly=true&pageSize=100&searchTerm=SearchTerm=REF12 - PUTCreates one or more sales invoices or purchase bills
/Invoices?summarizeErrors=true&unitdp=4&allowBackorders=true - POSTUpdates or creates one or more sales invoices or purchase bills
/Invoices?summarizeErrors=true&unitdp=4&allowBackorders=true - GETRetrieves a specific sales invoice or purchase bill using a unique invoice Id
/Invoices/:InvoiceID?unitdp=4 - POSTUpdates a specific sales invoices or purchase bills
/Invoices/:InvoiceID?unitdp=4&allowBackorders=true - GETRetrieves invoices or purchase bills as PDF files
/Invoices/:InvoiceID/pdf - GETRetrieves attachments for a specific invoice or purchase bill
/Invoices/:InvoiceID/Attachments - GETRetrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id
/Invoices/:InvoiceID/Attachments/:AttachmentID - GETRetrieves an attachment from a specific invoice or purchase bill by filename
/Invoices/:InvoiceID/Attachments/:FileName - PUTCreates an attachment for a specific invoice or purchase bill by filename
/Invoices/:InvoiceID/Attachments/:FileName?IncludeOnline=true - POSTUpdates an attachment from a specific invoices or purchase bill by filename
/Invoices/:InvoiceID/Attachments/:FileName - GETRetrieves a URL to an online invoice
/Invoices/:InvoiceID/OnlineInvoice - POSTSends a copy of a specific invoice to related contact via email
/Invoices/:InvoiceID/Email - GETRetrieves history records for a specific invoice
/Invoices/:InvoiceID/History - PUTCreates a history record for a specific invoice
/Invoices/:InvoiceID/History - GETRetrieves invoice reminder settings
/InvoiceReminders/Settings - GETRetrieves items
/Items?where=IsSold==true&order=Code ASC&unitdp=4 - PUTCreates one or more items
/Items?summarizeErrors=true&unitdp=4 - POSTUpdates or creates one or more items
/Items?summarizeErrors=true&unitdp=4 - GETRetrieves a specific item using a unique item Id
/Items/:ItemID?unitdp=4 - POSTUpdates a specific item
/Items/:ItemID?unitdp=4 - DELETEDeletes a specific item
/Items/:ItemID - GETRetrieves history for a specific item
/Items/:ItemID/History - PUTCreates a history record for a specific item
/Items/:ItemID/History - GETRetrieves journals
/Journals?offset=10&paymentsOnly=true - GETRetrieves a specific journal using a unique journal Id.
/Journals/:JournalID - GETRetrieves a specific journal using a unique journal number.
/Journals/:JournalNumber - GETRetrieves linked transactions (billable expenses)
/LinkedTransactions?page=1&LinkedTransactionID=00000000-0000-0000-0000-000000000000&SourceTransactionID=00000000-0000-0000-0000-000000000000&ContactID=00000000-0000-0000-0000-000000000000&Status=APPROVED&TargetTransactionID=00000000-0000-0000-0000-000000000000 - PUTCreates linked transactions (billable expenses)
/LinkedTransactions - GETRetrieves a specific linked transaction (billable expenses) using a unique linked transaction Id
/LinkedTransactions/:LinkedTransactionID - POSTUpdates a specific linked transactions (billable expenses)
/LinkedTransactions/:LinkedTransactionID - DELETEDeletes a specific linked transactions (billable expenses)
/LinkedTransactions/:LinkedTransactionID - GETRetrieves manual journals
/ManualJournals?where=Status=="DRAFT"&order=Date ASC&page=1&pageSize=100 - PUTCreates one or more manual journals
/ManualJournals?summarizeErrors=true - POSTUpdates or creates a single manual journal
/ManualJournals?summarizeErrors=true - GETRetrieves a specific manual journal
/ManualJournals/:ManualJournalID - POSTUpdates a specific manual journal
/ManualJournals/:ManualJournalID - GETRetrieves attachment for a specific manual journal
/ManualJournals/:ManualJournalID/Attachments - GETAllows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id
/ManualJournals/:ManualJournalID/Attachments/:AttachmentID - GETRetrieves a specific attachment from a specific manual journal by file name
/ManualJournals/:ManualJournalID/Attachments/:FileName - PUTCreates a specific attachment for a specific manual journal by file name
/ManualJournals/:ManualJournalID/Attachments/:FileName - POSTUpdates a specific attachment from a specific manual journal by file name
/ManualJournals/:ManualJournalID/Attachments/:FileName - GETRetrieves history for a specific manual journal
/ManualJournals/:ManualJournalID/History - PUTCreates a history record for a specific manual journal
/ManualJournals/:ManualJournalID/History - GETRetrieves Xero organisation details
/Organisation - GETRetrieves a list of the key actions your app has permission to perform in the connected Xero organisation.
/Organisation/Actions - GETRetrieves the CIS settings for the Xero organistaion.
/Organisation/:OrganisationID/CISSettings - GETRetrieves overpayments
/Overpayments?where=Status=="AUTHORISED"&order=Status ASC&page=1&unitdp=4&pageSize=100&References="Ref1", "Ref2" - GETRetrieves a specific overpayment using a unique overpayment Id
/Overpayments/:OverpaymentID - PUTCreates a single allocation for a specific overpayment
/Overpayments/:OverpaymentID/Allocations?summarizeErrors=true - DELETEDeletes an Allocation from an overpayment
/Overpayments/:OverpaymentID/Allocations/:AllocationID - GETRetrieves history records of a specific overpayment
/Overpayments/:OverpaymentID/History - PUTCreates a history record for a specific overpayment
/Overpayments/:OverpaymentID/History - GETRetrieves payments for invoices and credit notes
/Payments?where=Status=="AUTHORISED"&order=Amount ASC&page=1&pageSize=100 - PUTCreates multiple payments for invoices or credit notes
/Payments?summarizeErrors=true - POSTCreates a single payment for invoice or credit notes
/Payments - GETRetrieves a specific payment for invoices and credit notes using a unique payment Id
/Payments/:PaymentID - POSTUpdates a specific payment for invoices and credit notes
/Payments/:PaymentID - GETRetrieves history records of a specific payment
/Payments/:PaymentID/History - PUTCreates a history record for a specific payment
/Payments/:PaymentID/History - GETRetrieves payment services
/PaymentServices - PUTCreates a payment service
/PaymentServices - GETRetrieves prepayments
/Prepayments?where=Status=="AUTHORISED"&order=Reference ASC&page=1&unitdp=4&pageSize=100&InvoiceNumbers="INV-001", "INV-002"&References="Ref1", "Ref2" - GETAllows you to retrieve a specified prepayments
/Prepayments/:PrepaymentID - PUTAllows you to create an Allocation for prepayments
/Prepayments/:PrepaymentID/Allocations?summarizeErrors=true - DELETEDeletes an Allocation from a Prepayment
/Prepayments/:PrepaymentID/Allocations/:AllocationID - GETRetrieves history record for a specific prepayment
/Prepayments/:PrepaymentID/History - PUTCreates a history record for a specific prepayment
/Prepayments/:PrepaymentID/History - GETRetrieves purchase orders
/PurchaseOrders?Status=SUBMITTED&DateFrom=2019-12-01&DateTo=2019-12-31&order=PurchaseOrderNumber ASC&page=1&pageSize=100 - PUTCreates one or more purchase orders
/PurchaseOrders?summarizeErrors=true - POSTUpdates or creates one or more purchase orders
/PurchaseOrders?summarizeErrors=true - GETRetrieves specific purchase order as PDF files using a unique purchase order Id
/PurchaseOrders/:PurchaseOrderID/pdf - GETRetrieves a specific purchase order using a unique purchase order Id
/PurchaseOrders/:PurchaseOrderID - POSTUpdates a specific purchase order
/PurchaseOrders/:PurchaseOrderID - GETRetrieves a specific purchase order using purchase order number
/PurchaseOrders/:PurchaseOrderNumber - GETRetrieves history for a specific purchase order
/PurchaseOrders/:PurchaseOrderID/History - PUTCreates a history record for a specific purchase orders
/PurchaseOrders/:PurchaseOrderID/History - GETRetrieves attachments for a specific purchase order
/PurchaseOrders/:PurchaseOrderID/Attachments - GETRetrieves specific attachment for a specific purchase order using a unique attachment Id
/PurchaseOrders/:PurchaseOrderID/Attachments/:AttachmentID - GETRetrieves a specific attachment for a specific purchase order by filename
/PurchaseOrders/:PurchaseOrderID/Attachments/:FileName - PUTCreates attachment for a specific purchase order
/PurchaseOrders/:PurchaseOrderID/Attachments/:FileName - POSTUpdates a specific attachment for a specific purchase order by filename
/PurchaseOrders/:PurchaseOrderID/Attachments/:FileName - GETRetrieves sales quotes
/Quotes?DateFrom=2019-10-31&DateTo=2019-10-31&ExpiryDateFrom=2019-10-31&ExpiryDateTo=2019-10-31&ContactID=00000000-0000-0000-0000-000000000000&Status=DRAFT&page=1&order=Status ASC&QuoteNumber=QU-0001 - PUTCreate one or more quotes
/Quotes?summarizeErrors=true - POSTUpdates or creates one or more quotes
/Quotes?summarizeErrors=true - GETRetrieves a specific quote using a unique quote Id
/Quotes/:QuoteID - POSTUpdates a specific quote
/Quotes/:QuoteID - GETRetrieves history records of a specific quote
/Quotes/:QuoteID/History - PUTCreates a history record for a specific quote
/Quotes/:QuoteID/History - GETRetrieves a specific quote as a PDF file using a unique quote Id
/Quotes/:QuoteID/pdf - GETRetrieves attachments for a specific quote
/Quotes/:QuoteID/Attachments - GETRetrieves a specific attachment from a specific quote using a unique attachment Id
/Quotes/:QuoteID/Attachments/:AttachmentID - GETRetrieves a specific attachment from a specific quote by filename
/Quotes/:QuoteID/Attachments/:FileName - PUTCreates attachment for a specific quote
/Quotes/:QuoteID/Attachments/:FileName - POSTUpdates a specific attachment from a specific quote by filename
/Quotes/:QuoteID/Attachments/:FileName - GETRetrieves draft expense claim receipts for any user
/Receipts?where=Status=="DRAFT"&order=ReceiptNumber ASC&unitdp=4 - PUTCreates draft expense claim receipts for any user
/Receipts?unitdp=4 - GETRetrieves a specific draft expense claim receipt by using a unique receipt Id
/Receipts/:ReceiptID?unitdp=4 - POSTUpdates a specific draft expense claim receipts
/Receipts/:ReceiptID?unitdp=4 - GETRetrieves attachments for a specific expense claim receipt
/Receipts/:ReceiptID/Attachments - GETRetrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id
/Receipts/:ReceiptID/Attachments/:AttachmentID - GETRetrieves a specific attachment from a specific expense claim receipts by file name
/Receipts/:ReceiptID/Attachments/:FileName - PUTCreates an attachment on a specific expense claim receipts by file name
/Receipts/:ReceiptID/Attachments/:FileName - POSTUpdates a specific attachment on a specific expense claim receipts by file name
/Receipts/:ReceiptID/Attachments/:FileName - GETRetrieves a history record for a specific receipt
/Receipts/:ReceiptID/History - PUTCreates a history record for a specific receipt
/Receipts/:ReceiptID/History - GETRetrieves repeating invoices
/RepeatingInvoices?where=Status=="DRAFT"&order=Total ASC - PUTCreates one or more repeating invoice templates
/RepeatingInvoices?summarizeErrors=true - POSTCreates or deletes one or more repeating invoice templates
/RepeatingInvoices?summarizeErrors=true - GETRetrieves a specific repeating invoice by using a unique repeating invoice Id
/RepeatingInvoices/:RepeatingInvoiceID - POSTDeletes a specific repeating invoice template
/RepeatingInvoices/:RepeatingInvoiceID - GETRetrieves attachments from a specific repeating invoice
/RepeatingInvoices/:RepeatingInvoiceID/Attachments - GETRetrieves a specific attachment from a specific repeating invoice
/RepeatingInvoices/:RepeatingInvoiceID/Attachments/:AttachmentID - GETRetrieves a specific attachment from a specific repeating invoices by file name
/RepeatingInvoices/:RepeatingInvoiceID/Attachments/:FileName - PUTCreates an attachment from a specific repeating invoices by file name
/RepeatingInvoices/:RepeatingInvoiceID/Attachments/:FileName - POSTUpdates a specific attachment from a specific repeating invoices by file name
/RepeatingInvoices/:RepeatingInvoiceID/Attachments/:FileName - GETRetrieves history record for a specific repeating invoice
/RepeatingInvoices/:RepeatingInvoiceID/History - PUTCreates a history record for a specific repeating invoice
/RepeatingInvoices/:RepeatingInvoiceID/History - GETRetrieve reports for 1099
/Reports/TenNinetyNine?reportYear=2019 - GETRetrieves report for aged payables by contact
/Reports/AgedPayablesByContact?contactId=00000000-0000-0000-0000-000000000000&date=2019-10-31&fromDate=2019-10-31&toDate=2019-10-31 - GETRetrieves report for aged receivables by contact
/Reports/AgedReceivablesByContact?contactId=00000000-0000-0000-0000-000000000000&date=2019-10-31&fromDate=2019-10-31&toDate=2019-10-31 - GETRetrieves report for balancesheet
/Reports/BalanceSheet?date=2019-11-01&periods=3&timeframe=MONTH&trackingOptionID1=00000000-0000-0000-0000-000000000000&trackingOptionID2=00000000-0000-0000-0000-000000000000&standardLayout=true&paymentsOnly=false - GETRetrieves report for bank summary
/Reports/BankSummary?fromDate=2019-10-31&toDate=2019-10-31 - GETRetrieves a specific report using a unique ReportID
/Reports/:ReportID - GETRetrieves report for budget summary
/Reports/BudgetSummary?date=2019-03-31&periods=2&timeframe=3 - GETRetrieves report for executive summary
/Reports/ExecutiveSummary?date=2019-03-31 - GETRetrieves a list of the organistaions unique reports that require a uuid to fetch
/Reports - GETRetrieves report for profit and loss
/Reports/ProfitAndLoss?fromDate=2019-10-31&toDate=2019-10-31&periods=3&timeframe=MONTH&trackingCategoryID=00000000-0000-0000-0000-000000000000&trackingCategoryID2=00000000-0000-0000-0000-000000000000&trackingOptionID=00000000-0000-0000-0000-000000000000&trackingOptionID2=00000000-0000-0000-0000-000000000000&standardLayout=true&paymentsOnly=false - GETRetrieves report for trial balance
/Reports/TrialBalance?date=2019-10-31&paymentsOnly=true - POSTSets the chart of accounts, the conversion date and conversion balances
/Setup - GETRetrieves tax rates
/TaxRates?where=Status=="ACTIVE"&order=Name ASC - PUTCreates one or more tax rates
/TaxRates - POSTUpdates tax rates
/TaxRates - GETRetrieves a specific tax rate according to given TaxType code
/TaxRates/:TaxType - GETRetrieves tracking categories and options
/TrackingCategories?where=Status=="ACTIVE"&order=Name ASC&includeArchived=true - PUTCreate tracking categories
/TrackingCategories - GETRetrieves specific tracking categories and options using a unique tracking category Id
/TrackingCategories/:TrackingCategoryID - POSTUpdates a specific tracking category
/TrackingCategories/:TrackingCategoryID - DELETEDeletes a specific tracking category
/TrackingCategories/:TrackingCategoryID - PUTCreates options for a specific tracking category
/TrackingCategories/:TrackingCategoryID/Options - POSTUpdates a specific option for a specific tracking category
/TrackingCategories/:TrackingCategoryID/Options/:TrackingOptionID - DELETEDeletes a specific option for a specific tracking category
/TrackingCategories/:TrackingCategoryID/Options/:TrackingOptionID - GETRetrieves users
/Users?where=IsSubscriber==true&order=LastName ASC - GETRetrieves a specific user
/Users/:UserID
API details
- Base URL
https://api.xero.com/api.xro/2.0- Authentication
- OAuth 2.0 (authorization code flow) with 16 scopes
- Operations
- 235 operations on 138 pathsGET 126PUT 53POST 46DELETE 10
- Main resources
- Accounting 235
- Response formats
application/jsonapplication/octet-streamapplication/pdf- Description format
- OpenAPI 3.0.0, API version
20.1.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Xero's published OpenAPI description (XeroAPI/Xero-OpenAPI) (MIT)
How to test the Xero Accounting API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Xero Accounting API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 16 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Retrieves the full chart of accounts” (GET /Accounts?where=Status=="ACTIVE" AND Type=="BANK"&order=Name ASC), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Xero Accounting API?
Xero Accounting API endpoints from Xero It is listed under Finance & banking and has 235 endpoints.
Who publishes the Xero Accounting API?
It is listed from Xero's public API description (an OpenAPI document), not published by Xero on Swastik Codes. Anyone who controls xero.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Xero Accounting API?
Requests go to https://api.xero.com/api.xro/2.0. Endpoint paths are added to this base URL.
How do I authenticate with the Xero Accounting API?
With OAuth 2.0 (authorization code flow) with 16 scopes.
How many endpoints does the Xero Accounting API have?
235 operations on 138 paths (126 GET, 53 PUT, 46 POST, 10 DELETE). The largest groups are Accounting.
Is forking the Xero Accounting API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.