Skip to content
Changelog

Report a bug

Xero integration: operations for AI agents

Xero connects to Type.com as an integration. This page lists the 485 operations documented for Claude and Codex in Type.com: 259 read, 77 write, 149 destructive.

About Xero

Xero is a cloud-based accounting software for small businesses, providing invoicing, bank reconciliation, bookkeeping, and financial reporting in real time

Categories: Finance & Accounting

How to connect Xero to Type.com

Connect
Managed OAuth through Pipedream when enabled for your workspace
Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

485 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

485 operations listed.

Accounting

  • Read

    Retrieves the full chart of accounts

    GET /Accounts

    GET /Accounts

  • Read

    Retrieves a single chart of accounts by using a unique account Id

    GET /Accounts/{AccountID}

    GET /Accounts/{AccountID}

  • Read

    Retrieves attachments for a specific accounts by using a unique account Id

    GET /Accounts/{AccountID}/Attachments

    GET /Accounts/{AccountID}/Attachments

  • Read

    Retrieves a specific attachment from a specific account using a unique attachment Id

    GET /Accounts/{AccountID}/Attachments/{AttachmentID}

    GET /Accounts/{AccountID}/Attachments/{AttachmentID}

  • Read

    Retrieves an attachment for a specific account by filename

    GET /Accounts/{AccountID}/Attachments/{FileName}

    GET /Accounts/{AccountID}/Attachments/{FileName}

  • Read

    Retrieves either one or many batch payments for invoices

    GET /BatchPayments

    GET /BatchPayments

  • Read

    Retrieves a specific batch payment using a unique batch payment Id

    GET /BatchPayments/{BatchPaymentID}

    GET /BatchPayments/{BatchPaymentID}

  • Read

    Retrieves history from a specific batch payment

    GET /BatchPayments/{BatchPaymentID}/History

    GET /BatchPayments/{BatchPaymentID}/History

  • Read

    Retrieves any spent or received money transactions

    GET /BankTransactions

    GET /BankTransactions

  • Read

    Retrieves a single spent or received money transaction by using a unique bank transaction Id

    GET /BankTransactions/{BankTransactionID}

    GET /BankTransactions/{BankTransactionID}

  • Read

    Retrieves any attachments from a specific bank transactions

    GET /BankTransactions/{BankTransactionID}/Attachments

    GET /BankTransactions/{BankTransactionID}/Attachments

  • Read

    Retrieves specific attachments from a specific BankTransaction using a unique attachment Id

    GET /BankTransactions/{BankTransactionID}/Attachments/{AttachmentID}

    GET /BankTransactions/{BankTransactionID}/Attachments/{AttachmentID}

  • Read

    Retrieves a specific attachment from a specific bank transaction by filename

    GET /BankTransactions/{BankTransactionID}/Attachments/{FileName}

    GET /BankTransactions/{BankTransactionID}/Attachments/{FileName}

  • Read

    Retrieves history from a specific bank transaction using a unique bank transaction Id

    GET /BankTransactions/{BankTransactionID}/History

    GET /BankTransactions/{BankTransactionID}/History

  • Read

    Retrieves all bank transfers

    GET /BankTransfers

    GET /BankTransfers

  • Read

    Retrieves specific bank transfers by using a unique bank transfer Id

    GET /BankTransfers/{BankTransferID}

    GET /BankTransfers/{BankTransferID}

  • Read

    Retrieves attachments from a specific bank transfer

    GET /BankTransfers/{BankTransferID}/Attachments

    GET /BankTransfers/{BankTransferID}/Attachments

  • Read

    Retrieves a specific attachment from a specific bank transfer using a unique attachment ID

    GET /BankTransfers/{BankTransferID}/Attachments/{AttachmentID}

    GET /BankTransfers/{BankTransferID}/Attachments/{AttachmentID}

  • Read

    Retrieves a specific attachment on a specific bank transfer by file name

    GET /BankTransfers/{BankTransferID}/Attachments/{FileName}

    GET /BankTransfers/{BankTransferID}/Attachments/{FileName}

  • Read

    Retrieves history from a specific bank transfer using a unique bank transfer Id

    GET /BankTransfers/{BankTransferID}/History

    GET /BankTransfers/{BankTransferID}/History

  • Read

    Retrieves all the branding themes

    GET /BrandingThemes

    GET /BrandingThemes

  • Read

    Retrieves a specific branding theme using a unique branding theme Id

    GET /BrandingThemes/{BrandingThemeID}

    GET /BrandingThemes/{BrandingThemeID}

  • Read

    Retrieves the payment services for a specific branding theme

    GET /BrandingThemes/{BrandingThemeID}/PaymentServices

    GET /BrandingThemes/{BrandingThemeID}/PaymentServices

  • Read

    Retrieve a list of budgets

    GET /Budgets

    GET /Budgets

  • Read

    Retrieves a specific budget, which includes budget lines

    GET /Budgets/{BudgetID}

    GET /Budgets/{BudgetID}

  • Read

    Retrieves all contacts in a Xero organisation

    GET /Contacts

    GET /Contacts

  • Read

    Retrieves a specific contact by contact number in a Xero organisation

    GET /Contacts/{ContactNumber}

    GET /Contacts/{ContactNumber}

  • Read

    Retrieves a specific contacts in a Xero organisation using a unique contact Id

    GET /Contacts/{ContactID}

    GET /Contacts/{ContactID}

  • Read

    Retrieves attachments for a specific contact in a Xero organisation

    GET /Contacts/{ContactID}/Attachments

    GET /Contacts/{ContactID}/Attachments

  • Read

    Retrieves a specific attachment from a specific contact using a unique attachment Id

    GET /Contacts/{ContactID}/Attachments/{AttachmentID}

    GET /Contacts/{ContactID}/Attachments/{AttachmentID}

  • Read

    Retrieves a specific attachment from a specific contact by file name

    GET /Contacts/{ContactID}/Attachments/{FileName}

    GET /Contacts/{ContactID}/Attachments/{FileName}

  • Read

    Retrieves CIS settings for a specific contact in a Xero organisation

    GET /Contacts/{ContactID}/CISSettings

    GET /Contacts/{ContactID}/CISSettings

  • Read

    Retrieves history records for a specific contact

    GET /Contacts/{ContactID}/History

    GET /Contacts/{ContactID}/History

  • Read

    Retrieves the contact Id and name of each contact group

    GET /ContactGroups

    GET /ContactGroups

  • Read

    Retrieves a specific contact group by using a unique contact group Id

    GET /ContactGroups/{ContactGroupID}

    GET /ContactGroups/{ContactGroupID}

  • Read

    Retrieves any credit notes

    GET /CreditNotes

    GET /CreditNotes

  • Read

    Retrieves a specific credit note using a unique credit note Id

    GET /CreditNotes/{CreditNoteID}

    GET /CreditNotes/{CreditNoteID}

  • Read

    Retrieves attachments for a specific credit notes

    GET /CreditNotes/{CreditNoteID}/Attachments

    GET /CreditNotes/{CreditNoteID}/Attachments

  • Read

    Retrieves a specific attachment from a specific credit note using a unique attachment Id

    GET /CreditNotes/{CreditNoteID}/Attachments/{AttachmentID}

    GET /CreditNotes/{CreditNoteID}/Attachments/{AttachmentID}

  • Read

    Retrieves a specific attachment on a specific credit note by file name

    GET /CreditNotes/{CreditNoteID}/Attachments/{FileName}

    GET /CreditNotes/{CreditNoteID}/Attachments/{FileName}

  • Read

    Retrieves credit notes as PDF files

    GET /CreditNotes/{CreditNoteID}/pdf

    GET /CreditNotes/{CreditNoteID}/pdf

  • Read

    Retrieves history records of a specific credit note

    GET /CreditNotes/{CreditNoteID}/History

    GET /CreditNotes/{CreditNoteID}/History

  • Read

    Retrieves currencies for your Xero organisation

    GET /Currencies

    GET /Currencies

  • Read

    Retrieves expense claims

    GET /ExpenseClaims

    GET /ExpenseClaims

  • Read

    Retrieves a specific expense claim using a unique expense claim Id

    GET /ExpenseClaims/{ExpenseClaimID}

    GET /ExpenseClaims/{ExpenseClaimID}

  • Read

    Retrieves history records of a specific expense claim

    GET /ExpenseClaims/{ExpenseClaimID}/History

    GET /ExpenseClaims/{ExpenseClaimID}/History

  • Read

    Retrieves sales invoices or purchase bills

    GET /Invoices

    GET /Invoices

  • Read

    Retrieves a specific sales invoice or purchase bill using a unique invoice Id

    GET /Invoices/{InvoiceID}

    GET /Invoices/{InvoiceID}

  • Read

    Retrieves invoices or purchase bills as PDF files

    GET /Invoices/{InvoiceID}/pdf

    GET /Invoices/{InvoiceID}/pdf

  • Read

    Retrieves attachments for a specific invoice or purchase bill

    GET /Invoices/{InvoiceID}/Attachments

    GET /Invoices/{InvoiceID}/Attachments

  • Read

    Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id

    GET /Invoices/{InvoiceID}/Attachments/{AttachmentID}

    GET /Invoices/{InvoiceID}/Attachments/{AttachmentID}

  • Read

    Retrieves an attachment from a specific invoice or purchase bill by filename

    GET /Invoices/{InvoiceID}/Attachments/{FileName}

    GET /Invoices/{InvoiceID}/Attachments/{FileName}

  • Read

    Retrieves a URL to an online invoice

    GET /Invoices/{InvoiceID}/OnlineInvoice

    GET /Invoices/{InvoiceID}/OnlineInvoice

  • Read

    Retrieves history records for a specific invoice

    GET /Invoices/{InvoiceID}/History

    GET /Invoices/{InvoiceID}/History

  • Read

    Retrieves invoice reminder settings

    GET /InvoiceReminders/Settings

    GET /InvoiceReminders/Settings

  • Read

    Retrieves items

    GET /Items

    GET /Items

  • Read

    Retrieves a specific item using a unique item Id

    GET /Items/{ItemID}

    GET /Items/{ItemID}

  • Read

    Retrieves history for a specific item

    GET /Items/{ItemID}/History

    GET /Items/{ItemID}/History

  • Read

    Retrieves journals

    GET /Journals

    GET /Journals

  • Read

    Retrieves a specific journal using a unique journal Id.

    GET /Journals/{JournalID}

    GET /Journals/{JournalID}

  • Read

    Retrieves a specific journal using a unique journal number.

    GET /Journals/{JournalNumber}

    GET /Journals/{JournalNumber}

  • Read

    Retrieves linked transactions (billable expenses)

    GET /LinkedTransactions

    GET /LinkedTransactions

  • Read

    Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id

    GET /LinkedTransactions/{LinkedTransactionID}

    GET /LinkedTransactions/{LinkedTransactionID}

  • Read

    Retrieves manual journals

    GET /ManualJournals

    GET /ManualJournals

  • Read

    Retrieves a specific manual journal

    GET /ManualJournals/{ManualJournalID}

    GET /ManualJournals/{ManualJournalID}

  • Read

    Retrieves attachment for a specific manual journal

    GET /ManualJournals/{ManualJournalID}/Attachments

    GET /ManualJournals/{ManualJournalID}/Attachments

  • Read

    Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id

    GET /ManualJournals/{ManualJournalID}/Attachments/{AttachmentID}

    GET /ManualJournals/{ManualJournalID}/Attachments/{AttachmentID}

  • Read

    Retrieves a specific attachment from a specific manual journal by file name

    GET /ManualJournals/{ManualJournalID}/Attachments/{FileName}

    GET /ManualJournals/{ManualJournalID}/Attachments/{FileName}

  • Read

    Retrieves history for a specific manual journal

    GET /ManualJournals/{ManualJournalID}/History

    GET /ManualJournals/{ManualJournalID}/History

  • Read

    Retrieves Xero organisation details

    GET /Organisation

    GET /Organisation

  • Read

    Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.

    GET /Organisation/Actions

    GET /Organisation/Actions

  • Read

    Retrieves the CIS settings for the Xero organistaion.

    GET /Organisation/{OrganisationID}/CISSettings

    GET /Organisation/{OrganisationID}/CISSettings

  • Read

    Retrieves overpayments

    GET /Overpayments

    GET /Overpayments

  • Read

    Retrieves a specific overpayment using a unique overpayment Id

    GET /Overpayments/{OverpaymentID}

    GET /Overpayments/{OverpaymentID}

  • Read

    Retrieves history records of a specific overpayment

    GET /Overpayments/{OverpaymentID}/History

    GET /Overpayments/{OverpaymentID}/History

  • Read

    Retrieves payments for invoices and credit notes

    GET /Payments

    GET /Payments

  • Read

    Retrieves a specific payment for invoices and credit notes using a unique payment Id

    GET /Payments/{PaymentID}

    GET /Payments/{PaymentID}

  • Read

    Retrieves history records of a specific payment

    GET /Payments/{PaymentID}/History

    GET /Payments/{PaymentID}/History

  • Read

    Retrieves payment services

    GET /PaymentServices

    GET /PaymentServices

  • Read

    Retrieves prepayments

    GET /Prepayments

    GET /Prepayments

  • Read

    Allows you to retrieve a specified prepayments

    GET /Prepayments/{PrepaymentID}

    GET /Prepayments/{PrepaymentID}

  • Read

    Retrieves history record for a specific prepayment

    GET /Prepayments/{PrepaymentID}/History

    GET /Prepayments/{PrepaymentID}/History

  • Read

    Retrieves purchase orders

    GET /PurchaseOrders

    GET /PurchaseOrders

  • Read

    Retrieves specific purchase order as PDF files using a unique purchase order Id

    GET /PurchaseOrders/{PurchaseOrderID}/pdf

    GET /PurchaseOrders/{PurchaseOrderID}/pdf

  • Read

    Retrieves a specific purchase order using a unique purchase order Id

    GET /PurchaseOrders/{PurchaseOrderID}

    GET /PurchaseOrders/{PurchaseOrderID}

  • Read

    Retrieves a specific purchase order using purchase order number

    GET /PurchaseOrders/{PurchaseOrderNumber}

    GET /PurchaseOrders/{PurchaseOrderNumber}

  • Read

    Retrieves history for a specific purchase order

    GET /PurchaseOrders/{PurchaseOrderID}/History

    GET /PurchaseOrders/{PurchaseOrderID}/History

  • Read

    Retrieves attachments for a specific purchase order

    GET /PurchaseOrders/{PurchaseOrderID}/Attachments

    GET /PurchaseOrders/{PurchaseOrderID}/Attachments

  • Read

    Retrieves specific attachment for a specific purchase order using a unique attachment Id

    GET /PurchaseOrders/{PurchaseOrderID}/Attachments/{AttachmentID}

    GET /PurchaseOrders/{PurchaseOrderID}/Attachments/{AttachmentID}

  • Read

    Retrieves a specific attachment for a specific purchase order by filename

    GET /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}

    GET /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}

  • Read

    Retrieves sales quotes

    GET /Quotes

    GET /Quotes

  • Read

    Retrieves a specific quote using a unique quote Id

    GET /Quotes/{QuoteID}

    GET /Quotes/{QuoteID}

  • Read

    Retrieves history records of a specific quote

    GET /Quotes/{QuoteID}/History

    GET /Quotes/{QuoteID}/History

  • Read

    Retrieves a specific quote as a PDF file using a unique quote Id

    GET /Quotes/{QuoteID}/pdf

    GET /Quotes/{QuoteID}/pdf

  • Read

    Retrieves attachments for a specific quote

    GET /Quotes/{QuoteID}/Attachments

    GET /Quotes/{QuoteID}/Attachments

  • Read

    Retrieves a specific attachment from a specific quote using a unique attachment Id

    GET /Quotes/{QuoteID}/Attachments/{AttachmentID}

    GET /Quotes/{QuoteID}/Attachments/{AttachmentID}

  • Read

    Retrieves a specific attachment from a specific quote by filename

    GET /Quotes/{QuoteID}/Attachments/{FileName}

    GET /Quotes/{QuoteID}/Attachments/{FileName}

  • Read

    Retrieves draft expense claim receipts for any user

    GET /Receipts

    GET /Receipts

  • Read

    Retrieves a specific draft expense claim receipt by using a unique receipt Id

    GET /Receipts/{ReceiptID}

    GET /Receipts/{ReceiptID}

  • Read

    Retrieves attachments for a specific expense claim receipt

    GET /Receipts/{ReceiptID}/Attachments

    GET /Receipts/{ReceiptID}/Attachments

  • Read

    Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id

    GET /Receipts/{ReceiptID}/Attachments/{AttachmentID}

    GET /Receipts/{ReceiptID}/Attachments/{AttachmentID}

  • Read

    Retrieves a specific attachment from a specific expense claim receipts by file name

    GET /Receipts/{ReceiptID}/Attachments/{FileName}

    GET /Receipts/{ReceiptID}/Attachments/{FileName}

  • Read

    Retrieves a history record for a specific receipt

    GET /Receipts/{ReceiptID}/History

    GET /Receipts/{ReceiptID}/History

  • Read

    Retrieves repeating invoices

    GET /RepeatingInvoices

    GET /RepeatingInvoices

  • Read

    Retrieves a specific repeating invoice by using a unique repeating invoice Id

    GET /RepeatingInvoices/{RepeatingInvoiceID}

    GET /RepeatingInvoices/{RepeatingInvoiceID}

  • Read

    Retrieves attachments from a specific repeating invoice

    GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments

    GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments

  • Read

    Retrieves a specific attachment from a specific repeating invoice

    GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID}

    GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID}

  • Read

    Retrieves a specific attachment from a specific repeating invoices by file name

    GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}

    GET /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}

  • Read

    Retrieves history record for a specific repeating invoice

    GET /RepeatingInvoices/{RepeatingInvoiceID}/History

    GET /RepeatingInvoices/{RepeatingInvoiceID}/History

  • Read

    Retrieve reports for 1099

    GET /Reports/TenNinetyNine

    GET /Reports/TenNinetyNine

  • Read

    Retrieves report for aged payables by contact

    GET /Reports/AgedPayablesByContact

    GET /Reports/AgedPayablesByContact

  • Read

    Retrieves report for aged receivables by contact

    GET /Reports/AgedReceivablesByContact

    GET /Reports/AgedReceivablesByContact

  • Read

    Retrieves report for balancesheet

    GET /Reports/BalanceSheet

    GET /Reports/BalanceSheet

  • Read

    Retrieves report for bank summary

    GET /Reports/BankSummary

    GET /Reports/BankSummary

  • Read

    Retrieves a specific report using a unique ReportID

    GET /Reports/{ReportID}

    GET /Reports/{ReportID}

  • Read

    Retrieves report for budget summary

    GET /Reports/BudgetSummary

    GET /Reports/BudgetSummary

  • Read

    Retrieves report for executive summary

    GET /Reports/ExecutiveSummary

    GET /Reports/ExecutiveSummary

  • Read

    Retrieves a list of the organistaions unique reports that require a uuid to fetch

    GET /Reports

    GET /Reports

  • Read

    Retrieves report for profit and loss

    GET /Reports/ProfitAndLoss

    GET /Reports/ProfitAndLoss

  • Read

    Retrieves report for trial balance

    GET /Reports/TrialBalance

    GET /Reports/TrialBalance

  • Read

    Retrieves tax rates

    GET /TaxRates

    GET /TaxRates

  • Read

    Retrieves a specific tax rate according to given TaxType code

    GET /TaxRates/{TaxType}

    GET /TaxRates/{TaxType}

  • Read

    Retrieves tracking categories and options

    GET /TrackingCategories

    GET /TrackingCategories

  • Read

    Retrieves specific tracking categories and options using a unique tracking category Id

    GET /TrackingCategories/{TrackingCategoryID}

    GET /TrackingCategories/{TrackingCategoryID}

  • Read

    Retrieves users

    GET /Users

    GET /Users

  • Read

    Retrieves a specific user

    GET /Users/{UserID}

    GET /Users/{UserID}

  • Write

    Updates a specific expense claims

    POST /ExpenseClaims/{ExpenseClaimID}

    POST /ExpenseClaims/{ExpenseClaimID}

  • Write

    Sends a copy of a specific invoice to related contact via email

    POST /Invoices/{InvoiceID}/Email

    POST /Invoices/{InvoiceID}/Email

  • Write

    Updates a specific linked transactions (billable expenses)

    POST /LinkedTransactions/{LinkedTransactionID}

    POST /LinkedTransactions/{LinkedTransactionID}

  • Write

    Updates a specific draft expense claim receipts

    POST /Receipts/{ReceiptID}

    POST /Receipts/{ReceiptID}

  • Write

    Updates a specific attachment on a specific expense claim receipts by file name

    POST /Receipts/{ReceiptID}/Attachments/{FileName}

    POST /Receipts/{ReceiptID}/Attachments/{FileName}

  • Write

    Sets the chart of accounts, the conversion date and conversion balances

    POST /Setup

    POST /Setup

  • Destructive

    Creates a new chart of accounts

    PUT /Accounts

    PUT /Accounts

  • Destructive

    Updates a chart of accounts

    POST /Accounts/{AccountID}

    POST /Accounts/{AccountID}

  • Destructive

    Deletes a chart of accounts

    DELETE /Accounts/{AccountID}

    DELETE /Accounts/{AccountID}

  • Destructive

    Updates attachment on a specific account by filename

    POST /Accounts/{AccountID}/Attachments/{FileName}

    POST /Accounts/{AccountID}/Attachments/{FileName}

  • Destructive

    Creates an attachment on a specific account

    PUT /Accounts/{AccountID}/Attachments/{FileName}

    PUT /Accounts/{AccountID}/Attachments/{FileName}

  • Destructive

    Updates a specific batch payment for invoices and credit notes

    POST /BatchPayments

    POST /BatchPayments

  • Destructive

    Creates one or many batch payments for invoices

    PUT /BatchPayments

    PUT /BatchPayments

  • Destructive

    Updates a specific batch payment for invoices and credit notes

    POST /BatchPayments/{BatchPaymentID}

    POST /BatchPayments/{BatchPaymentID}

  • Destructive

    Creates a history record for a specific batch payment

    PUT /BatchPayments/{BatchPaymentID}/History

    PUT /BatchPayments/{BatchPaymentID}/History

  • Destructive

    Updates or creates one or more spent or received money transaction

    POST /BankTransactions

    POST /BankTransactions

  • Destructive

    Creates one or more spent or received money transaction

    PUT /BankTransactions

    PUT /BankTransactions

  • Destructive

    Updates a single spent or received money transaction

    POST /BankTransactions/{BankTransactionID}

    POST /BankTransactions/{BankTransactionID}

  • Destructive

    Updates a specific attachment from a specific bank transaction by filename

    POST /BankTransactions/{BankTransactionID}/Attachments/{FileName}

    POST /BankTransactions/{BankTransactionID}/Attachments/{FileName}

  • Destructive

    Creates an attachment for a specific bank transaction by filename

    PUT /BankTransactions/{BankTransactionID}/Attachments/{FileName}

    PUT /BankTransactions/{BankTransactionID}/Attachments/{FileName}

  • Destructive

    Creates a history record for a specific bank transactions

    PUT /BankTransactions/{BankTransactionID}/History

    PUT /BankTransactions/{BankTransactionID}/History

  • Destructive

    Deletes one or more bank transfers

    POST /BankTransfers

    POST /BankTransfers

  • Destructive

    Creates a bank transfer

    PUT /BankTransfers

    PUT /BankTransfers

  • Destructive

    Deletes a specific bank transfer

    POST /BankTransfers/{BankTransferID}

    POST /BankTransfers/{BankTransferID}

  • Destructive

    Update Bank Transfer Attachment By File Name

    POST /BankTransfers/{BankTransferID}/Attachments/{FileName}

    POST /BankTransfers/{BankTransferID}/Attachments/{FileName}

  • Destructive

    Create Bank Transfer Attachment By File Name

    PUT /BankTransfers/{BankTransferID}/Attachments/{FileName}

    PUT /BankTransfers/{BankTransferID}/Attachments/{FileName}

  • Destructive

    Creates a history record for a specific bank transfer

    PUT /BankTransfers/{BankTransferID}/History

    PUT /BankTransfers/{BankTransferID}/History

  • Destructive

    Creates a new custom payment service for a specific branding theme

    POST /BrandingThemes/{BrandingThemeID}/PaymentServices

    POST /BrandingThemes/{BrandingThemeID}/PaymentServices

  • Destructive

    Updates or creates one or more contacts in a Xero organisation

    POST /Contacts

    POST /Contacts

  • Destructive

    Creates multiple contacts (bulk) in a Xero organisation

    PUT /Contacts

    PUT /Contacts

  • Destructive

    Updates a specific contact in a Xero organisation

    POST /Contacts/{ContactID}

    POST /Contacts/{ContactID}

  • Destructive

    Update Contact Attachment By File Name

    POST /Contacts/{ContactID}/Attachments/{FileName}

    POST /Contacts/{ContactID}/Attachments/{FileName}

  • Destructive

    Create Contact Attachment By File Name

    PUT /Contacts/{ContactID}/Attachments/{FileName}

    PUT /Contacts/{ContactID}/Attachments/{FileName}

  • Destructive

    Creates a new history record for a specific contact

    PUT /Contacts/{ContactID}/History

    PUT /Contacts/{ContactID}/History

  • Destructive

    Creates a contact group

    PUT /ContactGroups

    PUT /ContactGroups

  • Destructive

    Updates a specific contact group

    POST /ContactGroups/{ContactGroupID}

    POST /ContactGroups/{ContactGroupID}

  • Destructive

    Creates contacts to a specific contact group

    PUT /ContactGroups/{ContactGroupID}/Contacts

    PUT /ContactGroups/{ContactGroupID}/Contacts

  • Destructive

    Deletes all contacts from a specific contact group

    DELETE /ContactGroups/{ContactGroupID}/Contacts

    DELETE /ContactGroups/{ContactGroupID}/Contacts

  • Destructive

    Deletes a specific contact from a contact group using a unique contact Id

    DELETE /ContactGroups/{ContactGroupID}/Contacts/{ContactID}

    DELETE /ContactGroups/{ContactGroupID}/Contacts/{ContactID}

  • Destructive

    Updates or creates one or more credit notes

    POST /CreditNotes

    POST /CreditNotes

  • Destructive

    Creates a new credit note

    PUT /CreditNotes

    PUT /CreditNotes

  • Destructive

    Updates a specific credit note

    POST /CreditNotes/{CreditNoteID}

    POST /CreditNotes/{CreditNoteID}

  • Destructive

    Updates attachments on a specific credit note by file name

    POST /CreditNotes/{CreditNoteID}/Attachments/{FileName}

    POST /CreditNotes/{CreditNoteID}/Attachments/{FileName}

  • Destructive

    Creates an attachment for a specific credit note

    PUT /CreditNotes/{CreditNoteID}/Attachments/{FileName}

    PUT /CreditNotes/{CreditNoteID}/Attachments/{FileName}

  • Destructive

    Creates allocation for a specific credit note

    PUT /CreditNotes/{CreditNoteID}/Allocations

    PUT /CreditNotes/{CreditNoteID}/Allocations

  • Destructive

    Deletes an Allocation from a Credit Note

    DELETE /CreditNotes/{CreditNoteID}/Allocations/{AllocationID}

    DELETE /CreditNotes/{CreditNoteID}/Allocations/{AllocationID}

  • Destructive

    Retrieves history records of a specific credit note

    PUT /CreditNotes/{CreditNoteID}/History

    PUT /CreditNotes/{CreditNoteID}/History

  • Destructive

    Create a new currency for a Xero organisation

    PUT /Currencies

    PUT /Currencies

  • Destructive

    Creates expense claims

    PUT /ExpenseClaims

    PUT /ExpenseClaims

  • Destructive

    Creates a history record for a specific expense claim

    PUT /ExpenseClaims/{ExpenseClaimID}/History

    PUT /ExpenseClaims/{ExpenseClaimID}/History

  • Destructive

    Updates or creates one or more sales invoices or purchase bills

    POST /Invoices

    POST /Invoices

  • Destructive

    Creates one or more sales invoices or purchase bills

    PUT /Invoices

    PUT /Invoices

  • Destructive

    Updates a specific sales invoices or purchase bills

    POST /Invoices/{InvoiceID}

    POST /Invoices/{InvoiceID}

  • Destructive

    Updates an attachment from a specific invoices or purchase bill by filename

    POST /Invoices/{InvoiceID}/Attachments/{FileName}

    POST /Invoices/{InvoiceID}/Attachments/{FileName}

  • Destructive

    Creates an attachment for a specific invoice or purchase bill by filename

    PUT /Invoices/{InvoiceID}/Attachments/{FileName}

    PUT /Invoices/{InvoiceID}/Attachments/{FileName}

  • Destructive

    Creates a history record for a specific invoice

    PUT /Invoices/{InvoiceID}/History

    PUT /Invoices/{InvoiceID}/History

  • Destructive

    Updates or creates one or more items

    POST /Items

    POST /Items

  • Destructive

    Creates one or more items

    PUT /Items

    PUT /Items

  • Destructive

    Updates a specific item

    POST /Items/{ItemID}

    POST /Items/{ItemID}

  • Destructive

    Deletes a specific item

    DELETE /Items/{ItemID}

    DELETE /Items/{ItemID}

  • Destructive

    Creates a history record for a specific item

    PUT /Items/{ItemID}/History

    PUT /Items/{ItemID}/History

  • Destructive

    Creates linked transactions (billable expenses)

    PUT /LinkedTransactions

    PUT /LinkedTransactions

  • Destructive

    Deletes a specific linked transactions (billable expenses)

    DELETE /LinkedTransactions/{LinkedTransactionID}

    DELETE /LinkedTransactions/{LinkedTransactionID}

  • Destructive

    Updates or creates a single manual journal

    POST /ManualJournals

    POST /ManualJournals

  • Destructive

    Creates one or more manual journals

    PUT /ManualJournals

    PUT /ManualJournals

  • Destructive

    Updates a specific manual journal

    POST /ManualJournals/{ManualJournalID}

    POST /ManualJournals/{ManualJournalID}

  • Destructive

    Updates a specific attachment from a specific manual journal by file name

    POST /ManualJournals/{ManualJournalID}/Attachments/{FileName}

    POST /ManualJournals/{ManualJournalID}/Attachments/{FileName}

  • Destructive

    Creates a specific attachment for a specific manual journal by file name

    PUT /ManualJournals/{ManualJournalID}/Attachments/{FileName}

    PUT /ManualJournals/{ManualJournalID}/Attachments/{FileName}

  • Destructive

    Creates a history record for a specific manual journal

    PUT /ManualJournals/{ManualJournalID}/History

    PUT /ManualJournals/{ManualJournalID}/History

  • Destructive

    Creates a single allocation for a specific overpayment

    PUT /Overpayments/{OverpaymentID}/Allocations

    PUT /Overpayments/{OverpaymentID}/Allocations

  • Destructive

    Deletes an Allocation from an overpayment

    DELETE /Overpayments/{OverpaymentID}/Allocations/{AllocationID}

    DELETE /Overpayments/{OverpaymentID}/Allocations/{AllocationID}

  • Destructive

    Creates a history record for a specific overpayment

    PUT /Overpayments/{OverpaymentID}/History

    PUT /Overpayments/{OverpaymentID}/History

  • Destructive

    Creates a single payment for invoice or credit notes

    POST /Payments

    POST /Payments

  • Destructive

    Creates multiple payments for invoices or credit notes

    PUT /Payments

    PUT /Payments

  • Destructive

    Updates a specific payment for invoices and credit notes

    POST /Payments/{PaymentID}

    POST /Payments/{PaymentID}

  • Destructive

    Creates a history record for a specific payment

    PUT /Payments/{PaymentID}/History

    PUT /Payments/{PaymentID}/History

  • Destructive

    Creates a payment service

    PUT /PaymentServices

    PUT /PaymentServices

  • Destructive

    Allows you to create an Allocation for prepayments

    PUT /Prepayments/{PrepaymentID}/Allocations

    PUT /Prepayments/{PrepaymentID}/Allocations

  • Destructive

    Deletes an Allocation from a Prepayment

    DELETE /Prepayments/{PrepaymentID}/Allocations/{AllocationID}

    DELETE /Prepayments/{PrepaymentID}/Allocations/{AllocationID}

  • Destructive

    Creates a history record for a specific prepayment

    PUT /Prepayments/{PrepaymentID}/History

    PUT /Prepayments/{PrepaymentID}/History

  • Destructive

    Updates or creates one or more purchase orders

    POST /PurchaseOrders

    POST /PurchaseOrders

  • Destructive

    Creates one or more purchase orders

    PUT /PurchaseOrders

    PUT /PurchaseOrders

  • Destructive

    Updates a specific purchase order

    POST /PurchaseOrders/{PurchaseOrderID}

    POST /PurchaseOrders/{PurchaseOrderID}

  • Destructive

    Creates a history record for a specific purchase orders

    PUT /PurchaseOrders/{PurchaseOrderID}/History

    PUT /PurchaseOrders/{PurchaseOrderID}/History

  • Destructive

    Updates a specific attachment for a specific purchase order by filename

    POST /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}

    POST /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}

  • Destructive

    Creates attachment for a specific purchase order

    PUT /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}

    PUT /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}

  • Destructive

    Updates or creates one or more quotes

    POST /Quotes

    POST /Quotes

  • Destructive

    Create one or more quotes

    PUT /Quotes

    PUT /Quotes

  • Destructive

    Updates a specific quote

    POST /Quotes/{QuoteID}

    POST /Quotes/{QuoteID}

  • Destructive

    Creates a history record for a specific quote

    PUT /Quotes/{QuoteID}/History

    PUT /Quotes/{QuoteID}/History

  • Destructive

    Updates a specific attachment from a specific quote by filename

    POST /Quotes/{QuoteID}/Attachments/{FileName}

    POST /Quotes/{QuoteID}/Attachments/{FileName}

  • Destructive

    Creates attachment for a specific quote

    PUT /Quotes/{QuoteID}/Attachments/{FileName}

    PUT /Quotes/{QuoteID}/Attachments/{FileName}

  • Destructive

    Creates draft expense claim receipts for any user

    PUT /Receipts

    PUT /Receipts

  • Destructive

    Creates an attachment on a specific expense claim receipts by file name

    PUT /Receipts/{ReceiptID}/Attachments/{FileName}

    PUT /Receipts/{ReceiptID}/Attachments/{FileName}

  • Destructive

    Creates a history record for a specific receipt

    PUT /Receipts/{ReceiptID}/History

    PUT /Receipts/{ReceiptID}/History

  • Destructive

    Creates or deletes one or more repeating invoice templates

    POST /RepeatingInvoices

    POST /RepeatingInvoices

  • Destructive

    Creates one or more repeating invoice templates

    PUT /RepeatingInvoices

    PUT /RepeatingInvoices

  • Destructive

    Deletes a specific repeating invoice template

    POST /RepeatingInvoices/{RepeatingInvoiceID}

    POST /RepeatingInvoices/{RepeatingInvoiceID}

  • Destructive

    Updates a specific attachment from a specific repeating invoices by file name

    POST /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}

    POST /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}

  • Destructive

    Creates an attachment from a specific repeating invoices by file name

    PUT /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}

    PUT /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}

  • Destructive

    Creates a history record for a specific repeating invoice

    Creates a history record for a specific repeating invoice

    PUT /RepeatingInvoices/{RepeatingInvoiceID}/History

  • Destructive

    Updates tax rates

    POST /TaxRates

    POST /TaxRates

  • Destructive

    Creates one or more tax rates

    PUT /TaxRates

    PUT /TaxRates

  • Destructive

    Create tracking categories

    PUT /TrackingCategories

    PUT /TrackingCategories

  • Destructive

    Updates a specific tracking category

    POST /TrackingCategories/{TrackingCategoryID}

    POST /TrackingCategories/{TrackingCategoryID}

  • Destructive

    Deletes a specific tracking category

    DELETE /TrackingCategories/{TrackingCategoryID}

    DELETE /TrackingCategories/{TrackingCategoryID}

  • Destructive

    Creates options for a specific tracking category

    PUT /TrackingCategories/{TrackingCategoryID}/Options

    PUT /TrackingCategories/{TrackingCategoryID}/Options

  • Destructive

    Updates a specific option for a specific tracking category

    POST /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}

    POST /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}

  • Destructive

    Deletes a specific option for a specific tracking category

    DELETE /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}

    DELETE /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}

