| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Accounting | rest | https://api.xero.com/ | link | — | — | — |
Actions (173)
Invoices · 23
- Create invoicePOST /Invoices
Create an invoice.
documented - Create invoice allocationsPOST /Invoices/{InvoiceID}/Allocations
Create allocations for an invoice.
documented - Create invoice allocationsPOST /Invoices/{InvoiceID}/Allocations
Create allocations for an invoice.
documented - Create invoice paymentsPOST /Invoices/{InvoiceID}/Payments
Create a payment against an invoice.
documented - Create invoice paymentsPOST /Invoices/{InvoiceID}/Payments
Create a payment against an invoice.
documented - Delete invoiceDELETE /Invoices/{InvoiceID}
Delete an invoice.
documented - Delete invoice allocationDELETE /Invoices/{InvoiceID}/Allocations/{AllocationID}
Delete an allocation for an invoice.
documented - Delete invoice allocationDELETE /Invoices/{InvoiceID}/Allocations/{AllocationID}
Delete an allocation on an invoice.
documented - Delete invoice attachmentDELETE /Invoices/{InvoiceID}/Attachments/{AttachmentID}
Delete an invoice attachment.
documented - Download invoice attachment fileGET /Invoices/{InvoiceID}/Attachments/{AttachmentID}/file
Download attachment file for an invoice.
documented - Get invoiceGET /Invoices/{InvoiceID}
Retrieve an invoice.
documented - Get invoice attachmentGET /Invoices/{InvoiceID}/Attachments/{AttachmentID}
Retrieve a specific invoice attachment.
documented - List invoice allocationsGET /Invoices/{InvoiceID}/Allocations
List allocations for an invoice.
documented - List invoice allocationsGET /Invoices/{InvoiceID}/Allocations
List allocations for an invoice.
documented - List invoice attachmentsGET /Invoices/{InvoiceID}/Attachments
List attachments for an invoice.
documented - List invoice paymentsGET /Invoices/{InvoiceID}/Payments
List payments for an invoice.
documented - List invoice paymentsGET /Invoices/{InvoiceID}/Payments
List payments for an invoice.
documented - List invoicesGET /Invoices
Retrieve invoices.
documented - List invoices (with filtering)GET /Invoices
List invoices with filter options.
documented - Update invoicePUT /Invoices/{InvoiceID}
Update an invoice.
documented - Update invoicePUT /Invoices/{InvoiceID}
Update an invoice.
documented - Update invoice attachmentPUT /Invoices/{InvoiceID}/Attachments/{AttachmentID}
Update an invoice attachment.
documented - Upload invoice attachmentPOST /Invoices/{InvoiceID}/Attachments
Upload an attachment to an invoice.
documented
Accounts · 12
- Create accountPOST /Accounts
Create a new chart of accounts entry.
documented - Delete accountDELETE /Accounts/{AccountID}
Delete a chart of accounts entry.
documented - Delete account attachmentDELETE /Accounts/{AccountID}/Attachments/{AttachmentID}
Delete an account attachment.
documented - Download account attachment fileGET /Accounts/{AccountID}/Attachments/{AttachmentID}/file
Download attachment file for a specific account attachment.
documented - Get accountGET /Accounts/{AccountID}
Retrieve a single chart of accounts entry by ID.
documented - Get account attachmentGET /Accounts/{AccountID}/Attachments/{AttachmentID}
Retrieve a specific account attachment.
documented - List account attachmentsGET /Accounts/{AccountID}/Attachments
List attachments for a specific account.
documented - List accountsGET /Accounts
Retrieve the full chart of accounts.
documented - Update accountPUT /Accounts/{AccountID}
Update a chart of accounts entry by ID.
documented - Update account attachmentPUT /Accounts/{AccountID}/Attachments/{AttachmentID}
Update an account attachment.
documented - Update account attachment by filenamePOST /Accounts/{AccountID}/Attachments/{AttachmentID}
Update an account attachment by filename.
documented - Upload account attachmentPOST /Accounts/{AccountID}/Attachments
Upload an attachment to a specific account.
documented
Files · 12
- Create file associationPOST /Files/{FileId}/Associations
Create a new file association.
documented - Delete fileDELETE /Files/{FileId}
Delete a file.
documented - Delete file associationDELETE /Files/{FileId}/Associations/{ObjectId}
Delete a file association.
documented - Get fileGET /Files/{FileId}
Retrieve a file by ID.
documented - Get file contentGET /Files/{FileId}/Content
Retrieve binary content of a file.
documented - List file associationsGET /Files/{FileId}/Associations
List associations for a file.
documented - List filesGET /Files
Retrieve files.
documented - List files in folderGET /Files/{FolderId}
List files in a folder.
documented - Update filePUT /Files/{FileId}
Update file properties.
documented - Update file by IDPOST /Files/{FileId}
Update file metadata by ID.
documented - Upload filePOST /Files
Upload a file to the inbox.
documented - Upload file to folderPOST /Files/{FolderId}
Upload a file to a specific folder.
documented
Projects · 11
- Create projectPOST /Projects
Create a new project.
documented - Create project taskPOST /Projects/{projectId}/Tasks
Create a task for a project.
documented - Create project taskPOST /Projects/{projectId}/Tasks
Create a task for a project.
documented - Delete projectDELETE /Projects/{projectId}
Delete a project.
documented - Get projectGET /Projects/{projectId}
Retrieve a specific project.
documented - Get project taskGET /Projects/{projectId}/Tasks/{taskId}
Retrieve a project task.
documented - List project tasksGET /Projects/{projectId}/Tasks
List tasks for a project.
documented - List project usersGET /ProjectsUsers
List users for projects.
documented - List projectsGET /Projects
Retrieve all projects.
documented - Update projectPUT /Projects/{projectId}
Update a project.
documented - Update project taskPUT /Projects/{projectId}/Tasks/{taskId}
Update a project task.
documented
CreditNotes · 8
- Create credit notePOST /CreditNotes
Create a credit note.
documented - Create credit note allocationsPOST /CreditNotes/{CreditNoteID}/Allocations
Create allocations for a credit note.
documented - Delete credit noteDELETE /CreditNotes/{CreditNoteID}
Delete a credit note.
documented - Delete credit note allocationDELETE /CreditNotes/{CreditNoteID}/Allocations/{AllocationID}
Delete an allocation on a credit note.
documented - Get credit noteGET /CreditNotes/{CreditNoteID}
Retrieve a credit note.
documented - List credit note allocationsGET /CreditNotes/{CreditNoteID}/Allocations
List allocations for a credit note.
documented - List credit notesGET /CreditNotes
Retrieve credit notes.
documented - Update credit notePUT /CreditNotes/{CreditNoteID}
Update a credit note.
documented
Payments · 8
- Create paymentPOST /Payments
Create a payment.
documented - Create payment allocationsPOST /Payments/{PaymentID}/Allocations
Create allocations for a payment.
documented - Delete paymentDELETE /Payments/{PaymentID}
Delete a payment.
documented - Delete payment allocationDELETE /Payments/{PaymentID}/Allocations/{AllocationID}
Delete an allocation for a payment.
documented - Get paymentGET /Payments/{PaymentID}
Retrieve a payment.
documented - List payment allocationsGET /Payments/{PaymentID}/Allocations
List allocations for a payment.
documented - List paymentsGET /Payments
Retrieve payments.
documented - Update paymentPUT /Payments/{PaymentID}
Update a payment.
documented
PayrollAu · 7
- Create employeePOST /Employees
Create a payroll employee.
documented - Create leave applicationPOST /LeaveApplications
Create a leave application.
documented - Get employeeGET /Employees/{EmployeeID}
Retrieve a payroll employee.
documented - Get employeesGET /Employees
List or search payroll employees.
documented - Get leave applicationGET /LeaveApplications/{LeaveApplicationID}
Retrieve leave application.
documented - Get leave applicationsGET /LeaveApplications
List leave applications.
documented - Update employeePUT /Employees/{EmployeeID}
Update a payroll employee.
documented
PayrollNz · 7
- Create employeePOST /Employees
Create a payroll employee.
documented - Create leave applicationPOST /LeaveApplications
Create a leave application.
documented - Get employeeGET /Employees/{EmployeeID}
Retrieve a payroll employee.
documented - Get employeesGET /Employees
List or search payroll employees.
documented - Get leave applicationGET /LeaveApplications/{LeaveApplicationID}
Retrieve leave application.
documented - Get leave applicationsGET /LeaveApplications
List leave applications.
documented - Update employeePUT /Employees/{EmployeeID}
Update a payroll employee.
documented
Contacts · 6
- Create contactPOST /Contacts
Create a contact.
documented - Delete contactDELETE /Contacts/{ContactID}
Delete a contact.
documented - Get contactGET /Contacts/{ContactID}
Retrieve a contact.
documented - List contact allocationsGET /Contacts/{ContactID}/Allocations
List allocations for a contact.
documented - List contactsGET /Contacts
Retrieve contacts.
documented - Update contactPUT /Contacts/{ContactID}
Update a contact.
documented
Webhooks · 6
- Publish contact eventPOST /webhooks/contacts
Publish a contact event notification.
documented - Publish credit note eventPOST /webhooks/creditnotes
Publish a credit note event notification.
documented - Publish invoice eventPOST /webhooks/invoices
Publish an invoice event notification.
documented - Publish invoice eventPOST /webhooks/invoices
Publish an invoice event notification.
documented - Publish subscription eventPOST /webhooks/subscriptions
Publish a subscription event notification.
documented - Publish subscription eventPOST /webhooks/subscriptions
Publish a subscription event notification.
documented
Assets · 5
Bank Transactions · 5
- Create bank transactionPOST /BankTransactions
Create a bank transaction.
documented - Delete bank transactionDELETE /BankTransactions/{BankTransactionID}
Delete a bank transaction.
documented - Get bank transactionGET /BankTransactions/{BankTransactionID}
Retrieve a bank transaction.
documented - List bank transactionsGET /BankTransactions
Retrieve bank transactions.
documented - Update bank transactionPUT /BankTransactions/{BankTransactionID}
Update a bank transaction.
documented
Bank Transfers · 5
- Create bank transferPOST /BankTransfers
Create a bank transfer.
documented - Delete bank transferDELETE /BankTransfers/{BankTransferID}
Delete a bank transfer.
documented - Get bank transferGET /BankTransfers/{BankTransferID}
Retrieve a single bank transfer by ID.
documented - List bank transfersGET /BankTransfers
Retrieve bank transfer records.
documented - Update bank transferPUT /BankTransfers/{BankTransferID}
Update a bank transfer.
documented
Budgets · 5
Finance · 5
- Get Balance SheetGET /FinancialStatements/BalanceSheet
Retrieve Balance Sheet report.
documented - Get Cash FlowGET /FinancialStatements/Cashflow
Retrieve Cash Flow report.
documented - Get Profit & LossGET /FinancialStatements/ProfitAndLoss
Retrieve Profit and Loss report.
documented - Get Trial BalanceGET /FinancialStatements/TrialBalance
Retrieve Trial Balance report.
documented - Get cash validationGET /CashValidation
Summarize cash position by account.
documented
Journals · 5
- Create journalPOST /Journals
Create a journal entry.
documented - Delete journalDELETE /Journals/{JournalID}
Delete a journal.
documented - Get journalGET /Journals/{JournalID}
Retrieve a journal.
documented - List journalsGET /Journals
Retrieve journals.
documented - Update journalPUT /Journals/{JournalID}
Update a journal.
documented
ManualJournals · 5
- Create manual journalPOST /ManualJournals
Create a manual journal entry.
documented - Delete manual journalDELETE /ManualJournals/{ManualJournalID}
Delete a manual journal.
documented - Get manual journalGET /ManualJournals/{ManualJournalID}
Retrieve a manual journal.
documented - List manual journalsGET /ManualJournals
Retrieve manual journals.
documented - Update manual journalPUT /ManualJournals/{ManualJournalID}
Update a manual journal.
documented
Overpayments · 5
- Create overpaymentPOST /Overpayments
Create an overpayment.
documented - Delete overpaymentDELETE /Overpayments/{OverpaymentID}
Delete an overpayment.
documented - Get overpaymentGET /Overpayments/{OverpaymentID}
Retrieve an overpayment.
documented - List overpaymentsGET /Overpayments
List overpayments.
documented - Update overpaymentPUT /Overpayments/{OverpaymentID}
Update an overpayment.
documented
Prepayments · 5
- Create prepaymentPOST /Prepayments
Create a prepayment.
documented - Delete prepaymentDELETE /Prepayments/{PrepaymentID}
Delete a prepayment.
documented - Get prepaymentGET /Prepayments/{PrepaymentID}
Retrieve a prepayment.
documented - List prepaymentsGET /Prepayments
List prepayments.
documented - Update prepaymentPUT /Prepayments/{PrepaymentID}
Update a prepayment.
documented
RepeatingInvoices · 5
- Create repeating invoicePOST /RepeatingInvoices
Create a repeating invoice.
documented - Delete repeating invoiceDELETE /RepeatingInvoices/{RepeatingInvoiceID}
Delete a repeating invoice.
documented - Get repeating invoiceGET /RepeatingInvoices/{RepeatingInvoiceID}
Retrieve a repeating invoice.
documented - List repeating invoicesGET /RepeatingInvoices
List repeating invoices.
documented - Update repeating invoicePUT /RepeatingInvoices/{RepeatingInvoiceID}
Update a repeating invoice.
documented
Attachments · 4
- Delete attachmentDELETE /Attachments/{AttachmentID}
Delete an attachment.
documented - Get attachmentGET /Attachments/{AttachmentID}
Retrieve a generic attachment.
documented - Update attachmentPUT /Attachments/{AttachmentID}
Update an attachment.
documented - Update attachment by filenamePOST /Attachments/{AttachmentID}
Update an attachment by filename.
documented
FeedConnections · 4
- Create feed connectionsPOST /FeedConnections
Create one or more new feed connections.
documented - Delete feed connectionsPOST /FeedConnections/DeleteRequests
Delete an existing feed connection.
documented - Get feed connectionGET /FeedConnections/{id}
Retrieve a feed connection by ID.
documented - List feed connectionsGET /FeedConnections
Search for available feed connections.
documented
Reports · 4
- Get Balance Sheet reportGET /Reports/BalanceSheet
Retrieve Balance Sheet report.
documented - Get Cash Flow reportGET /Reports/Cashflow
Retrieve Cash Flow report.
documented - Get Profit & Loss reportGET /Reports/ProfitAndLoss
Retrieve Profit and Loss report.
documented - Get Trial Balance reportGET /Reports/TrialBalance
Retrieve Trial Balance report.
documented