Xero Accounting API, an HTTP API described by an OpenAPI document.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.xero.com/api.xro/2.0 https://api.xero.com/payroll.xro/1.0 https://api.xero.com/files.xro/1.0 https://api.xero.com/bankfeeds.xro/1.0 https://api.xero.com/assets.xro/1.0 https://api.xero.com
auth: o a u t h 2
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Xero Accounting API, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | /Accounts | Retrieves the full chart of accounts Accounting |
PUT | /Accounts | Creates a new chart of accounts Accounting |
GET | /Accounts/{AccountID} | Retrieves a single chart of accounts by using a unique account Id Accounting |
POST | /Accounts/{AccountID} | Updates a chart of accounts Accounting |
DELETE | /Accounts/{AccountID} | Deletes a chart of accounts Accounting |
GET | /Accounts/{AccountID}/Attachments | Retrieves attachments for a specific accounts by using a unique account Id Accounting |
GET | /Accounts/{AccountID}/Attachments/{AttachmentID} | Retrieves a specific attachment from a specific account using a unique attachment Id Accounting |
GET | /Accounts/{AccountID}/Attachments/{FileName} | Retrieves an attachment for a specific account by filename Accounting |
POST | /Accounts/{AccountID}/Attachments/{FileName} | Updates attachment on a specific account by filename Accounting |
PUT | /Accounts/{AccountID}/Attachments/{FileName} | Creates an attachment on a specific account Accounting |
GET | /BankTransactions | Retrieves any spent or received money transactions Accounting |
POST | /BankTransactions | Updates or creates one or more spent or received money transaction Accounting |
PUT | /BankTransactions | Creates one or more spent or received money transaction Accounting |
GET | /BankTransactions/{BankTransactionID} | Retrieves a single spent or received money transaction by using a unique bank transaction Id Accounting |
POST | /BankTransactions/{BankTransactionID} | Updates a single spent or received money transaction Accounting |
GET | /BankTransactions/{BankTransactionID}/Attachments | Retrieves any attachments from a specific bank transactions Accounting |
GET | /BankTransactions/{BankTransactionID}/Attachments/{AttachmentID} | Retrieves specific attachments from a specific BankTransaction using a unique attachment Id Accounting |
GET | /BankTransactions/{BankTransactionID}/Attachments/{FileName} | Retrieves a specific attachment from a specific bank transaction by filename Accounting |
POST | /BankTransactions/{BankTransactionID}/Attachments/{FileName} | Updates a specific attachment from a specific bank transaction by filename Accounting |
PUT | /BankTransactions/{BankTransactionID}/Attachments/{FileName} | Creates an attachment for a specific bank transaction by filename Accounting |
GET | /BankTransactions/{BankTransactionID}/History | Retrieves history from a specific bank transaction using a unique bank transaction Id Accounting |
PUT | /BankTransactions/{BankTransactionID}/History | Creates a history record for a specific bank transactions Accounting |
GET | /BankTransfers | Retrieves all bank transfers Accounting |
PUT | /BankTransfers | Creates a bank transfer Accounting |
GET | /BankTransfers/{BankTransferID} | Retrieves specific bank transfers by using a unique bank transfer Id Accounting |
GET | /BankTransfers/{BankTransferID}/Attachments | Retrieves attachments from a specific bank transfer Accounting |
GET | /BankTransfers/{BankTransferID}/Attachments/{AttachmentID} | Retrieves a specific attachment from a specific bank transfer using a unique attachment ID Accounting |
GET | /BankTransfers/{BankTransferID}/Attachments/{FileName} | Retrieves a specific attachment on a specific bank transfer by file name Accounting |
GET | /BankTransfers/{BankTransferID}/History | Retrieves history from a specific bank transfer using a unique bank transfer Id Accounting |
PUT | /BankTransfers/{BankTransferID}/History | Creates a history record for a specific bank transfer Accounting |
GET | /BatchPayments | Retrieves either one or many batch payments for invoices Accounting |
PUT | /BatchPayments | Creates one or many batch payments for invoices Accounting |
GET | /BatchPayments/{BatchPaymentID}/History | Retrieves history from a specific batch payment Accounting |
PUT | /BatchPayments/{BatchPaymentID}/History | Creates a history record for a specific batch payment Accounting |
GET | /BrandingThemes | Retrieves all the branding themes Accounting |
GET | /BrandingThemes/{BrandingThemeID} | Retrieves a specific branding theme using a unique branding theme Id Accounting |
GET | /BrandingThemes/{BrandingThemeID}/PaymentServices | Retrieves the payment services for a specific branding theme Accounting |
POST | /BrandingThemes/{BrandingThemeID}/PaymentServices | Creates a new custom payment service for a specific branding theme Accounting |
GET | /ContactGroups | Retrieves the contact Id and name of all the contacts in a contact group Accounting |
PUT | /ContactGroups | Creates a contact group Accounting |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/master/xero_accounting.yaml
This is the Xero Payroll API for orgs in Australia region.
| method | path | what the vendor says it does |
|---|---|---|
GET | /Employees | Searches payroll employees PayrollAu |
POST | /Employees | Creates a payroll employee PayrollAu |
GET | /Employees/{EmployeeID} | Retrieves an employee's detail by unique employee id PayrollAu |
POST | /Employees/{EmployeeID} | Updates an employee's detail Update properties on a single employee PayrollAu |
GET | /LeaveApplications | Retrieves leave applications PayrollAu |
POST | /LeaveApplications | Creates a leave application PayrollAu |
GET | /LeaveApplications/{LeaveApplicationID} | Retrieves a leave application by a unique leave application id PayrollAu |
POST | /LeaveApplications/{LeaveApplicationID} | Updates a specific leave application PayrollAu |
GET | /PayItems | Retrieves pay items PayrollAu |
POST | /PayItems | Creates a pay item PayrollAu |
GET | /PayRuns | Retrieves pay runs PayrollAu |
POST | /PayRuns | Creates a pay run PayrollAu |
GET | /PayRuns/{PayRunID} | Retrieves a pay run by using a unique pay run id PayrollAu |
POST | /PayRuns/{PayRunID} | Updates a pay run Update properties on a single PayRun PayrollAu |
GET | /PayrollCalendars | Retrieves payroll calendars PayrollAu |
POST | /PayrollCalendars | Creates a Payroll Calendar PayrollAu |
GET | /PayrollCalendars/{PayrollCalendarID} | Retrieves payroll calendar by using a unique payroll calendar ID PayrollAu |
GET | /Payslip/{PayslipID} | Retrieves for a payslip by a unique payslip id PayrollAu |
POST | /Payslip/{PayslipID} | Updates a payslip Update lines on a single payslips PayrollAu |
GET | /Settings | Retrieves payroll settings PayrollAu |
GET | /SuperfundProducts | Retrieves superfund products PayrollAu |
GET | /Superfunds | Retrieves superfunds PayrollAu |
POST | /Superfunds | Creates a superfund PayrollAu |
GET | /Superfunds/{SuperFundID} | Retrieves a superfund by using a unique superfund ID PayrollAu |
POST | /Superfunds/{SuperFundID} | Updates a superfund Update properties on a single Superfund PayrollAu |
GET | /Timesheets | Retrieves timesheets PayrollAu |
POST | /Timesheets | Creates a timesheet PayrollAu |
GET | /Timesheets/{TimesheetID} | Retrieves a timesheet by using a unique timesheet id PayrollAu |
POST | /Timesheets/{TimesheetID} | Updates a timesheet Update properties on a single timesheet PayrollAu |
specification origin: https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/master/xero-payroll-au.yaml
These endpoints are specific to Xero Files API
| method | path | what the vendor says it does |
|---|---|---|
GET | /Associations/{ObjectId} | Retrieves an association object using a unique object ID By passing in the appropriate options, Files |
GET | /Files | Retrieves files Files |
POST | /Files | Uploads a File Files |
GET | /Files/{FileId} | Retrieves a file by a unique file ID Files |
PUT | /Files/{FileId} | Update a file Updates file properties of a single file Files |
DELETE | /Files/{FileId} | Deletes a specific file Delete a specific file Files |
GET | /Files/{FileId}/Associations | Retrieves a specific file associations By passing in the appropriate options, Files |
POST | /Files/{FileId}/Associations | Creates a new file association By passing in the appropriate options, you can create a new folder Files |
DELETE | /Files/{FileId}/Associations/{ObjectId} | Deletes an existing file association By passing in the appropriate options, you can create a new folder Files |
GET | /Files/{FileId}/Content | Retrieves the content of a specific file By passing in the appropriate options, retrieve data for specific fil |
GET | /Folders | Retrieves folders By passing in the appropriate options, you can search for available folders Files |
POST | /Folders | Creates a new folder By passing in the appropriate properties, you can create a new folder Files |
GET | /Folders/{FolderId} | Retrieves specific folder by using a unique folder ID By passing in the appropriate ID, you can search for spe |
PUT | /Folders/{FolderId} | Updates an existing folder By passing in the appropriate ID and properties, you can update a folder Files |
DELETE | /Folders/{FolderId} | Deletes a folder By passing in the appropriate ID, you can delete a folder Files |
GET | /Inbox | Retrieves inbox folder Search for the user inbox Files |
specification origin: https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/master/xero_files.yaml
The Bank Feeds API is a closed API that is only available to financial institutions that have an established financial services partnership with Xero. If you're an existing financial services partner that wants access, contact your local Partner Manager. If you're a financial institution who wants to provide bank feeds to your business customers, contact us to become a financial services partner.
| method | path | what the vendor says it does |
|---|---|---|
GET | /FeedConnections | Searches for feed connections By passing in the appropriate options, you can search for available feed connect |
POST | /FeedConnections | Create one or more new feed connection By passing in the FeedConnections array object in the body, you can cre |
POST | /FeedConnections/DeleteRequests | Delete an existing feed connection By passing in FeedConnections array object in the body, you can delete a fe |
GET | /FeedConnections/{id} | Retrieve single feed connection based on a unique id provided By passing in a FeedConnection Id options, you c |
GET | /Statements | Retrieve all statements By passing in parameters, you can search for matching statements BankFeeds |
POST | /Statements | Creates one or more new statements BankFeeds |
GET | /Statements/{statementID} | Retrieve single statement based on unique id provided By passing in a statement id, you can search for matchin |
specification origin: https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/master/xero_bankfeeds.yaml
The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc.
| method | path | what the vendor says it does |
|---|---|---|
GET | /AssetTypes | searches fixed asset types By passing in the appropriate options, you can search for available fixed asset typ |
POST | /AssetTypes | adds a fixed asset type Adds an fixed asset type to the system Asset |
GET | /Assets | searches fixed asset By passing in the appropriate options, you can search for available fixed asset in the sy |
POST | /Assets | adds a fixed asset Adds an asset to the system Asset |
GET | /Assets/{id} | Retrieves fixed asset by id By passing in the appropriate asset id, you can search for a specific fixed asset |
GET | /Settings | searches fixed asset settings By passing in the appropriate options, you can search for available fixed asset |
specification origin: https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/master/xero_assets.yaml
These endpoints are related to managing authentication tokens and identity for Xero API
| method | path | what the vendor says it does |
|---|---|---|
GET | /Connections | Retrieves the connections for this user Override the base server url that include version identity |
DELETE | /Connections/{id} | Deletes a connection for this user (i.e. disconnect a tenant) Override the base server url that include versio |
specification origin: https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/master/xero-identity.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.