Identity

  • Read

    Retrieves the connections for this user

    Override the base server url that include version

    GET /Connections

  • Destructive

    Deletes a connection for this user (i.e. disconnect a tenant)

    Override the base server url that include version

    DELETE /Connections/{id}

Asset

  • Read

    searches fixed asset

    By passing in the appropriate options, you can search for available fixed asset in the system

    GET /Assets

  • Read

    Retrieves fixed asset by id

    By passing in the appropriate asset id, you can search for a specific fixed asset in the system

    GET /Assets/{id}

  • Read

    searches fixed asset types

    By passing in the appropriate options, you can search for available fixed asset types in the system

    GET /AssetTypes

  • Read

    searches fixed asset settings

    By passing in the appropriate options, you can search for available fixed asset types in the system

    GET /Settings

  • Write

    adds a fixed asset

    Adds an asset to the system

    POST /Assets

  • Write

    adds a fixed asset type

    Adds an fixed asset type to the system

    POST /AssetTypes

Files

  • Read

    Retrieves files

    GET /Files

    GET /Files

  • Read

    Retrieves a file by a unique file ID

    GET /Files/{FileId}

    GET /Files/{FileId}

  • Read

    Retrieves the content of a specific file

    By passing in the appropriate options, retrieve data for specific file

    GET /Files/{FileId}/Content

  • Read

    Retrieves a specific file associations

    By passing in the appropriate options,

    GET /Files/{FileId}/Associations

  • Read

    Retrieves an association object using a unique object ID

    By passing in the appropriate options, you can retrieve an association

    GET /Associations/{ObjectId}

  • Read

    Retrieves a count of associations for a list of objects.

    By passing in the appropriate options, you can retrieve the association count for objects

    GET /Associations/Count

  • Read

    Retrieves folders

    By passing in the appropriate options, you can search for available folders

    GET /Folders

  • Read

    Retrieves specific folder by using a unique folder ID

    By passing in the appropriate ID, you can search for specific folder

    GET /Folders/{FolderId}

  • Read

    Retrieves inbox folder

    Search for the user inbox

    GET /Inbox

  • Write

    Uploads a File to the inbox

    POST /Files

    POST /Files

  • Write

    Uploads a File to a specific folder

    POST /Files/{FolderId}

    POST /Files/{FolderId}

  • Write

    Creates a new file association

    By passing in the appropriate options, you can create a new folder

    POST /Files/{FileId}/Associations

  • Write

    Creates a new folder

    By passing in the appropriate properties, you can create a new folder

    POST /Folders

  • Destructive

    Update a file

    Updates file properties of a single file

    PUT /Files/{FileId}

  • Destructive

    Deletes a specific file

    Delete a specific file

    DELETE /Files/{FileId}

  • Destructive

    Deletes an existing file association

    By passing in the appropriate options, you can create a new folder

    DELETE /Files/{FileId}/Associations/{ObjectId}

  • Destructive

    Updates an existing folder

    By passing in the appropriate ID and properties, you can update a folder

    PUT /Folders/{FolderId}

  • Destructive

    Deletes a folder

    By passing in the appropriate ID, you can delete a folder

    DELETE /Folders/{FolderId}

