Developer documentation
Route reference
Every mapped endpoint and the scope it requires, generated from the enforcement table.
Supported API families
| Family | Base path |
|---|---|
| Accounting | /api.xro/2.0 |
| Payroll AU (1.0) | /payroll.xro/1.0 |
| Payroll AU | /payroll.xro/2.0 |
| Payroll UK | /payroll.xro/2.0/uk |
| Payroll NZ | /payroll.xro/2.0/nz |
| Files | /files.xro/1.0 |
| Assets | /assets.xro/1.0 |
| Projects | /projects.xro/2.0 |
| Bank Feeds | /bankfeeds.xro/1.0 |
| Finance | /finance.xro/1.0 |
Endpoints
573 mapped endpoints across 10 API families. Every required scope below is read from the same table the enforcement middleware checks, so this reference cannot drift from what is actually enforced. Anything not listed is denied before it reaches Xero.
Accounting
| Methods | Path | Required scope | What it does |
|---|---|---|---|
| GET, HEAD | /api.xro/2.0/Invoices | accounting.transactions.read | List invoices |
| POST, PUT | /api.xro/2.0/Invoices | accounting.transactions | Create or update invoices |
| GET, HEAD | /api.xro/2.0/Invoices/{id} | accounting.transactions.read | Read a single invoices record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/Invoices/{id} | accounting.transactions | Update or delete a single invoices record |
| GET, HEAD | /api.xro/2.0/Invoices/{id}/Attachments | accounting.attachments.read | List attachments on a invoices record |
| GET, HEAD | /api.xro/2.0/Invoices/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a invoices record |
| POST, PUT | /api.xro/2.0/Invoices/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a invoices record |
| GET, HEAD | /api.xro/2.0/Invoices/{id}/History | accounting.transactions.read | Read history and notes on a invoices record |
| PUT, POST | /api.xro/2.0/Invoices/{id}/History | accounting.transactions | Add a history note to a invoices record |
| GET, HEAD | /api.xro/2.0/BankTransactions | accounting.transactions.read | List bank transactions |
| POST, PUT | /api.xro/2.0/BankTransactions | accounting.transactions | Create or update bank transactions |
| GET, HEAD | /api.xro/2.0/BankTransactions/{id} | accounting.transactions.read | Read a single bank transactions record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/BankTransactions/{id} | accounting.transactions | Update or delete a single bank transactions record |
| GET, HEAD | /api.xro/2.0/BankTransactions/{id}/Attachments | accounting.attachments.read | List attachments on a bank transactions record |
| GET, HEAD | /api.xro/2.0/BankTransactions/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a bank transactions record |
| POST, PUT | /api.xro/2.0/BankTransactions/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a bank transactions record |
| GET, HEAD | /api.xro/2.0/BankTransactions/{id}/History | accounting.transactions.read | Read history and notes on a bank transactions record |
| PUT, POST | /api.xro/2.0/BankTransactions/{id}/History | accounting.transactions | Add a history note to a bank transactions record |
| GET, HEAD | /api.xro/2.0/BankTransfers | accounting.transactions.read | List bank transfers |
| POST, PUT | /api.xro/2.0/BankTransfers | accounting.transactions | Create or update bank transfers |
| GET, HEAD | /api.xro/2.0/BankTransfers/{id} | accounting.transactions.read | Read a single bank transfers record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/BankTransfers/{id} | accounting.transactions | Update or delete a single bank transfers record |
| GET, HEAD | /api.xro/2.0/BankTransfers/{id}/Attachments | accounting.attachments.read | List attachments on a bank transfers record |
| GET, HEAD | /api.xro/2.0/BankTransfers/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a bank transfers record |
| POST, PUT | /api.xro/2.0/BankTransfers/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a bank transfers record |
| GET, HEAD | /api.xro/2.0/BankTransfers/{id}/History | accounting.transactions.read | Read history and notes on a bank transfers record |
| PUT, POST | /api.xro/2.0/BankTransfers/{id}/History | accounting.transactions | Add a history note to a bank transfers record |
| GET, HEAD | /api.xro/2.0/BatchPayments | accounting.transactions.read | List batch payments |
| POST, PUT | /api.xro/2.0/BatchPayments | accounting.transactions | Create or update batch payments |
| GET, HEAD | /api.xro/2.0/BatchPayments/{id} | accounting.transactions.read | Read a single batch payments record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/BatchPayments/{id} | accounting.transactions | Update or delete a single batch payments record |
| GET, HEAD | /api.xro/2.0/BatchPayments/{id}/Attachments | accounting.attachments.read | List attachments on a batch payments record |
| GET, HEAD | /api.xro/2.0/BatchPayments/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a batch payments record |
| POST, PUT | /api.xro/2.0/BatchPayments/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a batch payments record |
| GET, HEAD | /api.xro/2.0/BatchPayments/{id}/History | accounting.transactions.read | Read history and notes on a batch payments record |
| PUT, POST | /api.xro/2.0/BatchPayments/{id}/History | accounting.transactions | Add a history note to a batch payments record |
| GET, HEAD | /api.xro/2.0/CreditNotes | accounting.transactions.read | List credit notes |
| POST, PUT | /api.xro/2.0/CreditNotes | accounting.transactions | Create or update credit notes |
| GET, HEAD | /api.xro/2.0/CreditNotes/{id} | accounting.transactions.read | Read a single credit notes record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/CreditNotes/{id} | accounting.transactions | Update or delete a single credit notes record |
| GET, HEAD | /api.xro/2.0/CreditNotes/{id}/Attachments | accounting.attachments.read | List attachments on a credit notes record |
| GET, HEAD | /api.xro/2.0/CreditNotes/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a credit notes record |
| POST, PUT | /api.xro/2.0/CreditNotes/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a credit notes record |
| GET, HEAD | /api.xro/2.0/CreditNotes/{id}/History | accounting.transactions.read | Read history and notes on a credit notes record |
| PUT, POST | /api.xro/2.0/CreditNotes/{id}/History | accounting.transactions | Add a history note to a credit notes record |
| GET, HEAD | /api.xro/2.0/Payments | accounting.transactions.read | List payments |
| POST, PUT | /api.xro/2.0/Payments | accounting.transactions | Create or update payments |
| GET, HEAD | /api.xro/2.0/Payments/{id} | accounting.transactions.read | Read a single payments record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/Payments/{id} | accounting.transactions | Update or delete a single payments record |
| GET, HEAD | /api.xro/2.0/Payments/{id}/Attachments | accounting.attachments.read | List attachments on a payments record |
| GET, HEAD | /api.xro/2.0/Payments/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a payments record |
| POST, PUT | /api.xro/2.0/Payments/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a payments record |
| GET, HEAD | /api.xro/2.0/Payments/{id}/History | accounting.transactions.read | Read history and notes on a payments record |
| PUT, POST | /api.xro/2.0/Payments/{id}/History | accounting.transactions | Add a history note to a payments record |
| GET, HEAD | /api.xro/2.0/Prepayments | accounting.transactions.read | List prepayments |
| POST, PUT | /api.xro/2.0/Prepayments | accounting.transactions | Create or update prepayments |
| GET, HEAD | /api.xro/2.0/Prepayments/{id} | accounting.transactions.read | Read a single prepayments record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/Prepayments/{id} | accounting.transactions | Update or delete a single prepayments record |
| GET, HEAD | /api.xro/2.0/Prepayments/{id}/Attachments | accounting.attachments.read | List attachments on a prepayments record |
| GET, HEAD | /api.xro/2.0/Prepayments/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a prepayments record |
| POST, PUT | /api.xro/2.0/Prepayments/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a prepayments record |
| GET, HEAD | /api.xro/2.0/Prepayments/{id}/History | accounting.transactions.read | Read history and notes on a prepayments record |
| PUT, POST | /api.xro/2.0/Prepayments/{id}/History | accounting.transactions | Add a history note to a prepayments record |
| GET, HEAD | /api.xro/2.0/Overpayments | accounting.transactions.read | List overpayments |
| POST, PUT | /api.xro/2.0/Overpayments | accounting.transactions | Create or update overpayments |
| GET, HEAD | /api.xro/2.0/Overpayments/{id} | accounting.transactions.read | Read a single overpayments record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/Overpayments/{id} | accounting.transactions | Update or delete a single overpayments record |
| GET, HEAD | /api.xro/2.0/Overpayments/{id}/Attachments | accounting.attachments.read | List attachments on a overpayments record |
| GET, HEAD | /api.xro/2.0/Overpayments/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a overpayments record |
| POST, PUT | /api.xro/2.0/Overpayments/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a overpayments record |
| GET, HEAD | /api.xro/2.0/Overpayments/{id}/History | accounting.transactions.read | Read history and notes on a overpayments record |
| PUT, POST | /api.xro/2.0/Overpayments/{id}/History | accounting.transactions | Add a history note to a overpayments record |
| GET, HEAD | /api.xro/2.0/PurchaseOrders | accounting.transactions.read | List purchase orders |
| POST, PUT | /api.xro/2.0/PurchaseOrders | accounting.transactions | Create or update purchase orders |
| GET, HEAD | /api.xro/2.0/PurchaseOrders/{id} | accounting.transactions.read | Read a single purchase orders record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/PurchaseOrders/{id} | accounting.transactions | Update or delete a single purchase orders record |
| GET, HEAD | /api.xro/2.0/PurchaseOrders/{id}/Attachments | accounting.attachments.read | List attachments on a purchase orders record |
| GET, HEAD | /api.xro/2.0/PurchaseOrders/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a purchase orders record |
| POST, PUT | /api.xro/2.0/PurchaseOrders/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a purchase orders record |
| GET, HEAD | /api.xro/2.0/PurchaseOrders/{id}/History | accounting.transactions.read | Read history and notes on a purchase orders record |
| PUT, POST | /api.xro/2.0/PurchaseOrders/{id}/History | accounting.transactions | Add a history note to a purchase orders record |
| GET, HEAD | /api.xro/2.0/Quotes | accounting.transactions.read | List quotes |
| POST, PUT | /api.xro/2.0/Quotes | accounting.transactions | Create or update quotes |
| GET, HEAD | /api.xro/2.0/Quotes/{id} | accounting.transactions.read | Read a single quotes record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/Quotes/{id} | accounting.transactions | Update or delete a single quotes record |
| GET, HEAD | /api.xro/2.0/Quotes/{id}/Attachments | accounting.attachments.read | List attachments on a quotes record |
| GET, HEAD | /api.xro/2.0/Quotes/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a quotes record |
| POST, PUT | /api.xro/2.0/Quotes/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a quotes record |
| GET, HEAD | /api.xro/2.0/Quotes/{id}/History | accounting.transactions.read | Read history and notes on a quotes record |
| PUT, POST | /api.xro/2.0/Quotes/{id}/History | accounting.transactions | Add a history note to a quotes record |
| GET, HEAD | /api.xro/2.0/Receipts | accounting.transactions.read | List receipts |
| POST, PUT | /api.xro/2.0/Receipts | accounting.transactions | Create or update receipts |
| GET, HEAD | /api.xro/2.0/Receipts/{id} | accounting.transactions.read | Read a single receipts record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/Receipts/{id} | accounting.transactions | Update or delete a single receipts record |
| GET, HEAD | /api.xro/2.0/Receipts/{id}/Attachments | accounting.attachments.read | List attachments on a receipts record |
| GET, HEAD | /api.xro/2.0/Receipts/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a receipts record |
| POST, PUT | /api.xro/2.0/Receipts/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a receipts record |
| GET, HEAD | /api.xro/2.0/Receipts/{id}/History | accounting.transactions.read | Read history and notes on a receipts record |
| PUT, POST | /api.xro/2.0/Receipts/{id}/History | accounting.transactions | Add a history note to a receipts record |
| GET, HEAD | /api.xro/2.0/ExpenseClaims | accounting.transactions.read | List expense claims |
| POST, PUT | /api.xro/2.0/ExpenseClaims | accounting.transactions | Create or update expense claims |
| GET, HEAD | /api.xro/2.0/ExpenseClaims/{id} | accounting.transactions.read | Read a single expense claims record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/ExpenseClaims/{id} | accounting.transactions | Update or delete a single expense claims record |
| GET, HEAD | /api.xro/2.0/ExpenseClaims/{id}/Attachments | accounting.attachments.read | List attachments on a expense claims record |
| GET, HEAD | /api.xro/2.0/ExpenseClaims/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a expense claims record |
| POST, PUT | /api.xro/2.0/ExpenseClaims/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a expense claims record |
| GET, HEAD | /api.xro/2.0/ExpenseClaims/{id}/History | accounting.transactions.read | Read history and notes on a expense claims record |
| PUT, POST | /api.xro/2.0/ExpenseClaims/{id}/History | accounting.transactions | Add a history note to a expense claims record |
| GET, HEAD | /api.xro/2.0/ManualJournals | accounting.transactions.read | List manual journals |
| POST, PUT | /api.xro/2.0/ManualJournals | accounting.transactions | Create or update manual journals |
| GET, HEAD | /api.xro/2.0/ManualJournals/{id} | accounting.transactions.read | Read a single manual journals record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/ManualJournals/{id} | accounting.transactions | Update or delete a single manual journals record |
| GET, HEAD | /api.xro/2.0/ManualJournals/{id}/Attachments | accounting.attachments.read | List attachments on a manual journals record |
| GET, HEAD | /api.xro/2.0/ManualJournals/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a manual journals record |
| POST, PUT | /api.xro/2.0/ManualJournals/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a manual journals record |
| GET, HEAD | /api.xro/2.0/ManualJournals/{id}/History | accounting.transactions.read | Read history and notes on a manual journals record |
| PUT, POST | /api.xro/2.0/ManualJournals/{id}/History | accounting.transactions | Add a history note to a manual journals record |
| GET, HEAD | /api.xro/2.0/LinkedTransactions | accounting.transactions.read | List linked transactions |
| POST, PUT | /api.xro/2.0/LinkedTransactions | accounting.transactions | Create or update linked transactions |
| GET, HEAD | /api.xro/2.0/LinkedTransactions/{id} | accounting.transactions.read | Read a single linked transactions record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/LinkedTransactions/{id} | accounting.transactions | Update or delete a single linked transactions record |
| GET, HEAD | /api.xro/2.0/LinkedTransactions/{id}/Attachments | accounting.attachments.read | List attachments on a linked transactions record |
| GET, HEAD | /api.xro/2.0/LinkedTransactions/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a linked transactions record |
| POST, PUT | /api.xro/2.0/LinkedTransactions/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a linked transactions record |
| GET, HEAD | /api.xro/2.0/LinkedTransactions/{id}/History | accounting.transactions.read | Read history and notes on a linked transactions record |
| PUT, POST | /api.xro/2.0/LinkedTransactions/{id}/History | accounting.transactions | Add a history note to a linked transactions record |
| GET, HEAD | /api.xro/2.0/PaymentServices | accounting.transactions.read | List payment services |
| POST, PUT | /api.xro/2.0/PaymentServices | accounting.transactions | Create or update payment services |
| GET, HEAD | /api.xro/2.0/PaymentServices/{id} | accounting.transactions.read | Read a single payment services record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/PaymentServices/{id} | accounting.transactions | Update or delete a single payment services record |
| GET, HEAD | /api.xro/2.0/PaymentServices/{id}/Attachments | accounting.attachments.read | List attachments on a payment services record |
| GET, HEAD | /api.xro/2.0/PaymentServices/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a payment services record |
| POST, PUT | /api.xro/2.0/PaymentServices/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a payment services record |
| GET, HEAD | /api.xro/2.0/PaymentServices/{id}/History | accounting.transactions.read | Read history and notes on a payment services record |
| PUT, POST | /api.xro/2.0/PaymentServices/{id}/History | accounting.transactions | Add a history note to a payment services record |
| GET, HEAD | /api.xro/2.0/CreditNotes/{id}/Allocations | accounting.transactions.read | List the allocations on a credit note |
| PUT, POST | /api.xro/2.0/CreditNotes/{id}/Allocations | accounting.transactions | Allocate a credit note to an invoice or bill |
| DELETE | /api.xro/2.0/CreditNotes/{id}/Allocations/{allocationId} | accounting.transactions | Remove one allocation from a credit note |
| GET, HEAD | /api.xro/2.0/Prepayments/{id}/Allocations | accounting.transactions.read | List the allocations on a prepayment |
| PUT, POST | /api.xro/2.0/Prepayments/{id}/Allocations | accounting.transactions | Allocate a prepayment to an invoice or bill |
| DELETE | /api.xro/2.0/Prepayments/{id}/Allocations/{allocationId} | accounting.transactions | Remove one allocation from a prepayment |
| GET, HEAD | /api.xro/2.0/Overpayments/{id}/Allocations | accounting.transactions.read | List the allocations on a overpayment |
| PUT, POST | /api.xro/2.0/Overpayments/{id}/Allocations | accounting.transactions | Allocate a overpayment to an invoice or bill |
| DELETE | /api.xro/2.0/Overpayments/{id}/Allocations/{allocationId} | accounting.transactions | Remove one allocation from a overpayment |
| GET, HEAD | /api.xro/2.0/Invoices/{id}/OnlineInvoice | accounting.transactions.read | Read the online invoice URL for an invoice |
| POST | /api.xro/2.0/Invoices/{id}/Email | accounting.transactions | Send an invoice by email from Xero |
| POST, DELETE | /api.xro/2.0/BatchPayments/{id} | accounting.transactions | Delete or reverse a batch payment |
| GET, HEAD | /api.xro/2.0/Contacts | accounting.contacts.read | List contacts |
| POST, PUT | /api.xro/2.0/Contacts | accounting.contacts | Create or update contacts |
| GET, HEAD | /api.xro/2.0/Contacts/{id} | accounting.contacts.read | Read a single contacts record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/Contacts/{id} | accounting.contacts | Update or delete a single contacts record |
| GET, HEAD | /api.xro/2.0/Contacts/{id}/Attachments | accounting.attachments.read | List attachments on a contact record |
| GET, HEAD | /api.xro/2.0/Contacts/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a contact record |
| POST, PUT | /api.xro/2.0/Contacts/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a contact record |
| GET, HEAD | /api.xro/2.0/Contacts/{id}/History | accounting.contacts.read | Read history and notes on a contact record |
| PUT, POST | /api.xro/2.0/Contacts/{id}/History | accounting.contacts | Add a history note to a contact record |
| GET, HEAD | /api.xro/2.0/ContactGroups | accounting.contacts.read | List contact groups |
| POST, PUT | /api.xro/2.0/ContactGroups | accounting.contacts | Create or update contact groups |
| GET, HEAD | /api.xro/2.0/ContactGroups/{id} | accounting.contacts.read | Read a single contact groups record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/ContactGroups/{id} | accounting.contacts | Update or delete a single contact groups record |
| GET, HEAD | /api.xro/2.0/Contacts/{id}/CISSettings | accounting.contacts.read | Read CIS settings for a contact |
| GET, HEAD | /api.xro/2.0/ContactGroups/{id}/Contacts | accounting.contacts.read | List the contacts in a contact group |
| PUT, POST, DELETE | /api.xro/2.0/ContactGroups/{id}/Contacts | accounting.contacts | Add or clear the contacts in a contact group |
| DELETE | /api.xro/2.0/ContactGroups/{id}/Contacts/{contactId} | accounting.contacts | Remove one contact from a contact group |
| GET, HEAD | /api.xro/2.0/Accounts | accounting.settings.read | List chart of accounts |
| POST, PUT | /api.xro/2.0/Accounts | accounting.settings | Create or update chart of accounts |
| GET, HEAD | /api.xro/2.0/Accounts/{id} | accounting.settings.read | Read a single chart of accounts record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/Accounts/{id} | accounting.settings | Update or delete a single chart of accounts record |
| GET, HEAD | /api.xro/2.0/BrandingThemes | accounting.settings.read | List branding themes |
| POST, PUT | /api.xro/2.0/BrandingThemes | accounting.settings | Create or update branding themes |
| GET, HEAD | /api.xro/2.0/BrandingThemes/{id} | accounting.settings.read | Read a single branding themes record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/BrandingThemes/{id} | accounting.settings | Update or delete a single branding themes record |
| GET, HEAD | /api.xro/2.0/Currencies | accounting.settings.read | List currencies |
| POST, PUT | /api.xro/2.0/Currencies | accounting.settings | Create or update currencies |
| GET, HEAD | /api.xro/2.0/Currencies/{id} | accounting.settings.read | Read a single currencies record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/Currencies/{id} | accounting.settings | Update or delete a single currencies record |
| GET, HEAD | /api.xro/2.0/Employees | accounting.settings.read | List employees (accounting) |
| POST, PUT | /api.xro/2.0/Employees | accounting.settings | Create or update employees (accounting) |
| GET, HEAD | /api.xro/2.0/Employees/{id} | accounting.settings.read | Read a single employees (accounting) record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/Employees/{id} | accounting.settings | Update or delete a single employees (accounting) record |
| GET, HEAD | /api.xro/2.0/Items | accounting.settings.read | List items |
| POST, PUT | /api.xro/2.0/Items | accounting.settings | Create or update items |
| GET, HEAD | /api.xro/2.0/Items/{id} | accounting.settings.read | Read a single items record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/Items/{id} | accounting.settings | Update or delete a single items record |
| GET, HEAD | /api.xro/2.0/Organisation | accounting.settings.read | List organisation |
| POST, PUT | /api.xro/2.0/Organisation | accounting.settings | Create or update organisation |
| GET, HEAD | /api.xro/2.0/Organisation/{id} | accounting.settings.read | Read a single organisation record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/Organisation/{id} | accounting.settings | Update or delete a single organisation record |
| GET, HEAD | /api.xro/2.0/RepeatingInvoices | accounting.settings.read | List repeating invoices |
| POST, PUT | /api.xro/2.0/RepeatingInvoices | accounting.settings | Create or update repeating invoices |
| GET, HEAD | /api.xro/2.0/RepeatingInvoices/{id} | accounting.settings.read | Read a single repeating invoices record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/RepeatingInvoices/{id} | accounting.settings | Update or delete a single repeating invoices record |
| GET, HEAD | /api.xro/2.0/TaxRates | accounting.settings.read | List tax rates |
| POST, PUT | /api.xro/2.0/TaxRates | accounting.settings | Create or update tax rates |
| GET, HEAD | /api.xro/2.0/TaxRates/{id} | accounting.settings.read | Read a single tax rates record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/TaxRates/{id} | accounting.settings | Update or delete a single tax rates record |
| GET, HEAD | /api.xro/2.0/TrackingCategories | accounting.settings.read | List tracking categories |
| POST, PUT | /api.xro/2.0/TrackingCategories | accounting.settings | Create or update tracking categories |
| GET, HEAD | /api.xro/2.0/TrackingCategories/{id} | accounting.settings.read | Read a single tracking categories record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/TrackingCategories/{id} | accounting.settings | Update or delete a single tracking categories record |
| GET, HEAD | /api.xro/2.0/Users | accounting.settings.read | List users |
| POST, PUT | /api.xro/2.0/Users | accounting.settings | Create or update users |
| GET, HEAD | /api.xro/2.0/Users/{id} | accounting.settings.read | Read a single users record |
| POST, PUT, PATCH, DELETE | /api.xro/2.0/Users/{id} | accounting.settings | Update or delete a single users record |
| GET, HEAD | /api.xro/2.0/Accounts/{id}/Attachments | accounting.attachments.read | List attachments on a account record |
| GET, HEAD | /api.xro/2.0/Accounts/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a account record |
| POST, PUT | /api.xro/2.0/Accounts/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a account record |
| GET, HEAD | /api.xro/2.0/Accounts/{id}/History | accounting.settings.read | Read history and notes on a account record |
| PUT, POST | /api.xro/2.0/Accounts/{id}/History | accounting.settings | Add a history note to a account record |
| GET, HEAD | /api.xro/2.0/RepeatingInvoices/{id}/Attachments | accounting.attachments.read | List attachments on a repeating invoice record |
| GET, HEAD | /api.xro/2.0/RepeatingInvoices/{id}/Attachments/* | accounting.attachments.read | Download an attachment from a repeating invoice record |
| POST, PUT | /api.xro/2.0/RepeatingInvoices/{id}/Attachments/* | accounting.attachments | Upload or replace an attachment on a repeating invoice record |
| GET, HEAD | /api.xro/2.0/RepeatingInvoices/{id}/History | accounting.settings.read | Read history and notes on a repeating invoice record |
| PUT, POST | /api.xro/2.0/RepeatingInvoices/{id}/History | accounting.settings | Add a history note to a repeating invoice record |
| POST, PUT | /api.xro/2.0/Setup | accounting.settings | Post conversion balances and historical data during setup |
| GET, HEAD | /api.xro/2.0/Organisation/Actions | accounting.settings.read | Read which actions the organisation permits |
| GET, HEAD | /api.xro/2.0/Organisation/{id}/CISSettings | accounting.settings.read | Read organisation CIS settings |
| GET, HEAD | /api.xro/2.0/BrandingThemes/{id}/PaymentServices | accounting.settings.read | Read the payment services applied to a branding theme |
| POST | /api.xro/2.0/BrandingThemes/{id}/PaymentServices | accounting.settings | Apply a payment service to a branding theme |
| GET, HEAD | /api.xro/2.0/TrackingCategories/{id}/Options | accounting.settings.read | List the options on a tracking category |
| POST, PUT | /api.xro/2.0/TrackingCategories/{id}/Options | accounting.settings | Create or update options on a tracking category |
| POST, PUT, DELETE | /api.xro/2.0/TrackingCategories/{id}/Options/{optionId} | accounting.settings | Update or delete a single tracking category option |
| GET, HEAD | /api.xro/2.0/InvoiceReminders/Settings | accounting.settings.read | Read invoice reminder settings |
| GET, HEAD | /api.xro/2.0/Reports/* | accounting.reports.read | Run an accounting report (Balance Sheet, Profit & Loss, Aged reports) |
| GET, HEAD | /api.xro/2.0/Reports | accounting.reports.read | List available accounting reports |
| GET, HEAD | /api.xro/2.0/Reports/TenNinetyNine | accounting.reports.tenninetynine.read | Run the 1099 report |
| GET, HEAD | /api.xro/2.0/Journals | accounting.journals.read | Read the general ledger journals feed |
| GET, HEAD | /api.xro/2.0/Journals/{id} | accounting.journals.read | Read a single general ledger journal |
| GET, HEAD | /api.xro/2.0/Budgets | accounting.budgets.read | List budgets |
| GET, HEAD | /api.xro/2.0/Budgets/{id} | accounting.budgets.read | Read a single budget |
Payroll AU (1.0)
| Methods | Path | Required scope | What it does |
|---|---|---|---|
| GET, HEAD | /payroll.xro/1.0/Employees | payroll.employees.read | List employees |
| POST, PUT | /payroll.xro/1.0/Employees | payroll.employees | Create or update employees |
| GET, HEAD | /payroll.xro/1.0/Employees/{id} | payroll.employees.read | Read a single employees record |
| POST, PUT, PATCH, DELETE | /payroll.xro/1.0/Employees/{id} | payroll.employees | Update or delete a single employees record |
| GET, HEAD | /payroll.xro/1.0/PayRuns | payroll.payruns.read | List pay runs |
| POST, PUT | /payroll.xro/1.0/PayRuns | payroll.payruns | Create or update pay runs |
| GET, HEAD | /payroll.xro/1.0/PayRuns/{id} | payroll.payruns.read | Read a single pay runs record |
| POST, PUT, PATCH, DELETE | /payroll.xro/1.0/PayRuns/{id} | payroll.payruns | Update or delete a single pay runs record |
| GET, HEAD | /payroll.xro/1.0/Payslip | payroll.payslip.read | List pay slips |
| POST, PUT | /payroll.xro/1.0/Payslip | payroll.payslip | Create or update pay slips |
| GET, HEAD | /payroll.xro/1.0/Payslip/{id} | payroll.payslip.read | Read a single pay slips record |
| POST, PUT, PATCH, DELETE | /payroll.xro/1.0/Payslip/{id} | payroll.payslip | Update or delete a single pay slips record |
| GET, HEAD | /payroll.xro/1.0/Timesheets | payroll.timesheets.read | List timesheets |
| POST, PUT | /payroll.xro/1.0/Timesheets | payroll.timesheets | Create or update timesheets |
| GET, HEAD | /payroll.xro/1.0/Timesheets/{id} | payroll.timesheets.read | Read a single timesheets record |
| POST, PUT, PATCH, DELETE | /payroll.xro/1.0/Timesheets/{id} | payroll.timesheets | Update or delete a single timesheets record |
| GET, HEAD | /payroll.xro/1.0/PayItems | payroll.settings.read | List pay items |
| POST, PUT | /payroll.xro/1.0/PayItems | payroll.settings | Create or update pay items |
| GET, HEAD | /payroll.xro/1.0/PayItems/{id} | payroll.settings.read | Read a single pay items record |
| POST, PUT, PATCH, DELETE | /payroll.xro/1.0/PayItems/{id} | payroll.settings | Update or delete a single pay items record |
| GET, HEAD | /payroll.xro/1.0/PayrollCalendars | payroll.settings.read | List payroll calendars |
| POST, PUT | /payroll.xro/1.0/PayrollCalendars | payroll.settings | Create or update payroll calendars |
| GET, HEAD | /payroll.xro/1.0/PayrollCalendars/{id} | payroll.settings.read | Read a single payroll calendars record |
| POST, PUT, PATCH, DELETE | /payroll.xro/1.0/PayrollCalendars/{id} | payroll.settings | Update or delete a single payroll calendars record |
| GET, HEAD | /payroll.xro/1.0/Settings | payroll.settings.read | List payroll settings |
| POST, PUT | /payroll.xro/1.0/Settings | payroll.settings | Create or update payroll settings |
| GET, HEAD | /payroll.xro/1.0/Settings/{id} | payroll.settings.read | Read a single payroll settings record |
| POST, PUT, PATCH, DELETE | /payroll.xro/1.0/Settings/{id} | payroll.settings | Update or delete a single payroll settings record |
| GET, HEAD | /payroll.xro/1.0/Superfunds | payroll.superfunds.read | List superannuation funds |
| POST, PUT | /payroll.xro/1.0/Superfunds | payroll.superfunds | Create or update superannuation funds |
| GET, HEAD | /payroll.xro/1.0/Superfunds/{id} | payroll.superfunds.read | Read a single superannuation funds record |
| POST, PUT, PATCH, DELETE | /payroll.xro/1.0/Superfunds/{id} | payroll.superfunds | Update or delete a single superannuation funds record |
| GET, HEAD | /payroll.xro/1.0/LeaveApplications | payroll.employees.read | List leave applications |
| POST, PUT | /payroll.xro/1.0/LeaveApplications | payroll.employees | Create or update leave applications |
| GET, HEAD | /payroll.xro/1.0/LeaveApplications/{id} | payroll.employees.read | Read a single leave applications record |
| POST, PUT, PATCH, DELETE | /payroll.xro/1.0/LeaveApplications/{id} | payroll.employees | Update or delete a single leave applications record |
| GET, HEAD | /payroll.xro/1.0/PayrollCalendars | payroll.settings.read | List payroll calendars |
| POST, PUT | /payroll.xro/1.0/PayrollCalendars | payroll.settings | Create or update payroll calendars |
| GET, HEAD | /payroll.xro/1.0/PayrollCalendars/{id} | payroll.settings.read | Read a single payroll calendars record |
| POST, PUT, PATCH, DELETE | /payroll.xro/1.0/PayrollCalendars/{id} | payroll.settings | Update or delete a single payroll calendars record |
| GET, HEAD | /payroll.xro/1.0/SuperfundProducts | payroll.superfundproducts.read | Read the superannuation fund product register |
Payroll AU
| Methods | Path | Required scope | What it does |
|---|---|---|---|
| GET, HEAD | /payroll.xro/2.0/Employees | payroll.employees.read | List employees |
| POST, PUT | /payroll.xro/2.0/Employees | payroll.employees | Create or update employees |
| GET, HEAD | /payroll.xro/2.0/Employees/{id} | payroll.employees.read | Read a single employees record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/Employees/{id} | payroll.employees | Update or delete a single employees record |
| GET, HEAD | /payroll.xro/2.0/PayRuns | payroll.payruns.read | List pay runs |
| POST, PUT | /payroll.xro/2.0/PayRuns | payroll.payruns | Create or update pay runs |
| GET, HEAD | /payroll.xro/2.0/PayRuns/{id} | payroll.payruns.read | Read a single pay runs record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/PayRuns/{id} | payroll.payruns | Update or delete a single pay runs record |
| GET, HEAD | /payroll.xro/2.0/Timesheets | payroll.timesheets.read | List timesheets |
| POST, PUT | /payroll.xro/2.0/Timesheets | payroll.timesheets | Create or update timesheets |
| GET, HEAD | /payroll.xro/2.0/Timesheets/{id} | payroll.timesheets.read | Read a single timesheets record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/Timesheets/{id} | payroll.timesheets | Update or delete a single timesheets record |
| GET, HEAD | /payroll.xro/2.0/Payslips | payroll.payslip.read | List pay slips |
| POST, PUT | /payroll.xro/2.0/Payslips | payroll.payslip | Create or update pay slips |
| GET, HEAD | /payroll.xro/2.0/Payslips/{id} | payroll.payslip.read | Read a single pay slips record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/Payslips/{id} | payroll.payslip | Update or delete a single pay slips record |
| GET, HEAD | /payroll.xro/2.0/PayRunCalendars | payroll.settings.read | List pay run calendars |
| POST, PUT | /payroll.xro/2.0/PayRunCalendars | payroll.settings | Create or update pay run calendars |
| GET, HEAD | /payroll.xro/2.0/PayRunCalendars/{id} | payroll.settings.read | Read a single pay run calendars record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/PayRunCalendars/{id} | payroll.settings | Update or delete a single pay run calendars record |
| GET, HEAD | /payroll.xro/2.0/PayItems | payroll.settings.read | List pay items |
| POST, PUT | /payroll.xro/2.0/PayItems | payroll.settings | Create or update pay items |
| GET, HEAD | /payroll.xro/2.0/PayItems/{id} | payroll.settings.read | Read a single pay items record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/PayItems/{id} | payroll.settings | Update or delete a single pay items record |
| GET, HEAD | /payroll.xro/2.0/LeaveTypes | payroll.settings.read | List leave types |
| POST, PUT | /payroll.xro/2.0/LeaveTypes | payroll.settings | Create or update leave types |
| GET, HEAD | /payroll.xro/2.0/LeaveTypes/{id} | payroll.settings.read | Read a single leave types record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/LeaveTypes/{id} | payroll.settings | Update or delete a single leave types record |
| GET, HEAD | /payroll.xro/2.0/Settings | payroll.settings.read | List payroll settings |
| POST, PUT | /payroll.xro/2.0/Settings | payroll.settings | Create or update payroll settings |
| GET, HEAD | /payroll.xro/2.0/Settings/{id} | payroll.settings.read | Read a single payroll settings record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/Settings/{id} | payroll.settings | Update or delete a single payroll settings record |
| GET, HEAD | /payroll.xro/2.0/Superfunds | payroll.superfunds.read | List superannuation funds |
| POST, PUT | /payroll.xro/2.0/Superfunds | payroll.superfunds | Create or update superannuation funds |
| GET, HEAD | /payroll.xro/2.0/Superfunds/{id} | payroll.superfunds.read | Read a single superannuation funds record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/Superfunds/{id} | payroll.superfunds | Update or delete a single superannuation funds record |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/Leave | payroll.employees.read | Read leave for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/Employees/{id}/Leave | payroll.employees | Create or update leave for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/Leave/{subId} | payroll.employees.read | Read a single leave record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/Employees/{id}/Leave/{subId} | payroll.employees | Update or delete a single leave record for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/LeaveBalances | payroll.employees.read | Read leave balances for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/Employees/{id}/LeaveBalances | payroll.employees | Create or update leave balances for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/LeaveBalances/{subId} | payroll.employees.read | Read a single leave balances record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/Employees/{id}/LeaveBalances/{subId} | payroll.employees | Update or delete a single leave balances record for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/LeavePeriods | payroll.employees.read | Read leave periods for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/Employees/{id}/LeavePeriods | payroll.employees | Create or update leave periods for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/LeavePeriods/{subId} | payroll.employees.read | Read a single leave periods record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/Employees/{id}/LeavePeriods/{subId} | payroll.employees | Update or delete a single leave periods record for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/LeaveSetup | payroll.employees.read | Read leave setup for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/Employees/{id}/LeaveSetup | payroll.employees | Create or update leave setup for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/LeaveSetup/{subId} | payroll.employees.read | Read a single leave setup record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/Employees/{id}/LeaveSetup/{subId} | payroll.employees | Update or delete a single leave setup record for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/OpeningBalances | payroll.employees.read | Read opening balances for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/Employees/{id}/OpeningBalances | payroll.employees | Create or update opening balances for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/OpeningBalances/{subId} | payroll.employees.read | Read a single opening balances record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/Employees/{id}/OpeningBalances/{subId} | payroll.employees | Update or delete a single opening balances record for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/PayTemplates | payroll.employees.read | Read pay templates for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/Employees/{id}/PayTemplates | payroll.employees | Create or update pay templates for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/PayTemplates/{subId} | payroll.employees.read | Read a single pay templates record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/Employees/{id}/PayTemplates/{subId} | payroll.employees | Update or delete a single pay templates record for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/SalaryAndWages | payroll.employees.read | Read salary and wages for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/Employees/{id}/SalaryAndWages | payroll.employees | Create or update salary and wages for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/SalaryAndWages/{subId} | payroll.employees.read | Read a single salary and wages record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/Employees/{id}/SalaryAndWages/{subId} | payroll.employees | Update or delete a single salary and wages record for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/Tax | payroll.employees.read | Read tax for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/Employees/{id}/Tax | payroll.employees | Create or update tax for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/Tax/{subId} | payroll.employees.read | Read a single tax record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/Employees/{id}/Tax/{subId} | payroll.employees | Update or delete a single tax record for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/SuperMemberships | payroll.employees.read | Read super memberships for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/Employees/{id}/SuperMemberships | payroll.employees | Create or update super memberships for an employee |
| GET, HEAD | /payroll.xro/2.0/Employees/{id}/SuperMemberships/{subId} | payroll.employees.read | Read a single super memberships record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/Employees/{id}/SuperMemberships/{subId} | payroll.employees | Update or delete a single super memberships record for an employee |
Payroll UK
| Methods | Path | Required scope | What it does |
|---|---|---|---|
| GET, HEAD | /payroll.xro/2.0/uk/Employees | payroll_uk.employees.read | List employees |
| POST, PUT | /payroll.xro/2.0/uk/Employees | payroll_uk.employees | Create or update employees |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id} | payroll_uk.employees.read | Read a single employees record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Employees/{id} | payroll_uk.employees | Update or delete a single employees record |
| GET, HEAD | /payroll.xro/2.0/uk/PayRuns | payroll_uk.payruns.read | List pay runs |
| POST, PUT | /payroll.xro/2.0/uk/PayRuns | payroll_uk.payruns | Create or update pay runs |
| GET, HEAD | /payroll.xro/2.0/uk/PayRuns/{id} | payroll_uk.payruns.read | Read a single pay runs record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/PayRuns/{id} | payroll_uk.payruns | Update or delete a single pay runs record |
| GET, HEAD | /payroll.xro/2.0/uk/Payslips | payroll_uk.payslip.read | List pay slips |
| POST, PUT | /payroll.xro/2.0/uk/Payslips | payroll_uk.payslip | Create or update pay slips |
| GET, HEAD | /payroll.xro/2.0/uk/Payslips/{id} | payroll_uk.payslip.read | Read a single pay slips record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Payslips/{id} | payroll_uk.payslip | Update or delete a single pay slips record |
| GET, HEAD | /payroll.xro/2.0/uk/Timesheets | payroll_uk.timesheets.read | List timesheets |
| POST, PUT | /payroll.xro/2.0/uk/Timesheets | payroll_uk.timesheets | Create or update timesheets |
| GET, HEAD | /payroll.xro/2.0/uk/Timesheets/{id} | payroll_uk.timesheets.read | Read a single timesheets record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Timesheets/{id} | payroll_uk.timesheets | Update or delete a single timesheets record |
| GET, HEAD | /payroll.xro/2.0/uk/Settings | payroll_uk.settings.read | List payroll settings |
| POST, PUT | /payroll.xro/2.0/uk/Settings | payroll_uk.settings | Create or update payroll settings |
| GET, HEAD | /payroll.xro/2.0/uk/Settings/{id} | payroll_uk.settings.read | Read a single payroll settings record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Settings/{id} | payroll_uk.settings | Update or delete a single payroll settings record |
| GET, HEAD | /payroll.xro/2.0/uk/PayRunCalendars | payroll_uk.settings.read | List pay run calendars |
| POST, PUT | /payroll.xro/2.0/uk/PayRunCalendars | payroll_uk.settings | Create or update pay run calendars |
| GET, HEAD | /payroll.xro/2.0/uk/PayRunCalendars/{id} | payroll_uk.settings.read | Read a single pay run calendars record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/PayRunCalendars/{id} | payroll_uk.settings | Update or delete a single pay run calendars record |
| GET, HEAD | /payroll.xro/2.0/uk/Earnings | payroll_uk.settings.read | List earnings rates |
| POST, PUT | /payroll.xro/2.0/uk/Earnings | payroll_uk.settings | Create or update earnings rates |
| GET, HEAD | /payroll.xro/2.0/uk/Earnings/{id} | payroll_uk.settings.read | Read a single earnings rates record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Earnings/{id} | payroll_uk.settings | Update or delete a single earnings rates record |
| GET, HEAD | /payroll.xro/2.0/uk/Deductions | payroll_uk.settings.read | List deduction types |
| POST, PUT | /payroll.xro/2.0/uk/Deductions | payroll_uk.settings | Create or update deduction types |
| GET, HEAD | /payroll.xro/2.0/uk/Deductions/{id} | payroll_uk.settings.read | Read a single deduction types record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Deductions/{id} | payroll_uk.settings | Update or delete a single deduction types record |
| GET, HEAD | /payroll.xro/2.0/uk/LeaveTypes | payroll_uk.settings.read | List leave types |
| POST, PUT | /payroll.xro/2.0/uk/LeaveTypes | payroll_uk.settings | Create or update leave types |
| GET, HEAD | /payroll.xro/2.0/uk/LeaveTypes/{id} | payroll_uk.settings.read | Read a single leave types record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/LeaveTypes/{id} | payroll_uk.settings | Update or delete a single leave types record |
| GET, HEAD | /payroll.xro/2.0/uk/Reimbursements | payroll_uk.settings.read | List reimbursement types |
| POST, PUT | /payroll.xro/2.0/uk/Reimbursements | payroll_uk.settings | Create or update reimbursement types |
| GET, HEAD | /payroll.xro/2.0/uk/Reimbursements/{id} | payroll_uk.settings.read | Read a single reimbursement types record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Reimbursements/{id} | payroll_uk.settings | Update or delete a single reimbursement types record |
| GET, HEAD | /payroll.xro/2.0/uk/Benefits | payroll_uk.settings.read | List benefits |
| POST, PUT | /payroll.xro/2.0/uk/Benefits | payroll_uk.settings | Create or update benefits |
| GET, HEAD | /payroll.xro/2.0/uk/Benefits/{id} | payroll_uk.settings.read | Read a single benefits record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Benefits/{id} | payroll_uk.settings | Update or delete a single benefits record |
| GET, HEAD | /payroll.xro/2.0/uk/StatutoryLeaves | payroll_uk.employees.read | List statutory leave |
| POST, PUT | /payroll.xro/2.0/uk/StatutoryLeaves | payroll_uk.employees | Create or update statutory leave |
| GET, HEAD | /payroll.xro/2.0/uk/StatutoryLeaves/{id} | payroll_uk.employees.read | Read a single statutory leave record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/StatutoryLeaves/{id} | payroll_uk.employees | Update or delete a single statutory leave record |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/Employment | payroll_uk.employees.read | Read employment for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/uk/Employees/{id}/Employment | payroll_uk.employees | Create or update employment for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/Employment/{subId} | payroll_uk.employees.read | Read a single employment record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Employees/{id}/Employment/{subId} | payroll_uk.employees | Update or delete a single employment record for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/Tax | payroll_uk.employees.read | Read tax for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/uk/Employees/{id}/Tax | payroll_uk.employees | Create or update tax for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/Tax/{subId} | payroll_uk.employees.read | Read a single tax record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Employees/{id}/Tax/{subId} | payroll_uk.employees | Update or delete a single tax record for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/Leave | payroll_uk.employees.read | Read leave for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/uk/Employees/{id}/Leave | payroll_uk.employees | Create or update leave for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/Leave/{subId} | payroll_uk.employees.read | Read a single leave record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Employees/{id}/Leave/{subId} | payroll_uk.employees | Update or delete a single leave record for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/LeaveBalances | payroll_uk.employees.read | Read leave balances for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/uk/Employees/{id}/LeaveBalances | payroll_uk.employees | Create or update leave balances for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/LeaveBalances/{subId} | payroll_uk.employees.read | Read a single leave balances record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Employees/{id}/LeaveBalances/{subId} | payroll_uk.employees | Update or delete a single leave balances record for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/LeavePeriods | payroll_uk.employees.read | Read leave periods for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/uk/Employees/{id}/LeavePeriods | payroll_uk.employees | Create or update leave periods for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/LeavePeriods/{subId} | payroll_uk.employees.read | Read a single leave periods record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Employees/{id}/LeavePeriods/{subId} | payroll_uk.employees | Update or delete a single leave periods record for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/OpeningBalances | payroll_uk.employees.read | Read opening balances for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/uk/Employees/{id}/OpeningBalances | payroll_uk.employees | Create or update opening balances for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/OpeningBalances/{subId} | payroll_uk.employees.read | Read a single opening balances record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Employees/{id}/OpeningBalances/{subId} | payroll_uk.employees | Update or delete a single opening balances record for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/PayTemplates | payroll_uk.employees.read | Read pay templates for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/uk/Employees/{id}/PayTemplates | payroll_uk.employees | Create or update pay templates for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/PayTemplates/{subId} | payroll_uk.employees.read | Read a single pay templates record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Employees/{id}/PayTemplates/{subId} | payroll_uk.employees | Update or delete a single pay templates record for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/SalaryAndWages | payroll_uk.employees.read | Read salary and wages for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/uk/Employees/{id}/SalaryAndWages | payroll_uk.employees | Create or update salary and wages for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/SalaryAndWages/{subId} | payroll_uk.employees.read | Read a single salary and wages record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Employees/{id}/SalaryAndWages/{subId} | payroll_uk.employees | Update or delete a single salary and wages record for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/WorkingPattern | payroll_uk.employees.read | Read working pattern for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/uk/Employees/{id}/WorkingPattern | payroll_uk.employees | Create or update working pattern for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/WorkingPattern/{subId} | payroll_uk.employees.read | Read a single working pattern record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Employees/{id}/WorkingPattern/{subId} | payroll_uk.employees | Update or delete a single working pattern record for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/Benefits | payroll_uk.employees.read | Read benefits for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/uk/Employees/{id}/Benefits | payroll_uk.employees | Create or update benefits for an employee |
| GET, HEAD | /payroll.xro/2.0/uk/Employees/{id}/Benefits/{subId} | payroll_uk.employees.read | Read a single benefits record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/uk/Employees/{id}/Benefits/{subId} | payroll_uk.employees | Update or delete a single benefits record for an employee |
| POST, PUT | /payroll.xro/2.0/uk/Timesheets/{id}/Lines | payroll_uk.timesheets | Add a line to a UK timesheet |
| POST, PUT, DELETE | /payroll.xro/2.0/uk/Timesheets/{id}/Lines/{lineId} | payroll_uk.timesheets | Update or delete a UK timesheet line |
Payroll NZ
| Methods | Path | Required scope | What it does |
|---|---|---|---|
| GET, HEAD | /payroll.xro/2.0/nz/Employees | payroll_nz.employees.read | List employees |
| POST, PUT | /payroll.xro/2.0/nz/Employees | payroll_nz.employees | Create or update employees |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id} | payroll_nz.employees.read | Read a single employees record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Employees/{id} | payroll_nz.employees | Update or delete a single employees record |
| GET, HEAD | /payroll.xro/2.0/nz/PayRuns | payroll_nz.payruns.read | List pay runs |
| POST, PUT | /payroll.xro/2.0/nz/PayRuns | payroll_nz.payruns | Create or update pay runs |
| GET, HEAD | /payroll.xro/2.0/nz/PayRuns/{id} | payroll_nz.payruns.read | Read a single pay runs record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/PayRuns/{id} | payroll_nz.payruns | Update or delete a single pay runs record |
| GET, HEAD | /payroll.xro/2.0/nz/Payslips | payroll_nz.payslip.read | List pay slips |
| POST, PUT | /payroll.xro/2.0/nz/Payslips | payroll_nz.payslip | Create or update pay slips |
| GET, HEAD | /payroll.xro/2.0/nz/Payslips/{id} | payroll_nz.payslip.read | Read a single pay slips record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Payslips/{id} | payroll_nz.payslip | Update or delete a single pay slips record |
| GET, HEAD | /payroll.xro/2.0/nz/Timesheets | payroll_nz.timesheets.read | List timesheets |
| POST, PUT | /payroll.xro/2.0/nz/Timesheets | payroll_nz.timesheets | Create or update timesheets |
| GET, HEAD | /payroll.xro/2.0/nz/Timesheets/{id} | payroll_nz.timesheets.read | Read a single timesheets record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Timesheets/{id} | payroll_nz.timesheets | Update or delete a single timesheets record |
| GET, HEAD | /payroll.xro/2.0/nz/Settings | payroll_nz.settings.read | List payroll settings |
| POST, PUT | /payroll.xro/2.0/nz/Settings | payroll_nz.settings | Create or update payroll settings |
| GET, HEAD | /payroll.xro/2.0/nz/Settings/{id} | payroll_nz.settings.read | Read a single payroll settings record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Settings/{id} | payroll_nz.settings | Update or delete a single payroll settings record |
| GET, HEAD | /payroll.xro/2.0/nz/PayRunCalendars | payroll_nz.settings.read | List pay run calendars |
| POST, PUT | /payroll.xro/2.0/nz/PayRunCalendars | payroll_nz.settings | Create or update pay run calendars |
| GET, HEAD | /payroll.xro/2.0/nz/PayRunCalendars/{id} | payroll_nz.settings.read | Read a single pay run calendars record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/PayRunCalendars/{id} | payroll_nz.settings | Update or delete a single pay run calendars record |
| GET, HEAD | /payroll.xro/2.0/nz/EarningsRates | payroll_nz.settings.read | List earnings rates |
| POST, PUT | /payroll.xro/2.0/nz/EarningsRates | payroll_nz.settings | Create or update earnings rates |
| GET, HEAD | /payroll.xro/2.0/nz/EarningsRates/{id} | payroll_nz.settings.read | Read a single earnings rates record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/EarningsRates/{id} | payroll_nz.settings | Update or delete a single earnings rates record |
| GET, HEAD | /payroll.xro/2.0/nz/Deductions | payroll_nz.settings.read | List deduction types |
| POST, PUT | /payroll.xro/2.0/nz/Deductions | payroll_nz.settings | Create or update deduction types |
| GET, HEAD | /payroll.xro/2.0/nz/Deductions/{id} | payroll_nz.settings.read | Read a single deduction types record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Deductions/{id} | payroll_nz.settings | Update or delete a single deduction types record |
| GET, HEAD | /payroll.xro/2.0/nz/LeaveTypes | payroll_nz.settings.read | List leave types |
| POST, PUT | /payroll.xro/2.0/nz/LeaveTypes | payroll_nz.settings | Create or update leave types |
| GET, HEAD | /payroll.xro/2.0/nz/LeaveTypes/{id} | payroll_nz.settings.read | Read a single leave types record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/LeaveTypes/{id} | payroll_nz.settings | Update or delete a single leave types record |
| GET, HEAD | /payroll.xro/2.0/nz/Reimbursements | payroll_nz.settings.read | List reimbursement types |
| POST, PUT | /payroll.xro/2.0/nz/Reimbursements | payroll_nz.settings | Create or update reimbursement types |
| GET, HEAD | /payroll.xro/2.0/nz/Reimbursements/{id} | payroll_nz.settings.read | Read a single reimbursement types record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Reimbursements/{id} | payroll_nz.settings | Update or delete a single reimbursement types record |
| GET, HEAD | /payroll.xro/2.0/nz/Superannuations | payroll_nz.settings.read | List superannuation schemes |
| POST, PUT | /payroll.xro/2.0/nz/Superannuations | payroll_nz.settings | Create or update superannuation schemes |
| GET, HEAD | /payroll.xro/2.0/nz/Superannuations/{id} | payroll_nz.settings.read | Read a single superannuation schemes record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Superannuations/{id} | payroll_nz.settings | Update or delete a single superannuation schemes record |
| GET, HEAD | /payroll.xro/2.0/nz/StatutoryDeductions | payroll_nz.settings.read | List statutory deductions |
| POST, PUT | /payroll.xro/2.0/nz/StatutoryDeductions | payroll_nz.settings | Create or update statutory deductions |
| GET, HEAD | /payroll.xro/2.0/nz/StatutoryDeductions/{id} | payroll_nz.settings.read | Read a single statutory deductions record |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/StatutoryDeductions/{id} | payroll_nz.settings | Update or delete a single statutory deductions record |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/Employment | payroll_nz.employees.read | Read employment for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/nz/Employees/{id}/Employment | payroll_nz.employees | Create or update employment for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/Employment/{subId} | payroll_nz.employees.read | Read a single employment record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Employees/{id}/Employment/{subId} | payroll_nz.employees | Update or delete a single employment record for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/Tax | payroll_nz.employees.read | Read tax for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/nz/Employees/{id}/Tax | payroll_nz.employees | Create or update tax for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/Tax/{subId} | payroll_nz.employees.read | Read a single tax record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Employees/{id}/Tax/{subId} | payroll_nz.employees | Update or delete a single tax record for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/Leave | payroll_nz.employees.read | Read leave for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/nz/Employees/{id}/Leave | payroll_nz.employees | Create or update leave for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/Leave/{subId} | payroll_nz.employees.read | Read a single leave record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Employees/{id}/Leave/{subId} | payroll_nz.employees | Update or delete a single leave record for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/LeaveBalances | payroll_nz.employees.read | Read leave balances for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/nz/Employees/{id}/LeaveBalances | payroll_nz.employees | Create or update leave balances for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/LeaveBalances/{subId} | payroll_nz.employees.read | Read a single leave balances record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Employees/{id}/LeaveBalances/{subId} | payroll_nz.employees | Update or delete a single leave balances record for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/LeavePeriods | payroll_nz.employees.read | Read leave periods for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/nz/Employees/{id}/LeavePeriods | payroll_nz.employees | Create or update leave periods for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/LeavePeriods/{subId} | payroll_nz.employees.read | Read a single leave periods record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Employees/{id}/LeavePeriods/{subId} | payroll_nz.employees | Update or delete a single leave periods record for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/LeaveSetup | payroll_nz.employees.read | Read leave setup for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/nz/Employees/{id}/LeaveSetup | payroll_nz.employees | Create or update leave setup for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/LeaveSetup/{subId} | payroll_nz.employees.read | Read a single leave setup record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Employees/{id}/LeaveSetup/{subId} | payroll_nz.employees | Update or delete a single leave setup record for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/OpeningBalances | payroll_nz.employees.read | Read opening balances for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/nz/Employees/{id}/OpeningBalances | payroll_nz.employees | Create or update opening balances for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/OpeningBalances/{subId} | payroll_nz.employees.read | Read a single opening balances record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Employees/{id}/OpeningBalances/{subId} | payroll_nz.employees | Update or delete a single opening balances record for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/PayTemplates | payroll_nz.employees.read | Read pay templates for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/nz/Employees/{id}/PayTemplates | payroll_nz.employees | Create or update pay templates for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/PayTemplates/{subId} | payroll_nz.employees.read | Read a single pay templates record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Employees/{id}/PayTemplates/{subId} | payroll_nz.employees | Update or delete a single pay templates record for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/SalaryAndWages | payroll_nz.employees.read | Read salary and wages for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/nz/Employees/{id}/SalaryAndWages | payroll_nz.employees | Create or update salary and wages for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/SalaryAndWages/{subId} | payroll_nz.employees.read | Read a single salary and wages record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Employees/{id}/SalaryAndWages/{subId} | payroll_nz.employees | Update or delete a single salary and wages record for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/WorkingPattern | payroll_nz.employees.read | Read working pattern for an employee |
| POST, PUT, PATCH | /payroll.xro/2.0/nz/Employees/{id}/WorkingPattern | payroll_nz.employees | Create or update working pattern for an employee |
| GET, HEAD | /payroll.xro/2.0/nz/Employees/{id}/WorkingPattern/{subId} | payroll_nz.employees.read | Read a single working pattern record for an employee |
| POST, PUT, PATCH, DELETE | /payroll.xro/2.0/nz/Employees/{id}/WorkingPattern/{subId} | payroll_nz.employees | Update or delete a single working pattern record for an employee |
Files
| Methods | Path | Required scope | What it does |
|---|---|---|---|
| GET, HEAD | /files.xro/1.0/Files | files.read | List files |
| POST, PUT | /files.xro/1.0/Files | files | Create files |
| GET, HEAD | /files.xro/1.0/Files/{id} | files.read | Read a single files record |
| POST, PUT, PATCH, DELETE | /files.xro/1.0/Files/{id} | files | Update or delete a single files record |
| GET, HEAD | /files.xro/1.0/Folders | files.read | List folders |
| POST, PUT | /files.xro/1.0/Folders | files | Create folders |
| GET, HEAD | /files.xro/1.0/Folders/{id} | files.read | Read a single folders record |
| POST, PUT, PATCH, DELETE | /files.xro/1.0/Folders/{id} | files | Update or delete a single folders record |
| GET, HEAD | /files.xro/1.0/Associations | files.read | List file associations |
| POST, PUT | /files.xro/1.0/Associations | files | Create file associations |
| GET, HEAD | /files.xro/1.0/Associations/{id} | files.read | Read a single file associations record |
| POST, PUT, PATCH, DELETE | /files.xro/1.0/Associations/{id} | files | Update or delete a single file associations record |
| GET, HEAD | /files.xro/1.0/Files/{id}/Content | files.read | Download file content |
| GET, HEAD | /files.xro/1.0/Files/{id}/Associations | files.read | List what a file is associated with |
| POST, PUT | /files.xro/1.0/Files/{id}/Associations | files | Associate a file with an accounting record |
| DELETE | /files.xro/1.0/Files/{id}/Associations/{objectId} | files | Remove one association from a file |
| GET, HEAD | /files.xro/1.0/Associations/Count | files.read | Count associations for a set of objects |
| GET, HEAD | /files.xro/1.0/Inbox | files.read | Read the file inbox folder |
Assets
| Methods | Path | Required scope | What it does |
|---|---|---|---|
| GET, HEAD | /assets.xro/1.0/Assets | assets.read | List fixed assets |
| POST, PUT | /assets.xro/1.0/Assets | assets | Create fixed assets |
| GET, HEAD | /assets.xro/1.0/Assets/{id} | assets.read | Read a single fixed assets record |
| POST, PUT, PATCH, DELETE | /assets.xro/1.0/Assets/{id} | assets | Update or delete a single fixed assets record |
| GET, HEAD | /assets.xro/1.0/AssetTypes | assets.read | List asset types |
| POST, PUT | /assets.xro/1.0/AssetTypes | assets | Create or update an asset type |
| GET, HEAD | /assets.xro/1.0/AssetTypes/{id} | assets.read | Read a single asset type |
| GET, HEAD | /assets.xro/1.0/Settings | assets.read | Read fixed asset settings |
Projects
| Methods | Path | Required scope | What it does |
|---|---|---|---|
| GET, HEAD | /projects.xro/2.0/Projects | projects.read | List projects |
| POST, PUT | /projects.xro/2.0/Projects | projects | Create projects |
| GET, HEAD | /projects.xro/2.0/Projects/{id} | projects.read | Read a single projects record |
| POST, PUT, PATCH, DELETE | /projects.xro/2.0/Projects/{id} | projects | Update or delete a single projects record |
| GET, HEAD | /projects.xro/2.0/ProjectsUsers | projects.read | List project users |
| POST, PUT | /projects.xro/2.0/ProjectsUsers | projects | Create project users |
| GET, HEAD | /projects.xro/2.0/ProjectsUsers/{id} | projects.read | Read a single project users record |
| POST, PUT, PATCH, DELETE | /projects.xro/2.0/ProjectsUsers/{id} | projects | Update or delete a single project users record |
| GET, HEAD | /projects.xro/2.0/Tasks | projects.read | List tasks across projects |
| GET, HEAD | /projects.xro/2.0/Time | projects.read | List time entries across projects |
| GET, HEAD | /projects.xro/2.0/Projects/{id}/Tasks | projects.read | List tasks on a project |
| POST | /projects.xro/2.0/Projects/{id}/Tasks | projects | Create a task on a project |
| GET, HEAD | /projects.xro/2.0/Projects/{id}/Tasks/{taskId} | projects.read | Read a single task on a project |
| PUT, PATCH, DELETE | /projects.xro/2.0/Projects/{id}/Tasks/{taskId} | projects | Update or delete a task on a project |
| GET, HEAD | /projects.xro/2.0/Projects/{id}/Time | projects.read | List time entries on a project |
| POST | /projects.xro/2.0/Projects/{id}/Time | projects | Create a time entry on a project |
| GET, HEAD | /projects.xro/2.0/Projects/{id}/Time/{timeEntryId} | projects.read | Read a single time entry |
| PUT, PATCH, DELETE | /projects.xro/2.0/Projects/{id}/Time/{timeEntryId} | projects | Update or delete a time entry |
Bank Feeds
| Methods | Path | Required scope | What it does |
|---|---|---|---|
| GET, HEAD, POST, DELETE | /bankfeeds.xro/1.0/FeedConnections | bankfeeds | Manage bank feed connections |
| GET, HEAD, DELETE | /bankfeeds.xro/1.0/FeedConnections/{id} | bankfeeds | Read or delete a bank feed connection |
| GET, HEAD, POST | /bankfeeds.xro/1.0/Statements | bankfeeds | Deliver or list bank feed statements |
| GET, HEAD | /bankfeeds.xro/1.0/Statements/{id} | bankfeeds | Read a single bank feed statement |
Finance
| Methods | Path | Required scope | What it does |
|---|---|---|---|
| GET, HEAD | /finance.xro/1.0/AccountingActivity/* | finance.accountingactivity.read | Read accounting activity metrics |
| GET, HEAD | /finance.xro/1.0/CashValidation | finance.cashvalidation.read | Read cash validation data |
| GET, HEAD | /finance.xro/1.0/Statements/* | finance.statements.read | Read bank statements accounting data |
| GET, HEAD | /finance.xro/1.0/BankStatementsPlus/* | finance.bankstatementsplus.read | Read enriched bank statement data |
If an endpoint is missing
An unmapped method and path returns 403 route_not_mapped and is logged loudly on our side. That is the designed way to find gaps: a missing route is visible and refused, never quietly forwarded without a scope check.