/
XE
xeroapi
/
Xero Accounting API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 40m ago · Updated 1w ago
View markdown
xeroapi
Xero Accounting API
get
Retrieves payment services
latest
OpenAPI 3.0.0
raw.githubusercontent.com
2026-08-12
235
140
907.9 KB
f980dbcfc317
Accounting
235
get
Retrieves the full chart of accounts
put
Creates a new chart of accounts
get
Retrieves a single chart of accounts by using a unique account Id
post
Updates a chart of accounts
delete
Deletes a chart of accounts
get
Retrieves attachments for a specific accounts by using a unique account Id
get
Retrieves a specific attachment from a specific account using a unique attachment Id
get
Retrieves an attachment for a specific account by filename
put
Creates an attachment on a specific account
post
Updates attachment on a specific account by filename
get
Retrieves either one or many batch payments for invoices
put
Creates one or many batch payments for invoices
post
Updates a specific batch payment for invoices and credit notes
get
Retrieves a specific batch payment using a unique batch payment Id
post
Updates a specific batch payment for invoices and credit notes
get
Retrieves history from a specific batch payment
put
Creates a history record for a specific batch payment
get
Retrieves any spent or received money transactions
put
Creates one or more spent or received money transaction
post
Updates or creates one or more spent or received money transaction
get
Retrieves a single spent or received money transaction by using a unique bank transaction Id
post
Updates a single spent or received money transaction
get
Retrieves any attachments from a specific bank transactions
get
Retrieves specific attachments from a specific BankTransaction using a unique attachment Id
get
Retrieves a specific attachment from a specific bank transaction by filename
put
Creates an attachment for a specific bank transaction by filename
post
Updates a specific attachment from a specific bank transaction by filename
get
Retrieves history from a specific bank transaction using a unique bank transaction Id
put
Creates a history record for a specific bank transactions
get
Retrieves all bank transfers
put
Creates a bank transfer
post
Deletes one or more bank transfers
get
Retrieves specific bank transfers by using a unique bank transfer Id
post
Deletes a specific bank transfer
get
Retrieves attachments from a specific bank transfer
get
Retrieves a specific attachment from a specific bank transfer using a unique attachment ID
get
Retrieves a specific attachment on a specific bank transfer by file name
put
/BankTransfers/{BankTransferID}/Attachments/{FileName}
post
/BankTransfers/{BankTransferID}/Attachments/{FileName}
get
Retrieves history from a specific bank transfer using a unique bank transfer Id
put
Creates a history record for a specific bank transfer
get
Retrieves all the branding themes
get
Retrieves a specific branding theme using a unique branding theme Id
get
Retrieves the payment services for a specific branding theme
post
Creates a new custom payment service for a specific branding theme
get
Retrieve a list of budgets
get
Retrieves a specific budget, which includes budget lines
get
Retrieves all contacts in a Xero organisation
put
Creates multiple contacts (bulk) in a Xero organisation
post
Updates or creates one or more contacts in a Xero organisation
get
Retrieves a specific contact by contact number in a Xero organisation
get
Retrieves a specific contacts in a Xero organisation using a unique contact Id
post
Updates a specific contact in a Xero organisation
get
Retrieves attachments for a specific contact in a Xero organisation
get
Retrieves a specific attachment from a specific contact using a unique attachment Id
get
Retrieves a specific attachment from a specific contact by file name
put
/Contacts/{ContactID}/Attachments/{FileName}
post
/Contacts/{ContactID}/Attachments/{FileName}
get
Retrieves CIS settings for a specific contact in a Xero organisation
get
Retrieves history records for a specific contact
put
Creates a new history record for a specific contact
get
Retrieves the contact Id and name of each contact group
put
Creates a contact group
get
Retrieves a specific contact group by using a unique contact group Id
post
Updates a specific contact group
put
Creates contacts to a specific contact group
delete
Deletes all contacts from a specific contact group
delete
Deletes a specific contact from a contact group using a unique contact Id
get
Retrieves any credit notes
put
Creates a new credit note
post
Updates or creates one or more credit notes
get
Retrieves a specific credit note using a unique credit note Id
post
Updates a specific credit note
get
Retrieves attachments for a specific credit notes
get
Retrieves a specific attachment from a specific credit note using a unique attachment Id
get
Retrieves a specific attachment on a specific credit note by file name
put
Creates an attachment for a specific credit note
post
Updates attachments on a specific credit note by file name
get
Retrieves credit notes as PDF files
put
Creates allocation for a specific credit note
delete
Deletes an Allocation from a Credit Note
get
Retrieves history records of a specific credit note
put
Retrieves history records of a specific credit note
get
Retrieves currencies for your Xero organisation
put
Create a new currency for a Xero organisation
get
Retrieves expense claims
put
Creates expense claims
get
Retrieves a specific expense claim using a unique expense claim Id
post
Updates a specific expense claims
get
Retrieves history records of a specific expense claim
put
Creates a history record for a specific expense claim
get
Retrieves sales invoices or purchase bills
put
Creates one or more sales invoices or purchase bills
post
Updates or creates one or more sales invoices or purchase bills
get
Retrieves a specific sales invoice or purchase bill using a unique invoice Id
post
Updates a specific sales invoices or purchase bills
get
Retrieves invoices or purchase bills as PDF files
get
Retrieves attachments for a specific invoice or purchase bill
get
Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id
get
Retrieves an attachment from a specific invoice or purchase bill by filename
put
Creates an attachment for a specific invoice or purchase bill by filename
post
Updates an attachment from a specific invoices or purchase bill by filename
get
Retrieves a URL to an online invoice
post
Sends a copy of a specific invoice to related contact via email
get
Retrieves history records for a specific invoice
put
Creates a history record for a specific invoice
get
Retrieves invoice reminder settings
get
Retrieves items
put
Creates one or more items
post
Updates or creates one or more items
get
Retrieves a specific item using a unique item Id
post
Updates a specific item
delete
Deletes a specific item
get
Retrieves history for a specific item
put
Creates a history record for a specific item
get
Retrieves journals
get
Retrieves a specific journal using a unique journal Id.
get
Retrieves a specific journal using a unique journal number.
get
Retrieves linked transactions (billable expenses)
put
Creates linked transactions (billable expenses)
get
Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id
post
Updates a specific linked transactions (billable expenses)
delete
Deletes a specific linked transactions (billable expenses)
get
Retrieves manual journals
put
Creates one or more manual journals
post
Updates or creates a single manual journal
get
Retrieves a specific manual journal
post
Updates a specific manual journal
get
Retrieves attachment for a specific manual journal
get
Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id
get
Retrieves a specific attachment from a specific manual journal by file name
put
Creates a specific attachment for a specific manual journal by file name
post
Updates a specific attachment from a specific manual journal by file name
get
Retrieves history for a specific manual journal
put
Creates a history record for a specific manual journal
get
Retrieves Xero organisation details
get
Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.
get
Retrieves the CIS settings for the Xero organistaion.
get
Retrieves overpayments
get
Retrieves a specific overpayment using a unique overpayment Id
put
Creates a single allocation for a specific overpayment
delete
Deletes an Allocation from an overpayment
get
Retrieves history records of a specific overpayment
put
Creates a history record for a specific overpayment
get
Retrieves payments for invoices and credit notes
put
Creates multiple payments for invoices or credit notes
post
Creates a single payment for invoice or credit notes
get
Retrieves a specific payment for invoices and credit notes using a unique payment Id
post
Updates a specific payment for invoices and credit notes
get
Retrieves history records of a specific payment
put
Creates a history record for a specific payment
get
Retrieves payment services
put
Creates a payment service
get
Retrieves prepayments
get
Allows you to retrieve a specified prepayments
put
Allows you to create an Allocation for prepayments
delete
Deletes an Allocation from a Prepayment
get
Retrieves history record for a specific prepayment
put
Creates a history record for a specific prepayment
get
Retrieves purchase orders
put
Creates one or more purchase orders
post
Updates or creates one or more purchase orders
get
Retrieves specific purchase order as PDF files using a unique purchase order Id
get
Retrieves a specific purchase order using a unique purchase order Id
post
Updates a specific purchase order
get
Retrieves a specific purchase order using purchase order number
get
Retrieves history for a specific purchase order
put
Creates a history record for a specific purchase orders
get
Retrieves attachments for a specific purchase order
get
Retrieves specific attachment for a specific purchase order using a unique attachment Id
get
Retrieves a specific attachment for a specific purchase order by filename
put
Creates attachment for a specific purchase order
post
Updates a specific attachment for a specific purchase order by filename
get
Retrieves sales quotes
put
Create one or more quotes
post
Updates or creates one or more quotes
get
Retrieves a specific quote using a unique quote Id
post
Updates a specific quote
get
Retrieves history records of a specific quote
put
Creates a history record for a specific quote
get
Retrieves a specific quote as a PDF file using a unique quote Id
get
Retrieves attachments for a specific quote
get
Retrieves a specific attachment from a specific quote using a unique attachment Id
get
Retrieves a specific attachment from a specific quote by filename
put
Creates attachment for a specific quote
post
Updates a specific attachment from a specific quote by filename
get
Retrieves draft expense claim receipts for any user
put
Creates draft expense claim receipts for any user
get
Retrieves a specific draft expense claim receipt by using a unique receipt Id
post
Updates a specific draft expense claim receipts
get
Retrieves attachments for a specific expense claim receipt
get
Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id
get
Retrieves a specific attachment from a specific expense claim receipts by file name
put
Creates an attachment on a specific expense claim receipts by file name
post
Updates a specific attachment on a specific expense claim receipts by file name
get
Retrieves a history record for a specific receipt
put
Creates a history record for a specific receipt
get
Retrieves repeating invoices
put
Creates one or more repeating invoice templates
post
Creates or deletes one or more repeating invoice templates
get
Retrieves a specific repeating invoice by using a unique repeating invoice Id
post
Deletes a specific repeating invoice template
get
Retrieves attachments from a specific repeating invoice
get
Retrieves a specific attachment from a specific repeating invoice
get
Retrieves a specific attachment from a specific repeating invoices by file name
put
Creates an attachment from a specific repeating invoices by file name
post
Updates a specific attachment from a specific repeating invoices by file name
get
Retrieves history record for a specific repeating invoice
put
Creates a history record for a specific repeating invoice
get
Retrieve reports for 1099
get
Retrieves report for aged payables by contact
get
Retrieves report for aged receivables by contact
get
Retrieves report for balancesheet
get
Retrieves report for bank summary
get
Retrieves a specific report using a unique ReportID
get
Retrieves report for budget summary
get
Retrieves report for executive summary
get
Retrieves a list of the organistaions unique reports that require a uuid to fetch
get
Retrieves report for profit and loss
get
Retrieves report for trial balance
post
Sets the chart of accounts, the conversion date and conversion balances
get
Retrieves tax rates
put
Creates one or more tax rates
post
Updates tax rates
get
Retrieves a specific tax rate according to given TaxType code
get
Retrieves tracking categories and options
put
Create tracking categories
get
Retrieves specific tracking categories and options using a unique tracking category Id
post
Updates a specific tracking category
delete
Deletes a specific tracking category
put
Creates options for a specific tracking category
post
Updates a specific option for a specific tracking category
delete
Deletes a specific option for a specific tracking category
get
Retrieves users
get
Retrieves a specific user
Accounting
Retrieves payment services
get
/PaymentServices
Response
Success - return response of type PaymentServices array for all PaymentService
PaymentServices
required
PaymentServices
PaymentService[]