Project

  • Read

    Retrieves all projects

    Allows you to retrieve, create and update projects.

    GET /Projects

  • Read

    Retrieves a single project

    Allows you to retrieve a specific project using the projectId

    GET /Projects/{projectId}

  • Read

    Retrieves a list of all project users

    Allows you to retrieve the users on a projects.

    GET /ProjectsUsers

  • Read

    Retrieves all project tasks

    Allows you to retrieve a specific project

    GET /Projects/{projectId}/Tasks

  • Read

    Retrieves a single project task

    Allows you to retrieve a specific project

    GET /Projects/{projectId}/Tasks/{taskId}

  • Read

    Retrieves all time entries associated with a specific project

    Allows you to retrieve the time entries associated with a specific project

    GET /Projects/{projectId}/Time

  • Read

    Retrieves a single time entry for a specific project

    Allows you to get a single time entry in a project

    GET /Projects/{projectId}/Time/{timeEntryId}

  • Write

    Create one or more new projects

    POST /Projects

    POST /Projects

  • Write

    creates a project for the specified contact

    Allows you to update a specific projects.

    PATCH /Projects/{projectId}

  • Write

    Allows you to create a task

    Allows you to create a specific task

    POST /Projects/{projectId}/Tasks

  • Write

    Creates a time entry for a specific project

    Allows you to create a specific task

    POST /Projects/{projectId}/Time

  • Destructive

    Updates a specific project

    Allows you to update a specific projects.

    PUT /Projects/{projectId}

  • Destructive

    Allows you to update a task

    Allows you to update a specific task

    PUT /Projects/{projectId}/Tasks/{taskId}

  • Destructive

    Allows you to delete a task

    Allows you to delete a specific task

    DELETE /Projects/{projectId}/Tasks/{taskId}

  • Destructive

    Updates a time entry for a specific project

    Allows you to update time entry in a project

    PUT /Projects/{projectId}/Time/{timeEntryId}

  • Destructive

    Deletes a time entry for a specific project

    Allows you to delete a specific time entry

    DELETE /Projects/{projectId}/Time/{timeEntryId}

