Xero Accounting API

Claim this API

Are you the operator of Xero Accounting API? Submit a claim to establish contact with us.

Report an Issue

Found something wrong with Xero Accounting API? Let us know about broken links, changed auth, deprecated endpoints, or other issues.

Base URL: https://api.xero.com/api.xro/2.0
Auth: unknown
Endpoints: 102
Reachable: unknown
CORS: unknown

Links

Homepage: https://developer.xero.com
API Base: https://api.xero.com/api.xro/2.0

Endpoints

Method Path Summary Auth Last Status Latency
GET /BankTransactions Retrieves any spent or received money transactions
GET /BankTransactions/{BankTransactionID} Retrieves a single spent or received money transaction by using a unique bank transaction Id
GET /BankTransactions/{BankTransactionID}/Attachments Retrieves any attachments from a specific bank transactions
GET /BankTransactions/{BankTransactionID}/Attachments/{AttachmentID} Retrieves specific attachments from a specific BankTransaction using a unique attachment Id
GET /BankTransactions/{BankTransactionID}/Attachments/{FileName} Retrieves a specific attachment from a specific bank transaction by filename
GET /BankTransactions/{BankTransactionID}/History Retrieves history from a specific bank transaction using a unique bank transaction Id
GET /BankTransfers Retrieves all bank transfers
GET /BankTransfers/{BankTransferID} Retrieves specific bank transfers by using a unique bank transfer Id
GET /BankTransfers/{BankTransferID}/Attachments Retrieves attachments from a specific bank transfer
GET /BankTransfers/{BankTransferID}/Attachments/{AttachmentID} Retrieves a specific attachment from a specific bank transfer using a unique attachment ID
GET /BankTransfers/{BankTransferID}/Attachments/{FileName} Retrieves a specific attachment on a specific bank transfer by file name
GET /BankTransfers/{BankTransferID}/History Retrieves history from a specific bank transfer using a unique bank transfer Id
GET /BatchPayments Retrieves either one or many batch payments for invoices
GET /BatchPayments/{BatchPaymentID}/History Retrieves history from a specific batch payment
GET /BrandingThemes Retrieves all the branding themes
GET /BrandingThemes/{BrandingThemeID} Retrieves a specific branding theme using a unique branding theme Id
GET /BrandingThemes/{BrandingThemeID}/PaymentServices Retrieves the payment services for a specific branding theme
GET /ContactGroups Retrieves the contact Id and name of all the contacts in a contact group
GET /ContactGroups/{ContactGroupID} Retrieves a specific contact group by using a unique contact group Id
GET /Contacts Retrieves all contacts in a Xero organisation
GET /Contacts/{ContactID} Retrieves a specific contacts in a Xero organisation using a unique contact Id
GET /Contacts/{ContactID}/Attachments Retrieves attachments for a specific contact in a Xero organisation
GET /Contacts/{ContactID}/Attachments/{AttachmentID} Retrieves a specific attachment from a specific contact using a unique attachment Id
GET /Contacts/{ContactID}/Attachments/{FileName} Retrieves a specific attachment from a specific contact by file name
GET /Contacts/{ContactID}/CISSettings Retrieves CIS settings for a specific contact in a Xero organisation
GET /Contacts/{ContactID}/History Retrieves history records for a specific contact
GET /Contacts/{ContactNumber} Retrieves a specific contact by contact number in a Xero organisation
GET /CreditNotes Retrieves any credit notes
GET /CreditNotes/{CreditNoteID} Retrieves a specific credit note using a unique credit note Id
GET /CreditNotes/{CreditNoteID}/Attachments Retrieves attachments for a specific credit notes
GET /CreditNotes/{CreditNoteID}/Attachments/{AttachmentID} Retrieves a specific attachment from a specific credit note using a unique attachment Id
GET /CreditNotes/{CreditNoteID}/Attachments/{FileName} Retrieves a specific attachment on a specific credit note by file name
GET /CreditNotes/{CreditNoteID}/History Retrieves history records of a specific credit note
GET /CreditNotes/{CreditNoteID}/pdf Retrieves credit notes as PDF files
GET /Currencies Retrieves currencies for your Xero organisation
GET /Employees Retrieves employees used in Xero payrun
GET /Employees/{EmployeeID} Retrieves a specific employee used in Xero payrun using a unique employee Id
GET /ExpenseClaims Retrieves expense claims
GET /ExpenseClaims/{ExpenseClaimID} Retrieves a specific expense claim using a unique expense claim Id
GET /ExpenseClaims/{ExpenseClaimID}/History Retrieves history records of a specific expense claim
GET /Items Retrieves items
GET /Items/{ItemID} Retrieves a specific item using a unique item Id
GET /Items/{ItemID}/History Retrieves history for a specific item
GET /Journals Retrieves journals
GET /Journals/{JournalID} Retrieves a specific journal using a unique journal Id.
GET /LinkedTransactions Retrieves linked transactions (billable expenses)
GET /LinkedTransactions/{LinkedTransactionID} Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id
GET /ManualJournals Retrieves manual journals
GET /ManualJournals/{ManualJournalID} Retrieves a specific manual journal
GET /ManualJournals/{ManualJournalID}/Attachments Retrieves attachment for a specific manual journal
GET /ManualJournals/{ManualJournalID}/Attachments/{AttachmentID} Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id
GET /ManualJournals/{ManualJournalID}/Attachments/{FileName} Retrieves a specific attachment from a specific manual journal by file name
GET /ManualJournals/{ManualJournalID}/History Retrieves history for a specific manual journal
GET /Organisation Retrieves Xero organisation details
GET /Organisation/Actions Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.
GET /Organisation/{OrganisationID}/CISSettings Retrieves the CIS settings for the Xero organistaion.
GET /Overpayments Retrieves overpayments
GET /Overpayments/{OverpaymentID} Retrieves a specific overpayment using a unique overpayment Id
GET /Overpayments/{OverpaymentID}/History Retrieves history records of a specific overpayment
GET /PaymentServices Retrieves payment services
GET /Prepayments Retrieves prepayments
GET /Prepayments/{PrepaymentID} Allows you to retrieve a specified prepayments
GET /Prepayments/{PrepaymentID}/History Retrieves history record for a specific prepayment
GET /PurchaseOrders Retrieves purchase orders
GET /PurchaseOrders/{PurchaseOrderID} Retrieves a specific purchase order using a unique purchase order Id
GET /PurchaseOrders/{PurchaseOrderID}/Attachments Retrieves attachments for a specific purchase order
GET /PurchaseOrders/{PurchaseOrderID}/Attachments/{AttachmentID} Retrieves specific attachment for a specific purchase order using a unique attachment Id
GET /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName} Retrieves a specific attachment for a specific purchase order by filename
GET /PurchaseOrders/{PurchaseOrderID}/History Retrieves history for a specific purchase order
GET /PurchaseOrders/{PurchaseOrderID}/pdf Retrieves specific purchase order as PDF files using a unique purchase order Id
GET /PurchaseOrders/{PurchaseOrderNumber} Retrieves a specific purchase order using purchase order number
GET /Quotes Retrieves sales quotes
GET /Quotes/{QuoteID} Retrieves a specific quote using a unique quote Id
GET /Quotes/{QuoteID}/Attachments Retrieves attachments for a specific quote
GET /Quotes/{QuoteID}/Attachments/{AttachmentID} Retrieves a specific attachment from a specific quote using a unique attachment Id
GET /Quotes/{QuoteID}/Attachments/{FileName} Retrieves a specific attachment from a specific quote by filename
GET /Quotes/{QuoteID}/History Retrieves history records of a specific quote
GET /Quotes/{QuoteID}/pdf Retrieves a specific quote as a PDF file using a unique quote Id
GET /Receipts Retrieves draft expense claim receipts for any user
GET /Receipts/{ReceiptID} Retrieves a specific draft expense claim receipt by using a unique receipt Id
GET /Receipts/{ReceiptID}/Attachments Retrieves attachments for a specific expense claim receipt
GET /Receipts/{ReceiptID}/Attachments/{AttachmentID} Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id
GET /Receipts/{ReceiptID}/Attachments/{FileName} Retrieves a specific attachment from a specific expense claim receipts by file name
GET /Receipts/{ReceiptID}/History Retrieves a history record for a specific receipt
GET /RepeatingInvoices Retrieves repeating invoices
GET /RepeatingInvoices/{RepeatingInvoiceID} Retrieves a specific repeating invoice by using a unique repeating invoice Id
GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments Retrieves attachments from a specific repeating invoice
GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID} Retrieves a specific attachment from a specific repeating invoice
GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} Retrieves a specific attachment from a specific repeating invoices by file name
GET /RepeatingInvoices/{RepeatingInvoiceID}/History Retrieves history record for a specific repeating invoice
GET /Reports Retrieves report for BAS (only valid for AU orgs)
GET /Reports/AgedPayablesByContact Retrieves report for aged payables by contact
GET /Reports/AgedReceivablesByContact Retrieves report for aged receivables by contact
GET /Reports/BalanceSheet Retrieves report for balancesheet
GET /Reports/BankSummary Retrieves report for bank summary
GET /Reports/BudgetSummary Retrieves report for budget summary
GET /Reports/ExecutiveSummary Retrieves report for executive summary
GET /Reports/ProfitAndLoss Retrieves report for profit and loss
GET /Reports/TenNinetyNine Retrieve reports for 1099
GET /Reports/TrialBalance Retrieves report for trial balance
GET /Reports/{ReportID} Retrieves a specific report for BAS using a unique report Id (only valid for AU orgs)
GET /TaxRates Retrieves tax rates
GET /TrackingCategories Retrieves tracking categories and options
GET /TrackingCategories/{TrackingCategoryID} Retrieves specific tracking categories and options using a unique tracking category Id