/
XE
xeroapi
Search skmtc
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Accounting
235
get
/Accounts
Retrieves the full chart of accounts
put
/Accounts
Creates a new chart of accounts
get
/Accounts/{AccountID}
Retrieves a single chart of accounts by using a unique account Id
post
/Accounts/{AccountID}
Updates a chart of accounts
delete
/Accounts/{AccountID}
Deletes a chart of accounts
get
/Accounts/{AccountID}/Attachments
Retrieves attachments for a specific accounts by using a unique account Id
get
/Accounts/{AccountID}/Attachments/{AttachmentID}
Retrieves a specific attachment from a specific account using a unique attachment Id
get
/Accounts/{AccountID}/Attachments/{FileName}
Retrieves an attachment for a specific account by filename
put
/Accounts/{AccountID}/Attachments/{FileName}
Creates an attachment on a specific account
post
/Accounts/{AccountID}/Attachments/{FileName}
Updates attachment on a specific account by filename
get
/BatchPayments
Retrieves either one or many batch payments for invoices
put
/BatchPayments
Creates one or many batch payments for invoices
post
/BatchPayments
Updates a specific batch payment for invoices and credit notes
get
/BatchPayments/{BatchPaymentID}
Retrieves a specific batch payment using a unique batch payment Id
post
/BatchPayments/{BatchPaymentID}
Updates a specific batch payment for invoices and credit notes
get
/BatchPayments/{BatchPaymentID}/History
Retrieves history from a specific batch payment
put
/BatchPayments/{BatchPaymentID}/History
Creates a history record for a specific batch payment
get
/BankTransactions
Retrieves any spent or received money transactions
put
/BankTransactions
Creates one or more spent or received money transaction
post
/BankTransactions
Updates or creates one or more spent or received money transaction
get
/BankTransactions/{BankTransactionID}
Retrieves a single spent or received money transaction by using a unique bank transaction Id
post
/BankTransactions/{BankTransactionID}
Updates a single spent or received money transaction
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
put
/BankTransactions/{BankTransactionID}/Attachments/{FileName}
Creates an attachment for a specific bank transaction by filename
post
/BankTransactions/{BankTransactionID}/Attachments/{FileName}
Updates 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
put
/BankTransactions/{BankTransactionID}/History
Creates a history record for a specific bank transactions
get
/BankTransfers
Retrieves all bank transfers
put
/BankTransfers
Creates a bank transfer
post
/BankTransfers
Deletes one or more bank transfers
get
/BankTransfers/{BankTransferID}
Retrieves specific bank transfers by using a unique bank transfer Id
post
/BankTransfers/{BankTransferID}
Deletes a specific bank transfer
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
put
/BankTransfers/{BankTransferID}/Attachments/{FileName}
post
/BankTransfers/{BankTransferID}/Attachments/{FileName}
get
/BankTransfers/{BankTransferID}/History
Retrieves history from a specific bank transfer using a unique bank transfer Id
put
/BankTransfers/{BankTransferID}/History
Creates a history record for a specific bank transfer
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
post
/BrandingThemes/{BrandingThemeID}/PaymentServices
Creates a new custom payment service for a specific branding theme
get
/Budgets
Retrieve a list of budgets
get
/Budgets/{BudgetID}
Retrieves a specific budget, which includes budget lines
get
/Contacts
Retrieves all contacts in a Xero organisation
put
/Contacts
Creates multiple contacts (bulk) in a Xero organisation
post
/Contacts
Updates or creates one or more contacts in a Xero organisation
get
/Contacts/{ContactNumber}
Retrieves a specific contact by contact number in a Xero organisation
get
/Contacts/{ContactID}
Retrieves a specific contacts in a Xero organisation using a unique contact Id
post
/Contacts/{ContactID}
Updates a specific contact in a Xero organisation
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
put
/Contacts/{ContactID}/Attachments/{FileName}
post
/Contacts/{ContactID}/Attachments/{FileName}
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
put
/Contacts/{ContactID}/History
Creates a new history record for a specific contact
get
/ContactGroups
Retrieves the contact Id and name of each contact group
put
/ContactGroups
Creates a contact group
get
/ContactGroups/{ContactGroupID}
Retrieves a specific contact group by using a unique contact group Id
post
/ContactGroups/{ContactGroupID}
Updates a specific contact group
put
/ContactGroups/{ContactGroupID}/Contacts
Creates contacts to a specific contact group
delete
/ContactGroups/{ContactGroupID}/Contacts
Deletes all contacts from a specific contact group
delete
/ContactGroups/{ContactGroupID}/Contacts/{ContactID}
Deletes a specific contact from a contact group using a unique contact Id
get
/CreditNotes
Retrieves any credit notes
put
/CreditNotes
Creates a new credit note
post
/CreditNotes
Updates or creates one or more credit notes
get
/CreditNotes/{CreditNoteID}
Retrieves a specific credit note using a unique credit note Id
post
/CreditNotes/{CreditNoteID}
Updates a specific credit note
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
put
/CreditNotes/{CreditNoteID}/Attachments/{FileName}
Creates an attachment for a specific credit note
post
/CreditNotes/{CreditNoteID}/Attachments/{FileName}
Updates attachments on a specific credit note by file name
get
/CreditNotes/{CreditNoteID}/pdf
Retrieves credit notes as PDF files
put
/CreditNotes/{CreditNoteID}/Allocations
Creates allocation for a specific credit note
delete
/CreditNotes/{CreditNoteID}/Allocations/{AllocationID}
Deletes an Allocation from a Credit Note
get
/CreditNotes/{CreditNoteID}/History
Retrieves history records of a specific credit note
put
/CreditNotes/{CreditNoteID}/History
Retrieves history records of a specific credit note
get
/Currencies
Retrieves currencies for your Xero organisation
put
/Currencies
Create a new currency for a Xero organisation
get
/ExpenseClaims
Retrieves expense claims
put
/ExpenseClaims
Creates expense claims
get
/ExpenseClaims/{ExpenseClaimID}
Retrieves a specific expense claim using a unique expense claim Id
post
/ExpenseClaims/{ExpenseClaimID}
Updates a specific expense claims
get
/ExpenseClaims/{ExpenseClaimID}/History
Retrieves history records of a specific expense claim
put
/ExpenseClaims/{ExpenseClaimID}/History
Creates a history record for a specific expense claim
get
/Invoices
Retrieves sales invoices or purchase bills
put
/Invoices
Creates one or more sales invoices or purchase bills
post
/Invoices
Updates or creates one or more sales invoices or purchase bills
get
/Invoices/{InvoiceID}
Retrieves a specific sales invoice or purchase bill using a unique invoice Id
post
/Invoices/{InvoiceID}
Updates a specific sales invoices or purchase bills
get
/Invoices/{InvoiceID}/pdf
Retrieves invoices or purchase bills as PDF files
get
/Invoices/{InvoiceID}/Attachments
Retrieves attachments for a specific invoice or purchase bill
get
/Invoices/{InvoiceID}/Attachments/{AttachmentID}
Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id
get
/Invoices/{InvoiceID}/Attachments/{FileName}
Retrieves an attachment from a specific invoice or purchase bill by filename
put
/Invoices/{InvoiceID}/Attachments/{FileName}
Creates an attachment for a specific invoice or purchase bill by filename
post
/Invoices/{InvoiceID}/Attachments/{FileName}
Updates an attachment from a specific invoices or purchase bill by filename
get
/Invoices/{InvoiceID}/OnlineInvoice
Retrieves a URL to an online invoice
post
/Invoices/{InvoiceID}/Email
Sends a copy of a specific invoice to related contact via email
get
/Invoices/{InvoiceID}/History
Retrieves history records for a specific invoice
put
/Invoices/{InvoiceID}/History
Creates a history record for a specific invoice
get
/InvoiceReminders/Settings
Retrieves invoice reminder settings
get
/Items
Retrieves items
put
/Items
Creates one or more items
post
/Items
Updates or creates one or more items
get
/Items/{ItemID}
Retrieves a specific item using a unique item Id
post
/Items/{ItemID}
Updates a specific item
delete
/Items/{ItemID}
Deletes a specific item
get
/Items/{ItemID}/History
Retrieves history for a specific item
put
/Items/{ItemID}/History
Creates a history record for a specific item
get
/Journals
Retrieves journals
get
/Journals/{JournalID}
Retrieves a specific journal using a unique journal Id.
get
/Journals/{JournalNumber}
Retrieves a specific journal using a unique journal number.
get
/LinkedTransactions
Retrieves linked transactions (billable expenses)
put
/LinkedTransactions
Creates linked transactions (billable expenses)
get
/LinkedTransactions/{LinkedTransactionID}
Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id
post
/LinkedTransactions/{LinkedTransactionID}
Updates a specific linked transactions (billable expenses)
delete
/LinkedTransactions/{LinkedTransactionID}
Deletes a specific linked transactions (billable expenses)
get
/ManualJournals
Retrieves manual journals
put
/ManualJournals
Creates one or more manual journals
post
/ManualJournals
Updates or creates a single manual journal
get
/ManualJournals/{ManualJournalID}
Retrieves a specific manual journal
post
/ManualJournals/{ManualJournalID}
Updates 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
put
/ManualJournals/{ManualJournalID}/Attachments/{FileName}
Creates a specific attachment for a specific manual journal by file name
post
/ManualJournals/{ManualJournalID}/Attachments/{FileName}
Updates a specific attachment from a specific manual journal by file name
get
/ManualJournals/{ManualJournalID}/History
Retrieves history for a specific manual journal
put
/ManualJournals/{ManualJournalID}/History
Creates a history record 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
put
/Overpayments/{OverpaymentID}/Allocations
Creates a single allocation for a specific overpayment
delete
/Overpayments/{OverpaymentID}/Allocations/{AllocationID}
Deletes an Allocation from an overpayment
get
/Overpayments/{OverpaymentID}/History
Retrieves history records of a specific overpayment
put
/Overpayments/{OverpaymentID}/History
Creates a history record for a specific overpayment
get
/Payments
Retrieves payments for invoices and credit notes
put
/Payments
Creates multiple payments for invoices or credit notes
post
/Payments
Creates a single payment for invoice or credit notes
get
/Payments/{PaymentID}
Retrieves a specific payment for invoices and credit notes using a unique payment Id
post
/Payments/{PaymentID}
Updates a specific payment for invoices and credit notes
get
/Payments/{PaymentID}/History
Retrieves history records of a specific payment
put
/Payments/{PaymentID}/History
Creates a history record for a specific payment
get
/PaymentServices
Retrieves payment services
put
/PaymentServices
Creates a payment service
get
/Prepayments
Retrieves prepayments
get
/Prepayments/{PrepaymentID}
Allows you to retrieve a specified prepayments
put
/Prepayments/{PrepaymentID}/Allocations
Allows you to create an Allocation for prepayments
delete
/Prepayments/{PrepaymentID}/Allocations/{AllocationID}
Deletes an Allocation from a Prepayment
get
/Prepayments/{PrepaymentID}/History
Retrieves history record for a specific prepayment
put
/Prepayments/{PrepaymentID}/History
Creates a history record for a specific prepayment
get
/PurchaseOrders
Retrieves purchase orders
put
/PurchaseOrders
Creates one or more purchase orders
post
/PurchaseOrders
Updates or creates one or more purchase orders
get
/PurchaseOrders/{PurchaseOrderID}/pdf
Retrieves specific purchase order as PDF files using a unique purchase order Id
get
/PurchaseOrders/{PurchaseOrderID}
Retrieves a specific purchase order using a unique purchase order Id
post
/PurchaseOrders/{PurchaseOrderID}
Updates a specific purchase order
get
/PurchaseOrders/{PurchaseOrderNumber}
Retrieves a specific purchase order using purchase order number
get
/PurchaseOrders/{PurchaseOrderID}/History
Retrieves history for a specific purchase order
put
/PurchaseOrders/{PurchaseOrderID}/History
Creates a history record for a specific purchase orders
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
put
/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}
Creates attachment for a specific purchase order
post
/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}
Updates a specific attachment for a specific purchase order by filename
get
/Quotes
Retrieves sales quotes
put
/Quotes
Create one or more quotes
post
/Quotes
Updates or creates one or more quotes
get
/Quotes/{QuoteID}
Retrieves a specific quote using a unique quote Id
post
/Quotes/{QuoteID}
Updates a specific quote
get
/Quotes/{QuoteID}/History
Retrieves history records of a specific quote
put
/Quotes/{QuoteID}/History
Creates a history record for a specific quote
get
/Quotes/{QuoteID}/pdf
Retrieves a specific quote as a PDF file 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
put
/Quotes/{QuoteID}/Attachments/{FileName}
Creates attachment for a specific quote
post
/Quotes/{QuoteID}/Attachments/{FileName}
Updates a specific attachment from a specific quote by filename
get
/Receipts
Retrieves draft expense claim receipts for any user
put
/Receipts
Creates draft expense claim receipts for any user
get
/Receipts/{ReceiptID}
Retrieves a specific draft expense claim receipt by using a unique receipt Id
post
/Receipts/{ReceiptID}
Updates a specific draft expense claim receipts
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
put
/Receipts/{ReceiptID}/Attachments/{FileName}
Creates an attachment on a specific expense claim receipts by file name
post
/Receipts/{ReceiptID}/Attachments/{FileName}
Updates a specific attachment on a specific expense claim receipts by file name
get
/Receipts/{ReceiptID}/History
Retrieves a history record for a specific receipt
put
/Receipts/{ReceiptID}/History
Creates a history record for a specific receipt
get
/RepeatingInvoices
Retrieves repeating invoices
put
/RepeatingInvoices
Creates one or more repeating invoice templates
post
/RepeatingInvoices
Creates or deletes one or more repeating invoice templates
get
/RepeatingInvoices/{RepeatingInvoiceID}
Retrieves a specific repeating invoice by using a unique repeating invoice Id
post
/RepeatingInvoices/{RepeatingInvoiceID}
Deletes a specific repeating invoice template
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
put
/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}
Creates an attachment from a specific repeating invoices by file name
post
/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}
Updates a specific attachment from a specific repeating invoices by file name
get
/RepeatingInvoices/{RepeatingInvoiceID}/History
Retrieves history record for a specific repeating invoice
put
/RepeatingInvoices/{RepeatingInvoiceID}/History
Creates a history record for a specific repeating invoice
get
/Reports/TenNinetyNine
Retrieve reports for 1099
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/{ReportID}
Retrieves a specific report using a unique ReportID
get
/Reports/BudgetSummary
Retrieves report for budget summary
get
/Reports/ExecutiveSummary
Retrieves report for executive summary
get
/Reports
Retrieves a list of the organistaions unique reports that require a uuid to fetch
get
/Reports/ProfitAndLoss
Retrieves report for profit and loss
get
/Reports/TrialBalance
Retrieves report for trial balance
post
/Setup
Sets the chart of accounts, the conversion date and conversion balances
get
/TaxRates
Retrieves tax rates
put
/TaxRates
Creates one or more tax rates
post
/TaxRates
Updates tax rates
get
/TaxRates/{TaxType}
Retrieves a specific tax rate according to given TaxType code
get
/TrackingCategories
Retrieves tracking categories and options
put
/TrackingCategories
Create tracking categories
get
/TrackingCategories/{TrackingCategoryID}
Retrieves specific tracking categories and options using a unique tracking category Id
post
/TrackingCategories/{TrackingCategoryID}
Updates a specific tracking category
delete
/TrackingCategories/{TrackingCategoryID}
Deletes a specific tracking category
put
/TrackingCategories/{TrackingCategoryID}/Options
Creates options for a specific tracking category
post
/TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}
Updates a specific option for a specific tracking category
delete
/TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}
Deletes a specific option for a specific tracking category
get
/Users
Retrieves users
get
/Users/{UserID}
Retrieves a specific user
Accounting
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Retrieves a specific journal using a unique journal Id.
get
/Journals/{JournalID}
Jul 29, 2024
98ef773227e5
Revision changes
info
added the optional property
Warnings
to the response with the
200
status