Payroll Au

  • Read

    Searches payroll employees

    GET /Employees

    GET /Employees

  • Read

    Retrieves an employee's detail by unique employee id

    GET /Employees/{EmployeeID}

    GET /Employees/{EmployeeID}

  • Read

    Retrieves leave applications

    GET /LeaveApplications

    GET /LeaveApplications

  • Read

    Retrieves leave applications including leave requests

    GET /LeaveApplications/v2

    GET /LeaveApplications/v2

  • Read

    Retrieves a leave application by a unique leave application id

    GET /LeaveApplications/{LeaveApplicationID}

    GET /LeaveApplications/{LeaveApplicationID}

  • Read

    Retrieves pay items

    GET /PayItems

    GET /PayItems

  • Read

    Retrieves payroll calendars

    GET /PayrollCalendars

    GET /PayrollCalendars

  • Read

    Retrieves payroll calendar by using a unique payroll calendar ID

    GET /PayrollCalendars/{PayrollCalendarID}

    GET /PayrollCalendars/{PayrollCalendarID}

  • Read

    Retrieves pay runs

    GET /PayRuns

    GET /PayRuns

  • Read

    Retrieves a pay run by using a unique pay run id

    GET /PayRuns/{PayRunID}

    GET /PayRuns/{PayRunID}

  • Read

    Retrieves for a payslip by a unique payslip id

    GET /Payslip/{PayslipID}

    GET /Payslip/{PayslipID}

  • Read

    Retrieves payroll settings

    GET /Settings

    GET /Settings

  • Read

    Retrieves superfunds

    GET /Superfunds

    GET /Superfunds

  • Read

    Retrieves a superfund by using a unique superfund ID

    GET /Superfunds/{SuperFundID}

    GET /Superfunds/{SuperFundID}

  • Read

    Retrieves superfund products

    GET /SuperfundProducts

    GET /SuperfundProducts

  • Read

    Retrieves timesheets

    GET /Timesheets

    GET /Timesheets

  • Read

    Retrieves a timesheet by using a unique timesheet id

    GET /Timesheets/{TimesheetID}

    GET /Timesheets/{TimesheetID}

  • Write

    Creates a payroll employee

    POST /Employees

    POST /Employees

  • Write

    Updates an employee's detail

    Update properties on a single employee

    POST /Employees/{EmployeeID}

  • Write

    Creates a leave application

    POST /LeaveApplications

    POST /LeaveApplications

  • Write

    Updates a specific leave application

    POST /LeaveApplications/{LeaveApplicationID}

    POST /LeaveApplications/{LeaveApplicationID}

  • Write

    Approve a requested leave application by a unique leave application id

    POST /LeaveApplications/{LeaveApplicationID}/approve

    POST /LeaveApplications/{LeaveApplicationID}/approve

  • Write

    Reject a leave application by a unique leave application id

    POST /LeaveApplications/{LeaveApplicationID}/reject

    POST /LeaveApplications/{LeaveApplicationID}/reject

  • Write

    Creates a pay item

    POST /PayItems

    POST /PayItems

  • Write

    Creates a Payroll Calendar

    POST /PayrollCalendars

    POST /PayrollCalendars

  • Write

    Updates a payslip

    Update lines on a single payslips

    POST /Payslip/{PayslipID}

  • Write

    Creates a superfund

    POST /Superfunds

    POST /Superfunds

  • Write

    Updates a superfund

    Update properties on a single Superfund

    POST /Superfunds/{SuperFundID}

  • Write

    Creates a timesheet

    POST /Timesheets

    POST /Timesheets

  • Write

    Updates a timesheet

    Update properties on a single timesheet

    POST /Timesheets/{TimesheetID}

  • Destructive

    Creates a pay run

    POST /PayRuns

    POST /PayRuns

  • Destructive

    Updates a pay run

    Update properties on a single PayRun

    POST /PayRuns/{PayRunID}

