Xero (Client Credentials)
No catalog description yet.
Authentication
| Method | Kind | Status | Details |
|---|---|---|---|
| OAuth 2.0 | oauth2 | available | — |
Call a tool
import { createClient } from "@open-connector/sdk";const oc = createClient({ baseUrl: "https://api.openconnector.dev", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await oc.executeTool({ slug: "XERO_OAUTH2_CC_CREATE_ACCOUNT", connectedAccountId: "conn_...", arguments: { /* match this tool's input schema */ },});import Composio from "@composio/client";const composio = new Composio({ baseURL: "https://api.openconnector.dev/composio", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await composio.tools.execute("XERO_OAUTH2_CC_CREATE_ACCOUNT", { connected_account_id: "conn_...", arguments: { /* match this tool's input schema */ },});oc tools execute XERO_OAUTH2_CC_CREATE_ACCOUNT --data '{ }'Tool catalog
Available tools
233 callable operations
Creates a new chart of accountsXERO_OAUTH2_CC_CREATE_ACCOUNTCreates a new chart of accountsConnection1 scope
Creates a new chart of accounts
Authentication
Connected account requiredScopes
accounting.settingsTags
Creates an attachment on a specific accountXERO_OAUTH2_CC_CREATE_ACCOUNT_ATTACHMENT_BY_FILE_NAMECreates an attachment on a specific accountConnection1 scope
Creates an attachment on a specific account
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Creates an attachment for a specific bank transaction by filenameXERO_OAUTH2_CC_CREATE_BANK_TRANSACTION_ATTACHMENT_BY_FILE_NAMECreates an attachment for a specific bank transaction by filenameConnection1 scope
Creates an attachment for a specific bank transaction by filename
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Creates a history record for a specific bank transactionsXERO_OAUTH2_CC_CREATE_BANK_TRANSACTION_HISTORY_RECORDCreates a history record for a specific bank transactionsConnection1 scope
Creates a history record for a specific bank transactions
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates one or more spent or received money transactionXERO_OAUTH2_CC_CREATE_BANK_TRANSACTIONSCreates one or more spent or received money transactionConnection1 scope
Creates one or more spent or received money transaction
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates a bank transferXERO_OAUTH2_CC_CREATE_BANK_TRANSFERCreates a bank transferConnection1 scope
Creates a bank transfer
Authentication
Connected account requiredScopes
accounting.transactionsTags
CreateBankTransferAttachmentByFileNameXERO_OAUTH2_CC_CREATE_BANK_TRANSFER_ATTACHMENT_BY_FILE_NAMECreateBankTransferAttachmentByFileNameConnection1 scope
CreateBankTransferAttachmentByFileName
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Creates a history record for a specific bank transferXERO_OAUTH2_CC_CREATE_BANK_TRANSFER_HISTORY_RECORDCreates a history record for a specific bank transferConnection1 scope
Creates a history record for a specific bank transfer
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates one or many batch payments for invoicesXERO_OAUTH2_CC_CREATE_BATCH_PAYMENTBatch payments allow you to bundle multiple bills or invoices into one payment transaction. This means a single payment in Xero can be reconciled with a single transaction on the bank statement making for a much simpler bank reconciliation experience.Connection1 scope
Batch payments allow you to bundle multiple bills or invoices into one payment transaction. This means a single payment in Xero can be reconciled with a single transaction on the bank statement making for a much simpler bank reconciliation experience.
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates a history record for a specific batch paymentXERO_OAUTH2_CC_CREATE_BATCH_PAYMENT_HISTORY_RECORDCreates a history record for a specific batch paymentConnection1 scope
Creates a history record for a specific batch payment
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates a new custom payment service for a specific branding themeXERO_OAUTH2_CC_CREATE_BRANDING_THEME_PAYMENT_SERVICESCreates a new custom payment service for a specific branding themeConnection1 scope
Creates a new custom payment service for a specific branding theme
Authentication
Connected account requiredScopes
paymentservicesTags
CreateContactAttachmentByFileNameXERO_OAUTH2_CC_CREATE_CONTACT_ATTACHMENT_BY_FILE_NAMECreateContactAttachmentByFileNameConnection1 scope
CreateContactAttachmentByFileName
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Creates a contact groupXERO_OAUTH2_CC_CREATE_CONTACT_GROUPCreates a contact groupConnection1 scope
Creates a contact group
Authentication
Connected account requiredScopes
accounting.contactsTags
Creates contacts to a specific contact groupXERO_OAUTH2_CC_CREATE_CONTACT_GROUP_CONTACTSCreates contacts to a specific contact groupConnection1 scope
Creates contacts to a specific contact group
Authentication
Connected account requiredScopes
accounting.contactsTags
Creates a new history record for a specific contactXERO_OAUTH2_CC_CREATE_CONTACT_HISTORYCreates a new history record for a specific contactConnection1 scope
Creates a new history record for a specific contact
Authentication
Connected account requiredScopes
accounting.contactsTags
Creates multiple contacts (bulk) in a Xero organisationXERO_OAUTH2_CC_CREATE_CONTACTSCreates multiple contacts (bulk) in a Xero organisationConnection1 scope
Creates multiple contacts (bulk) in a Xero organisation
Authentication
Connected account requiredScopes
accounting.contactsTags
Creates allocation for a specific credit noteXERO_OAUTH2_CC_CREATE_CREDIT_NOTE_ALLOCATIONCreates allocation for a specific credit noteConnection1 scope
Creates allocation for a specific credit note
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates an attachment for a specific credit noteXERO_OAUTH2_CC_CREATE_CREDIT_NOTE_ATTACHMENT_BY_FILE_NAMECreates an attachment for a specific credit noteConnection1 scope
Creates an attachment for a specific credit note
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Retrieves history records of a specific credit noteXERO_OAUTH2_CC_CREATE_CREDIT_NOTE_HISTORYRetrieves history records of a specific credit noteConnection1 scope
Retrieves history records of a specific credit note
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates a new credit noteXERO_OAUTH2_CC_CREATE_CREDIT_NOTESCreates a new credit noteConnection1 scope
Creates a new credit note
Authentication
Connected account requiredScopes
accounting.transactionsTags
Create a new currency for a Xero organisationXERO_OAUTH2_CC_CREATE_CURRENCYCreate a new currency for a Xero organisationConnection1 scope
Create a new currency for a Xero organisation
Authentication
Connected account requiredScopes
accounting.settingsTags
Creates a history record for a specific expense claimXERO_OAUTH2_CC_CREATE_EXPENSE_CLAIM_HISTORYCreates a history record for a specific expense claimConnection1 scope
Creates a history record for a specific expense claim
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates expense claimsXERO_OAUTH2_CC_CREATE_EXPENSE_CLAIMSCreates expense claimsConnection1 scope
Creates expense claims
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates an attachment for a specific invoice or purchase bill by filenameXERO_OAUTH2_CC_CREATE_INVOICE_ATTACHMENT_BY_FILE_NAMECreates an attachment for a specific invoice or purchase bill by filenameConnection1 scope
Creates an attachment for a specific invoice or purchase bill by filename
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Creates a history record for a specific invoiceXERO_OAUTH2_CC_CREATE_INVOICE_HISTORYCreates a history record for a specific invoiceConnection1 scope
Creates a history record for a specific invoice
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates one or more sales invoices or purchase billsXERO_OAUTH2_CC_CREATE_INVOICESCreates one or more sales invoices or purchase billsConnection1 scope
Creates one or more sales invoices or purchase bills
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates a history record for a specific itemXERO_OAUTH2_CC_CREATE_ITEM_HISTORYCreates a history record for a specific itemConnection1 scope
Creates a history record for a specific item
Authentication
Connected account requiredScopes
accounting.settingsTags
Creates one or more itemsXERO_OAUTH2_CC_CREATE_ITEMSCreates one or more itemsConnection1 scope
Creates one or more items
Authentication
Connected account requiredScopes
accounting.settingsTags
Creates linked transactions (billable expenses)XERO_OAUTH2_CC_CREATE_LINKED_TRANSACTIONCreates linked transactions (billable expenses)Connection1 scope
Creates linked transactions (billable expenses)
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates a specific attachment for a specific manual journal by file nameXERO_OAUTH2_CC_CREATE_MANUAL_JOURNAL_ATTACHMENT_BY_FILE_NAMECreates a specific attachment for a specific manual journal by file nameConnection1 scope
Creates a specific attachment for a specific manual journal by file name
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Creates a history record for a specific manual journalXERO_OAUTH2_CC_CREATE_MANUAL_JOURNAL_HISTORY_RECORDCreates a history record for a specific manual journalConnection1 scope
Creates a history record for a specific manual journal
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates one or more manual journalsXERO_OAUTH2_CC_CREATE_MANUAL_JOURNALSCreates one or more manual journalsConnection1 scope
Creates one or more manual journals
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates a single allocation for a specific overpaymentXERO_OAUTH2_CC_CREATE_OVERPAYMENT_ALLOCATIONSCreates a single allocation for a specific overpaymentConnection1 scope
Creates a single allocation for a specific overpayment
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates a history record for a specific overpaymentXERO_OAUTH2_CC_CREATE_OVERPAYMENT_HISTORYCreates a history record for a specific overpaymentConnection1 scope
Creates a history record for a specific overpayment
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates a single payment for invoice or credit notesXERO_OAUTH2_CC_CREATE_PAYMENTCreates a single payment for invoice or credit notesConnection1 scope
Creates a single payment for invoice or credit notes
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates a history record for a specific paymentXERO_OAUTH2_CC_CREATE_PAYMENT_HISTORYCreates a history record for a specific paymentConnection1 scope
Creates a history record for a specific payment
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates a payment serviceXERO_OAUTH2_CC_CREATE_PAYMENT_SERVICECreates a payment serviceConnection1 scope
Creates a payment service
Authentication
Connected account requiredScopes
paymentservicesTags
Creates multiple payments for invoices or credit notesXERO_OAUTH2_CC_CREATE_PAYMENTSCreates multiple payments for invoices or credit notesConnection1 scope
Creates multiple payments for invoices or credit notes
Authentication
Connected account requiredScopes
accounting.transactionsTags
Allows you to create an Allocation for prepaymentsXERO_OAUTH2_CC_CREATE_PREPAYMENT_ALLOCATIONSAllows you to create an Allocation for prepaymentsConnection1 scope
Allows you to create an Allocation for prepayments
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates a history record for a specific prepaymentXERO_OAUTH2_CC_CREATE_PREPAYMENT_HISTORYCreates a history record for a specific prepaymentConnection1 scope
Creates a history record for a specific prepayment
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates attachment for a specific purchase orderXERO_OAUTH2_CC_CREATE_PURCHASE_ORDER_ATTACHMENT_BY_FILE_NAMECreates attachment for a specific purchase orderConnection1 scope
Creates attachment for a specific purchase order
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Creates a history record for a specific purchase ordersXERO_OAUTH2_CC_CREATE_PURCHASE_ORDER_HISTORYCreates a history record for a specific purchase ordersConnection1 scope
Creates a history record for a specific purchase orders
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates one or more purchase ordersXERO_OAUTH2_CC_CREATE_PURCHASE_ORDERSCreates one or more purchase ordersConnection1 scope
Creates one or more purchase orders
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates attachment for a specific quoteXERO_OAUTH2_CC_CREATE_QUOTE_ATTACHMENT_BY_FILE_NAMECreates attachment for a specific quoteConnection1 scope
Creates attachment for a specific quote
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Creates a history record for a specific quoteXERO_OAUTH2_CC_CREATE_QUOTE_HISTORYCreates a history record for a specific quoteConnection1 scope
Creates a history record for a specific quote
Authentication
Connected account requiredScopes
accounting.transactionsTags
Create one or more quotesXERO_OAUTH2_CC_CREATE_QUOTESCreate one or more quotesConnection1 scope
Create one or more quotes
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates draft expense claim receipts for any userXERO_OAUTH2_CC_CREATE_RECEIPTCreates draft expense claim receipts for any userConnection1 scope
Creates draft expense claim receipts for any user
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates an attachment on a specific expense claim receipts by file nameXERO_OAUTH2_CC_CREATE_RECEIPT_ATTACHMENT_BY_FILE_NAMECreates an attachment on a specific expense claim receipts by file nameConnection1 scope
Creates an attachment on a specific expense claim receipts by file name
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Creates a history record for a specific receiptXERO_OAUTH2_CC_CREATE_RECEIPT_HISTORYCreates a history record for a specific receiptConnection1 scope
Creates a history record for a specific receipt
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates an attachment from a specific repeating invoices by file nameXERO_OAUTH2_CC_CREATE_REPEATING_INVOICE_ATTACHMENT_BY_FILE_NAMECreates an attachment from a specific repeating invoices by file nameConnection1 scope
Creates an attachment from a specific repeating invoices by file name
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Creates a history record for a specific repeating invoiceXERO_OAUTH2_CC_CREATE_REPEATING_INVOICE_HISTORYCreates a history record for a specific repeating invoiceConnection1 scope
Creates a history record for a specific repeating invoice
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates one or more repeating invoice templatesXERO_OAUTH2_CC_CREATE_REPEATING_INVOICESCreates one or more repeating invoice templatesConnection1 scope
Creates one or more repeating invoice templates
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates one or more tax ratesXERO_OAUTH2_CC_CREATE_TAX_RATESCreates one or more tax ratesConnection1 scope
Creates one or more tax rates
Authentication
Connected account requiredScopes
accounting.settingsTags
Create tracking categoriesXERO_OAUTH2_CC_CREATE_TRACKING_CATEGORYCreate tracking categoriesConnection1 scope
Create tracking categories
Authentication
Connected account requiredScopes
accounting.settingsTags
Creates options for a specific tracking categoryXERO_OAUTH2_CC_CREATE_TRACKING_OPTIONSCreates options for a specific tracking categoryConnection1 scope
Creates options for a specific tracking category
Authentication
Connected account requiredScopes
accounting.settingsTags
Deletes a chart of accountsXERO_OAUTH2_CC_DELETE_ACCOUNTDeletes a chart of accountsConnection1 scope
Deletes a chart of accounts
Authentication
Connected account requiredScopes
accounting.settingsTags
Updates a specific batch payment for invoices and credit notesXERO_OAUTH2_CC_DELETE_BATCH_PAYMENTBatch payments allow you to bundle multiple bills or invoices into one payment transaction. This means a single payment in Xero can be reconciled with a single transaction on the bank statement making for a much simpler bank reconciliation experience.Connection1 scope
Batch payments allow you to bundle multiple bills or invoices into one payment transaction. This means a single payment in Xero can be reconciled with a single transaction on the bank statement making for a much simpler bank reconciliation experience.
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates a specific batch payment for invoices and credit notesXERO_OAUTH2_CC_DELETE_BATCH_PAYMENT_BY_URL_PARAMUpdates a specific batch payment for invoices and credit notesConnection1 scope
Updates a specific batch payment for invoices and credit notes
Authentication
Connected account requiredScopes
accounting.transactionsTags
Deletes a specific contact from a contact group using a unique contact IdXERO_OAUTH2_CC_DELETE_CONTACT_GROUP_CONTACTDeletes a specific contact from a contact group using a unique contact IdConnection1 scope
Deletes a specific contact from a contact group using a unique contact Id
Authentication
Connected account requiredScopes
accounting.contactsTags
Deletes all contacts from a specific contact groupXERO_OAUTH2_CC_DELETE_CONTACT_GROUP_CONTACTSDeletes all contacts from a specific contact groupConnection1 scope
Deletes all contacts from a specific contact group
Authentication
Connected account requiredScopes
accounting.contactsTags
Deletes an Allocation from a Credit NoteXERO_OAUTH2_CC_DELETE_CREDIT_NOTE_ALLOCATIONSDeletes an Allocation from a Credit NoteConnection1 scope
Deletes an Allocation from a Credit Note
Authentication
Connected account requiredScopes
accounting.transactionsTags
Deletes a specific itemXERO_OAUTH2_CC_DELETE_ITEMDeletes a specific itemConnection1 scope
Deletes a specific item
Authentication
Connected account requiredScopes
accounting.settingsTags
Deletes a specific linked transactions (billable expenses)XERO_OAUTH2_CC_DELETE_LINKED_TRANSACTIONDeletes a specific linked transactions (billable expenses)Connection1 scope
Deletes a specific linked transactions (billable expenses)
Authentication
Connected account requiredScopes
accounting.transactionsTags
Deletes an Allocation from an overpaymentXERO_OAUTH2_CC_DELETE_OVERPAYMENT_ALLOCATIONSDeletes an Allocation from an overpaymentConnection1 scope
Deletes an Allocation from an overpayment
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates a specific payment for invoices and credit notesXERO_OAUTH2_CC_DELETE_PAYMENTUpdates a specific payment for invoices and credit notesConnection1 scope
Updates a specific payment for invoices and credit notes
Authentication
Connected account requiredScopes
accounting.transactionsTags
Deletes an Allocation from a PrepaymentXERO_OAUTH2_CC_DELETE_PREPAYMENT_ALLOCATIONSDeletes an Allocation from a PrepaymentConnection1 scope
Deletes an Allocation from a Prepayment
Authentication
Connected account requiredScopes
accounting.transactionsTags
Deletes a specific tracking categoryXERO_OAUTH2_CC_DELETE_TRACKING_CATEGORYDeletes a specific tracking categoryConnection1 scope
Deletes a specific tracking category
Authentication
Connected account requiredScopes
accounting.settingsTags
Deletes a specific option for a specific tracking categoryXERO_OAUTH2_CC_DELETE_TRACKING_OPTIONSDeletes a specific option for a specific tracking categoryConnection1 scope
Deletes a specific option for a specific tracking category
Authentication
Connected account requiredScopes
accounting.settingsTags
Sends a copy of a specific invoice to related contact via emailXERO_OAUTH2_CC_EMAIL_INVOICESends a copy of a specific invoice to related contact via emailConnection1 scope
Sends a copy of a specific invoice to related contact via email
Authentication
Connected account requiredScopes
accounting.transactionsTags
Retrieves a single chart of accounts by using a unique account IdXERO_OAUTH2_CC_GET_ACCOUNTRetrieves a single chart of accounts by using a unique account IdConnection2 scopes
Retrieves a single chart of accounts by using a unique account Id
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves an attachment for a specific account by filenameXERO_OAUTH2_CC_GET_ACCOUNT_ATTACHMENT_BY_FILE_NAMERetrieves an attachment for a specific account by filenameConnection2 scopes
Retrieves an attachment for a specific account by filename
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves a specific attachment from a specific account using a unique attachment IdXERO_OAUTH2_CC_GET_ACCOUNT_ATTACHMENT_BY_IDRetrieves a specific attachment from a specific account using a unique attachment IdConnection2 scopes
Retrieves a specific attachment from a specific account using a unique attachment Id
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves attachments for a specific accounts by using a unique account IdXERO_OAUTH2_CC_GET_ACCOUNT_ATTACHMENTSRetrieves attachments for a specific accounts by using a unique account IdConnection2 scopes
Retrieves attachments for a specific accounts by using a unique account Id
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves the full chart of accountsXERO_OAUTH2_CC_GET_ACCOUNTSRetrieves the full chart of accountsConnection2 scopes
Retrieves the full chart of accounts
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves a single spent or received money transaction by using a unique bank transaction IdXERO_OAUTH2_CC_GET_BANK_TRANSACTIONRetrieves a single spent or received money transaction by using a unique bank transaction IdConnection2 scopes
Retrieves a single spent or received money transaction by using a unique bank transaction Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific attachment from a specific bank transaction by filenameXERO_OAUTH2_CC_GET_BANK_TRANSACTION_ATTACHMENT_BY_FILE_NAMERetrieves a specific attachment from a specific bank transaction by filenameConnection2 scopes
Retrieves a specific attachment from a specific bank transaction by filename
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves specific attachments from a specific BankTransaction using a unique attachment IdXERO_OAUTH2_CC_GET_BANK_TRANSACTION_ATTACHMENT_BY_IDRetrieves specific attachments from a specific BankTransaction using a unique attachment IdConnection2 scopes
Retrieves specific attachments from a specific BankTransaction using a unique attachment Id
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves any attachments from a specific bank transactionsXERO_OAUTH2_CC_GET_BANK_TRANSACTION_ATTACHMENTSRetrieves any attachments from a specific bank transactionsConnection2 scopes
Retrieves any attachments from a specific bank transactions
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves any spent or received money transactionsXERO_OAUTH2_CC_GET_BANK_TRANSACTIONSRetrieves any spent or received money transactionsConnection2 scopes
Retrieves any spent or received money transactions
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves history from a specific bank transaction using a unique bank transaction IdXERO_OAUTH2_CC_GET_BANK_TRANSACTIONS_HISTORYRetrieves history from a specific bank transaction using a unique bank transaction IdConnection2 scopes
Retrieves history from a specific bank transaction using a unique bank transaction Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves specific bank transfers by using a unique bank transfer IdXERO_OAUTH2_CC_GET_BANK_TRANSFERRetrieves specific bank transfers by using a unique bank transfer IdConnection2 scopes
Retrieves specific bank transfers by using a unique bank transfer Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific attachment on a specific bank transfer by file nameXERO_OAUTH2_CC_GET_BANK_TRANSFER_ATTACHMENT_BY_FILE_NAMERetrieves a specific attachment on a specific bank transfer by file nameConnection2 scopes
Retrieves a specific attachment on a specific bank transfer by file name
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves a specific attachment from a specific bank transfer using a unique attachment IDXERO_OAUTH2_CC_GET_BANK_TRANSFER_ATTACHMENT_BY_IDRetrieves a specific attachment from a specific bank transfer using a unique attachment IDConnection2 scopes
Retrieves a specific attachment from a specific bank transfer using a unique attachment ID
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves attachments from a specific bank transferXERO_OAUTH2_CC_GET_BANK_TRANSFER_ATTACHMENTSRetrieves attachments from a specific bank transferConnection2 scopes
Retrieves attachments from a specific bank transfer
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves history from a specific bank transfer using a unique bank transfer IdXERO_OAUTH2_CC_GET_BANK_TRANSFER_HISTORYRetrieves history from a specific bank transfer using a unique bank transfer IdConnection2 scopes
Retrieves history from a specific bank transfer using a unique bank transfer Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves all bank transfersXERO_OAUTH2_CC_GET_BANK_TRANSFERSRetrieves all bank transfersConnection2 scopes
Retrieves all bank transfers
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific batch payment using a unique batch payment IdXERO_OAUTH2_CC_GET_BATCH_PAYMENTRetrieves a specific batch payment using a unique batch payment IdConnection2 scopes
Retrieves a specific batch payment using a unique batch payment Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves history from a specific batch paymentXERO_OAUTH2_CC_GET_BATCH_PAYMENT_HISTORYRetrieves history from a specific batch paymentConnection2 scopes
Retrieves history from a specific batch payment
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves either one or many batch payments for invoicesXERO_OAUTH2_CC_GET_BATCH_PAYMENTSBatch payments allow you to bundle multiple bills or invoices into one payment transaction. This means a single payment in Xero can be reconciled with a single transaction on the bank statement making for a much simpler bank reconciliation experience.Connection2 scopes
Batch payments allow you to bundle multiple bills or invoices into one payment transaction. This means a single payment in Xero can be reconciled with a single transaction on the bank statement making for a much simpler bank reconciliation experience.
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific branding theme using a unique branding theme IdXERO_OAUTH2_CC_GET_BRANDING_THEMERetrieves a specific branding theme using a unique branding theme IdConnection2 scopes
Retrieves a specific branding theme using a unique branding theme Id
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves the payment services for a specific branding themeXERO_OAUTH2_CC_GET_BRANDING_THEME_PAYMENT_SERVICESRetrieves the payment services for a specific branding themeConnection1 scope
Retrieves the payment services for a specific branding theme
Authentication
Connected account requiredScopes
paymentservicesTags
Retrieves all the branding themesXERO_OAUTH2_CC_GET_BRANDING_THEMESRetrieves all the branding themesConnection2 scopes
Retrieves all the branding themes
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves a specific budget, which includes budget linesXERO_OAUTH2_CC_GET_BUDGETRetrieves a specific budget, which includes budget linesConnection1 scope
Retrieves a specific budget, which includes budget lines
Authentication
Connected account requiredScopes
accounting.budgets.readTags
Retrieve a list of budgetsXERO_OAUTH2_CC_GET_BUDGETSRetrieve a list of budgetsConnection1 scope
Retrieve a list of budgets
Authentication
Connected account requiredScopes
accounting.budgets.readTags
Retrieves a specific contacts in a Xero organisation using a unique contact IdXERO_OAUTH2_CC_GET_CONTACTRetrieves a specific contacts in a Xero organisation using a unique contact IdConnection2 scopes
Retrieves a specific contacts in a Xero organisation using a unique contact Id
Authentication
Connected account requiredScopes
accounting.contactsaccounting.contacts.readTags
Retrieves a specific attachment from a specific contact by file nameXERO_OAUTH2_CC_GET_CONTACT_ATTACHMENT_BY_FILE_NAMERetrieves a specific attachment from a specific contact by file nameConnection2 scopes
Retrieves a specific attachment from a specific contact by file name
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves a specific attachment from a specific contact using a unique attachment IdXERO_OAUTH2_CC_GET_CONTACT_ATTACHMENT_BY_IDRetrieves a specific attachment from a specific contact using a unique attachment IdConnection2 scopes
Retrieves a specific attachment from a specific contact using a unique attachment Id
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves attachments for a specific contact in a Xero organisationXERO_OAUTH2_CC_GET_CONTACT_ATTACHMENTSRetrieves attachments for a specific contact in a Xero organisationConnection2 scopes
Retrieves attachments for a specific contact in a Xero organisation
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves a specific contact by contact number in a Xero organisationXERO_OAUTH2_CC_GET_CONTACT_BY_CONTACT_NUMBERRetrieves a specific contact by contact number in a Xero organisationConnection2 scopes
Retrieves a specific contact by contact number in a Xero organisation
Authentication
Connected account requiredScopes
accounting.contactsaccounting.contacts.readTags
Retrieves CIS settings for a specific contact in a Xero organisationXERO_OAUTH2_CC_GET_CONTACT_CISSETTINGSRetrieves CIS settings for a specific contact in a Xero organisationConnection2 scopes
Retrieves CIS settings for a specific contact in a Xero organisation
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves a specific contact group by using a unique contact group IdXERO_OAUTH2_CC_GET_CONTACT_GROUPRetrieves a specific contact group by using a unique contact group IdConnection2 scopes
Retrieves a specific contact group by using a unique contact group Id
Authentication
Connected account requiredScopes
accounting.contactsaccounting.contacts.readTags
Retrieves the contact Id and name of each contact groupXERO_OAUTH2_CC_GET_CONTACT_GROUPSRetrieves the contact Id and name of each contact groupConnection2 scopes
Retrieves the contact Id and name of each contact group
Authentication
Connected account requiredScopes
accounting.contactsaccounting.contacts.readTags
Retrieves history records for a specific contactXERO_OAUTH2_CC_GET_CONTACT_HISTORYRetrieves history records for a specific contactConnection2 scopes
Retrieves history records for a specific contact
Authentication
Connected account requiredScopes
accounting.contactsaccounting.contacts.readTags
Retrieves all contacts in a Xero organisationXERO_OAUTH2_CC_GET_CONTACTSRetrieves all contacts in a Xero organisationConnection2 scopes
Retrieves all contacts in a Xero organisation
Authentication
Connected account requiredScopes
accounting.contactsaccounting.contacts.readTags
Retrieves a specific credit note using a unique credit note IdXERO_OAUTH2_CC_GET_CREDIT_NOTERetrieves a specific credit note using a unique credit note IdConnection2 scopes
Retrieves a specific credit note using a unique credit note Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves credit notes as PDF filesXERO_OAUTH2_CC_GET_CREDIT_NOTE_AS_PDFRetrieves credit notes as PDF filesConnection2 scopes
Retrieves credit notes as PDF files
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific attachment on a specific credit note by file nameXERO_OAUTH2_CC_GET_CREDIT_NOTE_ATTACHMENT_BY_FILE_NAMERetrieves a specific attachment on a specific credit note by file nameConnection2 scopes
Retrieves a specific attachment on a specific credit note by file name
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves a specific attachment from a specific credit note using a unique attachment IdXERO_OAUTH2_CC_GET_CREDIT_NOTE_ATTACHMENT_BY_IDRetrieves a specific attachment from a specific credit note using a unique attachment IdConnection2 scopes
Retrieves a specific attachment from a specific credit note using a unique attachment Id
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves attachments for a specific credit notesXERO_OAUTH2_CC_GET_CREDIT_NOTE_ATTACHMENTSRetrieves attachments for a specific credit notesConnection2 scopes
Retrieves attachments for a specific credit notes
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves history records of a specific credit noteXERO_OAUTH2_CC_GET_CREDIT_NOTE_HISTORYRetrieves history records of a specific credit noteConnection2 scopes
Retrieves history records of a specific credit note
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves any credit notesXERO_OAUTH2_CC_GET_CREDIT_NOTESRetrieves any credit notesConnection2 scopes
Retrieves any credit notes
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves currencies for your Xero organisationXERO_OAUTH2_CC_GET_CURRENCIESRetrieves currencies for your Xero organisationConnection2 scopes
Retrieves currencies for your Xero organisation
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves a specific expense claim using a unique expense claim IdXERO_OAUTH2_CC_GET_EXPENSE_CLAIMRetrieves a specific expense claim using a unique expense claim IdConnection2 scopes
Retrieves a specific expense claim using a unique expense claim Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves history records of a specific expense claimXERO_OAUTH2_CC_GET_EXPENSE_CLAIM_HISTORYRetrieves history records of a specific expense claimConnection2 scopes
Retrieves history records of a specific expense claim
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves expense claimsXERO_OAUTH2_CC_GET_EXPENSE_CLAIMSRetrieves expense claimsConnection2 scopes
Retrieves expense claims
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific sales invoice or purchase bill using a unique invoice IdXERO_OAUTH2_CC_GET_INVOICERetrieves a specific sales invoice or purchase bill using a unique invoice IdConnection2 scopes
Retrieves a specific sales invoice or purchase bill using a unique invoice Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves invoices or purchase bills as PDF filesXERO_OAUTH2_CC_GET_INVOICE_AS_PDFRetrieves invoices or purchase bills as PDF filesConnection2 scopes
Retrieves invoices or purchase bills as PDF files
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves an attachment from a specific invoice or purchase bill by filenameXERO_OAUTH2_CC_GET_INVOICE_ATTACHMENT_BY_FILE_NAMERetrieves an attachment from a specific invoice or purchase bill by filenameConnection2 scopes
Retrieves an attachment from a specific invoice or purchase bill by filename
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment IdXERO_OAUTH2_CC_GET_INVOICE_ATTACHMENT_BY_IDRetrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment IdConnection2 scopes
Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves attachments for a specific invoice or purchase billXERO_OAUTH2_CC_GET_INVOICE_ATTACHMENTSRetrieves attachments for a specific invoice or purchase billConnection2 scopes
Retrieves attachments for a specific invoice or purchase bill
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves history records for a specific invoiceXERO_OAUTH2_CC_GET_INVOICE_HISTORYRetrieves history records for a specific invoiceConnection2 scopes
Retrieves history records for a specific invoice
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves invoice reminder settingsXERO_OAUTH2_CC_GET_INVOICE_REMINDERSRetrieves invoice reminder settingsConnection2 scopes
Retrieves invoice reminder settings
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves sales invoices or purchase billsXERO_OAUTH2_CC_GET_INVOICESRetrieves sales invoices or purchase billsConnection2 scopes
Retrieves sales invoices or purchase bills
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific item using a unique item IdXERO_OAUTH2_CC_GET_ITEMRetrieves a specific item using a unique item IdConnection2 scopes
Retrieves a specific item using a unique item Id
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves history for a specific itemXERO_OAUTH2_CC_GET_ITEM_HISTORYRetrieves history for a specific itemConnection2 scopes
Retrieves history for a specific item
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves itemsXERO_OAUTH2_CC_GET_ITEMSRetrieves itemsConnection2 scopes
Retrieves items
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves a specific journal using a unique journal Id.XERO_OAUTH2_CC_GET_JOURNALRetrieves a specific journal using a unique journal Id.Connection1 scope
Retrieves a specific journal using a unique journal Id.
Authentication
Connected account requiredScopes
accounting.journals.readTags
Retrieves a specific journal using a unique journal number.XERO_OAUTH2_CC_GET_JOURNAL_BY_NUMBERRetrieves a specific journal using a unique journal number.Connection1 scope
Retrieves a specific journal using a unique journal number.
Authentication
Connected account requiredScopes
accounting.journals.readTags
Retrieves journalsXERO_OAUTH2_CC_GET_JOURNALSRetrieves journalsConnection1 scope
Retrieves journals
Authentication
Connected account requiredScopes
accounting.journals.readTags
Retrieves a specific linked transaction (billable expenses) using a unique linked transaction IdXERO_OAUTH2_CC_GET_LINKED_TRANSACTIONRetrieves a specific linked transaction (billable expenses) using a unique linked transaction IdConnection2 scopes
Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves linked transactions (billable expenses)XERO_OAUTH2_CC_GET_LINKED_TRANSACTIONSRetrieves linked transactions (billable expenses)Connection2 scopes
Retrieves linked transactions (billable expenses)
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific manual journalXERO_OAUTH2_CC_GET_MANUAL_JOURNALRetrieves a specific manual journalConnection2 scopes
Retrieves a specific manual journal
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific attachment from a specific manual journal by file nameXERO_OAUTH2_CC_GET_MANUAL_JOURNAL_ATTACHMENT_BY_FILE_NAMERetrieves a specific attachment from a specific manual journal by file nameConnection2 scopes
Retrieves a specific attachment from a specific manual journal by file name
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment IdXERO_OAUTH2_CC_GET_MANUAL_JOURNAL_ATTACHMENT_BY_IDAllows you to retrieve a specific attachment from a specific manual journal using a unique attachment IdConnection2 scopes
Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves attachment for a specific manual journalXERO_OAUTH2_CC_GET_MANUAL_JOURNAL_ATTACHMENTSRetrieves attachment for a specific manual journalConnection2 scopes
Retrieves attachment for a specific manual journal
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves manual journalsXERO_OAUTH2_CC_GET_MANUAL_JOURNALSRetrieves manual journalsConnection2 scopes
Retrieves manual journals
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves history for a specific manual journalXERO_OAUTH2_CC_GET_MANUAL_JOURNALS_HISTORYRetrieves history for a specific manual journalConnection2 scopes
Retrieves history for a specific manual journal
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a URL to an online invoiceXERO_OAUTH2_CC_GET_ONLINE_INVOICERetrieves a URL to an online invoiceConnection2 scopes
Retrieves a URL to an online invoice
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.XERO_OAUTH2_CC_GET_ORGANISATION_ACTIONSRetrieves a list of the key actions your app has permission to perform in the connected Xero organisation.Connection2 scopes
Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves the CIS settings for the Xero organistaion.XERO_OAUTH2_CC_GET_ORGANISATION_CISSETTINGSRetrieves the CIS settings for the Xero organistaion.Connection2 scopes
Retrieves the CIS settings for the Xero organistaion.
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves Xero organisation detailsXERO_OAUTH2_CC_GET_ORGANISATIONSRetrieves Xero organisation detailsConnection2 scopes
Retrieves Xero organisation details
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves a specific overpayment using a unique overpayment IdXERO_OAUTH2_CC_GET_OVERPAYMENTRetrieves a specific overpayment using a unique overpayment IdConnection2 scopes
Retrieves a specific overpayment using a unique overpayment Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves history records of a specific overpaymentXERO_OAUTH2_CC_GET_OVERPAYMENT_HISTORYRetrieves history records of a specific overpaymentConnection2 scopes
Retrieves history records of a specific overpayment
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves overpaymentsXERO_OAUTH2_CC_GET_OVERPAYMENTSRetrieves overpaymentsConnection2 scopes
Retrieves overpayments
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific payment for invoices and credit notes using a unique payment IdXERO_OAUTH2_CC_GET_PAYMENTRetrieves a specific payment for invoices and credit notes using a unique payment IdConnection2 scopes
Retrieves a specific payment for invoices and credit notes using a unique payment Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves history records of a specific paymentXERO_OAUTH2_CC_GET_PAYMENT_HISTORYRetrieves history records of a specific paymentConnection2 scopes
Retrieves history records of a specific payment
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves payment servicesXERO_OAUTH2_CC_GET_PAYMENT_SERVICESRetrieves payment servicesConnection1 scope
Retrieves payment services
Authentication
Connected account requiredScopes
paymentservicesTags
Retrieves payments for invoices and credit notesXERO_OAUTH2_CC_GET_PAYMENTSRetrieves payments for invoices and credit notesConnection2 scopes
Retrieves payments for invoices and credit notes
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Allows you to retrieve a specified prepaymentsXERO_OAUTH2_CC_GET_PREPAYMENTAllows you to retrieve a specified prepaymentsConnection2 scopes
Allows you to retrieve a specified prepayments
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves history record for a specific prepaymentXERO_OAUTH2_CC_GET_PREPAYMENT_HISTORYRetrieves history record for a specific prepaymentConnection2 scopes
Retrieves history record for a specific prepayment
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves prepaymentsXERO_OAUTH2_CC_GET_PREPAYMENTSRetrieves prepaymentsConnection2 scopes
Retrieves prepayments
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific purchase order using a unique purchase order IdXERO_OAUTH2_CC_GET_PURCHASE_ORDERRetrieves a specific purchase order using a unique purchase order IdConnection2 scopes
Retrieves a specific purchase order using a unique purchase order Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves specific purchase order as PDF files using a unique purchase order IdXERO_OAUTH2_CC_GET_PURCHASE_ORDER_AS_PDFRetrieves specific purchase order as PDF files using a unique purchase order IdConnection2 scopes
Retrieves specific purchase order as PDF files using a unique purchase order Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific attachment for a specific purchase order by filenameXERO_OAUTH2_CC_GET_PURCHASE_ORDER_ATTACHMENT_BY_FILE_NAMERetrieves a specific attachment for a specific purchase order by filenameConnection2 scopes
Retrieves a specific attachment for a specific purchase order by filename
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves specific attachment for a specific purchase order using a unique attachment IdXERO_OAUTH2_CC_GET_PURCHASE_ORDER_ATTACHMENT_BY_IDRetrieves specific attachment for a specific purchase order using a unique attachment IdConnection2 scopes
Retrieves specific attachment for a specific purchase order using a unique attachment Id
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves attachments for a specific purchase orderXERO_OAUTH2_CC_GET_PURCHASE_ORDER_ATTACHMENTSRetrieves attachments for a specific purchase orderConnection2 scopes
Retrieves attachments for a specific purchase order
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves a specific purchase order using purchase order numberXERO_OAUTH2_CC_GET_PURCHASE_ORDER_BY_NUMBERRetrieves a specific purchase order using purchase order numberConnection2 scopes
Retrieves a specific purchase order using purchase order number
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves history for a specific purchase orderXERO_OAUTH2_CC_GET_PURCHASE_ORDER_HISTORYRetrieves history for a specific purchase orderConnection2 scopes
Retrieves history for a specific purchase order
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves purchase ordersXERO_OAUTH2_CC_GET_PURCHASE_ORDERSRetrieves purchase ordersConnection2 scopes
Retrieves purchase orders
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific quote using a unique quote IdXERO_OAUTH2_CC_GET_QUOTERetrieves a specific quote using a unique quote IdConnection2 scopes
Retrieves a specific quote using a unique quote Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific quote as a PDF file using a unique quote IdXERO_OAUTH2_CC_GET_QUOTE_AS_PDFRetrieves a specific quote as a PDF file using a unique quote IdConnection2 scopes
Retrieves a specific quote as a PDF file using a unique quote Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific attachment from a specific quote by filenameXERO_OAUTH2_CC_GET_QUOTE_ATTACHMENT_BY_FILE_NAMERetrieves a specific attachment from a specific quote by filenameConnection2 scopes
Retrieves a specific attachment from a specific quote by filename
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves a specific attachment from a specific quote using a unique attachment IdXERO_OAUTH2_CC_GET_QUOTE_ATTACHMENT_BY_IDRetrieves a specific attachment from a specific quote using a unique attachment IdConnection2 scopes
Retrieves a specific attachment from a specific quote using a unique attachment Id
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves attachments for a specific quoteXERO_OAUTH2_CC_GET_QUOTE_ATTACHMENTSRetrieves attachments for a specific quoteConnection2 scopes
Retrieves attachments for a specific quote
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves history records of a specific quoteXERO_OAUTH2_CC_GET_QUOTE_HISTORYRetrieves history records of a specific quoteConnection2 scopes
Retrieves history records of a specific quote
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves sales quotesXERO_OAUTH2_CC_GET_QUOTESRetrieves sales quotesConnection2 scopes
Retrieves sales quotes
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific draft expense claim receipt by using a unique receipt IdXERO_OAUTH2_CC_GET_RECEIPTRetrieves a specific draft expense claim receipt by using a unique receipt IdConnection2 scopes
Retrieves a specific draft expense claim receipt by using a unique receipt Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific attachment from a specific expense claim receipts by file nameXERO_OAUTH2_CC_GET_RECEIPT_ATTACHMENT_BY_FILE_NAMERetrieves a specific attachment from a specific expense claim receipts by file nameConnection2 scopes
Retrieves a specific attachment from a specific expense claim receipts by file name
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment IdXERO_OAUTH2_CC_GET_RECEIPT_ATTACHMENT_BY_IDRetrieves a specific attachments from a specific expense claim receipts by using a unique attachment IdConnection2 scopes
Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves attachments for a specific expense claim receiptXERO_OAUTH2_CC_GET_RECEIPT_ATTACHMENTSRetrieves attachments for a specific expense claim receiptConnection2 scopes
Retrieves attachments for a specific expense claim receipt
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves a history record for a specific receiptXERO_OAUTH2_CC_GET_RECEIPT_HISTORYRetrieves a history record for a specific receiptConnection2 scopes
Retrieves a history record for a specific receipt
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves draft expense claim receipts for any userXERO_OAUTH2_CC_GET_RECEIPTSRetrieves draft expense claim receipts for any userConnection2 scopes
Retrieves draft expense claim receipts for any user
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific repeating invoice by using a unique repeating invoice IdXERO_OAUTH2_CC_GET_REPEATING_INVOICERetrieves a specific repeating invoice by using a unique repeating invoice IdConnection2 scopes
Retrieves a specific repeating invoice by using a unique repeating invoice Id
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves a specific attachment from a specific repeating invoices by file nameXERO_OAUTH2_CC_GET_REPEATING_INVOICE_ATTACHMENT_BY_FILE_NAMERetrieves a specific attachment from a specific repeating invoices by file nameConnection2 scopes
Retrieves a specific attachment from a specific repeating invoices by file name
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves a specific attachment from a specific repeating invoiceXERO_OAUTH2_CC_GET_REPEATING_INVOICE_ATTACHMENT_BY_IDRetrieves a specific attachment from a specific repeating invoiceConnection2 scopes
Retrieves a specific attachment from a specific repeating invoice
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves attachments from a specific repeating invoiceXERO_OAUTH2_CC_GET_REPEATING_INVOICE_ATTACHMENTSRetrieves attachments from a specific repeating invoiceConnection2 scopes
Retrieves attachments from a specific repeating invoice
Authentication
Connected account requiredScopes
accounting.attachmentsaccounting.attachments.readTags
Retrieves history record for a specific repeating invoiceXERO_OAUTH2_CC_GET_REPEATING_INVOICE_HISTORYRetrieves history record for a specific repeating invoiceConnection2 scopes
Retrieves history record for a specific repeating invoice
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves repeating invoicesXERO_OAUTH2_CC_GET_REPEATING_INVOICESRetrieves repeating invoicesConnection2 scopes
Retrieves repeating invoices
Authentication
Connected account requiredScopes
accounting.transactionsaccounting.transactions.readTags
Retrieves report for aged payables by contactXERO_OAUTH2_CC_GET_REPORT_AGED_PAYABLES_BY_CONTACTRetrieves report for aged payables by contactConnection1 scope
Retrieves report for aged payables by contact
Authentication
Connected account requiredScopes
accounting.reports.readTags
Retrieves report for aged receivables by contactXERO_OAUTH2_CC_GET_REPORT_AGED_RECEIVABLES_BY_CONTACTRetrieves report for aged receivables by contactConnection1 scope
Retrieves report for aged receivables by contact
Authentication
Connected account requiredScopes
accounting.reports.readTags
Retrieves report for balancesheetXERO_OAUTH2_CC_GET_REPORT_BALANCE_SHEETRetrieves report for balancesheetConnection1 scope
Retrieves report for balancesheet
Authentication
Connected account requiredScopes
accounting.reports.readTags
Retrieves report for bank summaryXERO_OAUTH2_CC_GET_REPORT_BANK_SUMMARYRetrieves report for bank summaryConnection1 scope
Retrieves report for bank summary
Authentication
Connected account requiredScopes
accounting.reports.readTags
Retrieves report for budget summaryXERO_OAUTH2_CC_GET_REPORT_BUDGET_SUMMARYRetrieves report for budget summaryConnection1 scope
Retrieves report for budget summary
Authentication
Connected account requiredScopes
accounting.reports.readTags
Retrieves report for executive summaryXERO_OAUTH2_CC_GET_REPORT_EXECUTIVE_SUMMARYRetrieves report for executive summaryConnection1 scope
Retrieves report for executive summary
Authentication
Connected account requiredScopes
accounting.reports.readTags
Retrieves a specific report using a unique ReportIDXERO_OAUTH2_CC_GET_REPORT_FROM_IDRetrieves a specific report using a unique ReportIDConnection1 scope
Retrieves a specific report using a unique ReportID
Authentication
Connected account requiredScopes
accounting.reports.readTags
Retrieves report for profit and lossXERO_OAUTH2_CC_GET_REPORT_PROFIT_AND_LOSSRetrieves report for profit and lossConnection1 scope
Retrieves report for profit and loss
Authentication
Connected account requiredScopes
accounting.reports.readTags
Retrieve reports for 1099XERO_OAUTH2_CC_GET_REPORT_TEN_NINETY_NINERetrieve reports for 1099Connection2 scopes
Retrieve reports for 1099
Authentication
Connected account requiredScopes
accounting.reports.readaccounting.reports.tenninetynine.readTags
Retrieves report for trial balanceXERO_OAUTH2_CC_GET_REPORT_TRIAL_BALANCERetrieves report for trial balanceConnection1 scope
Retrieves report for trial balance
Authentication
Connected account requiredScopes
accounting.reports.readTags
Retrieves a list of the organistaions unique reports that require a uuid to fetchXERO_OAUTH2_CC_GET_REPORTS_LISTRetrieves a list of the organistaions unique reports that require a uuid to fetchConnection1 scope
Retrieves a list of the organistaions unique reports that require a uuid to fetch
Authentication
Connected account requiredScopes
accounting.reports.readTags
Retrieves a specific tax rate according to given TaxType codeXERO_OAUTH2_CC_GET_TAX_RATE_BY_TAX_TYPERetrieves a specific tax rate according to given TaxType codeConnection2 scopes
Retrieves a specific tax rate according to given TaxType code
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves tax ratesXERO_OAUTH2_CC_GET_TAX_RATESRetrieves tax ratesConnection2 scopes
Retrieves tax rates
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves tracking categories and optionsXERO_OAUTH2_CC_GET_TRACKING_CATEGORIESRetrieves tracking categories and optionsConnection2 scopes
Retrieves tracking categories and options
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves specific tracking categories and options using a unique tracking category IdXERO_OAUTH2_CC_GET_TRACKING_CATEGORYRetrieves specific tracking categories and options using a unique tracking category IdConnection2 scopes
Retrieves specific tracking categories and options using a unique tracking category Id
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves a specific userXERO_OAUTH2_CC_GET_USERRetrieves a specific userConnection2 scopes
Retrieves a specific user
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Retrieves usersXERO_OAUTH2_CC_GET_USERSRetrieves usersConnection2 scopes
Retrieves users
Authentication
Connected account requiredScopes
accounting.settingsaccounting.settings.readTags
Sets the chart of accounts, the conversion date and conversion balancesXERO_OAUTH2_CC_POST_SETUPSets the chart of accounts, the conversion date and conversion balancesConnection1 scope
Sets the chart of accounts, the conversion date and conversion balances
Authentication
Connected account requiredScopes
accounting.settingsTags
Updates a chart of accountsXERO_OAUTH2_CC_UPDATE_ACCOUNTUpdates a chart of accountsConnection1 scope
Updates a chart of accounts
Authentication
Connected account requiredScopes
accounting.settingsTags
Updates attachment on a specific account by filenameXERO_OAUTH2_CC_UPDATE_ACCOUNT_ATTACHMENT_BY_FILE_NAMEUpdates attachment on a specific account by filenameConnection1 scope
Updates attachment on a specific account by filename
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Updates a single spent or received money transactionXERO_OAUTH2_CC_UPDATE_BANK_TRANSACTIONUpdates a single spent or received money transactionConnection1 scope
Updates a single spent or received money transaction
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates a specific attachment from a specific bank transaction by filenameXERO_OAUTH2_CC_UPDATE_BANK_TRANSACTION_ATTACHMENT_BY_FILE_NAMEUpdates a specific attachment from a specific bank transaction by filenameConnection1 scope
Updates a specific attachment from a specific bank transaction by filename
Authentication
Connected account requiredScopes
accounting.attachmentsTags
UpdateBankTransferAttachmentByFileNameXERO_OAUTH2_CC_UPDATE_BANK_TRANSFER_ATTACHMENT_BY_FILE_NAMEUpdateBankTransferAttachmentByFileNameConnection1 scope
UpdateBankTransferAttachmentByFileName
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Updates a specific contact in a Xero organisationXERO_OAUTH2_CC_UPDATE_CONTACTUpdates a specific contact in a Xero organisationConnection1 scope
Updates a specific contact in a Xero organisation
Authentication
Connected account requiredScopes
accounting.contactsTags
UpdateContactAttachmentByFileNameXERO_OAUTH2_CC_UPDATE_CONTACT_ATTACHMENT_BY_FILE_NAMEUpdateContactAttachmentByFileNameConnection1 scope
UpdateContactAttachmentByFileName
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Updates a specific contact groupXERO_OAUTH2_CC_UPDATE_CONTACT_GROUPUpdates a specific contact groupConnection1 scope
Updates a specific contact group
Authentication
Connected account requiredScopes
accounting.contactsTags
Updates a specific credit noteXERO_OAUTH2_CC_UPDATE_CREDIT_NOTEUpdates a specific credit noteConnection1 scope
Updates a specific credit note
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates attachments on a specific credit note by file nameXERO_OAUTH2_CC_UPDATE_CREDIT_NOTE_ATTACHMENT_BY_FILE_NAMEUpdates attachments on a specific credit note by file nameConnection1 scope
Updates attachments on a specific credit note by file name
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Updates a specific expense claimsXERO_OAUTH2_CC_UPDATE_EXPENSE_CLAIMUpdates a specific expense claimsConnection1 scope
Updates a specific expense claims
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates a specific sales invoices or purchase billsXERO_OAUTH2_CC_UPDATE_INVOICEUpdates a specific sales invoices or purchase billsConnection1 scope
Updates a specific sales invoices or purchase bills
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates an attachment from a specific invoices or purchase bill by filenameXERO_OAUTH2_CC_UPDATE_INVOICE_ATTACHMENT_BY_FILE_NAMEUpdates an attachment from a specific invoices or purchase bill by filenameConnection1 scope
Updates an attachment from a specific invoices or purchase bill by filename
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Updates a specific itemXERO_OAUTH2_CC_UPDATE_ITEMUpdates a specific itemConnection1 scope
Updates a specific item
Authentication
Connected account requiredScopes
accounting.settingsTags
Updates a specific linked transactions (billable expenses)XERO_OAUTH2_CC_UPDATE_LINKED_TRANSACTIONUpdates a specific linked transactions (billable expenses)Connection1 scope
Updates a specific linked transactions (billable expenses)
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates a specific manual journalXERO_OAUTH2_CC_UPDATE_MANUAL_JOURNALUpdates a specific manual journalConnection1 scope
Updates a specific manual journal
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates a specific attachment from a specific manual journal by file nameXERO_OAUTH2_CC_UPDATE_MANUAL_JOURNAL_ATTACHMENT_BY_FILE_NAMEUpdates a specific attachment from a specific manual journal by file nameConnection1 scope
Updates a specific attachment from a specific manual journal by file name
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Updates or creates one or more spent or received money transactionXERO_OAUTH2_CC_UPDATE_OR_CREATE_BANK_TRANSACTIONSUpdates or creates one or more spent or received money transactionConnection1 scope
Updates or creates one or more spent or received money transaction
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates or creates one or more contacts in a Xero organisationXERO_OAUTH2_CC_UPDATE_OR_CREATE_CONTACTSUpdates or creates one or more contacts in a Xero organisationConnection1 scope
Updates or creates one or more contacts in a Xero organisation
Authentication
Connected account requiredScopes
accounting.contactsTags
Updates or creates one or more credit notesXERO_OAUTH2_CC_UPDATE_OR_CREATE_CREDIT_NOTESUpdates or creates one or more credit notesConnection1 scope
Updates or creates one or more credit notes
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates or creates one or more sales invoices or purchase billsXERO_OAUTH2_CC_UPDATE_OR_CREATE_INVOICESUpdates or creates one or more sales invoices or purchase billsConnection1 scope
Updates or creates one or more sales invoices or purchase bills
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates or creates one or more itemsXERO_OAUTH2_CC_UPDATE_OR_CREATE_ITEMSUpdates or creates one or more itemsConnection1 scope
Updates or creates one or more items
Authentication
Connected account requiredScopes
accounting.settingsTags
Updates or creates a single manual journalXERO_OAUTH2_CC_UPDATE_OR_CREATE_MANUAL_JOURNALSUpdates or creates a single manual journalConnection1 scope
Updates or creates a single manual journal
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates or creates one or more purchase ordersXERO_OAUTH2_CC_UPDATE_OR_CREATE_PURCHASE_ORDERSUpdates or creates one or more purchase ordersConnection1 scope
Updates or creates one or more purchase orders
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates or creates one or more quotesXERO_OAUTH2_CC_UPDATE_OR_CREATE_QUOTESUpdates or creates one or more quotesConnection1 scope
Updates or creates one or more quotes
Authentication
Connected account requiredScopes
accounting.transactionsTags
Creates or deletes one or more repeating invoice templatesXERO_OAUTH2_CC_UPDATE_OR_CREATE_REPEATING_INVOICESCreates or deletes one or more repeating invoice templatesConnection1 scope
Creates or deletes one or more repeating invoice templates
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates a specific purchase orderXERO_OAUTH2_CC_UPDATE_PURCHASE_ORDERUpdates a specific purchase orderConnection1 scope
Updates a specific purchase order
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates a specific attachment for a specific purchase order by filenameXERO_OAUTH2_CC_UPDATE_PURCHASE_ORDER_ATTACHMENT_BY_FILE_NAMEUpdates a specific attachment for a specific purchase order by filenameConnection1 scope
Updates a specific attachment for a specific purchase order by filename
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Updates a specific quoteXERO_OAUTH2_CC_UPDATE_QUOTEUpdates a specific quoteConnection1 scope
Updates a specific quote
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates a specific attachment from a specific quote by filenameXERO_OAUTH2_CC_UPDATE_QUOTE_ATTACHMENT_BY_FILE_NAMEUpdates a specific attachment from a specific quote by filenameConnection1 scope
Updates a specific attachment from a specific quote by filename
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Updates a specific draft expense claim receiptsXERO_OAUTH2_CC_UPDATE_RECEIPTUpdates a specific draft expense claim receiptsConnection1 scope
Updates a specific draft expense claim receipts
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates a specific attachment on a specific expense claim receipts by file nameXERO_OAUTH2_CC_UPDATE_RECEIPT_ATTACHMENT_BY_FILE_NAMEUpdates a specific attachment on a specific expense claim receipts by file nameConnection1 scope
Updates a specific attachment on a specific expense claim receipts by file name
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Deletes a specific repeating invoice templateXERO_OAUTH2_CC_UPDATE_REPEATING_INVOICEDeletes a specific repeating invoice templateConnection1 scope
Deletes a specific repeating invoice template
Authentication
Connected account requiredScopes
accounting.transactionsTags
Updates a specific attachment from a specific repeating invoices by file nameXERO_OAUTH2_CC_UPDATE_REPEATING_INVOICE_ATTACHMENT_BY_FILE_NAMEUpdates a specific attachment from a specific repeating invoices by file nameConnection1 scope
Updates a specific attachment from a specific repeating invoices by file name
Authentication
Connected account requiredScopes
accounting.attachmentsTags
Updates tax ratesXERO_OAUTH2_CC_UPDATE_TAX_RATEUpdates tax ratesConnection1 scope
Updates tax rates
Authentication
Connected account requiredScopes
accounting.settingsTags
Updates a specific tracking categoryXERO_OAUTH2_CC_UPDATE_TRACKING_CATEGORYUpdates a specific tracking categoryConnection1 scope
Updates a specific tracking category
Authentication
Connected account requiredScopes
accounting.settingsTags
Updates a specific option for a specific tracking categoryXERO_OAUTH2_CC_UPDATE_TRACKING_OPTIONSUpdates a specific option for a specific tracking categoryConnection1 scope
Updates a specific option for a specific tracking category
Authentication
Connected account requiredScopes
accounting.settingsTags