Payroll Au V2

  • Read

    Retrieves timesheets

    GET /Timesheets

    GET /Timesheets

  • Read

    Retrieve a specific timesheet by using a unique timesheet ID

    GET /Timesheets/{TimesheetID}

    GET /Timesheets/{TimesheetID}

  • Write

    Creates a new timesheet

    POST /Timesheets

    POST /Timesheets

  • Write

    Creates a new timesheet line for a specific timesheet using a unique timesheet ID

    POST /Timesheets/{TimesheetID}/Lines

    POST /Timesheets/{TimesheetID}/Lines

  • Write

    Approves a specific timesheet

    POST /Timesheets/{TimesheetID}/Approve

    POST /Timesheets/{TimesheetID}/Approve

  • Write

    Reverts a specific timesheet to draft

    POST /Timesheets/{TimesheetID}/RevertToDraft

    POST /Timesheets/{TimesheetID}/RevertToDraft

  • Destructive

    Deletes a specific timesheet

    DELETE /Timesheets/{TimesheetID}

    DELETE /Timesheets/{TimesheetID}

  • Destructive

    Updates a specific timesheet line for a specific timesheet

    PUT /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

    PUT /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

  • Destructive

    Deletes a specific timesheet line

    DELETE /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

    DELETE /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

Payroll Uk

  • Read

    Retrieves employees

    GET /Employees

    GET /Employees

  • Read

    Retrieves specific employees by using a unique employee ID

    GET /Employees/{EmployeeID}

    GET /Employees/{EmployeeID}

  • Read

    Retrieves tax records for a specific employee using a unique employee ID

    GET /Employees/{EmployeeID}/Tax

    GET /Employees/{EmployeeID}/Tax

  • Read

    Retrieves a specific employee's openingbalances using a unique employee ID

    GET /Employees/{EmployeeID}/ukopeningbalances

    GET /Employees/{EmployeeID}/ukopeningbalances

  • Read

    Retrieves a specific employee's leave records using a unique employee ID

    GET /Employees/{EmployeeID}/Leave

    GET /Employees/{EmployeeID}/Leave

  • Read

    Retrieves a specific employee's leave record using a unique employee ID

    GET /Employees/{EmployeeID}/Leave/{LeaveID}

    GET /Employees/{EmployeeID}/Leave/{LeaveID}

  • Read

    Retrieves a specific employee's leave balances using a unique employee ID

    GET /Employees/{EmployeeID}/LeaveBalances

    GET /Employees/{EmployeeID}/LeaveBalances

  • Read

    Retrieves a specific employee's leave balances using a unique employee ID

    GET /Employees/{EmployeeID}/StatutoryLeaveBalance

    GET /Employees/{EmployeeID}/StatutoryLeaveBalance

  • Read

    Retrieves a specific employee's summary of statutory leaves using a unique employee ID

    GET /StatutoryLeaves/Summary/{EmployeeID}

    GET /StatutoryLeaves/Summary/{EmployeeID}

  • Read

    Retrieves a statutory sick leave for an employee

    GET /StatutoryLeaves/Sick/{StatutorySickLeaveID}

    GET /StatutoryLeaves/Sick/{StatutorySickLeaveID}

  • Read

    Retrieves a specific employee's leave periods using a unique employee ID

    GET /Employees/{EmployeeID}/LeavePeriods

    GET /Employees/{EmployeeID}/LeavePeriods

  • Read

    Retrieves a specific employee's leave types using a unique employee ID

    GET /Employees/{EmployeeID}/LeaveTypes

    GET /Employees/{EmployeeID}/LeaveTypes

  • Read

    Retrieves a specific employee's payment method using a unique employee ID

    GET /Employees/{EmployeeID}/PaymentMethods

    GET /Employees/{EmployeeID}/PaymentMethods

  • Read

    Retrieves a specific employee pay templates using a unique employee ID

    GET /Employees/{EmployeeID}/PayTemplates

    GET /Employees/{EmployeeID}/PayTemplates

  • Read

    Retrieves employee benefits

    GET /Benefits

    GET /Benefits

  • Read

    Retrieves a specific benefit by using a unique benefit ID

    GET /Benefits/{id}

    GET /Benefits/{id}

  • Read

    Retrieves deductions

    GET /Deductions

    GET /Deductions

  • Read

    Retrieves a specific deduction by using a unique deduction ID

    GET /Deductions/{deductionId}

    GET /Deductions/{deductionId}

  • Read

    Retrieves earnings orders

    GET /EarningsOrders

    GET /EarningsOrders

  • Read

    Retrieves a specific earnings orders by using a unique earnings orders id

    GET /EarningsOrders/{id}

    GET /EarningsOrders/{id}

  • Read

    Retrieves earnings rates

    GET /EarningsRates

    GET /EarningsRates

  • Read

    Retrieves a specific earnings rates by using a unique earnings rate id

    GET /EarningsRates/{EarningsRateID}

    GET /EarningsRates/{EarningsRateID}

  • Read

    Retrieves leave types

    GET /LeaveTypes

    GET /LeaveTypes

  • Read

    Retrieves a specific leave type by using a unique leave type ID

    GET /LeaveTypes/{LeaveTypeID}

    GET /LeaveTypes/{LeaveTypeID}

  • Read

    Retrieves reimbursements

    GET /Reimbursements

    GET /Reimbursements

  • Read

    Retrieves a specific reimbursement by using a unique reimbursement id

    GET /Reimbursements/{ReimbursementID}

    GET /Reimbursements/{ReimbursementID}

  • Read

    Retrieves timesheets

    GET /Timesheets

    GET /Timesheets

  • Read

    Retrieve a specific timesheet by using a unique timesheet ID

    GET /Timesheets/{TimesheetID}

    GET /Timesheets/{TimesheetID}

  • Read

    Retrieves payrun calendars

    GET /PayRunCalendars

    GET /PayRunCalendars

  • Read

    Retrieves a specific payrun calendar by using a unique payrun calendar ID

    GET /PayRunCalendars/{PayRunCalendarID}

    GET /PayRunCalendars/{PayRunCalendarID}

  • Read

    Retrieves a specific employee's salary and wages by using a unique employee ID

    GET /Employees/{EmployeeID}/SalaryAndWages

    GET /Employees/{EmployeeID}/SalaryAndWages

  • Read

    Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id

    GET /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}

    GET /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}

  • Read

    Retrieves pay runs

    GET /PayRuns

    GET /PayRuns

  • Read

    Retrieves a specific pay run by using a unique pay run ID

    GET /PayRuns/{PayRunID}

    GET /PayRuns/{PayRunID}

  • Read

    Retrieves payslips

    GET /Payslips

    GET /Payslips

  • Read

    Retrieves a specific payslip by using a unique payslip ID

    GET /Payslips/{PayslipID}

    GET /Payslips/{PayslipID}

  • Read

    Retrieves payroll settings

    GET /Settings

    GET /Settings

  • Read

    Retrieves tracking categories

    GET /Settings/trackingCategories

    GET /Settings/trackingCategories

  • Write

    Creates employees

    POST /Employees

    POST /Employees

  • Write

    Creates employment detail for a specific employee using a unique employee ID

    POST /Employees/{EmployeeID}/Employment

    POST /Employees/{EmployeeID}/Employment

  • Write

    Creates an opening balance for a specific employee

    POST /Employees/{EmployeeID}/ukopeningbalances

    POST /Employees/{EmployeeID}/ukopeningbalances

  • Write

    Creates leave records for a specific employee

    POST /Employees/{EmployeeID}/Leave

    POST /Employees/{EmployeeID}/Leave

  • Write

    Creates statutory sick leave records

    POST /StatutoryLeaves/Sick

    POST /StatutoryLeaves/Sick

  • Write

    Creates employee leave type records

    POST /Employees/{EmployeeID}/LeaveTypes

    POST /Employees/{EmployeeID}/LeaveTypes

  • Write

    Creates an earnings template records for a specific employee

    POST /Employees/{EmployeeID}/PayTemplates/earnings

    POST /Employees/{EmployeeID}/PayTemplates/earnings

  • Write

    Creates multiple earnings template records for a specific employee using a unique employee ID

    POST /Employees/{EmployeeID}/paytemplateearnings

    POST /Employees/{EmployeeID}/paytemplateearnings

  • Write

    Creates a new employee benefit

    POST /Benefits

    POST /Benefits

  • Write

    Creates a new deduction

    POST /Deductions

    POST /Deductions

  • Write

    Creates a new earnings rate

    POST /EarningsRates

    POST /EarningsRates

  • Write

    Creates a new leave type

    POST /LeaveTypes

    POST /LeaveTypes

  • Write

    Creates a new reimbursement

    POST /Reimbursements

    POST /Reimbursements

  • Write

    Creates a new timesheet

    POST /Timesheets

    POST /Timesheets

  • Write

    Creates a new timesheet line for a specific timesheet using a unique timesheet ID

    POST /Timesheets/{TimesheetID}/Lines

    POST /Timesheets/{TimesheetID}/Lines

  • Write

    Approves a specific timesheet

    POST /Timesheets/{TimesheetID}/Approve

    POST /Timesheets/{TimesheetID}/Approve

  • Write

    Reverts a specific timesheet to draft

    POST /Timesheets/{TimesheetID}/RevertToDraft

    POST /Timesheets/{TimesheetID}/RevertToDraft

  • Write

    Creates a salary and wage record for a specific employee

    POST /Employees/{EmployeeID}/SalaryAndWages

    POST /Employees/{EmployeeID}/SalaryAndWages

  • Destructive

    Updates a specific employee's detail

    PUT /Employees/{EmployeeID}

    PUT /Employees/{EmployeeID}

  • Destructive

    Updates a specific employee's opening balances

    PUT /Employees/{EmployeeID}/ukopeningbalances

    PUT /Employees/{EmployeeID}/ukopeningbalances

  • Destructive

    Updates a specific employee's leave records

    PUT /Employees/{EmployeeID}/Leave/{LeaveID}

    PUT /Employees/{EmployeeID}/Leave/{LeaveID}

  • Destructive

    Deletes a specific employee's leave record

    DELETE /Employees/{EmployeeID}/Leave/{LeaveID}

    DELETE /Employees/{EmployeeID}/Leave/{LeaveID}

  • Destructive

    Creates an employee payment method

    POST /Employees/{EmployeeID}/PaymentMethods

    POST /Employees/{EmployeeID}/PaymentMethods

  • Destructive

    Updates a specific employee's earnings template records

    PUT /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}

    PUT /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}

  • Destructive

    Deletes a specific employee's earnings template record

    DELETE /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}

    DELETE /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}

  • Destructive

    Deletes a specific timesheet

    DELETE /Timesheets/{TimesheetID}

    DELETE /Timesheets/{TimesheetID}

  • Destructive

    Updates a specific timesheet line for a specific timesheet

    PUT /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

    PUT /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

  • Destructive

    Deletes a specific timesheet line

    DELETE /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

    DELETE /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

  • Destructive

    Creates a new payrun calendar

    POST /PayRunCalendars

    POST /PayRunCalendars

  • Destructive

    Updates salary and wages record for a specific employee

    PUT /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}

    PUT /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}

  • Destructive

    Deletes a salary and wages record for a specific employee

    DELETE /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}

    DELETE /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}

Payroll Nz

  • Read

    Retrieves employees

    GET /Employees

    GET /Employees

  • Read

    Retrieves an employees using a unique employee ID

    GET /Employees/{EmployeeID}

    GET /Employees/{EmployeeID}

  • Read

    Retrieves tax records for a specific employee

    GET /Employees/{EmployeeID}/Tax

    GET /Employees/{EmployeeID}/Tax

  • Read

    Retrieves the opening balance for a specific employee

    GET /Employees/{EmployeeID}/OpeningBalances

    GET /Employees/{EmployeeID}/OpeningBalances

  • Read

    Retrieves leave records for a specific employee

    GET /Employees/{EmployeeID}/Leave

    GET /Employees/{EmployeeID}/Leave

  • Read

    Retrieves leave balances for a specific employee

    GET /Employees/{EmployeeID}/LeaveBalances

    GET /Employees/{EmployeeID}/LeaveBalances

  • Read

    Retrieves leave periods for a specific employee

    GET /Employees/{EmployeeID}/LeavePeriods

    GET /Employees/{EmployeeID}/LeavePeriods

  • Read

    Retrieves leave types for a specific employee

    GET /Employees/{EmployeeID}/LeaveTypes

    GET /Employees/{EmployeeID}/LeaveTypes

  • Read

    Retrieves available payment methods for a specific employee

    GET /Employees/{EmployeeID}/PaymentMethods

    GET /Employees/{EmployeeID}/PaymentMethods

  • Read

    Retrieves pay templates for a specific employee

    GET /Employees/{EmployeeID}/PayTemplates

    GET /Employees/{EmployeeID}/PayTemplates

  • Read

    Retrieves deductions for a specific employee

    GET /Deductions

    GET /Deductions

  • Read

    Retrieves a single deduction by using a unique deduction ID

    GET /Deductions/{deductionId}

    GET /Deductions/{deductionId}

  • Read

    Retrieves statutory deductions

    GET /StatutoryDeductions

    GET /StatutoryDeductions

  • Read

    Retrieves a specific statutory deduction by using a unique statutory deductions id

    GET /StatutoryDeductions/{id}

    GET /StatutoryDeductions/{id}

  • Read

    Retrieves superannuations

    GET /Superannuations

    GET /Superannuations

  • Read

    Retrieves a specific superannuation using a unique superannuation ID

    GET /Superannuations/{SuperannuationID}

    GET /Superannuations/{SuperannuationID}

  • Read

    Retrieves earnings rates

    GET /EarningsRates

    GET /EarningsRates

  • Read

    Retrieves a specific earnings rates by using a unique earnings rate id

    GET /EarningsRates/{EarningsRateID}

    GET /EarningsRates/{EarningsRateID}

  • Read

    Retrieves leave types

    GET /LeaveTypes

    GET /LeaveTypes

  • Read

    Retrieves a specific leave type by using a unique leave type ID

    GET /LeaveTypes/{LeaveTypeID}

    GET /LeaveTypes/{LeaveTypeID}

  • Read

    Retrieves reimbursements

    GET /Reimbursements

    GET /Reimbursements

  • Read

    Retrieves a specific reimbursement by using a unique reimbursement ID

    GET /Reimbursements/{ReimbursementID}

    GET /Reimbursements/{ReimbursementID}

  • Read

    Retrieves timesheets

    GET /Timesheets

    GET /Timesheets

  • Read

    Retrieves a specific timesheet by using a unique timesheet ID

    GET /Timesheets/{TimesheetID}

    GET /Timesheets/{TimesheetID}

  • Read

    Retrieves payrun calendars

    GET /PayRunCalendars

    GET /PayRunCalendars

  • Read

    Retrieves a specific payrun calendar by using a unique payroll calendar ID

    GET /PayRunCalendars/{PayrollCalendarID}

    GET /PayRunCalendars/{PayrollCalendarID}

  • Read

    Retrieves an employee's salary and wages

    GET /Employees/{EmployeeID}/SalaryAndWages

    GET /Employees/{EmployeeID}/SalaryAndWages

  • Read

    Retrieves an employee's salary and wages record by using a unique salary and wage ID

    GET /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}

    GET /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}

  • Read

    Retrieves pay runs

    GET /PayRuns

    GET /PayRuns

  • Read

    Retrieves a specific pay run by using a unique pay run ID

    GET /PayRuns/{PayRunID}

    GET /PayRuns/{PayRunID}

  • Read

    Retrieves payslips

    GET /PaySlips

    GET /PaySlips

  • Read

    Retrieves a specific payslip by a unique pay slip ID

    GET /PaySlips/{PaySlipID}

    GET /PaySlips/{PaySlipID}

  • Read

    Retrieves settings

    GET /Settings

    GET /Settings

  • Read

    Retrieves tracking categories

    GET /Settings/TrackingCategories

    GET /Settings/TrackingCategories

  • Read

    Retrieves employee's working patterns

    GET /Employees/{EmployeeID}/Working-Patterns

    GET /Employees/{EmployeeID}/Working-Patterns

  • Read

    Retrieves employee's working patterns

    GET /Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}

    GET /Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}

  • Write

    Creates an employees

    POST /Employees

    POST /Employees

  • Write

    Creates an employment detail for a specific employee

    POST /Employees/{EmployeeID}/Employment

    POST /Employees/{EmployeeID}/Employment

  • Write

    Updates the tax records for a specific employee

    POST /Employees/{EmployeeID}/Tax

    POST /Employees/{EmployeeID}/Tax

  • Write

    Creates opening balances for a specific employee

    POST /Employees/{EmployeeID}/OpeningBalances

    POST /Employees/{EmployeeID}/OpeningBalances

  • Write

    Creates leave records for a specific employee

    POST /Employees/{EmployeeID}/Leave

    POST /Employees/{EmployeeID}/Leave

  • Write

    Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for a…

    Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee

    POST /Employees/{EmployeeID}/LeaveSetup

  • Write

    Creates leave type records for a specific employee

    POST /Employees/{EmployeeID}/LeaveTypes

    POST /Employees/{EmployeeID}/LeaveTypes

  • Write

    Creates earnings template records for an employee

    POST /Employees/{EmployeeID}/PayTemplates/Earnings

    POST /Employees/{EmployeeID}/PayTemplates/Earnings

  • Write

    Creates multiple employee earnings template records for a specific employee

    POST /Employees/{EmployeeID}/PayTemplateEarnings

    POST /Employees/{EmployeeID}/PayTemplateEarnings

  • Write

    Creates a new deduction for a specific employee

    POST /Deductions

    POST /Deductions

  • Write

    Creates a new superannuation

    POST /Superannuations

    POST /Superannuations

  • Write

    Creates a new earnings rate

    POST /EarningsRates

    POST /EarningsRates

  • Write

    Creates a new leave type

    POST /LeaveTypes

    POST /LeaveTypes

  • Write

    Creates a new reimbursement

    POST /Reimbursements

    POST /Reimbursements

  • Write

    Creates a new timesheet

    POST /Timesheets

    POST /Timesheets

  • Write

    Create a new timesheet line for a specific time sheet

    POST /Timesheets/{TimesheetID}/Lines

    POST /Timesheets/{TimesheetID}/Lines

  • Write

    Approves a timesheet

    POST /Timesheets/{TimesheetID}/Approve

    POST /Timesheets/{TimesheetID}/Approve

  • Write

    Reverts a timesheet to draft

    POST /Timesheets/{TimesheetID}/RevertToDraft

    POST /Timesheets/{TimesheetID}/RevertToDraft

  • Write

    Creates an employee salary and wage record

    POST /Employees/{EmployeeID}/SalaryAndWages

    POST /Employees/{EmployeeID}/SalaryAndWages

  • Write

    Creates an employee working pattern

    POST /Employees/{EmployeeID}/Working-Patterns

    POST /Employees/{EmployeeID}/Working-Patterns

  • Destructive

    Updates an existing employee

    PUT /Employees/{EmployeeID}

    PUT /Employees/{EmployeeID}

  • Destructive

    Updates leave records for a specific employee

    PUT /Employees/{EmployeeID}/Leave/{LeaveID}

    PUT /Employees/{EmployeeID}/Leave/{LeaveID}

  • Destructive

    Deletes a leave record for a specific employee

    DELETE /Employees/{EmployeeID}/Leave/{LeaveID}

    DELETE /Employees/{EmployeeID}/Leave/{LeaveID}

  • Destructive

    Creates a payment method for an employee

    POST /Employees/{EmployeeID}/PaymentMethods

    POST /Employees/{EmployeeID}/PaymentMethods

  • Destructive

    Updates an earnings template records for an employee

    PUT /Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}

    PUT /Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}

  • Destructive

    Deletes an employee's earnings template record

    DELETE /Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}

    DELETE /Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}

  • Destructive

    Deletes a timesheet

    DELETE /Timesheets/{TimesheetID}

    DELETE /Timesheets/{TimesheetID}

  • Destructive

    Updates a timesheet line for a specific timesheet

    PUT /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

    PUT /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

  • Destructive

    Deletes a timesheet line for a specific timesheet

    DELETE /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

    DELETE /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

  • Destructive

    Creates a new payrun calendar

    POST /PayRunCalendars

    POST /PayRunCalendars

  • Destructive

    Updates an employee's salary and wages record

    PUT /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}

    PUT /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}

  • Destructive

    Deletes an employee's salary and wages record

    DELETE /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}

    DELETE /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}

  • Destructive

    Creates a pay run

    POST /PayRuns

    POST /PayRuns

  • Destructive

    Creates an employee pay slip

    PUT /PaySlips/{PaySlipID}

    PUT /PaySlips/{PaySlipID}

  • Destructive

    deletes employee's working patterns

    DELETE /Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}

    DELETE /Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}

Bank Feeds

  • Read

    Searches for feed connections

    By passing in the appropriate options, you can search for available feed connections in the system.

    GET /FeedConnections

  • Read

    Retrieve single feed connection based on a unique id provided

    By passing in a FeedConnection Id options, you can search for matching feed connections

    GET /FeedConnections/{id}

  • Read

    Retrieve all statements

    By passing in parameters, you can search for matching statements

    GET /Statements

  • Read

    Retrieve single statement based on unique id provided

    By passing in a statement id, you can search for matching statements

    GET /Statements/{statementId}

  • Write

    Create one or more new feed connection

    By passing in the FeedConnections array object in the body, you can create one or more new feed connections

    POST /FeedConnections

  • Write

    Creates one or more new statements

    POST /Statements

    POST /Statements

  • Destructive

    Delete an existing feed connection

    By passing in FeedConnections array object in the body, you can delete a feed connection.

    POST /FeedConnections/DeleteRequests

Finance

  • Read

    Get cash validation

    Summarizes the total cash position for each account for an org

    GET /CashValidation

  • Read

    Get Balance Sheet report

    The balance sheet report is a standard financial report which describes the financial position of an organisation at a point in time.

    GET /FinancialStatements/BalanceSheet

  • Read

    Get Cash flow report

    The statement of cash flows - direct method, provides the year to date changes in operating, financing and investing cash flow activities for an organisation. Cashflow statement is not available in US region at this stage.

    GET /FinancialStatements/Cashflow

  • Read

    Get Profit & Loss report

    The profit and loss statement is a standard financial report providing detailed year to date income and expense detail for an organisation.

    GET /FinancialStatements/ProfitAndLoss

  • Read

    Get Trial Balance report

    The trial balance provides a detailed list of all accounts of an organisation at a point in time, with revenue and expense items being year to date.

    GET /FinancialStatements/TrialBalance

  • Read

    Get revenue by contacts report

    The revenue by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.

    GET /FinancialStatements/contacts/revenue

  • Read

    Get expense by contacts report

    The expense by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.

    GET /FinancialStatements/contacts/expense

  • Read

    Get Bank Statement Accounting

    For lenders that prefer using bank statement data as the source of truth. We provide a data point that will allow access to customer bank statements, plus for reconciled bank transactions the matching accounting, invoice and billing data as well. As customers reconcile bank statements to invoices and bills, this transaction detail will provide valuable insight for lender's assessment measures.

    GET /BankStatementsPlus/statements

App Store

  • Read

    Retrieves a subscription for a given subscriptionId

    GET /subscriptions/{subscriptionId}

    GET /subscriptions/{subscriptionId}

  • Read

    Gets all usage records related to the subscription

    GET /subscriptions/{subscriptionId}/usage-records

    GET /subscriptions/{subscriptionId}/usage-records

  • Write

    Send metered usage belonging to this subscription and subscription item

    POST /subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records

    POST /subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records

  • Destructive

    Update and existing metered usage belonging to this subscription and subscription item

    PUT /subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records/{usageRecordId}

    PUT /subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records/{usageRecordId}

Account Data

  • Read

    Get the balance of each general ledger account as at a given date

    Retrieves account balances as at date, optionally including balances for one or more prior comparison periods, and optionally filtered by account class, type, account IDs, system account code, or tracking item. Filtering - Filter by class, type, accountIds, and/or systemAccountCodes. These can be combined freely — when more than one is supplied, the server returns only accounts that match all of the supplied filters (an intersection, not a union). - type values are matched case-sensitively, so use uppercase (for example BANK). Inventory asset accounts are reported as, and can only be filtered by, INVENTORY; filtering by their underlying account type does not match them. - trackingItemIds and unassignedToTrackingCategoryIds can be used independently of the filters above to further narrow which accounts are returned. Comparison periods - Supplying comparisonPeriodCount together with comparisonPeriodSize returns additional balances at prior points in time, in addition to the balance at date. - The n-th comparison date is date shifted back n times comparisonPeriodSize. For MONTH, QUARTER, and YEAR sizes, a date that falls on the last day of its month keeps landing on the last day of the shifted month (so comparisons across February behave correctly). - comparisonPeriodCount and comparisonPeriodSize must be supplied together. Bank accounts Bank account data is only available to users with bank account view permission for the organisation. - If the request would include bank accounts and the user lacks this permission, it is rejected with 403 Forbidden. A request is treated as including bank accounts when it has no account filters, filters by all five class values and nothing else, includes BANK in type, or lists a bank account in accountIds. - For other requests (for example class=ASSET), bank accounts are silently excluded from the response for users without this permission, instead of the request being rejected. Results Only accounts with a non-zero balance at a given date are returned; accounts and comparison dates with a net-zero balance are omitted, so the response can be empty. Pagination This endpoint does not paginate — all matching account balances are returned in a single response.

    GET /account-balances

  • Read

    Get the net movement of each general ledger account over a date range

    Retrieves account movements between startDate and endDate, optionally including movements for one or more prior comparison periods of the same length, and optionally filtered by account class, type, account IDs, system account code, or tracking item. Filtering - Filter by class, type, accountIds, and/or systemAccountCodes. These can be combined freely — when more than one is supplied, the server returns only accounts that match all of the supplied filters (an intersection, not a union). - type values are matched case-sensitively, so use uppercase (for example BANK). Inventory asset accounts are reported as, and can only be filtered by, INVENTORY; filtering by their underlying account type does not match them. - trackingItemIds and unassignedToTrackingCategoryIds can be used independently of the filters above to further narrow which accounts are returned. Comparison periods - Supplying comparisonPeriodCount together with comparisonPeriodSize returns additional movements for prior date ranges of the same length, in addition to the movement between startDate and endDate. - Each comparison range is calculated by moving the primary range back by comparisonPeriodSize, comparisonPeriodCount times. For MONTH, QUARTER, and YEAR sizes, range boundaries that fall on the last day of a month keep landing on the last day of the shifted month. - comparisonPeriodCount and comparisonPeriodSize must be supplied together. - The primary range and every comparison range must not overlap each other. A request whose periods would overlap is rejected with 400 Bad Request. Ranges that share a single boundary day count as overlapping, which month-end adjustment can cause when shifting by MONTH, QUARTER, or YEAR. Bank accounts Bank account data is only available to users with bank account view permission for the organisation. - If the request would include bank accounts and the user lacks this permission, it is rejected with 403 Forbidden. A request is treated as including bank accounts when it has no account filters, filters by all five class values and nothing else, includes BANK in type, or lists a bank account in accountIds. - For other requests (for example class=ASSET), bank accounts are silently excluded from the response for users without this permission, instead of the request being rejected. Pagination This endpoint does not paginate — the full set of matching account movements is returned in a single response. Results Only combinations of account and date range with non-zero movement are returned; comparison ranges are not zero-filled. The response is a flat list with no guaranteed ordering.

    GET /account-movements

  • Read

    Get general ledger account transactions between two dates, with pagination and filtering

    Retrieves transactions posted between startDate and endDate (inclusive), optionally filtered by account IDs, class, type, or system account code, with cursor-based pagination for large result sets. First call: omit token. Supply accountingBasis, startDate, and endDate (all required), plus any optional filters. Continuation calls: supply only token, taken from the previous response's pagination.nextToken. Do not send any other query parameters — they are ignored if present, since the original request is captured by the token. Pagination - Results are returned in pages of 200 lines. - Use pagination.nextToken from the response as the token query parameter to fetch the next page. Send only the token query parameter on continuation requests — all other query parameters are ignored on a continuation call, since the original request's parameters are already captured by the token. - The token value is an opaque string. Treat it as an opaque string only — do not parse, modify, or construct it yourself. Tokens may expire. - When pagination is null, you've reached the last page. - The API captures a consistent snapshot at the time of the first request (via maxJournalNumber), so transactions added while you are paginating through a result set won't appear partway through, and won't cause duplicates or gaps. Filtering - Filter by accountIds, class, type, and/or systemAccountCodes. These can be combined freely — when more than one is supplied, the server returns only transactions for accounts that match all of the supplied filters (an intersection, not a union). - type values are matched case-sensitively, so use uppercase (for example BANK). Inventory asset accounts are reported as, and can only be filtered by, INVENTORY; filtering by their underlying account type does not match them. - Use systemAccountCodes=NONE to match accounts that have no system account code. - Filters are only read from the first request in a pagination sequence — see Pagination above. Bank accounts Bank account transactions are only available to users with bank account view permission for the organisation. - If the user lacks this permission and the request includes BANK in type, or lists a bank account in accountIds, it is rejected with 403 Forbidden. - For all other requests, including unfiltered requests, bank account transactions are silently excluded from the results for users without this permission.

    GET /account-transactions

Feed Connections

  • Read

    Retrieve the Feed Connections for an Organisation

    Returns the Feed Connections belonging to both the Organisation in Xero-Tenant-Id and the Application associated with the OAuth client. Connections belonging to another Application are not returned, and there is no way to observe that they exist. A page beyond the end of the collection returns an empty items array rather than an error.

    GET /FeedConnections

  • Read

    Retrieve a single Feed Connection

    Returns one Feed Connection, as a bare object rather than inside an envelope. The response is 404 bank-feed-not-found when the identifier names no Feed Connection, when it names one belonging to a different Application, when it is an all-zeros GUID, and when it is not a GUID at all. These cases are deliberately indistinguishable from one another, so an Application cannot use this endpoint to discover what another Application has.

    GET /FeedConnections/{id}

  • Write

    Connect feeds to Xero Bank Accounts that already exist

    Creates Feed Connections against Xero Bank Accounts the Organisation already has. Each item must include the accountId of the account it connects to. Xero performs no matching of its own, and accountNumber and accountName are ignored if supplied. Use this endpoint whenever the customer has chosen an account, including when they are reconnecting a feed that was previously terminated. Each item is processed independently, and the response has one result per request item in request order.

    POST /FeedConnections/ExistingAccount

  • Write

    Create Xero Bank Accounts and connect feeds to them

    Creates a new Xero Bank Account for each item and connects a feed to it. accountId must not be supplied. An item that includes one — including an all-zeros GUID, or a value that is not a GUID at all — is rejected, because supplying an account identifier means the Application intends to connect an account that already exists, which is what /FeedConnections/ExistingAccount is for. accountNumber and accountName are required here, since they describe the account being created. If the Organisation already has an account with the requested name, the item is rejected with account-name-already-exists naming that account, and no account is created. The same applies to a second item in the same request that uses a name an earlier item has just taken.

    POST /FeedConnections/NewAccount

  • Write

    Terminate Feed Connections

    Terminates the Feed Connections named in the request. Terminating a Feed Connection discontinues the bank feed, and does not otherwise affect the customer's data in Xero. Each item is identified by the Feed Connection id alone. An item naming a Feed Connection that does not exist, has already been terminated, or belongs to a different Application is reported as feed-not-found-or-already-deleted with status SUCCESS and statusCode 204 — there was nothing to terminate, which is not a failure, and is reported the same way a real termination is. The same identifier may not appear twice in one request. Re-sending a completed delete is idempotent. If an item reports PARTIALFAILURE, or the original response was lost, resend the same DeleteRequests item. The retry checks whether the connection remains and terminates it if needed. A SUCCESS item on the resend means the deletion is complete, including feed-not-found-or-already-deleted at statusCode 204. If a retry keeps reporting PARTIALFAILURE, contact Xero support with the connection id in error.connectionId.

    POST /FeedConnections/DeleteRequests

Get started

  1. Open Space settings → Connections and search for Xero.
  2. Connect your account and add the connection to the Space.
  3. Ask for what you need in any thread in that Space.

See How connections work for access and permissions, or browse all integrations.