Module xero.accounts
ballerinax/xero.accounts Ballerina library
2.0.0
Overview
Xero is a cloud-based accounting platform for small and medium-sized businesses, covering invoicing, bills, bank reconciliation, payments, payroll and financial reporting.
The Ballerina Xero Accounts connector lets you work with the Xero Accounting API from Ballerina: manage contacts, invoices, credit notes, quotes, purchase orders, bank transactions and transfers, payments and batch payments, manual journals, items, tax rates and tracking categories, and read organisation settings and financial reports.
Key features
- Create, update and track sales invoices, purchase bills, credit notes, quotes and purchase orders
- Manage contacts, contact groups, items and the chart of accounts
- Record payments, batch payments, overpayments, prepayments and allocations
- Work with bank transactions and bank transfers, including attachments and history notes
- Read organisation settings, tax rates, tracking categories and financial reports such as the balance sheet and profit and loss
Setup guide
To use the connector you need a Xero account, an app registered in the Xero developer portal, an OAuth 2.0 refresh token and the ID of the organisation (tenant) to work with.
-
Sign up for a Xero account if you do not already have one. A free demo company is enough for development, except for emailing invoices: the
emailInvoiceoperation, and the email step of the customer invoice billing example, need an organisation that Xero permits to send email. -
Sign in to the Xero developer portal and select New app. Choose the Web app integration type, enter an app name, a company or application URL, and a redirect URI such as
http://localhost:8080/callback, then create the app. -
On the app's Configuration page, copy the Client id and generate a Client secret. Keep the secret safe; it is shown only once.
-
Obtain a refresh token with the OAuth 2.0 authorization code flow. Open the authorization URL below in a browser, replacing the client ID and redirect URI with your own and requesting only the scopes your integration needs.
offline_accessis required to receive a refresh token.https://login.xero.com/identity/connect/authorize?response_type=code&client_id=<CLIENT_ID>&redirect_uri=<REDIRECT_URI>&scope=openid profile email offline_access accounting.transactions accounting.contacts accounting.settings accounting.reports.read&state=123After you approve access, Xero redirects to your redirect URI with a
codequery parameter. Exchange it for tokens:curl -X POST https://identity.xero.com/connect/token \ -u "<CLIENT_ID>:<CLIENT_SECRET>" \ -d grant_type=authorization_code \ -d code=<CODE> \ -d redirect_uri=<REDIRECT_URI>The response contains an
access_tokenand arefresh_token. -
Every Accounting API call is scoped to an organisation through the
xero-tenant-idheader. List the organisations the token can access and note thetenantIdof the one you want:curl https://api.xero.com/connections -H "Authorization: Bearer <ACCESS_TOKEN>"
Quickstart
To use the Xero Accounts connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
Import the xero.accounts module.
import ballerinax/xero.accounts;
Step 2: Instantiate a new connector
-
Create a
Config.tomlfile with the credentials from the setup guide:clientId = "<CLIENT_ID>" clientSecret = "<CLIENT_SECRET>" refreshToken = "<REFRESH_TOKEN>" refreshUrl = "https://identity.xero.com/connect/token" tenantId = "<TENANT_ID>" -
Create an
accounts:Clientthat refreshes its access token with those credentials:configurable string clientId = ?; configurable string clientSecret = ?; configurable string refreshToken = ?; configurable string refreshUrl = ?; configurable string tenantId = ?; final accounts:Client xero = check new ({ auth: {clientId, clientSecret, refreshToken, refreshUrl} });
Step 3: Invoke the connector operation
Now, utilize the available connector operations. Every operation takes the tenant ID in its headers record.
List the organisation's authorised sales invoices
public function main() returns error? { accounts:Invoices _ = check xero->getInvoices({xeroTenantId: tenantId}, statuses = ["AUTHORISED"]); }
Step 4: Run the Ballerina application
bal run
Examples
The Xero Accounts connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Customer invoice billing - Creates a customer contact, raises an approved sales invoice, optionally emails it and checks the amount due.
- Invoice payment recording - Records a payment against a sales invoice, attaches a remittance note and prints the payment's audit history.
- Supplier batch payment run - Pays all of a supplier's outstanding bills in one bank transaction with a batch payment.
- Financial reports overview - Prints the month's profit and loss, the balance sheet and the trial balance for an organisation.
Clients
xero.accounts: Client
Isolated
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.xero.com/api.xro/2.0" - URL of the target service
getAccounts
Isolated FunctionRemote Function
function getAccounts(GetAccountsHeaders headers, *GetAccountsQueries queries) returns Accounts|errorRetrieves the full chart of accounts
Parameters
- headers GetAccountsHeaders - Headers to be sent with the request
- queries *GetAccountsQueries - Queries to be sent with the request
createAccount
Isolated FunctionRemote Function
function createAccount(CreateAccountHeaders headers, Account payload) returns Accounts|errorCreates a new chart of accounts
Parameters
- headers CreateAccountHeaders - Headers to be sent with the request
- payload Account - Account object in body of request
Return Type
getAccount
Isolated FunctionRemote Function
function getAccount(string accountID, GetAccountHeaders headers) returns Accounts|errorRetrieves a single chart of accounts by using a unique account Id
Parameters
- accountID string - Unique identifier for Account object
- headers GetAccountHeaders - Headers to be sent with the request
updateAccount
Isolated FunctionRemote Function
function updateAccount(string accountID, UpdateAccountHeaders headers, Accounts payload) returns Accounts|errorUpdates a chart of accounts
Parameters
- accountID string - Unique identifier for Account object
- headers UpdateAccountHeaders - Headers to be sent with the request
- payload Accounts - Request of type Accounts array with one Account
Return Type
deleteAccount
Isolated FunctionRemote Function
function deleteAccount(string accountID, DeleteAccountHeaders headers) returns Accounts|errorDeletes a chart of accounts
Parameters
- accountID string - Unique identifier for Account object
- headers DeleteAccountHeaders - Headers to be sent with the request
Return Type
getAccountAttachments
Isolated FunctionRemote Function
function getAccountAttachments(string accountID, GetAccountAttachmentsHeaders headers) returns Attachments|errorRetrieves attachments for a specific accounts by using a unique account Id
Parameters
- accountID string - Unique identifier for Account object
- headers GetAccountAttachmentsHeaders - Headers to be sent with the request
Return Type
- Attachments|error - Success - return response of type Attachments array of Attachment
getAccountAttachmentById
Isolated FunctionRemote Function
function getAccountAttachmentById(string accountID, string attachmentID, GetAccountAttachmentByIdHeaders headers) returns byte[]|errorRetrieves a specific attachment from a specific account using a unique attachment Id
Parameters
- accountID string - Unique identifier for Account object
- attachmentID string - Unique identifier for Attachment object
- headers GetAccountAttachmentByIdHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Account as binary data
getAccountAttachmentByFileName
Isolated FunctionRemote Function
function getAccountAttachmentByFileName(string accountID, string fileName, GetAccountAttachmentByFileNameHeaders headers) returns byte[]|errorRetrieves an attachment for a specific account by filename
Parameters
- accountID string - Unique identifier for Account object
- fileName string - Name of the attachment
- headers GetAccountAttachmentByFileNameHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Account as binary data
createAccountAttachmentByFileName
Isolated FunctionRemote Function
function createAccountAttachmentByFileName(string accountID, string fileName, CreateAccountAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorCreates an attachment on a specific account
Parameters
- accountID string - Unique identifier for Account object
- fileName string - Name of the attachment
- headers CreateAccountAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array of Attachment
updateAccountAttachmentByFileName
Isolated FunctionRemote Function
function updateAccountAttachmentByFileName(string accountID, string fileName, UpdateAccountAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorUpdates attachment on a specific account by filename
Parameters
- accountID string - Unique identifier for Account object
- fileName string - Name of the attachment
- headers UpdateAccountAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array of Attachment
getBatchPayments
Isolated FunctionRemote Function
function getBatchPayments(GetBatchPaymentsHeaders headers, *GetBatchPaymentsQueries queries) returns BatchPayments|errorRetrieves either one or many batch payments for invoices
Parameters
- headers GetBatchPaymentsHeaders - Headers to be sent with the request
- queries *GetBatchPaymentsQueries - Queries to be sent with the request
Return Type
- BatchPayments|error - Success - return response of type BatchPayments array of BatchPayment objects
createBatchPayment
Isolated FunctionRemote Function
function createBatchPayment(CreateBatchPaymentHeaders headers, BatchPayments payload, *CreateBatchPaymentQueries queries) returns BatchPayments|errorCreates one or many batch payments for invoices
Parameters
- headers CreateBatchPaymentHeaders - Headers to be sent with the request
- payload BatchPayments - BatchPayments with an array of Payments in body of request
- queries *CreateBatchPaymentQueries - Queries to be sent with the request
Return Type
- BatchPayments|error - Success - return response of type BatchPayments array of BatchPayment objects
deleteBatchPayment
Isolated FunctionRemote Function
function deleteBatchPayment(DeleteBatchPaymentHeaders headers, BatchPaymentDelete payload) returns BatchPayments|errorDeletes one or more batch payments by setting their status to DELETED
Parameters
- headers DeleteBatchPaymentHeaders - Headers to be sent with the request
- payload BatchPaymentDelete - Batch payments to delete, each identified by ID with status set to DELETED
Return Type
- BatchPayments|error - Success - return response of type BatchPayments array for updated BatchPayment
getBatchPayment
Isolated FunctionRemote Function
function getBatchPayment(string batchPaymentID, GetBatchPaymentHeaders headers) returns BatchPayments|errorRetrieves a specific batch payment using a unique batch payment Id
Parameters
- batchPaymentID string - Unique identifier for BatchPayment
- headers GetBatchPaymentHeaders - Headers to be sent with the request
Return Type
- BatchPayments|error - Success - return response of type BatchPayments array with matching batch payment Id
deleteBatchPaymentByUrlParam
Isolated FunctionRemote Function
function deleteBatchPaymentByUrlParam(string batchPaymentID, DeleteBatchPaymentByUrlParamHeaders headers, BatchPaymentDeleteByUrlParam payload) returns BatchPayments|errorDeletes a specific batch payment by setting its status to DELETED
Parameters
- batchPaymentID string - Unique identifier for BatchPayment
- headers DeleteBatchPaymentByUrlParamHeaders - Headers to be sent with the request
- payload BatchPaymentDeleteByUrlParam - Status update that deletes the batch payment identified in the path
Return Type
- BatchPayments|error - Success - return response of type BatchPayments array for updated BatchPayment
getBatchPaymentHistory
Isolated FunctionRemote Function
function getBatchPaymentHistory(string batchPaymentID, GetBatchPaymentHistoryHeaders headers) returns HistoryRecords|errorRetrieves history from a specific batch payment
Parameters
- batchPaymentID string - Unique identifier for BatchPayment
- headers GetBatchPaymentHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createBatchPaymentHistoryRecord
Isolated FunctionRemote Function
function createBatchPaymentHistoryRecord(string batchPaymentID, CreateBatchPaymentHistoryRecordHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific batch payment
Parameters
- batchPaymentID string - Unique identifier for BatchPayment
- headers CreateBatchPaymentHistoryRecordHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getBankTransactions
Isolated FunctionRemote Function
function getBankTransactions(GetBankTransactionsHeaders headers, *GetBankTransactionsQueries queries) returns BankTransactions|errorRetrieves any spent or received money transactions
Parameters
- headers GetBankTransactionsHeaders - Headers to be sent with the request
- queries *GetBankTransactionsQueries - Queries to be sent with the request
Return Type
- BankTransactions|error - Success - return response of type BankTransactions array with 0 to n BankTransaction
createBankTransactions
Isolated FunctionRemote Function
function createBankTransactions(CreateBankTransactionsHeaders headers, BankTransactions payload, *CreateBankTransactionsQueries queries) returns BankTransactions|errorCreates one or more spent or received money transaction
Parameters
- headers CreateBankTransactionsHeaders - Headers to be sent with the request
- payload BankTransactions - BankTransactions with an array of BankTransaction objects in body of request
- queries *CreateBankTransactionsQueries - Queries to be sent with the request
Return Type
- BankTransactions|error - Success - return response of type BankTransactions array with new BankTransaction
updateOrCreateBankTransactions
Isolated FunctionRemote Function
function updateOrCreateBankTransactions(UpdateOrCreateBankTransactionsHeaders headers, BankTransactions payload, *UpdateOrCreateBankTransactionsQueries queries) returns BankTransactions|errorUpdates or creates one or more spent or received money transaction
Parameters
- headers UpdateOrCreateBankTransactionsHeaders - Headers to be sent with the request
- payload BankTransactions - Bank transactions to create or update
- queries *UpdateOrCreateBankTransactionsQueries - Queries to be sent with the request
Return Type
- BankTransactions|error - Success - return response of type BankTransactions array with new BankTransaction
getBankTransaction
Isolated FunctionRemote Function
function getBankTransaction(string bankTransactionID, GetBankTransactionHeaders headers, *GetBankTransactionQueries queries) returns BankTransactions|errorRetrieves a single spent or received money transaction by using a unique bank transaction Id
Parameters
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- headers GetBankTransactionHeaders - Headers to be sent with the request
- queries *GetBankTransactionQueries - Queries to be sent with the request
Return Type
- BankTransactions|error - Success - return response of type BankTransactions array with a specific BankTransaction
updateBankTransaction
Isolated FunctionRemote Function
function updateBankTransaction(string bankTransactionID, UpdateBankTransactionHeaders headers, BankTransactions payload, *UpdateBankTransactionQueries queries) returns BankTransactions|errorUpdates a single spent or received money transaction
Parameters
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- headers UpdateBankTransactionHeaders - Headers to be sent with the request
- payload BankTransactions - Bank transaction with the fields to update
- queries *UpdateBankTransactionQueries - Queries to be sent with the request
Return Type
- BankTransactions|error - Success - return response of type BankTransactions array with updated BankTransaction
getBankTransactionAttachments
Isolated FunctionRemote Function
function getBankTransactionAttachments(string bankTransactionID, GetBankTransactionAttachmentsHeaders headers) returns Attachments|errorRetrieves any attachments from a specific bank transactions
Parameters
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- headers GetBankTransactionAttachmentsHeaders - Headers to be sent with the request
Return Type
- Attachments|error - Success - return response of type Attachments array with 0 to n Attachment
getBankTransactionAttachmentById
Isolated FunctionRemote Function
function getBankTransactionAttachmentById(string bankTransactionID, string attachmentID, GetBankTransactionAttachmentByIdHeaders headers) returns byte[]|errorRetrieves specific attachments from a specific BankTransaction using a unique attachment Id
Parameters
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- attachmentID string - Unique identifier for Attachment object
- headers GetBankTransactionAttachmentByIdHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for BankTransaction as binary data
getBankTransactionAttachmentByFileName
Isolated FunctionRemote Function
function getBankTransactionAttachmentByFileName(string bankTransactionID, string fileName, GetBankTransactionAttachmentByFileNameHeaders headers) returns byte[]|errorRetrieves a specific attachment from a specific bank transaction by filename
Parameters
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- fileName string - Name of the attachment
- headers GetBankTransactionAttachmentByFileNameHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for BankTransaction as binary data
createBankTransactionAttachmentByFileName
Isolated FunctionRemote Function
function createBankTransactionAttachmentByFileName(string bankTransactionID, string fileName, CreateBankTransactionAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorCreates an attachment for a specific bank transaction by filename
Parameters
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- fileName string - Name of the attachment
- headers CreateBankTransactionAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of Attachments array of Attachment
updateBankTransactionAttachmentByFileName
Isolated FunctionRemote Function
function updateBankTransactionAttachmentByFileName(string bankTransactionID, string fileName, UpdateBankTransactionAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorUpdates a specific attachment from a specific bank transaction by filename
Parameters
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- fileName string - Name of the attachment
- headers UpdateBankTransactionAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of Attachments array of Attachment
getBankTransactionsHistory
Isolated FunctionRemote Function
function getBankTransactionsHistory(string bankTransactionID, GetBankTransactionsHistoryHeaders headers) returns HistoryRecords|errorRetrieves history from a specific bank transaction using a unique bank transaction Id
Parameters
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- headers GetBankTransactionsHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createBankTransactionHistoryRecord
Isolated FunctionRemote Function
function createBankTransactionHistoryRecord(string bankTransactionID, CreateBankTransactionHistoryRecordHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific bank transactions
Parameters
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- headers CreateBankTransactionHistoryRecordHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getBankTransfers
Isolated FunctionRemote Function
function getBankTransfers(GetBankTransfersHeaders headers, *GetBankTransfersQueries queries) returns BankTransfers|errorRetrieves all bank transfers
Parameters
- headers GetBankTransfersHeaders - Headers to be sent with the request
- queries *GetBankTransfersQueries - Queries to be sent with the request
Return Type
- BankTransfers|error - Success - return response of BankTransfers array of 0 to N BankTransfer
createBankTransfer
Isolated FunctionRemote Function
function createBankTransfer(CreateBankTransferHeaders headers, BankTransfers payload) returns BankTransfers|errorCreates a bank transfer
Parameters
- headers CreateBankTransferHeaders - Headers to be sent with the request
- payload BankTransfers - BankTransfers with array of BankTransfer objects in request body
Return Type
- BankTransfers|error - Success - return response of BankTransfers array of one BankTransfer
deleteBankTransfers
Isolated FunctionRemote Function
function deleteBankTransfers(DeleteBankTransfersHeaders headers, BankTransfersDelete payload, *DeleteBankTransfersQueries queries) returns BankTransfers|errorDeletes one or more bank transfers
Parameters
- headers DeleteBankTransfersHeaders - Headers to be sent with the request
- payload BankTransfersDelete - BankTransfers with array of BankTransfer objects in request body
- queries *DeleteBankTransfersQueries - Queries to be sent with the request
Return Type
- BankTransfers|error - Success - return response of BankTransfers array of deleted BankTransfer
getBankTransfer
Isolated FunctionRemote Function
function getBankTransfer(string bankTransferID, GetBankTransferHeaders headers) returns BankTransfers|errorRetrieves specific bank transfers by using a unique bank transfer Id
Parameters
- bankTransferID string - Xero generated unique identifier for a bank transfer
- headers GetBankTransferHeaders - Headers to be sent with the request
Return Type
- BankTransfers|error - Success - return response of BankTransfers array with one BankTransfer
deleteBankTransfer
Isolated FunctionRemote Function
function deleteBankTransfer(string bankTransferID, DeleteBankTransferHeaders headers, BankTransferDeleteByUrlParam payload) returns BankTransfers|errorDeletes a specific bank transfer
Parameters
- bankTransferID string - Xero generated unique identifier for a bank transfer
- headers DeleteBankTransferHeaders - Headers to be sent with the request
- payload BankTransferDeleteByUrlParam - Status update that deletes the bank transfer identified in the path
Return Type
- BankTransfers|error - Success - return response of BankTransfers array with one deleted BankTransfer
getBankTransferAttachments
Isolated FunctionRemote Function
function getBankTransferAttachments(string bankTransferID, GetBankTransferAttachmentsHeaders headers) returns Attachments|errorRetrieves attachments from a specific bank transfer
Parameters
- bankTransferID string - Xero generated unique identifier for a bank transfer
- headers GetBankTransferAttachmentsHeaders - Headers to be sent with the request
Return Type
- Attachments|error - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
getBankTransferAttachmentById
Isolated FunctionRemote Function
function getBankTransferAttachmentById(string bankTransferID, string attachmentID, GetBankTransferAttachmentByIdHeaders headers) returns byte[]|errorRetrieves a specific attachment from a specific bank transfer using a unique attachment ID
Parameters
- bankTransferID string - Xero generated unique identifier for a bank transfer
- attachmentID string - Unique identifier for Attachment object
- headers GetBankTransferAttachmentByIdHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of binary data from the Attachment to a Bank Transfer
getBankTransferAttachmentByFileName
Isolated FunctionRemote Function
function getBankTransferAttachmentByFileName(string bankTransferID, string fileName, GetBankTransferAttachmentByFileNameHeaders headers) returns byte[]|errorRetrieves a specific attachment on a specific bank transfer by file name
Parameters
- bankTransferID string - Xero generated unique identifier for a bank transfer
- fileName string - Name of the attachment
- headers GetBankTransferAttachmentByFileNameHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of binary data from the Attachment to a Bank Transfer
createBankTransferAttachmentByFileName
Isolated FunctionRemote Function
function createBankTransferAttachmentByFileName(string bankTransferID, string fileName, CreateBankTransferAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorUploads an attachment to a specific bank transfer by file name
Parameters
- bankTransferID string - Xero generated unique identifier for a bank transfer
- fileName string - Name of the attachment
- headers CreateBankTransferAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
updateBankTransferAttachmentByFileName
Isolated FunctionRemote Function
function updateBankTransferAttachmentByFileName(string bankTransferID, string fileName, UpdateBankTransferAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorUpdates an attachment on a specific bank transfer by file name
Parameters
- bankTransferID string - Xero generated unique identifier for a bank transfer
- fileName string - Name of the attachment
- headers UpdateBankTransferAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
getBankTransferHistory
Isolated FunctionRemote Function
function getBankTransferHistory(string bankTransferID, GetBankTransferHistoryHeaders headers) returns HistoryRecords|errorRetrieves history from a specific bank transfer using a unique bank transfer Id
Parameters
- bankTransferID string - Xero generated unique identifier for a bank transfer
- headers GetBankTransferHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createBankTransferHistoryRecord
Isolated FunctionRemote Function
function createBankTransferHistoryRecord(string bankTransferID, CreateBankTransferHistoryRecordHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific bank transfer
Parameters
- bankTransferID string - Xero generated unique identifier for a bank transfer
- headers CreateBankTransferHistoryRecordHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getBrandingThemes
Isolated FunctionRemote Function
function getBrandingThemes(GetBrandingThemesHeaders headers) returns BrandingThemes|errorRetrieves all the branding themes
Parameters
- headers GetBrandingThemesHeaders - Headers to be sent with the request
Return Type
- BrandingThemes|error - Success - return response of type BrandingThemes
getBrandingTheme
Isolated FunctionRemote Function
function getBrandingTheme(string brandingThemeID, GetBrandingThemeHeaders headers) returns BrandingThemes|errorRetrieves a specific branding theme using a unique branding theme Id
Parameters
- brandingThemeID string - Unique identifier for a Branding Theme
- headers GetBrandingThemeHeaders - Headers to be sent with the request
Return Type
- BrandingThemes|error - Success - return response of type BrandingThemes with one BrandingTheme
getBrandingThemePaymentServices
Isolated FunctionRemote Function
function getBrandingThemePaymentServices(string brandingThemeID, GetBrandingThemePaymentServicesHeaders headers) returns PaymentServices|errorRetrieves the payment services for a specific branding theme
Parameters
- brandingThemeID string - Unique identifier for a Branding Theme
- headers GetBrandingThemePaymentServicesHeaders - Headers to be sent with the request
Return Type
- PaymentServices|error - Success - return response of type PaymentServices array with 0 to N PaymentService
createBrandingThemePaymentServices
Isolated FunctionRemote Function
function createBrandingThemePaymentServices(string brandingThemeID, CreateBrandingThemePaymentServicesHeaders headers, PaymentServices payload) returns PaymentServices|errorCreates a new custom payment service for a specific branding theme
Parameters
- brandingThemeID string - Unique identifier for a Branding Theme
- headers CreateBrandingThemePaymentServicesHeaders - Headers to be sent with the request
- payload PaymentServices - PaymentServices array with PaymentService object in body of request
Return Type
- PaymentServices|error - Success - return response of type PaymentServices array with newly created PaymentService
getBudgets
Isolated FunctionRemote Function
function getBudgets(GetBudgetsHeaders headers, *GetBudgetsQueries queries) returns Budgets|errorRetrieve a list of budgets
Parameters
- headers GetBudgetsHeaders - Headers to be sent with the request
- queries *GetBudgetsQueries - Queries to be sent with the request
getBudget
Isolated FunctionRemote Function
function getBudget(string budgetID, GetBudgetHeaders headers, *GetBudgetQueries queries) returns Budgets|errorRetrieves a specific budget, which includes budget lines
Parameters
- budgetID string - Unique identifier for Budgets
- headers GetBudgetHeaders - Headers to be sent with the request
- queries *GetBudgetQueries - Queries to be sent with the request
getContacts
Isolated FunctionRemote Function
function getContacts(GetContactsHeaders headers, *GetContactsQueries queries) returns Contacts|errorRetrieves all contacts in a Xero organisation
Parameters
- headers GetContactsHeaders - Headers to be sent with the request
- queries *GetContactsQueries - Queries to be sent with the request
createContacts
Isolated FunctionRemote Function
function createContacts(CreateContactsHeaders headers, Contacts payload, *CreateContactsQueries queries) returns Contacts|errorCreates multiple contacts (bulk) in a Xero organisation
Parameters
- headers CreateContactsHeaders - Headers to be sent with the request
- payload Contacts - Contacts with an array of Contact objects to create in body of request
- queries *CreateContactsQueries - Queries to be sent with the request
Return Type
updateOrCreateContacts
Isolated FunctionRemote Function
function updateOrCreateContacts(UpdateOrCreateContactsHeaders headers, Contacts payload, *UpdateOrCreateContactsQueries queries) returns Contacts|errorUpdates or creates one or more contacts in a Xero organisation
Parameters
- headers UpdateOrCreateContactsHeaders - Headers to be sent with the request
- payload Contacts - Contacts to create or update
- queries *UpdateOrCreateContactsQueries - Queries to be sent with the request
Return Type
getContactByContactNumber
Isolated FunctionRemote Function
function getContactByContactNumber(string contactNumber, GetContactByContactNumberHeaders headers) returns Contacts|errorRetrieves a specific contact by contact number in a Xero organisation
Parameters
- contactNumber string - This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50)
- headers GetContactByContactNumberHeaders - Headers to be sent with the request
getContact
Isolated FunctionRemote Function
function getContact(string contactID, GetContactHeaders headers) returns Contacts|errorRetrieves a specific contacts in a Xero organisation using a unique contact Id
Parameters
- contactID string - Unique identifier for a Contact
- headers GetContactHeaders - Headers to be sent with the request
updateContact
Isolated FunctionRemote Function
function updateContact(string contactID, UpdateContactHeaders headers, Contacts payload) returns Contacts|errorUpdates a specific contact in a Xero organisation
Parameters
- contactID string - Unique identifier for a Contact
- headers UpdateContactHeaders - Headers to be sent with the request
- payload Contacts - an array of Contacts containing single Contact object with properties to update
Return Type
getContactAttachments
Isolated FunctionRemote Function
function getContactAttachments(string contactID, GetContactAttachmentsHeaders headers) returns Attachments|errorRetrieves attachments for a specific contact in a Xero organisation
Parameters
- contactID string - Unique identifier for a Contact
- headers GetContactAttachmentsHeaders - Headers to be sent with the request
Return Type
- Attachments|error - Success - return response of type Attachments array with 0 to N Attachment
getContactAttachmentById
Isolated FunctionRemote Function
function getContactAttachmentById(string contactID, string attachmentID, GetContactAttachmentByIdHeaders headers) returns byte[]|errorRetrieves a specific attachment from a specific contact using a unique attachment Id
Parameters
- contactID string - Unique identifier for a Contact
- attachmentID string - Unique identifier for Attachment object
- headers GetContactAttachmentByIdHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Contact as binary data
getContactAttachmentByFileName
Isolated FunctionRemote Function
function getContactAttachmentByFileName(string contactID, string fileName, GetContactAttachmentByFileNameHeaders headers) returns byte[]|errorRetrieves a specific attachment from a specific contact by file name
Parameters
- contactID string - Unique identifier for a Contact
- fileName string - Name of the attachment
- headers GetContactAttachmentByFileNameHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Contact as binary data
createContactAttachmentByFileName
Isolated FunctionRemote Function
function createContactAttachmentByFileName(string contactID, string fileName, CreateContactAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorUploads an attachment to a specific contact by file name
Parameters
- contactID string - Unique identifier for a Contact
- fileName string - Name of the attachment
- headers CreateContactAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array with an newly created Attachment
updateContactAttachmentByFileName
Isolated FunctionRemote Function
function updateContactAttachmentByFileName(string contactID, string fileName, UpdateContactAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorUpdates an attachment on a specific contact by file name
Parameters
- contactID string - Unique identifier for a Contact
- fileName string - Name of the attachment
- headers UpdateContactAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array with an updated Attachment
getContactCISSettings
Isolated FunctionRemote Function
function getContactCISSettings(string contactID, GetContactCISSettingsHeaders headers) returns CISSettings|errorRetrieves CIS settings for a specific contact in a Xero organisation
Parameters
- contactID string - Unique identifier for a Contact
- headers GetContactCISSettingsHeaders - Headers to be sent with the request
Return Type
- CISSettings|error - Success - return response of type CISSettings for a specific Contact
getContactHistory
Isolated FunctionRemote Function
function getContactHistory(string contactID, GetContactHistoryHeaders headers) returns HistoryRecords|errorRetrieves history records for a specific contact
Parameters
- contactID string - Unique identifier for a Contact
- headers GetContactHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createContactHistory
Isolated FunctionRemote Function
function createContactHistory(string contactID, CreateContactHistoryHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a new history record for a specific contact
Parameters
- contactID string - Unique identifier for a Contact
- headers CreateContactHistoryHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getContactGroups
Isolated FunctionRemote Function
function getContactGroups(GetContactGroupsHeaders headers, *GetContactGroupsQueries queries) returns ContactGroups|errorRetrieves the contact Id and name of each contact group
Parameters
- headers GetContactGroupsHeaders - Headers to be sent with the request
- queries *GetContactGroupsQueries - Queries to be sent with the request
Return Type
- ContactGroups|error - Success - return response of type Contact Groups array of Contact Group
createContactGroup
Isolated FunctionRemote Function
function createContactGroup(CreateContactGroupHeaders headers, ContactGroups payload) returns ContactGroups|errorCreates a contact group
Parameters
- headers CreateContactGroupHeaders - Headers to be sent with the request
- payload ContactGroups - ContactGroups with an array of names in request body
Return Type
- ContactGroups|error - Success - return response of type Contact Groups array of newly created Contact Group
getContactGroup
Isolated FunctionRemote Function
function getContactGroup(string contactGroupID, GetContactGroupHeaders headers) returns ContactGroups|errorRetrieves a specific contact group by using a unique contact group Id
Parameters
- contactGroupID string - Unique identifier for a Contact Group
- headers GetContactGroupHeaders - Headers to be sent with the request
Return Type
- ContactGroups|error - Success - return response of type Contact Groups array with a specific Contact Group
updateContactGroup
Isolated FunctionRemote Function
function updateContactGroup(string contactGroupID, UpdateContactGroupHeaders headers, ContactGroups payload) returns ContactGroups|errorUpdates a specific contact group
Parameters
- contactGroupID string - Unique identifier for a Contact Group
- headers UpdateContactGroupHeaders - Headers to be sent with the request
- payload ContactGroups - an array of Contact groups with Name of specific group to update
Return Type
- ContactGroups|error - Success - return response of type Contact Groups array of updated Contact Group
createContactGroupContacts
Isolated FunctionRemote Function
function createContactGroupContacts(string contactGroupID, CreateContactGroupContactsHeaders headers, Contacts payload) returns Contacts|errorCreates contacts to a specific contact group
Parameters
- contactGroupID string - Unique identifier for a Contact Group
- headers CreateContactGroupContactsHeaders - Headers to be sent with the request
- payload Contacts - Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request
deleteContactGroupContacts
Isolated FunctionRemote Function
function deleteContactGroupContacts(string contactGroupID, DeleteContactGroupContactsHeaders headers) returns error?Deletes all contacts from a specific contact group
Parameters
- contactGroupID string - Unique identifier for a Contact Group
- headers DeleteContactGroupContactsHeaders - Headers to be sent with the request
Return Type
- error? - Success - return response 204 no content
deleteContactGroupContact
Isolated FunctionRemote Function
function deleteContactGroupContact(string contactGroupID, string contactID, DeleteContactGroupContactHeaders headers) returns error?Deletes a specific contact from a contact group using a unique contact Id
Parameters
- contactGroupID string - Unique identifier for a Contact Group
- contactID string - Unique identifier for a Contact
- headers DeleteContactGroupContactHeaders - Headers to be sent with the request
Return Type
- error? - Success - return response 204 no content
getCreditNotes
Isolated FunctionRemote Function
function getCreditNotes(GetCreditNotesHeaders headers, *GetCreditNotesQueries queries) returns CreditNotes|errorRetrieves any credit notes
Parameters
- headers GetCreditNotesHeaders - Headers to be sent with the request
- queries *GetCreditNotesQueries - Queries to be sent with the request
Return Type
- CreditNotes|error - Success - return response of type Credit Notes array of CreditNote
createCreditNotes
Isolated FunctionRemote Function
function createCreditNotes(CreateCreditNotesHeaders headers, CreditNotes payload, *CreateCreditNotesQueries queries) returns CreditNotes|errorCreates a new credit note
Parameters
- headers CreateCreditNotesHeaders - Headers to be sent with the request
- payload CreditNotes - Credit Notes with array of CreditNote object in body of request
- queries *CreateCreditNotesQueries - Queries to be sent with the request
Return Type
- CreditNotes|error - Success - return response of type Credit Notes array of newly created CreditNote
updateOrCreateCreditNotes
Isolated FunctionRemote Function
function updateOrCreateCreditNotes(UpdateOrCreateCreditNotesHeaders headers, CreditNotes payload, *UpdateOrCreateCreditNotesQueries queries) returns CreditNotes|errorUpdates or creates one or more credit notes
Parameters
- headers UpdateOrCreateCreditNotesHeaders - Headers to be sent with the request
- payload CreditNotes - an array of Credit Notes with a single CreditNote object
- queries *UpdateOrCreateCreditNotesQueries - Queries to be sent with the request
Return Type
- CreditNotes|error - Success - return response of type Credit Notes array of newly created CreditNote
getCreditNote
Isolated FunctionRemote Function
function getCreditNote(string creditNoteID, GetCreditNoteHeaders headers, *GetCreditNoteQueries queries) returns CreditNotes|errorRetrieves a specific credit note using a unique credit note Id
Parameters
- creditNoteID string - Unique identifier for a Credit Note
- headers GetCreditNoteHeaders - Headers to be sent with the request
- queries *GetCreditNoteQueries - Queries to be sent with the request
Return Type
- CreditNotes|error - Success - return response of type Credit Notes array with a unique CreditNote
updateCreditNote
Isolated FunctionRemote Function
function updateCreditNote(string creditNoteID, UpdateCreditNoteHeaders headers, CreditNotes payload, *UpdateCreditNoteQueries queries) returns CreditNotes|errorUpdates a specific credit note
Parameters
- creditNoteID string - Unique identifier for a Credit Note
- headers UpdateCreditNoteHeaders - Headers to be sent with the request
- payload CreditNotes - an array of Credit Notes containing credit note details to update
- queries *UpdateCreditNoteQueries - Queries to be sent with the request
Return Type
- CreditNotes|error - Success - return response of type Credit Notes array with updated CreditNote
getCreditNoteAttachments
Isolated FunctionRemote Function
function getCreditNoteAttachments(string creditNoteID, GetCreditNoteAttachmentsHeaders headers) returns Attachments|errorRetrieves attachments for a specific credit notes
Parameters
- creditNoteID string - Unique identifier for a Credit Note
- headers GetCreditNoteAttachmentsHeaders - Headers to be sent with the request
Return Type
- Attachments|error - Success - return response of type Attachments array with all Attachment for specific Credit Note
getCreditNoteAttachmentById
Isolated FunctionRemote Function
function getCreditNoteAttachmentById(string creditNoteID, string attachmentID, GetCreditNoteAttachmentByIdHeaders headers) returns byte[]|errorRetrieves a specific attachment from a specific credit note using a unique attachment Id
Parameters
- creditNoteID string - Unique identifier for a Credit Note
- attachmentID string - Unique identifier for Attachment object
- headers GetCreditNoteAttachmentByIdHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Credit Note as binary data
getCreditNoteAttachmentByFileName
Isolated FunctionRemote Function
function getCreditNoteAttachmentByFileName(string creditNoteID, string fileName, GetCreditNoteAttachmentByFileNameHeaders headers) returns byte[]|errorRetrieves a specific attachment on a specific credit note by file name
Parameters
- creditNoteID string - Unique identifier for a Credit Note
- fileName string - Name of the attachment
- headers GetCreditNoteAttachmentByFileNameHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Credit Note as binary data
createCreditNoteAttachmentByFileName
Isolated FunctionRemote Function
function createCreditNoteAttachmentByFileName(string creditNoteID, string fileName, CreateCreditNoteAttachmentByFileNameHeaders headers, byte[] payload, *CreateCreditNoteAttachmentByFileNameQueries queries) returns Attachments|errorCreates an attachment for a specific credit note
Parameters
- creditNoteID string - Unique identifier for a Credit Note
- fileName string - Name of the attachment
- headers CreateCreditNoteAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
- queries *CreateCreditNoteAttachmentByFileNameQueries - Queries to be sent with the request
Return Type
- Attachments|error - Success - return response of type Attachments array with newly created Attachment for specific Credit Note
updateCreditNoteAttachmentByFileName
Isolated FunctionRemote Function
function updateCreditNoteAttachmentByFileName(string creditNoteID, string fileName, UpdateCreditNoteAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorUpdates attachments on a specific credit note by file name
Parameters
- creditNoteID string - Unique identifier for a Credit Note
- fileName string - Name of the attachment
- headers UpdateCreditNoteAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array with updated Attachment for specific Credit Note
getCreditNoteAsPdf
Isolated FunctionRemote Function
function getCreditNoteAsPdf(string creditNoteID, GetCreditNoteAsPdfHeaders headers) returns Response|errorRetrieves credit notes as PDF files
Parameters
- creditNoteID string - Unique identifier for a Credit Note
- headers GetCreditNoteAsPdfHeaders - Headers to be sent with the request
Return Type
createCreditNoteAllocation
Isolated FunctionRemote Function
function createCreditNoteAllocation(string creditNoteID, CreateCreditNoteAllocationHeaders headers, Allocations payload, *CreateCreditNoteAllocationQueries queries) returns Allocations|errorCreates allocation for a specific credit note
Parameters
- creditNoteID string - Unique identifier for a Credit Note
- headers CreateCreditNoteAllocationHeaders - Headers to be sent with the request
- payload Allocations - Allocations with array of Allocation object in body of request
- queries *CreateCreditNoteAllocationQueries - Queries to be sent with the request
Return Type
- Allocations|error - Success - return response of type Allocations array with newly created Allocation for specific Credit Note
deleteCreditNoteAllocations
Isolated FunctionRemote Function
function deleteCreditNoteAllocations(string creditNoteID, string allocationID, DeleteCreditNoteAllocationsHeaders headers) returns Allocation|errorDeletes an Allocation from a Credit Note
Parameters
- creditNoteID string - Unique identifier for a Credit Note
- allocationID string - Unique identifier for Allocation object
- headers DeleteCreditNoteAllocationsHeaders - Headers to be sent with the request
Return Type
- Allocation|error - Success - return response of type Allocation with the isDeleted flag as true
getCreditNoteHistory
Isolated FunctionRemote Function
function getCreditNoteHistory(string creditNoteID, GetCreditNoteHistoryHeaders headers) returns HistoryRecords|errorRetrieves history records of a specific credit note
Parameters
- creditNoteID string - Unique identifier for a Credit Note
- headers GetCreditNoteHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createCreditNoteHistory
Isolated FunctionRemote Function
function createCreditNoteHistory(string creditNoteID, CreateCreditNoteHistoryHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific credit note
Parameters
- creditNoteID string - Unique identifier for a Credit Note
- headers CreateCreditNoteHistoryHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getCurrencies
Isolated FunctionRemote Function
function getCurrencies(GetCurrenciesHeaders headers, *GetCurrenciesQueries queries) returns Currencies|errorRetrieves currencies for your Xero organisation
Parameters
- headers GetCurrenciesHeaders - Headers to be sent with the request
- queries *GetCurrenciesQueries - Queries to be sent with the request
Return Type
- Currencies|error - Success - return response of type Currencies array with all Currencies
createCurrency
Isolated FunctionRemote Function
function createCurrency(CreateCurrencyHeaders headers, Currency payload) returns Currencies|errorCreate a new currency for a Xero organisation
Parameters
- headers CreateCurrencyHeaders - Headers to be sent with the request
- payload Currency - Currency object in the body of request
Return Type
- Currencies|error - Unsupported - return response incorrect exception, API is not able to create new Currency
getExpenseClaims
Isolated FunctionRemote Function
function getExpenseClaims(GetExpenseClaimsHeaders headers, *GetExpenseClaimsQueries queries) returns ExpenseClaims|errorRetrieves expense claims
Parameters
- headers GetExpenseClaimsHeaders - Headers to be sent with the request
- queries *GetExpenseClaimsQueries - Queries to be sent with the request
Return Type
- ExpenseClaims|error - Success - return response of type ExpenseClaims array with all ExpenseClaims
createExpenseClaims
Isolated FunctionRemote Function
function createExpenseClaims(CreateExpenseClaimsHeaders headers, ExpenseClaims payload) returns ExpenseClaims|errorCreates expense claims
Parameters
- headers CreateExpenseClaimsHeaders - Headers to be sent with the request
- payload ExpenseClaims - ExpenseClaims with array of ExpenseClaim object in body of request
Return Type
- ExpenseClaims|error - Success - return response of type ExpenseClaims array with newly created ExpenseClaim
getExpenseClaim
Isolated FunctionRemote Function
function getExpenseClaim(string expenseClaimID, GetExpenseClaimHeaders headers) returns ExpenseClaims|errorRetrieves a specific expense claim using a unique expense claim Id
Parameters
- expenseClaimID string - Unique identifier for a ExpenseClaim
- headers GetExpenseClaimHeaders - Headers to be sent with the request
Return Type
- ExpenseClaims|error - Success - return response of type ExpenseClaims array with specified ExpenseClaim
updateExpenseClaim
Isolated FunctionRemote Function
function updateExpenseClaim(string expenseClaimID, UpdateExpenseClaimHeaders headers, ExpenseClaims payload) returns ExpenseClaims|errorUpdates a specific expense claims
Parameters
- expenseClaimID string - Unique identifier for a ExpenseClaim
- headers UpdateExpenseClaimHeaders - Headers to be sent with the request
- payload ExpenseClaims - Expense claim with the fields to update
Return Type
- ExpenseClaims|error - Success - return response of type ExpenseClaims array with updated ExpenseClaim
getExpenseClaimHistory
Isolated FunctionRemote Function
function getExpenseClaimHistory(string expenseClaimID, GetExpenseClaimHistoryHeaders headers) returns HistoryRecords|errorRetrieves history records of a specific expense claim
Parameters
- expenseClaimID string - Unique identifier for a ExpenseClaim
- headers GetExpenseClaimHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createExpenseClaimHistory
Isolated FunctionRemote Function
function createExpenseClaimHistory(string expenseClaimID, CreateExpenseClaimHistoryHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific expense claim
Parameters
- expenseClaimID string - Unique identifier for a ExpenseClaim
- headers CreateExpenseClaimHistoryHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getInvoices
Isolated FunctionRemote Function
function getInvoices(GetInvoicesHeaders headers, *GetInvoicesQueries queries) returns Invoices|errorRetrieves sales invoices or purchase bills
Parameters
- headers GetInvoicesHeaders - Headers to be sent with the request
- queries *GetInvoicesQueries - Queries to be sent with the request
createInvoices
Isolated FunctionRemote Function
function createInvoices(CreateInvoicesHeaders headers, Invoices payload, *CreateInvoicesQueries queries) returns Invoices|errorCreates one or more sales invoices or purchase bills
Parameters
- headers CreateInvoicesHeaders - Headers to be sent with the request
- payload Invoices - Invoices with an array of invoice objects in body of request
- queries *CreateInvoicesQueries - Queries to be sent with the request
Return Type
updateOrCreateInvoices
Isolated FunctionRemote Function
function updateOrCreateInvoices(UpdateOrCreateInvoicesHeaders headers, Invoices payload, *UpdateOrCreateInvoicesQueries queries) returns Invoices|errorUpdates or creates one or more sales invoices or purchase bills
Parameters
- headers UpdateOrCreateInvoicesHeaders - Headers to be sent with the request
- payload Invoices - Sales invoices or purchase bills to create or update
- queries *UpdateOrCreateInvoicesQueries - Queries to be sent with the request
Return Type
getInvoice
Isolated FunctionRemote Function
function getInvoice(string invoiceID, GetInvoiceHeaders headers, *GetInvoiceQueries queries) returns Invoices|errorRetrieves a specific sales invoice or purchase bill using a unique invoice Id
Parameters
- invoiceID string - Unique identifier for an Invoice
- headers GetInvoiceHeaders - Headers to be sent with the request
- queries *GetInvoiceQueries - Queries to be sent with the request
Return Type
updateInvoice
Isolated FunctionRemote Function
function updateInvoice(string invoiceID, UpdateInvoiceHeaders headers, Invoices payload, *UpdateInvoiceQueries queries) returns Invoices|errorUpdates a specific sales invoices or purchase bills
Parameters
- invoiceID string - Unique identifier for an Invoice
- headers UpdateInvoiceHeaders - Headers to be sent with the request
- payload Invoices - Invoice with the fields to update
- queries *UpdateInvoiceQueries - Queries to be sent with the request
getInvoiceAsPdf
Isolated FunctionRemote Function
function getInvoiceAsPdf(string invoiceID, GetInvoiceAsPdfHeaders headers) returns Response|errorRetrieves invoices or purchase bills as PDF files
Parameters
- invoiceID string - Unique identifier for an Invoice
- headers GetInvoiceAsPdfHeaders - Headers to be sent with the request
Return Type
getInvoiceAttachments
Isolated FunctionRemote Function
function getInvoiceAttachments(string invoiceID, GetInvoiceAttachmentsHeaders headers) returns Attachments|errorRetrieves attachments for a specific invoice or purchase bill
Parameters
- invoiceID string - Unique identifier for an Invoice
- headers GetInvoiceAttachmentsHeaders - Headers to be sent with the request
Return Type
- Attachments|error - Success - return response of type Attachments array of Attachments for specified Invoices
getInvoiceAttachmentById
Isolated FunctionRemote Function
function getInvoiceAttachmentById(string invoiceID, string attachmentID, GetInvoiceAttachmentByIdHeaders headers) returns byte[]|errorRetrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id
Parameters
- invoiceID string - Unique identifier for an Invoice
- attachmentID string - Unique identifier for Attachment object
- headers GetInvoiceAttachmentByIdHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Invoice as binary data
getInvoiceAttachmentByFileName
Isolated FunctionRemote Function
function getInvoiceAttachmentByFileName(string invoiceID, string fileName, GetInvoiceAttachmentByFileNameHeaders headers) returns byte[]|errorRetrieves an attachment from a specific invoice or purchase bill by filename
Parameters
- invoiceID string - Unique identifier for an Invoice
- fileName string - Name of the attachment
- headers GetInvoiceAttachmentByFileNameHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Invoice as binary data
createInvoiceAttachmentByFileName
Isolated FunctionRemote Function
function createInvoiceAttachmentByFileName(string invoiceID, string fileName, CreateInvoiceAttachmentByFileNameHeaders headers, byte[] payload, *CreateInvoiceAttachmentByFileNameQueries queries) returns Attachments|errorCreates an attachment for a specific invoice or purchase bill by filename
Parameters
- invoiceID string - Unique identifier for an Invoice
- fileName string - Name of the attachment
- headers CreateInvoiceAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
- queries *CreateInvoiceAttachmentByFileNameQueries - Queries to be sent with the request
Return Type
- Attachments|error - Success - return response of type Attachments array with newly created Attachment
updateInvoiceAttachmentByFileName
Isolated FunctionRemote Function
function updateInvoiceAttachmentByFileName(string invoiceID, string fileName, UpdateInvoiceAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorUpdates an attachment from a specific invoices or purchase bill by filename
Parameters
- invoiceID string - Unique identifier for an Invoice
- fileName string - Name of the attachment
- headers UpdateInvoiceAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array with updated Attachment
getOnlineInvoice
Isolated FunctionRemote Function
function getOnlineInvoice(string invoiceID, GetOnlineInvoiceHeaders headers) returns OnlineInvoices|errorRetrieves a URL to an online invoice
Parameters
- invoiceID string - Unique identifier for an Invoice
- headers GetOnlineInvoiceHeaders - Headers to be sent with the request
Return Type
- OnlineInvoices|error - Success - return response of type OnlineInvoice array with one OnlineInvoice
emailInvoice
Isolated FunctionRemote Function
function emailInvoice(string invoiceID, EmailInvoiceHeaders headers, RequestEmpty payload) returns error?Sends a copy of a specific invoice to related contact via email
Parameters
- invoiceID string - Unique identifier for an Invoice
- headers EmailInvoiceHeaders - Headers to be sent with the request
- payload RequestEmpty - Empty request body that triggers the invoice email
Return Type
- error? - Success - return response 204 no content
getInvoiceHistory
Isolated FunctionRemote Function
function getInvoiceHistory(string invoiceID, GetInvoiceHistoryHeaders headers) returns HistoryRecords|errorRetrieves history records for a specific invoice
Parameters
- invoiceID string - Unique identifier for an Invoice
- headers GetInvoiceHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createInvoiceHistory
Isolated FunctionRemote Function
function createInvoiceHistory(string invoiceID, CreateInvoiceHistoryHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific invoice
Parameters
- invoiceID string - Unique identifier for an Invoice
- headers CreateInvoiceHistoryHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getInvoiceReminders
Isolated FunctionRemote Function
function getInvoiceReminders(GetInvoiceRemindersHeaders headers) returns InvoiceReminders|errorRetrieves invoice reminder settings
Parameters
- headers GetInvoiceRemindersHeaders - Headers to be sent with the request
Return Type
- InvoiceReminders|error - Success - return response of Invoice Reminders
getItems
Isolated FunctionRemote Function
function getItems(GetItemsHeaders headers, *GetItemsQueries queries) returns Items|errorRetrieves items
Parameters
- headers GetItemsHeaders - Headers to be sent with the request
- queries *GetItemsQueries - Queries to be sent with the request
createItems
Isolated FunctionRemote Function
function createItems(CreateItemsHeaders headers, Items payload, *CreateItemsQueries queries) returns Items|errorCreates one or more items
Parameters
- headers CreateItemsHeaders - Headers to be sent with the request
- payload Items - Items with an array of Item objects in body of request
- queries *CreateItemsQueries - Queries to be sent with the request
updateOrCreateItems
Isolated FunctionRemote Function
function updateOrCreateItems(UpdateOrCreateItemsHeaders headers, Items payload, *UpdateOrCreateItemsQueries queries) returns Items|errorUpdates or creates one or more items
Parameters
- headers UpdateOrCreateItemsHeaders - Headers to be sent with the request
- payload Items - Items to create or update
- queries *UpdateOrCreateItemsQueries - Queries to be sent with the request
getItem
Isolated FunctionRemote Function
function getItem(string itemID, GetItemHeaders headers, *GetItemQueries queries) returns Items|errorRetrieves a specific item using a unique item Id
Parameters
- itemID string - Unique identifier for an Item
- headers GetItemHeaders - Headers to be sent with the request
- queries *GetItemQueries - Queries to be sent with the request
updateItem
Isolated FunctionRemote Function
function updateItem(string itemID, UpdateItemHeaders headers, Items payload, *UpdateItemQueries queries) returns Items|errorUpdates a specific item
Parameters
- itemID string - Unique identifier for an Item
- headers UpdateItemHeaders - Headers to be sent with the request
- payload Items - Item with the fields to update
- queries *UpdateItemQueries - Queries to be sent with the request
deleteItem
Isolated FunctionRemote Function
function deleteItem(string itemID, DeleteItemHeaders headers) returns error?Deletes a specific item
Parameters
- itemID string - Unique identifier for an Item
- headers DeleteItemHeaders - Headers to be sent with the request
Return Type
- error? - Success - return response 204 no content
getItemHistory
Isolated FunctionRemote Function
function getItemHistory(string itemID, GetItemHistoryHeaders headers) returns HistoryRecords|errorRetrieves history for a specific item
Parameters
- itemID string - Unique identifier for an Item
- headers GetItemHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createItemHistory
Isolated FunctionRemote Function
function createItemHistory(string itemID, CreateItemHistoryHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific item
Parameters
- itemID string - Unique identifier for an Item
- headers CreateItemHistoryHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getJournals
Isolated FunctionRemote Function
function getJournals(GetJournalsHeaders headers, *GetJournalsQueries queries) returns Journals|errorRetrieves journals
Parameters
- headers GetJournalsHeaders - Headers to be sent with the request
- queries *GetJournalsQueries - Queries to be sent with the request
getJournal
Isolated FunctionRemote Function
function getJournal(string journalID, GetJournalHeaders headers) returns Journals|errorRetrieves a specific journal using a unique journal Id.
Parameters
- journalID string - Unique identifier for a Journal
- headers GetJournalHeaders - Headers to be sent with the request
getJournalByNumber
Isolated FunctionRemote Function
function getJournalByNumber(int journalNumber, GetJournalByNumberHeaders headers) returns Journals|errorRetrieves a specific journal using a unique journal number.
Parameters
- journalNumber int - Number of a Journal
- headers GetJournalByNumberHeaders - Headers to be sent with the request
getLinkedTransactions
Isolated FunctionRemote Function
function getLinkedTransactions(GetLinkedTransactionsHeaders headers, *GetLinkedTransactionsQueries queries) returns LinkedTransactions|errorRetrieves linked transactions (billable expenses)
Parameters
- headers GetLinkedTransactionsHeaders - Headers to be sent with the request
- queries *GetLinkedTransactionsQueries - Queries to be sent with the request
Return Type
- LinkedTransactions|error - Success - return response of type LinkedTransactions array with all LinkedTransaction
createLinkedTransaction
Isolated FunctionRemote Function
function createLinkedTransaction(CreateLinkedTransactionHeaders headers, LinkedTransaction payload) returns LinkedTransactions|errorCreates linked transactions (billable expenses)
Parameters
- headers CreateLinkedTransactionHeaders - Headers to be sent with the request
- payload LinkedTransaction - LinkedTransaction object in body of request
Return Type
- LinkedTransactions|error - Success - return response of type LinkedTransactions array with newly created LinkedTransaction
getLinkedTransaction
Isolated FunctionRemote Function
function getLinkedTransaction(string linkedTransactionID, GetLinkedTransactionHeaders headers) returns LinkedTransactions|errorRetrieves a specific linked transaction (billable expenses) using a unique linked transaction Id
Parameters
- linkedTransactionID string - Unique identifier for a LinkedTransaction
- headers GetLinkedTransactionHeaders - Headers to be sent with the request
Return Type
- LinkedTransactions|error - Success - return response of type LinkedTransactions array with a specified LinkedTransaction
updateLinkedTransaction
Isolated FunctionRemote Function
function updateLinkedTransaction(string linkedTransactionID, UpdateLinkedTransactionHeaders headers, LinkedTransactions payload) returns LinkedTransactions|errorUpdates a specific linked transactions (billable expenses)
Parameters
- linkedTransactionID string - Unique identifier for a LinkedTransaction
- headers UpdateLinkedTransactionHeaders - Headers to be sent with the request
- payload LinkedTransactions - Linked transaction with the fields to update
Return Type
- LinkedTransactions|error - Success - return response of type LinkedTransactions array with updated LinkedTransaction
deleteLinkedTransaction
Isolated FunctionRemote Function
function deleteLinkedTransaction(string linkedTransactionID, DeleteLinkedTransactionHeaders headers) returns error?Deletes a specific linked transactions (billable expenses)
Parameters
- linkedTransactionID string - Unique identifier for a LinkedTransaction
- headers DeleteLinkedTransactionHeaders - Headers to be sent with the request
Return Type
- error? - Success - return response 204 no content
getManualJournals
Isolated FunctionRemote Function
function getManualJournals(GetManualJournalsHeaders headers, *GetManualJournalsQueries queries) returns ManualJournals|errorRetrieves manual journals
Parameters
- headers GetManualJournalsHeaders - Headers to be sent with the request
- queries *GetManualJournalsQueries - Queries to be sent with the request
Return Type
- ManualJournals|error - Success - return response of type ManualJournals array with a all ManualJournals
createManualJournals
Isolated FunctionRemote Function
function createManualJournals(CreateManualJournalsHeaders headers, ManualJournals payload, *CreateManualJournalsQueries queries) returns ManualJournals|errorCreates one or more manual journals
Parameters
- headers CreateManualJournalsHeaders - Headers to be sent with the request
- payload ManualJournals - ManualJournals array with ManualJournal object in body of request
- queries *CreateManualJournalsQueries - Queries to be sent with the request
Return Type
- ManualJournals|error - Success - return response of type ManualJournals array with newly created ManualJournal
updateOrCreateManualJournals
Isolated FunctionRemote Function
function updateOrCreateManualJournals(UpdateOrCreateManualJournalsHeaders headers, ManualJournals payload, *UpdateOrCreateManualJournalsQueries queries) returns ManualJournals|errorUpdates or creates a single manual journal
Parameters
- headers UpdateOrCreateManualJournalsHeaders - Headers to be sent with the request
- payload ManualJournals - ManualJournals array with ManualJournal object in body of request
- queries *UpdateOrCreateManualJournalsQueries - Queries to be sent with the request
Return Type
- ManualJournals|error - Success - return response of type ManualJournals array with newly created ManualJournal
getManualJournal
Isolated FunctionRemote Function
function getManualJournal(string manualJournalID, GetManualJournalHeaders headers) returns ManualJournals|errorRetrieves a specific manual journal
Parameters
- manualJournalID string - Unique identifier for a ManualJournal
- headers GetManualJournalHeaders - Headers to be sent with the request
Return Type
- ManualJournals|error - Success - return response of type ManualJournals array with a specified ManualJournals
updateManualJournal
Isolated FunctionRemote Function
function updateManualJournal(string manualJournalID, UpdateManualJournalHeaders headers, ManualJournals payload) returns ManualJournals|errorUpdates a specific manual journal
Parameters
- manualJournalID string - Unique identifier for a ManualJournal
- headers UpdateManualJournalHeaders - Headers to be sent with the request
- payload ManualJournals - Manual journal with the fields to update
Return Type
- ManualJournals|error - Success - return response of type ManualJournals array with an updated ManualJournal
getManualJournalAttachments
Isolated FunctionRemote Function
function getManualJournalAttachments(string manualJournalID, GetManualJournalAttachmentsHeaders headers) returns Attachments|errorRetrieves attachment for a specific manual journal
Parameters
- manualJournalID string - Unique identifier for a ManualJournal
- headers GetManualJournalAttachmentsHeaders - Headers to be sent with the request
Return Type
- Attachments|error - Success - return response of type Attachments array with all Attachments for a ManualJournals
getManualJournalAttachmentById
Isolated FunctionRemote Function
function getManualJournalAttachmentById(string manualJournalID, string attachmentID, GetManualJournalAttachmentByIdHeaders headers) returns byte[]|errorAllows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id
Parameters
- manualJournalID string - Unique identifier for a ManualJournal
- attachmentID string - Unique identifier for Attachment object
- headers GetManualJournalAttachmentByIdHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Manual Journal as binary data
getManualJournalAttachmentByFileName
Isolated FunctionRemote Function
function getManualJournalAttachmentByFileName(string manualJournalID, string fileName, GetManualJournalAttachmentByFileNameHeaders headers) returns byte[]|errorRetrieves a specific attachment from a specific manual journal by file name
Parameters
- manualJournalID string - Unique identifier for a ManualJournal
- fileName string - Name of the attachment
- headers GetManualJournalAttachmentByFileNameHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Manual Journal as binary data
createManualJournalAttachmentByFileName
Isolated FunctionRemote Function
function createManualJournalAttachmentByFileName(string manualJournalID, string fileName, CreateManualJournalAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorCreates a specific attachment for a specific manual journal by file name
Parameters
- manualJournalID string - Unique identifier for a ManualJournal
- fileName string - Name of the attachment
- headers CreateManualJournalAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array with a newly created Attachment for a ManualJournals
updateManualJournalAttachmentByFileName
Isolated FunctionRemote Function
function updateManualJournalAttachmentByFileName(string manualJournalID, string fileName, UpdateManualJournalAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorUpdates a specific attachment from a specific manual journal by file name
Parameters
- manualJournalID string - Unique identifier for a ManualJournal
- fileName string - Name of the attachment
- headers UpdateManualJournalAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array with an update Attachment for a ManualJournals
getManualJournalsHistory
Isolated FunctionRemote Function
function getManualJournalsHistory(string manualJournalID, GetManualJournalsHistoryHeaders headers) returns HistoryRecords|errorRetrieves history for a specific manual journal
Parameters
- manualJournalID string - Unique identifier for a ManualJournal
- headers GetManualJournalsHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createManualJournalHistoryRecord
Isolated FunctionRemote Function
function createManualJournalHistoryRecord(string manualJournalID, CreateManualJournalHistoryRecordHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific manual journal
Parameters
- manualJournalID string - Unique identifier for a ManualJournal
- headers CreateManualJournalHistoryRecordHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getOrganisations
Isolated FunctionRemote Function
function getOrganisations(GetOrganisationsHeaders headers) returns Organisations|errorRetrieves Xero organisation details
Parameters
- headers GetOrganisationsHeaders - Headers to be sent with the request
Return Type
- Organisations|error - Success - return response of type Organisation array with all Organisation
getOrganisationActions
Isolated FunctionRemote Function
function getOrganisationActions(GetOrganisationActionsHeaders headers) returns Actions|errorRetrieves a list of the key actions your app has permission to perform in the connected Xero organisation.
Parameters
- headers GetOrganisationActionsHeaders - Headers to be sent with the request
getOrganisationCISSettings
Isolated FunctionRemote Function
function getOrganisationCISSettings(string organisationID, GetOrganisationCISSettingsHeaders headers) returns CISOrgSettings|errorRetrieves the CIS settings for the Xero organistaion.
Parameters
- organisationID string - The unique Xero identifier for an organisation
- headers GetOrganisationCISSettingsHeaders - Headers to be sent with the request
Return Type
- CISOrgSettings|error - Success - return response of type Organisation array with specified Organisation
getOverpayments
Isolated FunctionRemote Function
function getOverpayments(GetOverpaymentsHeaders headers, *GetOverpaymentsQueries queries) returns Overpayments|errorRetrieves overpayments
Parameters
- headers GetOverpaymentsHeaders - Headers to be sent with the request
- queries *GetOverpaymentsQueries - Queries to be sent with the request
Return Type
- Overpayments|error - Success - return response of type Overpayments array with all Overpayments
getOverpayment
Isolated FunctionRemote Function
function getOverpayment(string overpaymentID, GetOverpaymentHeaders headers) returns Overpayments|errorRetrieves a specific overpayment using a unique overpayment Id
Parameters
- overpaymentID string - Unique identifier for a Overpayment
- headers GetOverpaymentHeaders - Headers to be sent with the request
Return Type
- Overpayments|error - Success - return response of type Overpayments array with specified Overpayments
createOverpaymentAllocations
Isolated FunctionRemote Function
function createOverpaymentAllocations(string overpaymentID, CreateOverpaymentAllocationsHeaders headers, Allocations payload, *CreateOverpaymentAllocationsQueries queries) returns Allocations|errorCreates a single allocation for a specific overpayment
Parameters
- overpaymentID string - Unique identifier for a Overpayment
- headers CreateOverpaymentAllocationsHeaders - Headers to be sent with the request
- payload Allocations - Allocations array with Allocation object in body of request
- queries *CreateOverpaymentAllocationsQueries - Queries to be sent with the request
Return Type
- Allocations|error - Success - return response of type Allocations array with all Allocation for Overpayments
deleteOverpaymentAllocations
Isolated FunctionRemote Function
function deleteOverpaymentAllocations(string overpaymentID, string allocationID, DeleteOverpaymentAllocationsHeaders headers) returns Allocation|errorDeletes an Allocation from an overpayment
Parameters
- overpaymentID string - Unique identifier for a Overpayment
- allocationID string - Unique identifier for Allocation object
- headers DeleteOverpaymentAllocationsHeaders - Headers to be sent with the request
Return Type
- Allocation|error - Success - return response of type Allocation with the isDeleted flag as true
getOverpaymentHistory
Isolated FunctionRemote Function
function getOverpaymentHistory(string overpaymentID, GetOverpaymentHistoryHeaders headers) returns HistoryRecords|errorRetrieves history records of a specific overpayment
Parameters
- overpaymentID string - Unique identifier for a Overpayment
- headers GetOverpaymentHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createOverpaymentHistory
Isolated FunctionRemote Function
function createOverpaymentHistory(string overpaymentID, CreateOverpaymentHistoryHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific overpayment
Parameters
- overpaymentID string - Unique identifier for a Overpayment
- headers CreateOverpaymentHistoryHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getPayments
Isolated FunctionRemote Function
function getPayments(GetPaymentsHeaders headers, *GetPaymentsQueries queries) returns Payments|errorRetrieves payments for invoices and credit notes
Parameters
- headers GetPaymentsHeaders - Headers to be sent with the request
- queries *GetPaymentsQueries - Queries to be sent with the request
createPayments
Isolated FunctionRemote Function
function createPayments(CreatePaymentsHeaders headers, Payments payload, *CreatePaymentsQueries queries) returns Payments|errorCreates multiple payments for invoices or credit notes
Parameters
- headers CreatePaymentsHeaders - Headers to be sent with the request
- payload Payments - Payments array with Payment object in body of request
- queries *CreatePaymentsQueries - Queries to be sent with the request
Return Type
createPayment
Isolated FunctionRemote Function
function createPayment(CreatePaymentHeaders headers, Payment payload) returns Payments|errorCreates a single payment for invoice or credit notes
Parameters
- headers CreatePaymentHeaders - Headers to be sent with the request
- payload Payment - Request body with a single Payment object
Return Type
getPayment
Isolated FunctionRemote Function
function getPayment(string paymentID, GetPaymentHeaders headers) returns Payments|errorRetrieves a specific payment for invoices and credit notes using a unique payment Id
Parameters
- paymentID string - Unique identifier for a Payment
- headers GetPaymentHeaders - Headers to be sent with the request
deletePayment
Isolated FunctionRemote Function
function deletePayment(string paymentID, DeletePaymentHeaders headers, PaymentDelete payload) returns Payments|errorDeletes a specific payment by setting its status to DELETED
Parameters
- paymentID string - Unique identifier for a Payment
- headers DeletePaymentHeaders - Headers to be sent with the request
- payload PaymentDelete - Status update that deletes the payment identified in the path
getPaymentHistory
Isolated FunctionRemote Function
function getPaymentHistory(string paymentID, GetPaymentHistoryHeaders headers) returns HistoryRecords|errorRetrieves history records of a specific payment
Parameters
- paymentID string - Unique identifier for a Payment
- headers GetPaymentHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createPaymentHistory
Isolated FunctionRemote Function
function createPaymentHistory(string paymentID, CreatePaymentHistoryHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific payment
Parameters
- paymentID string - Unique identifier for a Payment
- headers CreatePaymentHistoryHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getPaymentServices
Isolated FunctionRemote Function
function getPaymentServices(GetPaymentServicesHeaders headers) returns PaymentServices|errorRetrieves payment services
Parameters
- headers GetPaymentServicesHeaders - Headers to be sent with the request
Return Type
- PaymentServices|error - Success - return response of type PaymentServices array for all PaymentService
createPaymentService
Isolated FunctionRemote Function
function createPaymentService(CreatePaymentServiceHeaders headers, PaymentServices payload) returns PaymentServices|errorCreates a payment service
Parameters
- headers CreatePaymentServiceHeaders - Headers to be sent with the request
- payload PaymentServices - PaymentServices array with PaymentService object in body of request
Return Type
- PaymentServices|error - Success - return response of type PaymentServices array for newly created PaymentService
getPrepayments
Isolated FunctionRemote Function
function getPrepayments(GetPrepaymentsHeaders headers, *GetPrepaymentsQueries queries) returns Prepayments|errorRetrieves prepayments
Parameters
- headers GetPrepaymentsHeaders - Headers to be sent with the request
- queries *GetPrepaymentsQueries - Queries to be sent with the request
Return Type
- Prepayments|error - Success - return response of type Prepayments array for all Prepayment
getPrepayment
Isolated FunctionRemote Function
function getPrepayment(string prepaymentID, GetPrepaymentHeaders headers) returns Prepayments|errorAllows you to retrieve a specified prepayments
Parameters
- prepaymentID string - Unique identifier for a PrePayment
- headers GetPrepaymentHeaders - Headers to be sent with the request
Return Type
- Prepayments|error - Success - return response of type Prepayments array for a specified Prepayment
createPrepaymentAllocations
Isolated FunctionRemote Function
function createPrepaymentAllocations(string prepaymentID, CreatePrepaymentAllocationsHeaders headers, Allocations payload, *CreatePrepaymentAllocationsQueries queries) returns Allocations|errorAllows you to create an Allocation for prepayments
Parameters
- prepaymentID string - Unique identifier for a PrePayment
- headers CreatePrepaymentAllocationsHeaders - Headers to be sent with the request
- payload Allocations - Allocations with an array of Allocation object in body of request
- queries *CreatePrepaymentAllocationsQueries - Queries to be sent with the request
Return Type
- Allocations|error - Success - return response of type Allocations array of Allocation for all Prepayment
deletePrepaymentAllocations
Isolated FunctionRemote Function
function deletePrepaymentAllocations(string prepaymentID, string allocationID, DeletePrepaymentAllocationsHeaders headers) returns Allocation|errorDeletes an Allocation from a Prepayment
Parameters
- prepaymentID string - Unique identifier for a PrePayment
- allocationID string - Unique identifier for Allocation object
- headers DeletePrepaymentAllocationsHeaders - Headers to be sent with the request
Return Type
- Allocation|error - Success - return response of type Allocation with the isDeleted flag as true
getPrepaymentHistory
Isolated FunctionRemote Function
function getPrepaymentHistory(string prepaymentID, GetPrepaymentHistoryHeaders headers) returns HistoryRecords|errorRetrieves history record for a specific prepayment
Parameters
- prepaymentID string - Unique identifier for a PrePayment
- headers GetPrepaymentHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createPrepaymentHistory
Isolated FunctionRemote Function
function createPrepaymentHistory(string prepaymentID, CreatePrepaymentHistoryHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific prepayment
Parameters
- prepaymentID string - Unique identifier for a PrePayment
- headers CreatePrepaymentHistoryHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getPurchaseOrders
Isolated FunctionRemote Function
function getPurchaseOrders(GetPurchaseOrdersHeaders headers, *GetPurchaseOrdersQueries queries) returns PurchaseOrders|errorRetrieves purchase orders
Parameters
- headers GetPurchaseOrdersHeaders - Headers to be sent with the request
- queries *GetPurchaseOrdersQueries - Queries to be sent with the request
Return Type
- PurchaseOrders|error - Success - return response of type PurchaseOrder array of all PurchaseOrder
createPurchaseOrders
Isolated FunctionRemote Function
function createPurchaseOrders(CreatePurchaseOrdersHeaders headers, PurchaseOrders payload, *CreatePurchaseOrdersQueries queries) returns PurchaseOrders|errorCreates one or more purchase orders
Parameters
- headers CreatePurchaseOrdersHeaders - Headers to be sent with the request
- payload PurchaseOrders - PurchaseOrders with an array of PurchaseOrder object in body of request
- queries *CreatePurchaseOrdersQueries - Queries to be sent with the request
Return Type
- PurchaseOrders|error - Success - return response of type PurchaseOrder array for specified PurchaseOrder
updateOrCreatePurchaseOrders
Isolated FunctionRemote Function
function updateOrCreatePurchaseOrders(UpdateOrCreatePurchaseOrdersHeaders headers, PurchaseOrders payload, *UpdateOrCreatePurchaseOrdersQueries queries) returns PurchaseOrders|errorUpdates or creates one or more purchase orders
Parameters
- headers UpdateOrCreatePurchaseOrdersHeaders - Headers to be sent with the request
- payload PurchaseOrders - Purchase orders to create or update
- queries *UpdateOrCreatePurchaseOrdersQueries - Queries to be sent with the request
Return Type
- PurchaseOrders|error - Success - return response of type PurchaseOrder array for specified PurchaseOrder
getPurchaseOrderAsPdf
Isolated FunctionRemote Function
function getPurchaseOrderAsPdf(string purchaseOrderID, GetPurchaseOrderAsPdfHeaders headers) returns Response|errorRetrieves specific purchase order as PDF files using a unique purchase order Id
Parameters
- purchaseOrderID string - Unique identifier for an Purchase Order
- headers GetPurchaseOrderAsPdfHeaders - Headers to be sent with the request
Return Type
getPurchaseOrder
Isolated FunctionRemote Function
function getPurchaseOrder(string purchaseOrderID, GetPurchaseOrderHeaders headers) returns PurchaseOrders|errorRetrieves a specific purchase order using a unique purchase order Id
Parameters
- purchaseOrderID string - Unique identifier for an Purchase Order
- headers GetPurchaseOrderHeaders - Headers to be sent with the request
Return Type
- PurchaseOrders|error - Success - return response of type PurchaseOrder array for specified PurchaseOrder
updatePurchaseOrder
Isolated FunctionRemote Function
function updatePurchaseOrder(string purchaseOrderID, UpdatePurchaseOrderHeaders headers, PurchaseOrders payload) returns PurchaseOrders|errorUpdates a specific purchase order
Parameters
- purchaseOrderID string - Unique identifier for an Purchase Order
- headers UpdatePurchaseOrderHeaders - Headers to be sent with the request
- payload PurchaseOrders - Purchase order with the fields to update
Return Type
- PurchaseOrders|error - Success - return response of type PurchaseOrder array for updated PurchaseOrder
getPurchaseOrderByNumber
Isolated FunctionRemote Function
function getPurchaseOrderByNumber(string purchaseOrderNumber, GetPurchaseOrderByNumberHeaders headers) returns PurchaseOrders|errorRetrieves a specific purchase order using purchase order number
Parameters
- purchaseOrderNumber string - Unique identifier for a PurchaseOrder
- headers GetPurchaseOrderByNumberHeaders - Headers to be sent with the request
Return Type
- PurchaseOrders|error - Success - return response of type PurchaseOrder array for specified PurchaseOrder
getPurchaseOrderHistory
Isolated FunctionRemote Function
function getPurchaseOrderHistory(string purchaseOrderID, GetPurchaseOrderHistoryHeaders headers) returns HistoryRecords|errorRetrieves history for a specific purchase order
Parameters
- purchaseOrderID string - Unique identifier for an Purchase Order
- headers GetPurchaseOrderHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createPurchaseOrderHistory
Isolated FunctionRemote Function
function createPurchaseOrderHistory(string purchaseOrderID, CreatePurchaseOrderHistoryHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific purchase orders
Parameters
- purchaseOrderID string - Unique identifier for an Purchase Order
- headers CreatePurchaseOrderHistoryHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getPurchaseOrderAttachments
Isolated FunctionRemote Function
function getPurchaseOrderAttachments(string purchaseOrderID, GetPurchaseOrderAttachmentsHeaders headers) returns Attachments|errorRetrieves attachments for a specific purchase order
Parameters
- purchaseOrderID string - Unique identifier for an Purchase Order
- headers GetPurchaseOrderAttachmentsHeaders - Headers to be sent with the request
Return Type
- Attachments|error - Success - return response of type Attachments array of Purchase Orders
getPurchaseOrderAttachmentById
Isolated FunctionRemote Function
function getPurchaseOrderAttachmentById(string purchaseOrderID, string attachmentID, GetPurchaseOrderAttachmentByIdHeaders headers) returns byte[]|errorRetrieves specific attachment for a specific purchase order using a unique attachment Id
Parameters
- purchaseOrderID string - Unique identifier for an Purchase Order
- attachmentID string - Unique identifier for Attachment object
- headers GetPurchaseOrderAttachmentByIdHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Account as binary data
getPurchaseOrderAttachmentByFileName
Isolated FunctionRemote Function
function getPurchaseOrderAttachmentByFileName(string purchaseOrderID, string fileName, GetPurchaseOrderAttachmentByFileNameHeaders headers) returns byte[]|errorRetrieves a specific attachment for a specific purchase order by filename
Parameters
- purchaseOrderID string - Unique identifier for an Purchase Order
- fileName string - Name of the attachment
- headers GetPurchaseOrderAttachmentByFileNameHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Purchase Order as binary data
createPurchaseOrderAttachmentByFileName
Isolated FunctionRemote Function
function createPurchaseOrderAttachmentByFileName(string purchaseOrderID, string fileName, CreatePurchaseOrderAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorCreates attachment for a specific purchase order
Parameters
- purchaseOrderID string - Unique identifier for an Purchase Order
- fileName string - Name of the attachment
- headers CreatePurchaseOrderAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array of Attachment
updatePurchaseOrderAttachmentByFileName
Isolated FunctionRemote Function
function updatePurchaseOrderAttachmentByFileName(string purchaseOrderID, string fileName, UpdatePurchaseOrderAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorUpdates a specific attachment for a specific purchase order by filename
Parameters
- purchaseOrderID string - Unique identifier for an Purchase Order
- fileName string - Name of the attachment
- headers UpdatePurchaseOrderAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array of Attachment
getQuotes
Isolated FunctionRemote Function
function getQuotes(GetQuotesHeaders headers, *GetQuotesQueries queries) returns Quotes|errorRetrieves sales quotes
Parameters
- headers GetQuotesHeaders - Headers to be sent with the request
- queries *GetQuotesQueries - Queries to be sent with the request
createQuotes
Isolated FunctionRemote Function
function createQuotes(CreateQuotesHeaders headers, Quotes payload, *CreateQuotesQueries queries) returns Quotes|errorCreate one or more quotes
Parameters
- headers CreateQuotesHeaders - Headers to be sent with the request
- payload Quotes - Quotes with an array of Quote object in body of request
- queries *CreateQuotesQueries - Queries to be sent with the request
Return Type
updateOrCreateQuotes
Isolated FunctionRemote Function
function updateOrCreateQuotes(UpdateOrCreateQuotesHeaders headers, Quotes payload, *UpdateOrCreateQuotesQueries queries) returns Quotes|errorUpdates or creates one or more quotes
Parameters
- headers UpdateOrCreateQuotesHeaders - Headers to be sent with the request
- payload Quotes - Quotes to create or update
- queries *UpdateOrCreateQuotesQueries - Queries to be sent with the request
Return Type
getQuote
Isolated FunctionRemote Function
function getQuote(string quoteID, GetQuoteHeaders headers) returns Quotes|errorRetrieves a specific quote using a unique quote Id
Parameters
- quoteID string - Unique identifier for an Quote
- headers GetQuoteHeaders - Headers to be sent with the request
updateQuote
Isolated FunctionRemote Function
function updateQuote(string quoteID, UpdateQuoteHeaders headers, Quotes payload) returns Quotes|errorUpdates a specific quote
Parameters
- quoteID string - Unique identifier for an Quote
- headers UpdateQuoteHeaders - Headers to be sent with the request
- payload Quotes - Quote with the fields to update
getQuoteHistory
Isolated FunctionRemote Function
function getQuoteHistory(string quoteID, GetQuoteHistoryHeaders headers) returns HistoryRecords|errorRetrieves history records of a specific quote
Parameters
- quoteID string - Unique identifier for an Quote
- headers GetQuoteHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createQuoteHistory
Isolated FunctionRemote Function
function createQuoteHistory(string quoteID, CreateQuoteHistoryHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific quote
Parameters
- quoteID string - Unique identifier for an Quote
- headers CreateQuoteHistoryHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getQuoteAsPdf
Isolated FunctionRemote Function
function getQuoteAsPdf(string quoteID, GetQuoteAsPdfHeaders headers) returns Response|errorRetrieves a specific quote as a PDF file using a unique quote Id
Parameters
- quoteID string - Unique identifier for an Quote
- headers GetQuoteAsPdfHeaders - Headers to be sent with the request
getQuoteAttachments
Isolated FunctionRemote Function
function getQuoteAttachments(string quoteID, GetQuoteAttachmentsHeaders headers) returns Attachments|errorRetrieves attachments for a specific quote
Parameters
- quoteID string - Unique identifier for an Quote
- headers GetQuoteAttachmentsHeaders - Headers to be sent with the request
Return Type
- Attachments|error - Success - return response of type Attachments array of Attachment
getQuoteAttachmentById
Isolated FunctionRemote Function
function getQuoteAttachmentById(string quoteID, string attachmentID, GetQuoteAttachmentByIdHeaders headers) returns byte[]|errorRetrieves a specific attachment from a specific quote using a unique attachment Id
Parameters
- quoteID string - Unique identifier for an Quote
- attachmentID string - Unique identifier for Attachment object
- headers GetQuoteAttachmentByIdHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Quote as binary data
getQuoteAttachmentByFileName
Isolated FunctionRemote Function
function getQuoteAttachmentByFileName(string quoteID, string fileName, GetQuoteAttachmentByFileNameHeaders headers) returns byte[]|errorRetrieves a specific attachment from a specific quote by filename
Parameters
- quoteID string - Unique identifier for an Quote
- fileName string - Name of the attachment
- headers GetQuoteAttachmentByFileNameHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Quote as binary data
createQuoteAttachmentByFileName
Isolated FunctionRemote Function
function createQuoteAttachmentByFileName(string quoteID, string fileName, CreateQuoteAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorCreates attachment for a specific quote
Parameters
- quoteID string - Unique identifier for an Quote
- fileName string - Name of the attachment
- headers CreateQuoteAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array of Attachment
updateQuoteAttachmentByFileName
Isolated FunctionRemote Function
function updateQuoteAttachmentByFileName(string quoteID, string fileName, UpdateQuoteAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorUpdates a specific attachment from a specific quote by filename
Parameters
- quoteID string - Unique identifier for an Quote
- fileName string - Name of the attachment
- headers UpdateQuoteAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array of Attachment
getReceipts
Isolated FunctionRemote Function
function getReceipts(GetReceiptsHeaders headers, *GetReceiptsQueries queries) returns Receipts|errorRetrieves draft expense claim receipts for any user
Parameters
- headers GetReceiptsHeaders - Headers to be sent with the request
- queries *GetReceiptsQueries - Queries to be sent with the request
createReceipt
Isolated FunctionRemote Function
function createReceipt(CreateReceiptHeaders headers, Receipts payload, *CreateReceiptQueries queries) returns Receipts|errorCreates draft expense claim receipts for any user
Parameters
- headers CreateReceiptHeaders - Headers to be sent with the request
- payload Receipts - Receipts with an array of Receipt object in body of request
- queries *CreateReceiptQueries - Queries to be sent with the request
Return Type
getReceipt
Isolated FunctionRemote Function
function getReceipt(string receiptID, GetReceiptHeaders headers, *GetReceiptQueries queries) returns Receipts|errorRetrieves a specific draft expense claim receipt by using a unique receipt Id
Parameters
- receiptID string - Unique identifier for a Receipt
- headers GetReceiptHeaders - Headers to be sent with the request
- queries *GetReceiptQueries - Queries to be sent with the request
Return Type
updateReceipt
Isolated FunctionRemote Function
function updateReceipt(string receiptID, UpdateReceiptHeaders headers, Receipts payload, *UpdateReceiptQueries queries) returns Receipts|errorUpdates a specific draft expense claim receipts
Parameters
- receiptID string - Unique identifier for a Receipt
- headers UpdateReceiptHeaders - Headers to be sent with the request
- payload Receipts - Draft expense claim receipt with the fields to update
- queries *UpdateReceiptQueries - Queries to be sent with the request
getReceiptAttachments
Isolated FunctionRemote Function
function getReceiptAttachments(string receiptID, GetReceiptAttachmentsHeaders headers) returns Attachments|errorRetrieves attachments for a specific expense claim receipt
Parameters
- receiptID string - Unique identifier for a Receipt
- headers GetReceiptAttachmentsHeaders - Headers to be sent with the request
Return Type
- Attachments|error - Success - return response of type Attachments array of Attachments for a specified Receipt
getReceiptAttachmentById
Isolated FunctionRemote Function
function getReceiptAttachmentById(string receiptID, string attachmentID, GetReceiptAttachmentByIdHeaders headers) returns byte[]|errorRetrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id
Parameters
- receiptID string - Unique identifier for a Receipt
- attachmentID string - Unique identifier for Attachment object
- headers GetReceiptAttachmentByIdHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Receipt as binary data
getReceiptAttachmentByFileName
Isolated FunctionRemote Function
function getReceiptAttachmentByFileName(string receiptID, string fileName, GetReceiptAttachmentByFileNameHeaders headers) returns byte[]|errorRetrieves a specific attachment from a specific expense claim receipts by file name
Parameters
- receiptID string - Unique identifier for a Receipt
- fileName string - Name of the attachment
- headers GetReceiptAttachmentByFileNameHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Receipt as binary data
createReceiptAttachmentByFileName
Isolated FunctionRemote Function
function createReceiptAttachmentByFileName(string receiptID, string fileName, CreateReceiptAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorCreates an attachment on a specific expense claim receipts by file name
Parameters
- receiptID string - Unique identifier for a Receipt
- fileName string - Name of the attachment
- headers CreateReceiptAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array with newly created Attachment for a specified Receipt
updateReceiptAttachmentByFileName
Isolated FunctionRemote Function
function updateReceiptAttachmentByFileName(string receiptID, string fileName, UpdateReceiptAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorUpdates a specific attachment on a specific expense claim receipts by file name
Parameters
- receiptID string - Unique identifier for a Receipt
- fileName string - Name of the attachment
- headers UpdateReceiptAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array with updated Attachment for a specified Receipt
getReceiptHistory
Isolated FunctionRemote Function
function getReceiptHistory(string receiptID, GetReceiptHistoryHeaders headers) returns HistoryRecords|errorRetrieves a history record for a specific receipt
Parameters
- receiptID string - Unique identifier for a Receipt
- headers GetReceiptHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createReceiptHistory
Isolated FunctionRemote Function
function createReceiptHistory(string receiptID, CreateReceiptHistoryHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific receipt
Parameters
- receiptID string - Unique identifier for a Receipt
- headers CreateReceiptHistoryHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getRepeatingInvoices
Isolated FunctionRemote Function
function getRepeatingInvoices(GetRepeatingInvoicesHeaders headers, *GetRepeatingInvoicesQueries queries) returns RepeatingInvoices|errorRetrieves repeating invoices
Parameters
- headers GetRepeatingInvoicesHeaders - Headers to be sent with the request
- queries *GetRepeatingInvoicesQueries - Queries to be sent with the request
Return Type
- RepeatingInvoices|error - Success - return response of type Repeating Invoices array for all Repeating Invoice
createRepeatingInvoices
Isolated FunctionRemote Function
function createRepeatingInvoices(CreateRepeatingInvoicesHeaders headers, RepeatingInvoices payload, *CreateRepeatingInvoicesQueries queries) returns RepeatingInvoices|errorCreates one or more repeating invoice templates
Parameters
- headers CreateRepeatingInvoicesHeaders - Headers to be sent with the request
- payload RepeatingInvoices - RepeatingInvoices with an array of repeating invoice objects in body of request
- queries *CreateRepeatingInvoicesQueries - Queries to be sent with the request
Return Type
- RepeatingInvoices|error - Success - return response of type RepeatingInvoices array with newly created RepeatingInvoice
updateOrCreateRepeatingInvoices
Isolated FunctionRemote Function
function updateOrCreateRepeatingInvoices(UpdateOrCreateRepeatingInvoicesHeaders headers, RepeatingInvoices payload, *UpdateOrCreateRepeatingInvoicesQueries queries) returns RepeatingInvoices|errorCreates or deletes one or more repeating invoice templates
Parameters
- headers UpdateOrCreateRepeatingInvoicesHeaders - Headers to be sent with the request
- payload RepeatingInvoices - RepeatingInvoices with an array of repeating invoice objects in body of request
- queries *UpdateOrCreateRepeatingInvoicesQueries - Queries to be sent with the request
Return Type
- RepeatingInvoices|error - Success - return response of type RepeatingInvoices array with newly created RepeatingInvoice
getRepeatingInvoice
Isolated FunctionRemote Function
function getRepeatingInvoice(string repeatingInvoiceID, GetRepeatingInvoiceHeaders headers) returns RepeatingInvoices|errorRetrieves a specific repeating invoice by using a unique repeating invoice Id
Parameters
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
- headers GetRepeatingInvoiceHeaders - Headers to be sent with the request
Return Type
- RepeatingInvoices|error - Success - return response of type Repeating Invoices array with a specified Repeating Invoice
updateRepeatingInvoice
Isolated FunctionRemote Function
function updateRepeatingInvoice(string repeatingInvoiceID, UpdateRepeatingInvoiceHeaders headers, RepeatingInvoices payload) returns RepeatingInvoices|errorUpdates or deletes a specific repeating invoice template
Parameters
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
- headers UpdateRepeatingInvoiceHeaders - Headers to be sent with the request
- payload RepeatingInvoices - Repeating invoice template with the fields to update, or a DELETED status
Return Type
- RepeatingInvoices|error - Success - return response of type RepeatingInvoices array with deleted Invoice
getRepeatingInvoiceAttachments
Isolated FunctionRemote Function
function getRepeatingInvoiceAttachments(string repeatingInvoiceID, GetRepeatingInvoiceAttachmentsHeaders headers) returns Attachments|errorRetrieves attachments from a specific repeating invoice
Parameters
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
- headers GetRepeatingInvoiceAttachmentsHeaders - Headers to be sent with the request
Return Type
- Attachments|error - Success - return response of type Attachments array with all Attachments for a specified Repeating Invoice
getRepeatingInvoiceAttachmentById
Isolated FunctionRemote Function
function getRepeatingInvoiceAttachmentById(string repeatingInvoiceID, string attachmentID, GetRepeatingInvoiceAttachmentByIdHeaders headers) returns byte[]|errorRetrieves a specific attachment from a specific repeating invoice
Parameters
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
- attachmentID string - Unique identifier for Attachment object
- headers GetRepeatingInvoiceAttachmentByIdHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Repeating Invoice as binary data
getRepeatingInvoiceAttachmentByFileName
Isolated FunctionRemote Function
function getRepeatingInvoiceAttachmentByFileName(string repeatingInvoiceID, string fileName, GetRepeatingInvoiceAttachmentByFileNameHeaders headers) returns byte[]|errorRetrieves a specific attachment from a specific repeating invoices by file name
Parameters
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
- fileName string - Name of the attachment
- headers GetRepeatingInvoiceAttachmentByFileNameHeaders - Headers to be sent with the request
Return Type
- byte[]|error - Success - return response of attachment for Repeating Invoice as binary data
createRepeatingInvoiceAttachmentByFileName
Isolated FunctionRemote Function
function createRepeatingInvoiceAttachmentByFileName(string repeatingInvoiceID, string fileName, CreateRepeatingInvoiceAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorCreates an attachment from a specific repeating invoices by file name
Parameters
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
- fileName string - Name of the attachment
- headers CreateRepeatingInvoiceAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array with updated Attachment for a specified Repeating Invoice
updateRepeatingInvoiceAttachmentByFileName
Isolated FunctionRemote Function
function updateRepeatingInvoiceAttachmentByFileName(string repeatingInvoiceID, string fileName, UpdateRepeatingInvoiceAttachmentByFileNameHeaders headers, byte[] payload) returns Attachments|errorUpdates a specific attachment from a specific repeating invoices by file name
Parameters
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
- fileName string - Name of the attachment
- headers UpdateRepeatingInvoiceAttachmentByFileNameHeaders - Headers to be sent with the request
- payload byte[] - Byte array of file in body of request
Return Type
- Attachments|error - Success - return response of type Attachments array with specified Attachment for a specified Repeating Invoice
getRepeatingInvoiceHistory
Isolated FunctionRemote Function
function getRepeatingInvoiceHistory(string repeatingInvoiceID, GetRepeatingInvoiceHistoryHeaders headers) returns HistoryRecords|errorRetrieves history record for a specific repeating invoice
Parameters
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
- headers GetRepeatingInvoiceHistoryHeaders - Headers to be sent with the request
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createRepeatingInvoiceHistory
Isolated FunctionRemote Function
function createRepeatingInvoiceHistory(string repeatingInvoiceID, CreateRepeatingInvoiceHistoryHeaders headers, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific repeating invoice
Parameters
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
- headers CreateRepeatingInvoiceHistoryHeaders - Headers to be sent with the request
- payload HistoryRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
Return Type
- HistoryRecords|error - Success - return response of type HistoryRecords array of HistoryRecord objects
getReportTenNinetyNine
Isolated FunctionRemote Function
function getReportTenNinetyNine(GetReportTenNinetyNineHeaders headers, *GetReportTenNinetyNineQueries queries) returns Reports|errorRetrieve reports for 1099
Parameters
- headers GetReportTenNinetyNineHeaders - Headers to be sent with the request
- queries *GetReportTenNinetyNineQueries - Queries to be sent with the request
getReportAgedPayablesByContact
Isolated FunctionRemote Function
function getReportAgedPayablesByContact(GetReportAgedPayablesByContactHeaders headers, *GetReportAgedPayablesByContactQueries queries) returns ReportWithRows|errorRetrieves report for aged payables by contact
Parameters
- headers GetReportAgedPayablesByContactHeaders - Headers to be sent with the request
- queries *GetReportAgedPayablesByContactQueries - Queries to be sent with the request
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportAgedReceivablesByContact
Isolated FunctionRemote Function
function getReportAgedReceivablesByContact(GetReportAgedReceivablesByContactHeaders headers, *GetReportAgedReceivablesByContactQueries queries) returns ReportWithRows|errorRetrieves report for aged receivables by contact
Parameters
- headers GetReportAgedReceivablesByContactHeaders - Headers to be sent with the request
- queries *GetReportAgedReceivablesByContactQueries - Queries to be sent with the request
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportBalanceSheet
Isolated FunctionRemote Function
function getReportBalanceSheet(GetReportBalanceSheetHeaders headers, *GetReportBalanceSheetQueries queries) returns ReportWithRows|errorRetrieves report for balancesheet
Parameters
- headers GetReportBalanceSheetHeaders - Headers to be sent with the request
- queries *GetReportBalanceSheetQueries - Queries to be sent with the request
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportBankSummary
Isolated FunctionRemote Function
function getReportBankSummary(GetReportBankSummaryHeaders headers, *GetReportBankSummaryQueries queries) returns ReportWithRows|errorRetrieves report for bank summary
Parameters
- headers GetReportBankSummaryHeaders - Headers to be sent with the request
- queries *GetReportBankSummaryQueries - Queries to be sent with the request
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportFromId
Isolated FunctionRemote Function
function getReportFromId(string reportID, GetReportFromIdHeaders headers) returns ReportWithRows|errorRetrieves a specific report using a unique ReportID
Parameters
- reportID string - Unique identifier for a Report
- headers GetReportFromIdHeaders - Headers to be sent with the request
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportBudgetSummary
Isolated FunctionRemote Function
function getReportBudgetSummary(GetReportBudgetSummaryHeaders headers, *GetReportBudgetSummaryQueries queries) returns ReportWithRows|errorRetrieves report for budget summary
Parameters
- headers GetReportBudgetSummaryHeaders - Headers to be sent with the request
- queries *GetReportBudgetSummaryQueries - Queries to be sent with the request
Return Type
- ReportWithRows|error - success- return a Report with Rows object
getReportExecutiveSummary
Isolated FunctionRemote Function
function getReportExecutiveSummary(GetReportExecutiveSummaryHeaders headers, *GetReportExecutiveSummaryQueries queries) returns ReportWithRows|errorRetrieves report for executive summary
Parameters
- headers GetReportExecutiveSummaryHeaders - Headers to be sent with the request
- queries *GetReportExecutiveSummaryQueries - Queries to be sent with the request
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportsList
Isolated FunctionRemote Function
function getReportsList(GetReportsListHeaders headers) returns ReportWithRows|errorRetrieves a list of the organistaions unique reports that require a uuid to fetch
Parameters
- headers GetReportsListHeaders - Headers to be sent with the request
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportProfitAndLoss
Isolated FunctionRemote Function
function getReportProfitAndLoss(GetReportProfitAndLossHeaders headers, *GetReportProfitAndLossQueries queries) returns ReportWithRows|errorRetrieves report for profit and loss
Parameters
- headers GetReportProfitAndLossHeaders - Headers to be sent with the request
- queries *GetReportProfitAndLossQueries - Queries to be sent with the request
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportTrialBalance
Isolated FunctionRemote Function
function getReportTrialBalance(GetReportTrialBalanceHeaders headers, *GetReportTrialBalanceQueries queries) returns ReportWithRows|errorRetrieves report for trial balance
Parameters
- headers GetReportTrialBalanceHeaders - Headers to be sent with the request
- queries *GetReportTrialBalanceQueries - Queries to be sent with the request
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
postSetup
Isolated FunctionRemote Function
function postSetup(PostSetupHeaders headers, Setup payload) returns ImportSummaryObject|errorSets the chart of accounts, the conversion date and conversion balances
Parameters
- headers PostSetupHeaders - Headers to be sent with the request
- payload Setup - Object including an accounts array, a conversion balances array and a conversion date object in body of request
Return Type
- ImportSummaryObject|error - Success - returns a summary of the chart of accounts updates
getTaxRates
Isolated FunctionRemote Function
function getTaxRates(GetTaxRatesHeaders headers, *GetTaxRatesQueries queries) returns TaxRates|errorRetrieves tax rates
Parameters
- headers GetTaxRatesHeaders - Headers to be sent with the request
- queries *GetTaxRatesQueries - Queries to be sent with the request
createTaxRates
Isolated FunctionRemote Function
function createTaxRates(CreateTaxRatesHeaders headers, TaxRates payload) returns TaxRates|errorCreates one or more tax rates
Parameters
- headers CreateTaxRatesHeaders - Headers to be sent with the request
- payload TaxRates - TaxRates array with TaxRate object in body of request
updateTaxRate
Isolated FunctionRemote Function
function updateTaxRate(UpdateTaxRateHeaders headers, TaxRates payload) returns TaxRates|errorUpdates tax rates
Parameters
- headers UpdateTaxRateHeaders - Headers to be sent with the request
- payload TaxRates - Tax rates with the fields to update
getTaxRateByTaxType
Isolated FunctionRemote Function
function getTaxRateByTaxType(string taxType, GetTaxRateByTaxTypeHeaders headers) returns TaxRates|errorRetrieves a specific tax rate according to given TaxType code
Parameters
- taxType string - A valid TaxType code
- headers GetTaxRateByTaxTypeHeaders - Headers to be sent with the request
getTrackingCategories
Isolated FunctionRemote Function
function getTrackingCategories(GetTrackingCategoriesHeaders headers, *GetTrackingCategoriesQueries queries) returns TrackingCategories|errorRetrieves tracking categories and options
Parameters
- headers GetTrackingCategoriesHeaders - Headers to be sent with the request
- queries *GetTrackingCategoriesQueries - Queries to be sent with the request
Return Type
- TrackingCategories|error - Success - return response of type TrackingCategories array of TrackingCategory
createTrackingCategory
Isolated FunctionRemote Function
function createTrackingCategory(CreateTrackingCategoryHeaders headers, TrackingCategory payload) returns TrackingCategories|errorCreate tracking categories
Parameters
- headers CreateTrackingCategoryHeaders - Headers to be sent with the request
- payload TrackingCategory - TrackingCategory object in body of request
Return Type
- TrackingCategories|error - Success - return response of type TrackingCategories array of newly created TrackingCategory
getTrackingCategory
Isolated FunctionRemote Function
function getTrackingCategory(string trackingCategoryID, GetTrackingCategoryHeaders headers) returns TrackingCategories|errorRetrieves specific tracking categories and options using a unique tracking category Id
Parameters
- trackingCategoryID string - Unique identifier for a TrackingCategory
- headers GetTrackingCategoryHeaders - Headers to be sent with the request
Return Type
- TrackingCategories|error - Success - return response of type TrackingCategories array of specified TrackingCategory
updateTrackingCategory
Isolated FunctionRemote Function
function updateTrackingCategory(string trackingCategoryID, UpdateTrackingCategoryHeaders headers, TrackingCategory payload) returns TrackingCategories|errorUpdates a specific tracking category
Parameters
- trackingCategoryID string - Unique identifier for a TrackingCategory
- headers UpdateTrackingCategoryHeaders - Headers to be sent with the request
- payload TrackingCategory - Tracking category with the fields to update
Return Type
- TrackingCategories|error - Success - return response of type TrackingCategories array of updated TrackingCategory
deleteTrackingCategory
Isolated FunctionRemote Function
function deleteTrackingCategory(string trackingCategoryID, DeleteTrackingCategoryHeaders headers) returns TrackingCategories|errorDeletes a specific tracking category
Parameters
- trackingCategoryID string - Unique identifier for a TrackingCategory
- headers DeleteTrackingCategoryHeaders - Headers to be sent with the request
Return Type
- TrackingCategories|error - Success - return response of type TrackingCategories array of deleted TrackingCategory
createTrackingOptions
Isolated FunctionRemote Function
function createTrackingOptions(string trackingCategoryID, CreateTrackingOptionsHeaders headers, TrackingOption payload) returns TrackingOptions|errorCreates options for a specific tracking category
Parameters
- trackingCategoryID string - Unique identifier for a TrackingCategory
- headers CreateTrackingOptionsHeaders - Headers to be sent with the request
- payload TrackingOption - TrackingOption object in body of request
Return Type
- TrackingOptions|error - Success - return response of type TrackingOptions array of options for a specified category
updateTrackingOptions
Isolated FunctionRemote Function
function updateTrackingOptions(string trackingCategoryID, string trackingOptionID, UpdateTrackingOptionsHeaders headers, TrackingOption payload) returns TrackingOptions|errorUpdates a specific option for a specific tracking category
Parameters
- trackingCategoryID string - Unique identifier for a TrackingCategory
- trackingOptionID string - Unique identifier for a Tracking Option
- headers UpdateTrackingOptionsHeaders - Headers to be sent with the request
- payload TrackingOption - Tracking option with the fields to update
Return Type
- TrackingOptions|error - Success - return response of type TrackingOptions array of options for a specified category
deleteTrackingOptions
Isolated FunctionRemote Function
function deleteTrackingOptions(string trackingCategoryID, string trackingOptionID, DeleteTrackingOptionsHeaders headers) returns TrackingOptions|errorDeletes a specific option for a specific tracking category
Parameters
- trackingCategoryID string - Unique identifier for a TrackingCategory
- trackingOptionID string - Unique identifier for a Tracking Option
- headers DeleteTrackingOptionsHeaders - Headers to be sent with the request
Return Type
- TrackingOptions|error - Success - return response of type TrackingOptions array of remaining options for a specified category
getUsers
Isolated FunctionRemote Function
function getUsers(GetUsersHeaders headers, *GetUsersQueries queries) returns Users|errorRetrieves users
Parameters
- headers GetUsersHeaders - Headers to be sent with the request
- queries *GetUsersQueries - Queries to be sent with the request
getUser
Isolated FunctionRemote Function
function getUser(string userID, GetUserHeaders headers) returns Users|errorRetrieves a specific user
Parameters
- userID string - Unique identifier for a User
- headers GetUserHeaders - Headers to be sent with the request
Records
xero.accounts: Account
Fields
- status? "ACTIVE"|"ARCHIVED"|"DELETED" - Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes
- accountID? string - The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9
- description? string - Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)
- updatedDateUTC? string - Last modified date UTC format
- validationErrors? ValidationError[] - Displays array of validation error messages from the API
- showInExpenseClaims? boolean - Boolean – describes whether account code is available for use with expense claims
- hasAttachments boolean(default false) - boolean to indicate if an account has an attachment (read only)
- code? string - Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)
- name? string - Name of account (max length = 150)
- currencyCode? CurrencyCode - Currency code of the account
- reportingCodeName? string - Shown if set
- taxType? string - The tax type from taxRates
- enablePaymentsToAccount? boolean - Boolean – describes whether account can have payments applied to it
- 'type? AccountType - Type of the account (for example BANK, REVENUE or EXPENSE)
- bankAccountType? "BANK"|"CREDITCARD"|"PAYPAL"|"NONE"|"" - For bank accounts only. See Bank Account types
- addToWatchlist? boolean - Boolean – describes whether the account is shown in the watchlist widget on the dashboard
- 'class? "ASSET"|"EQUITY"|"EXPENSE"|"LIABILITY"|"REVENUE" - See Account Class Types
- bankAccountNumber? string - For bank accounts only (Account Type BANK)
- reportingCode? string - Shown if set
- systemAccount? "DEBTORS"|"CREDITORS"|"BANKCURRENCYGAIN"|"GST"|"GSTONIMPORTS"|"HISTORICAL"|"REALISEDCURRENCYGAIN"|"RETAINEDEARNINGS"|"ROUNDING"|"TRACKINGTRANSFERS"|"UNPAIDEXPCLM"|"UNREALISEDCURRENCYGAIN"|"WAGEPAYABLES"|"CISASSETS"|"CISASSET"|"CISLABOUR"|"CISLABOUREXPENSE"|"CISLABOURINCOME"|"CISLIABILITY"|"CISMATERIALS"|"" - If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null
xero.accounts: Accounts
Fields
- accounts? Account[] - List of accounts
xero.accounts: AccountsPayable
Fields
- outstanding? decimal - Outstanding accounts payable amount
- overdue? decimal - Overdue accounts payable amount
xero.accounts: AccountsReceivable
Fields
- outstanding? decimal - Outstanding accounts receivable amount
- overdue? decimal - Overdue accounts receivable amount
xero.accounts: Action
Fields
- Name? string - Name of the actions for this organisation
- Status? "ALLOWED"|"NOT-ALLOWED" - Status of the action for this organisation
xero.accounts: Actions
Fields
- actions? Action[] - List of actions the organisation can perform
xero.accounts: Address
Fields
- addressLine3? string - max length = 500
- addressLine2? string - max length = 500
- addressLine1? string - max length = 500
- attentionTo? string - max length = 255
- addressLine4? string - max length = 500
- region? string - max length = 255
- postalCode? string - max length = 50
- country? string - max length = 50, [A-Z], [a-z] only
- city? string - max length = 255
- addressType? "POBOX"|"STREET" - define the type of address
xero.accounts: AddressForOrganisation
Fields
- addressLine3? string - max length = 500
- addressLine2? string - max length = 500
- addressLine1? string - max length = 500
- attentionTo? string - max length = 255
- addressLine4? string - max length = 500
- region? string - max length = 255
- postalCode? string - max length = 50
- country? string - max length = 50, [A-Z], [a-z] only
- city? string - max length = 255
- addressType? "POBOX"|"STREET"|"DELIVERY" - define the type of address
xero.accounts: Allocation
Fields
- isDeleted? boolean - A flag that returns true when the allocation is succesfully deleted
- invoice Invoice - Invoice the amount is allocated to
- statusAttributeString? string - A string to indicate if a invoice status
- validationErrors? ValidationError[] - Displays array of validation error messages from the API
- allocationID? string - Xero generated unique identifier
- creditNote? CreditNote - Credit note the amount is allocated from
- amount decimal - the amount being applied to the invoice
- prepayment? Prepayment - Prepayment the amount is allocated from
- overpayment? Overpayment - Overpayment the amount is allocated from
- date string - the date the allocation is applied YYYY-MM-DD
xero.accounts: Allocations
Fields
- allocations? Allocation[] - List of allocations
xero.accounts: Attachment
Fields
- fileName? string - Name of the file
- contentLength? int - Length of the file content
- includeOnline? boolean - Include the file with the online invoice
- attachmentID? string - Unique ID for the file
- url? string - URL to the file on xero.com
- mimeType? string - Type of file
xero.accounts: Attachments
Fields
- attachments? Attachment[] - List of attachments
xero.accounts: BalanceDetails
An array to specify multiple currency balances of an account
Fields
- currencyCode? string - The currency of the balance (Not required for base currency)
- currencyRate? decimal - (Optional) Exchange rate to base currency when money is spent or received. If not specified, XE rate for the day is applied
- balance? decimal - The opening balances of the account. Debits are positive, credits are negative values
xero.accounts: Balances
The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only)
Fields
- accountsPayable? AccountsPayable - Accounts payable (outstanding and overdue) balances of the contact
- accountsReceivable? AccountsReceivable - Accounts receivable (outstanding and overdue) balances of the contact
xero.accounts: BankTransaction
Fields
- status? "AUTHORISED"|"DELETED"|"VOIDED" - See Bank Transaction Status Codes
- lineItems LineItem[] - See LineItems
- statusAttributeString? string - A string to indicate if a invoice status
- currencyRate? decimal - Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments
- updatedDateUTC? string - Last modified date UTC format
- validationErrors? ValidationError[] - Displays array of validation error messages from the API
- reference? string - Reference for the transaction. Only supported for SPEND and RECEIVE transactions
- hasAttachments boolean(default false) - Boolean to indicate if a bank transaction has an attachment
- bankAccount Account - Bank account of the transaction
- isReconciled? boolean - Boolean to show if transaction is reconciled
- subTotal? decimal - Total of bank transaction excluding taxes
- date? string - Date of transaction – YYYY-MM-DD
- url? string - URL link to a source document – shown as “Go to App Name”
- contact? Contact - Contact associated with the bank transaction
- lineAmountTypes? LineAmountTypes - Whether line amounts of the bank transaction are tax exclusive, tax inclusive or have no tax
- currencyCode? CurrencyCode - Currency code of the bank transaction
- 'type "RECEIVE"|"RECEIVE-OVERPAYMENT"|"RECEIVE-PREPAYMENT"|"SPEND"|"SPEND-OVERPAYMENT"|"SPEND-PREPAYMENT"|"RECEIVE-TRANSFER"|"SPEND-TRANSFER" - See Bank Transaction Types
- prepaymentID? string - Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT
- totalTax? decimal - Total tax on bank transaction
- total? decimal - Total of bank transaction tax inclusive
- overpaymentID? string - Xero generated unique identifier for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT
- bankTransactionID? string - Xero generated unique identifier for bank transaction
xero.accounts: BankTransactions
Fields
- bankTransactions? BankTransaction[] - List of bank transactions
- pagination? Pagination - Pagination details of the returned page of results
- warnings? ValidationError[] - Displays array of warning messages from the API
xero.accounts: BankTransfer
Fields
- status? "AUTHORISED"|"DELETED" - AUTHORISED or DELETED (read-only). New bank transfers will have a status of AUTHORISED
- currencyRate? decimal - The currency rate
- validationErrors? ValidationError[] - Displays array of validation error messages from the API
- reference? string - Reference for the transactions
- hasAttachments boolean(default false) - Boolean to indicate if a Bank Transfer has an attachment
- amount decimal - amount of the transaction
- toBankTransactionID? string - The Bank Transaction ID for the destination account
- toTracking? TrackingReference[] - Optional Tracking Category for the destination account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account
- date? string - The date of the Transfer YYYY-MM-DD
- createdDateUTC? string - UTC timestamp of creation date of bank transfer
- fromIsReconciled boolean(default false) - The Bank Transaction boolean to show if it is reconciled for the source account
- fromBankAccount Account - Bank account the money is transferred from
- toBankAccount Account - Bank account the money is transferred to
- fromBankTransactionID? string - The Bank Transaction ID for the source account
- bankTransferID? string - The identifier of the Bank Transfer
- toIsReconciled boolean(default false) - The Bank Transaction boolean to show if it is reconciled for the destination account
- fromTracking? TrackingReference[] - Optional Tracking Category for the source account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account
xero.accounts: BankTransferDelete
Fields
- status string(default "DELETED") - The status of the bank transfer
- bankTransferID string - The Xero identifier for a bank transfer
xero.accounts: BankTransferDeleteByUrlParam
Fields
- status string(default "DELETED") - The status of the bank transfer
xero.accounts: BankTransfers
Fields
- bankTransfers? BankTransfer[] - List of bank transfers
xero.accounts: BankTransfersDelete
Fields
- bankTransfers? BankTransferDelete[] - List of bank transfers to delete
xero.accounts: BatchPayment
Fields
- status? "AUTHORISED"|"DELETED" - AUTHORISED or DELETED (read-only). New batch payments will have a status of AUTHORISED. It is not possible to delete batch payments via the API
- account? Account - Bank account the batch payment is made from
- batchPaymentID? string - The Xero generated unique identifier for the bank transaction (read-only)
- updatedDateUTC? string - UTC timestamp of last update to the payment
- validationErrors? ValidationError[] - Displays array of validation error messages from the API
- reference? string - (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero
- amount? decimal - The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00
- payments? Payment[] - An array of payments
- totalAmount? decimal - The total of the payments that make up the batch (read-only)
- isReconciled? boolean - Booelan that tells you if the batch payment has been reconciled (read-only)
- code? string - (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero
- date? string - Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
- particulars? string - (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero
- 'type? "PAYBATCH"|"RECBATCH" - PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only)
- details? string - (Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18
- narrative? string - (UK Only) Only shows on the statement line in Xero. Max length =18
- dateString? string - Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
xero.accounts: BatchPaymentDelete
Fields
- status string(default "DELETED") - The status of the batch payment
- batchPaymentID string - The Xero generated unique identifier for the bank transaction (read-only)
xero.accounts: BatchPaymentDeleteByUrlParam
Fields
- status string(default "DELETED") - The status of the batch payment
xero.accounts: BatchPaymentDetails
Bank details for use on a batch payment stored with each contact
Fields
- BankAccountNumber? string - Bank account number for use with Batch Payments
- BankAccountName? string - Name of bank for use with Batch Payments
- Details? string - (Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18
- Code? string - (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero.
- Reference? string - (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero.
xero.accounts: BatchPayments
Fields
- batchPayments? BatchPayment[] - List of batch payments
xero.accounts: Bill
Fields
- 'type? PaymentTermType - Payment term type that determines how the day value is applied
- day? int - Day of Month (0-31)
xero.accounts: BrandingTheme
Fields
- createdDateUTC? string - UTC timestamp of creation date of branding theme
- brandingThemeID? string - Xero identifier
- 'type? "INVOICE" - Always INVOICE
- logoUrl? string - The location of the image file used as the logo on this branding theme
- sortOrder? int - Integer – ranked order of branding theme. The default branding theme has a value of 0
- name? string - Name of branding theme
xero.accounts: BrandingThemes
Fields
- brandingThemes? BrandingTheme[] - List of branding themes
xero.accounts: Budget
Fields
- 'type? "OVERALL"|"TRACKING" - Type of Budget. OVERALL or TRACKING
- description? string - The Budget description
- tracking? TrackingCategory[] - Tracking categories applied to the budget
- updatedDateUTC? string - UTC timestamp of last update to budget
- budgetID? string - Xero identifier
- budgetLines? BudgetLine[] - Lines of the budget
xero.accounts: BudgetBalance
Fields
- amount? decimal - LineItem Quantity
- period? string - Period the amount applies to (e.g. “2019-08”)
- unitAmount? decimal - Budgeted amount
- notes? string - Any footnotes associated with this balance
xero.accounts: BudgetLine
Fields
- accountID? string - See Accounts
- accountCode? string - See Accounts
- budgetBalances? BudgetBalance[] - Budget balances for each period of the budget line
xero.accounts: Budgets
Fields
- budgets? Budget[] - List of budgets
xero.accounts: CISOrgSetting
Fields
- CISContractorEnabled? boolean - true or false - Boolean that describes if the organisation is a CIS Contractor
- CISSubContractorEnabled? boolean - true or false - Boolean that describes if the organisation is a CIS SubContractor
- Rate? decimal - CIS Deduction rate for the organisation
xero.accounts: CISOrgSettings
Fields
- cISSettings? CISOrgSetting[] - CIS settings of the organisation
xero.accounts: CISSetting
Fields
- CISEnabled? boolean - Boolean that describes if the contact is a CIS Subcontractor
- Rate? decimal - CIS Deduction rate for the contact if he is a subcontractor. If the contact is not CISEnabled, then the rate is not returned
xero.accounts: CISSettings
Fields
- cISSettings? CISSetting[] - CIS settings of the contact
xero.accounts: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
xero.accounts: Contact
Fields
- discount? decimal - The default discount rate for the contact (read only)
- updatedDateUTC? string - UTC timestamp of last update to contact
- validationErrors? ValidationError[] - Displays validation errors returned from the API
- purchasesDefaultLineAmountType? "INCLUSIVE"|"EXCLUSIVE"|"NONE" - The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber
- website? string - Website address for contact (read only)
- paymentTerms? PaymentTerm - Default payment terms of the contact
- attachments? Attachment[] - Displays array of attachments from the API
- salesDefaultLineAmountType? "INCLUSIVE"|"EXCLUSIVE"|"NONE" - The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber
- name? string - Full name of contact/organisation (max length = 255)
- salesTrackingCategories? SalesTrackingCategory[] - The default sales tracking categories for contacts
- addresses? Address[] - Store certain address types for a contact – see address types
- salesDefaultAccountCode? string - The default sales account code for contacts
- isSupplier? boolean - true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact
- companyNumber? string - Company registration number (max length = 50)
- phones? Phone[] - Store certain phone types for a contact – see phone types
- accountsReceivableTaxType? string - The tax type from TaxRates
- accountsPayableTaxType? string - The tax type from TaxRates
- bankAccountDetails? string - Bank account number of contact
- purchasesDefaultAccountCode? string - The default purchases account code for contacts
- batchPayments? BatchPaymentDetails - Batch payment details of the contact
- contactNumber? string - This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero
- taxNumber? string - Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)
- brandingTheme? BrandingTheme - Default branding theme of the contact
- contactGroups? ContactGroup[] - Displays which contact groups a contact is included in
- isCustomer? boolean - true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact
- statusAttributeString? string - Status of object
- defaultCurrency? CurrencyCode - Default currency of the contact
- firstName? string - First name of contact person (max length = 255)
- hasAttachments boolean(default false) - A boolean to indicate if a contact has an attachment
- balances? Balances - Accounts receivable and payable balances of the contact
- contactID? string - Xero identifier
- mergedToContactID? string - ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber
- emailAddress? string - Email address of contact person (umlauts not supported) (max length = 255)
- accountNumber? string - A user defined account number. This can be updated via the API and the Xero UI (max length = 50)
- purchasesTrackingCategories? SalesTrackingCategory[] - The default purchases tracking categories for contacts
- trackingCategoryOption? string - The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
- contactPersons? ContactPerson[] - See contact persons
- contactStatus? "ACTIVE"|"ARCHIVED"|"GDPRREQUEST" - Current status of a contact – see contact status types
- lastName? string - Last name of contact person (max length = 255)
- trackingCategoryName? string - The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
- hasValidationErrors boolean(default false) - A boolean to indicate if a contact has an validation errors
- taxNumberType? "SSN"|"EIN"|"ITIN"|"ATIN" - Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers
- xeroNetworkKey? string - Store XeroNetworkKey for contacts
xero.accounts: ContactGroup
Fields
- status? "ACTIVE"|"DELETED" - The Status of a contact group. To delete a contact group update the status to DELETED. Only contact groups with a status of ACTIVE are returned on GETs
- contactGroupID? string - The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9
- contacts? Contact[] - The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL
- name? string - The Name of the contact group. Required when creating a new contact group
xero.accounts: ContactGroups
Fields
- contactGroups? ContactGroup[] - List of contact groups
xero.accounts: ContactPerson
Fields
- includeInEmails? boolean - boolean to indicate whether contact should be included on emails with invoices etc
- firstName? string - First name of person
- lastName? string - Last name of person
- emailAddress? string - Email address of person
xero.accounts: Contacts
Fields
- pagination? Pagination - Pagination details of the returned page of results
- contacts? Contact[] - List of contacts
- warnings? ValidationError[] - Displays array of warning messages from the API
xero.accounts: ConversionBalances
Balance supplied for each account that has a value as at the conversion date
Fields
- accountCode? string - The account code for a account
- balanceDetails? BalanceDetails[] - Balance details of the conversion balance entry
- balance? decimal - The opening balances of the account. Debits are positive, credits are negative values
xero.accounts: ConversionDate
The date when the organisation starts using Xero
Fields
- month? int - The month the organisation starts using Xero. Value is an integer between 1 and 12
- year? int - The year the organisation starts using Xero. Value is an integer greater than 2006
xero.accounts: CreateAccountAttachmentByFileNameHeaders
Represents the Headers record for the operation: createAccountAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateAccountHeaders
Represents the Headers record for the operation: createAccount
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateBankTransactionAttachmentByFileNameHeaders
Represents the Headers record for the operation: createBankTransactionAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateBankTransactionHistoryRecordHeaders
Represents the Headers record for the operation: createBankTransactionHistoryRecord
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateBankTransactionsHeaders
Represents the Headers record for the operation: createBankTransactions
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateBankTransactionsQueries
Represents the Queries record for the operation: createBankTransactions
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: CreateBankTransferAttachmentByFileNameHeaders
Represents the Headers record for the operation: createBankTransferAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateBankTransferHeaders
Represents the Headers record for the operation: createBankTransfer
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateBankTransferHistoryRecordHeaders
Represents the Headers record for the operation: createBankTransferHistoryRecord
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateBatchPaymentHeaders
Represents the Headers record for the operation: createBatchPayment
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateBatchPaymentHistoryRecordHeaders
Represents the Headers record for the operation: createBatchPaymentHistoryRecord
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateBatchPaymentQueries
Represents the Queries record for the operation: createBatchPayment
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: CreateBrandingThemePaymentServicesHeaders
Represents the Headers record for the operation: createBrandingThemePaymentServices
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateContactAttachmentByFileNameHeaders
Represents the Headers record for the operation: createContactAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateContactGroupContactsHeaders
Represents the Headers record for the operation: createContactGroupContacts
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateContactGroupHeaders
Represents the Headers record for the operation: createContactGroup
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateContactHistoryHeaders
Represents the Headers record for the operation: createContactHistory
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateContactsHeaders
Represents the Headers record for the operation: createContacts
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateContactsQueries
Represents the Queries record for the operation: createContacts
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: CreateCreditNoteAllocationHeaders
Represents the Headers record for the operation: createCreditNoteAllocation
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateCreditNoteAllocationQueries
Represents the Queries record for the operation: createCreditNoteAllocation
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: CreateCreditNoteAttachmentByFileNameHeaders
Represents the Headers record for the operation: createCreditNoteAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateCreditNoteAttachmentByFileNameQueries
Represents the Queries record for the operation: createCreditNoteAttachmentByFileName
Fields
- includeOnline boolean(default false) - Allows an attachment to be seen by the end customer within their online invoice
xero.accounts: CreateCreditNoteHistoryHeaders
Represents the Headers record for the operation: createCreditNoteHistory
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateCreditNotesHeaders
Represents the Headers record for the operation: createCreditNotes
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateCreditNotesQueries
Represents the Queries record for the operation: createCreditNotes
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: CreateCurrencyHeaders
Represents the Headers record for the operation: createCurrency
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateExpenseClaimHistoryHeaders
Represents the Headers record for the operation: createExpenseClaimHistory
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateExpenseClaimsHeaders
Represents the Headers record for the operation: createExpenseClaims
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateInvoiceAttachmentByFileNameHeaders
Represents the Headers record for the operation: createInvoiceAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateInvoiceAttachmentByFileNameQueries
Represents the Queries record for the operation: createInvoiceAttachmentByFileName
Fields
- includeOnline boolean(default false) - Allows an attachment to be seen by the end customer within their online invoice
xero.accounts: CreateInvoiceHistoryHeaders
Represents the Headers record for the operation: createInvoiceHistory
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateInvoicesHeaders
Represents the Headers record for the operation: createInvoices
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateInvoicesQueries
Represents the Queries record for the operation: createInvoices
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- allowBackorders? boolean - Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: CreateItemHistoryHeaders
Represents the Headers record for the operation: createItemHistory
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateItemsHeaders
Represents the Headers record for the operation: createItems
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateItemsQueries
Represents the Queries record for the operation: createItems
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: CreateLinkedTransactionHeaders
Represents the Headers record for the operation: createLinkedTransaction
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateManualJournalAttachmentByFileNameHeaders
Represents the Headers record for the operation: createManualJournalAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateManualJournalHistoryRecordHeaders
Represents the Headers record for the operation: createManualJournalHistoryRecord
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateManualJournalsHeaders
Represents the Headers record for the operation: createManualJournals
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateManualJournalsQueries
Represents the Queries record for the operation: createManualJournals
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: CreateOverpaymentAllocationsHeaders
Represents the Headers record for the operation: createOverpaymentAllocations
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateOverpaymentAllocationsQueries
Represents the Queries record for the operation: createOverpaymentAllocations
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: CreateOverpaymentHistoryHeaders
Represents the Headers record for the operation: createOverpaymentHistory
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreatePaymentHeaders
Represents the Headers record for the operation: createPayment
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreatePaymentHistoryHeaders
Represents the Headers record for the operation: createPaymentHistory
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreatePaymentServiceHeaders
Represents the Headers record for the operation: createPaymentService
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreatePaymentsHeaders
Represents the Headers record for the operation: createPayments
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreatePaymentsQueries
Represents the Queries record for the operation: createPayments
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: CreatePrepaymentAllocationsHeaders
Represents the Headers record for the operation: createPrepaymentAllocations
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreatePrepaymentAllocationsQueries
Represents the Queries record for the operation: createPrepaymentAllocations
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: CreatePrepaymentHistoryHeaders
Represents the Headers record for the operation: createPrepaymentHistory
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreatePurchaseOrderAttachmentByFileNameHeaders
Represents the Headers record for the operation: createPurchaseOrderAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreatePurchaseOrderHistoryHeaders
Represents the Headers record for the operation: createPurchaseOrderHistory
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreatePurchaseOrdersHeaders
Represents the Headers record for the operation: createPurchaseOrders
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreatePurchaseOrdersQueries
Represents the Queries record for the operation: createPurchaseOrders
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: CreateQuoteAttachmentByFileNameHeaders
Represents the Headers record for the operation: createQuoteAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateQuoteHistoryHeaders
Represents the Headers record for the operation: createQuoteHistory
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateQuotesHeaders
Represents the Headers record for the operation: createQuotes
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateQuotesQueries
Represents the Queries record for the operation: createQuotes
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: CreateReceiptAttachmentByFileNameHeaders
Represents the Headers record for the operation: createReceiptAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateReceiptHeaders
Represents the Headers record for the operation: createReceipt
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateReceiptHistoryHeaders
Represents the Headers record for the operation: createReceiptHistory
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateReceiptQueries
Represents the Queries record for the operation: createReceipt
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
xero.accounts: CreateRepeatingInvoiceAttachmentByFileNameHeaders
Represents the Headers record for the operation: createRepeatingInvoiceAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateRepeatingInvoiceHistoryHeaders
Represents the Headers record for the operation: createRepeatingInvoiceHistory
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateRepeatingInvoicesHeaders
Represents the Headers record for the operation: createRepeatingInvoices
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateRepeatingInvoicesQueries
Represents the Queries record for the operation: createRepeatingInvoices
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: CreateTaxRatesHeaders
Represents the Headers record for the operation: createTaxRates
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateTrackingCategoryHeaders
Represents the Headers record for the operation: createTrackingCategory
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreateTrackingOptionsHeaders
Represents the Headers record for the operation: createTrackingOptions
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: CreditNote
Fields
- allocations? Allocation[] - See Allocations
- brandingThemeID? string - See BrandingThemes
- updatedDateUTC? string - UTC timestamp of last update to the credit note
- currencyRate? decimal - The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used
- validationErrors? ValidationError[] - Displays array of validation error messages from the API
- payments? Payment[] - See Payments
- subTotal? decimal - The subtotal of the credit note excluding taxes
- updatedDateUTCString? string - UTC ISO-8601 formatted timestamp of last update to the credit note
- currencyCode? CurrencyCode - Currency code of the credit note
- invoiceAddresses? InvoiceAddress[] - An array of addresses used to auto calculate sales tax
- remainingCredit? decimal - The remaining credit balance on the Credit Note
- totalTax? decimal - The total tax on the credit note
- dueDate? string - Date invoice is due – YYYY-MM-DD
- status? "DRAFT"|"SUBMITTED"|"DELETED"|"AUTHORISED"|"PAID"|"VOIDED" - See Credit Note Status Codes
- lineItems? LineItem[] - See Invoice Line Items
- creditNoteID? string - Xero generated unique identifier
- creditNoteNumber? string - ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)
- statusAttributeString? string - A string to indicate if a invoice status
- cISRate? decimal - CIS Deduction rate for the organisation
- reference? string - ACCRECCREDIT only – additional reference number
- hasAttachments boolean(default false) - boolean to indicate if a credit note has an attachment
- appliedAmount? decimal - The amount of applied to an invoice
- sentToContact? boolean - Boolean to set whether the credit note in the Xero app should be marked as “sent”. This can be set only on credit notes that have been approved
- date? string - The date the credit note is issued YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation
- contact? Contact - Contact associated with the credit note
- lineAmountTypes? LineAmountTypes - Whether line amounts of the credit note are tax exclusive, tax inclusive or have no tax
- cISDeduction? decimal - CIS deduction for UK contractors
- 'type? "ACCPAYCREDIT"|"ACCRECCREDIT" - See Credit Note Types
- fullyPaidOnDate? string - Date when credit note was fully paid(UTC format)
- total? decimal - The total of the Credit Note(subtotal + total tax)
- hasErrors boolean(default false) - A boolean to indicate if a credit note has an validation errors
- warnings? ValidationError[] - Displays array of warning messages from the API
xero.accounts: CreditNotes
Fields
- pagination? Pagination - Pagination details of the returned page of results
- creditNotes? CreditNote[] - List of credit notes
- warnings? ValidationError[] - Displays array of warning messages from the API
xero.accounts: Currencies
Fields
- currencies? Currency[] - List of currencies
xero.accounts: Currency
Fields
- description? string - Name of Currency
- code? CurrencyCode - ISO 4217 code of the currency
xero.accounts: DeleteAccountHeaders
Represents the Headers record for the operation: deleteAccount
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: DeleteBankTransferHeaders
Represents the Headers record for the operation: deleteBankTransfer
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: DeleteBankTransfersHeaders
Represents the Headers record for the operation: deleteBankTransfers
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: DeleteBankTransfersQueries
Represents the Queries record for the operation: deleteBankTransfers
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: DeleteBatchPaymentByUrlParamHeaders
Represents the Headers record for the operation: deleteBatchPaymentByUrlParam
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: DeleteBatchPaymentHeaders
Represents the Headers record for the operation: deleteBatchPayment
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: DeleteContactGroupContactHeaders
Represents the Headers record for the operation: deleteContactGroupContact
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: DeleteContactGroupContactsHeaders
Represents the Headers record for the operation: deleteContactGroupContacts
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: DeleteCreditNoteAllocationsHeaders
Represents the Headers record for the operation: deleteCreditNoteAllocations
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: DeleteItemHeaders
Represents the Headers record for the operation: deleteItem
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: DeleteLinkedTransactionHeaders
Represents the Headers record for the operation: deleteLinkedTransaction
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: DeleteOverpaymentAllocationsHeaders
Represents the Headers record for the operation: deleteOverpaymentAllocations
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: DeletePaymentHeaders
Represents the Headers record for the operation: deletePayment
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: DeletePrepaymentAllocationsHeaders
Represents the Headers record for the operation: deletePrepaymentAllocations
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: DeleteTrackingCategoryHeaders
Represents the Headers record for the operation: deleteTrackingCategory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: DeleteTrackingOptionsHeaders
Represents the Headers record for the operation: deleteTrackingOptions
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: EmailInvoiceHeaders
Represents the Headers record for the operation: emailInvoice
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: ExpenseClaim
Fields
- status? "SUBMITTED"|"AUTHORISED"|"PAID"|"VOIDED"|"DELETED" - Current status of an expense claim – see status types
- expenseClaimID? string - Xero generated unique identifier for an expense claim
- amountDue? decimal - The amount due to be paid for an expense claim
- user? User - User who submitted the expense claim
- receiptID? string - The Xero identifier for the Receipt e.g. e59a2c7f-1306-4078-a0f3-73537afcbba9
- updatedDateUTC? string - Last modified date UTC format
- amountPaid? decimal - The amount still to pay for an expense claim
- total? decimal - The total of an expense claim being paid
- payments? Payment[] - See Payments
- reportingDate? string - The date the expense claim will be reported in Xero YYYY-MM-DD
- receipts? Receipt[] - Receipts included in the expense claim
- paymentDueDate? string - The date when the expense claim is due to be paid YYYY-MM-DD
xero.accounts: ExpenseClaims
Fields
- expenseClaims? ExpenseClaim[] - List of expense claims
xero.accounts: ExternalLink
Fields
- description? string - Description of the external link
- linkType? "Facebook"|"GooglePlus"|"LinkedIn"|"Twitter"|"Website" - See External link types
- url? string - URL for service e.g. http://twitter.com/xeroapi
xero.accounts: GetAccountAttachmentByFileNameHeaders
Represents the Headers record for the operation: getAccountAttachmentByFileName
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetAccountAttachmentByIdHeaders
Represents the Headers record for the operation: getAccountAttachmentById
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetAccountAttachmentsHeaders
Represents the Headers record for the operation: getAccountAttachments
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetAccountHeaders
Represents the Headers record for the operation: getAccount
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetAccountsHeaders
Represents the Headers record for the operation: getAccounts
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetAccountsQueries
Represents the Queries record for the operation: getAccounts
Fields
- 'where? string - Filter by an any element
- 'order? string - Order by an any element
xero.accounts: GetBankTransactionAttachmentByFileNameHeaders
Represents the Headers record for the operation: getBankTransactionAttachmentByFileName
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetBankTransactionAttachmentByIdHeaders
Represents the Headers record for the operation: getBankTransactionAttachmentById
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetBankTransactionAttachmentsHeaders
Represents the Headers record for the operation: getBankTransactionAttachments
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBankTransactionHeaders
Represents the Headers record for the operation: getBankTransaction
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBankTransactionQueries
Represents the Queries record for the operation: getBankTransaction
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
xero.accounts: GetBankTransactionsHeaders
Represents the Headers record for the operation: getBankTransactions
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBankTransactionsHistoryHeaders
Represents the Headers record for the operation: getBankTransactionsHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBankTransactionsQueries
Represents the Queries record for the operation: getBankTransactions
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- references? string[] - Filter by a comma-separated list of References
- pageSize? int - Number of records to retrieve per page
- 'where? string - Filter by an any element
- page? int - Up to 100 bank transactions will be returned in a single API call with line items details
- 'order? string - Order by an any element
xero.accounts: GetBankTransferAttachmentByFileNameHeaders
Represents the Headers record for the operation: getBankTransferAttachmentByFileName
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetBankTransferAttachmentByIdHeaders
Represents the Headers record for the operation: getBankTransferAttachmentById
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetBankTransferAttachmentsHeaders
Represents the Headers record for the operation: getBankTransferAttachments
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBankTransferHeaders
Represents the Headers record for the operation: getBankTransfer
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBankTransferHistoryHeaders
Represents the Headers record for the operation: getBankTransferHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBankTransfersHeaders
Represents the Headers record for the operation: getBankTransfers
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBankTransfersQueries
Represents the Queries record for the operation: getBankTransfers
Fields
- includeDeleted? boolean - e.g. includeDeleted=true - Bank transfers with a status of DELETED will be included in the response
- 'where? string - Filter by an any element
- 'order? string - Order by an any element
xero.accounts: GetBatchPaymentHeaders
Represents the Headers record for the operation: getBatchPayment
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBatchPaymentHistoryHeaders
Represents the Headers record for the operation: getBatchPaymentHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBatchPaymentsHeaders
Represents the Headers record for the operation: getBatchPayments
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBatchPaymentsQueries
Represents the Queries record for the operation: getBatchPayments
Fields
- 'where? string - Filter by an any element
- 'order? string - Order by an any element
xero.accounts: GetBrandingThemeHeaders
Represents the Headers record for the operation: getBrandingTheme
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBrandingThemePaymentServicesHeaders
Represents the Headers record for the operation: getBrandingThemePaymentServices
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBrandingThemesHeaders
Represents the Headers record for the operation: getBrandingThemes
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBudgetHeaders
Represents the Headers record for the operation: getBudget
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBudgetQueries
Represents the Queries record for the operation: getBudget
Fields
- dateFrom? string - Filter by end date
- dateTo? string - Filter by start date
xero.accounts: GetBudgetsHeaders
Represents the Headers record for the operation: getBudgets
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetBudgetsQueries
Represents the Queries record for the operation: getBudgets
Fields
- dateFrom? string - Filter by end date
- iDs? string[] - Filter by BudgetID. Allows you to retrieve a specific individual budget
- dateTo? string - Filter by start date
xero.accounts: GetContactAttachmentByFileNameHeaders
Represents the Headers record for the operation: getContactAttachmentByFileName
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetContactAttachmentByIdHeaders
Represents the Headers record for the operation: getContactAttachmentById
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetContactAttachmentsHeaders
Represents the Headers record for the operation: getContactAttachments
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetContactByContactNumberHeaders
Represents the Headers record for the operation: getContactByContactNumber
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetContactCISSettingsHeaders
Represents the Headers record for the operation: getContactCISSettings
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetContactGroupHeaders
Represents the Headers record for the operation: getContactGroup
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetContactGroupsHeaders
Represents the Headers record for the operation: getContactGroups
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetContactGroupsQueries
Represents the Queries record for the operation: getContactGroups
Fields
- 'where? string - Filter by an any element
- 'order? string - Order by an any element
xero.accounts: GetContactHeaders
Represents the Headers record for the operation: getContact
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetContactHistoryHeaders
Represents the Headers record for the operation: getContactHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetContactsHeaders
Represents the Headers record for the operation: getContacts
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetContactsQueries
Represents the Queries record for the operation: getContacts
Fields
- includeArchived? boolean - e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response
- summaryOnly boolean(default false) - Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient
- searchTerm? string - Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields
- iDs? string[] - Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call
- pageSize? int - Number of records to retrieve per page
- 'where? string - Filter by an any element
- page? int - e.g. page=1 - Up to 100 contacts will be returned in a single API call
- 'order? string - Order by an any element
xero.accounts: GetCreditNoteAsPdfHeaders
Represents the Headers record for the operation: getCreditNoteAsPdf
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetCreditNoteAttachmentByFileNameHeaders
Represents the Headers record for the operation: getCreditNoteAttachmentByFileName
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetCreditNoteAttachmentByIdHeaders
Represents the Headers record for the operation: getCreditNoteAttachmentById
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetCreditNoteAttachmentsHeaders
Represents the Headers record for the operation: getCreditNoteAttachments
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetCreditNoteHeaders
Represents the Headers record for the operation: getCreditNote
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetCreditNoteHistoryHeaders
Represents the Headers record for the operation: getCreditNoteHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetCreditNoteQueries
Represents the Queries record for the operation: getCreditNote
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
xero.accounts: GetCreditNotesHeaders
Represents the Headers record for the operation: getCreditNotes
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetCreditNotesQueries
Represents the Queries record for the operation: getCreditNotes
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- pageSize? int - Number of records to retrieve per page
- 'where? string - Filter by an any element
- page? int - e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note
- 'order? string - Order by an any element
xero.accounts: GetCurrenciesHeaders
Represents the Headers record for the operation: getCurrencies
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetCurrenciesQueries
Represents the Queries record for the operation: getCurrencies
Fields
- 'where? string - Filter by an any element
- 'order? string - Order by an any element
xero.accounts: GetExpenseClaimHeaders
Represents the Headers record for the operation: getExpenseClaim
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetExpenseClaimHistoryHeaders
Represents the Headers record for the operation: getExpenseClaimHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetExpenseClaimsHeaders
Represents the Headers record for the operation: getExpenseClaims
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetExpenseClaimsQueries
Represents the Queries record for the operation: getExpenseClaims
Fields
- 'where? string - Filter by an any element
- 'order? string - Order by an any element
xero.accounts: GetInvoiceAsPdfHeaders
Represents the Headers record for the operation: getInvoiceAsPdf
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetInvoiceAttachmentByFileNameHeaders
Represents the Headers record for the operation: getInvoiceAttachmentByFileName
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetInvoiceAttachmentByIdHeaders
Represents the Headers record for the operation: getInvoiceAttachmentById
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetInvoiceAttachmentsHeaders
Represents the Headers record for the operation: getInvoiceAttachments
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetInvoiceHeaders
Represents the Headers record for the operation: getInvoice
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetInvoiceHistoryHeaders
Represents the Headers record for the operation: getInvoiceHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetInvoiceQueries
Represents the Queries record for the operation: getInvoice
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
xero.accounts: GetInvoiceRemindersHeaders
Represents the Headers record for the operation: getInvoiceReminders
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetInvoicesHeaders
Represents the Headers record for the operation: getInvoices
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetInvoicesQueries
Represents the Queries record for the operation: getInvoices
Fields
- includeArchived? boolean - e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response
- invoiceNumbers? string[] - Filter by a comma-separated list of InvoiceNumbers
- pageSize? int - Number of records to retrieve per page
- summaryOnly boolean(default false) - Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient
- searchTerm? string - Search parameter that performs a case-insensitive text search across the fields e.g. InvoiceNumber, Reference
- statuses? string[] - Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter
- createdByMyApp? boolean - When set to true you'll only retrieve Invoices created by your app
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- iDs? string[] - Filter by a comma-separated list of InvoicesIDs
- 'where? string - Filter by an any element
- page? int - e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice
- 'order? string - Order by an any element
- contactIDs? string[] - Filter by a comma-separated list of ContactIDs
xero.accounts: GetItemHeaders
Represents the Headers record for the operation: getItem
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetItemHistoryHeaders
Represents the Headers record for the operation: getItemHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetItemQueries
Represents the Queries record for the operation: getItem
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
xero.accounts: GetItemsHeaders
Represents the Headers record for the operation: getItems
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetItemsQueries
Represents the Queries record for the operation: getItems
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- 'where? string - Filter by an any element
- 'order? string - Order by an any element
xero.accounts: GetJournalByNumberHeaders
Represents the Headers record for the operation: getJournalByNumber
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetJournalHeaders
Represents the Headers record for the operation: getJournal
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetJournalsHeaders
Represents the Headers record for the operation: getJournals
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetJournalsQueries
Represents the Queries record for the operation: getJournals
Fields
- paymentsOnly? boolean - Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default
- offset? int - Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned
xero.accounts: GetLinkedTransactionHeaders
Represents the Headers record for the operation: getLinkedTransaction
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetLinkedTransactionsHeaders
Represents the Headers record for the operation: getLinkedTransactions
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetLinkedTransactionsQueries
Represents the Queries record for the operation: getLinkedTransactions
Fields
- status? string - Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status
- targetTransactionID? string - Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice
- sourceTransactionID? string - Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice
- linkedTransactionID? string - The Xero identifier for an Linked Transaction
- page? int - Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1
- contactID? string - Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer
xero.accounts: GetManualJournalAttachmentByFileNameHeaders
Represents the Headers record for the operation: getManualJournalAttachmentByFileName
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetManualJournalAttachmentByIdHeaders
Represents the Headers record for the operation: getManualJournalAttachmentById
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetManualJournalAttachmentsHeaders
Represents the Headers record for the operation: getManualJournalAttachments
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetManualJournalHeaders
Represents the Headers record for the operation: getManualJournal
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetManualJournalsHeaders
Represents the Headers record for the operation: getManualJournals
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetManualJournalsHistoryHeaders
Represents the Headers record for the operation: getManualJournalsHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetManualJournalsQueries
Represents the Queries record for the operation: getManualJournals
Fields
- pageSize? int - Number of records to retrieve per page
- 'where? string - Filter by an any element
- page? int - e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment
- 'order? string - Order by an any element
xero.accounts: GetOnlineInvoiceHeaders
Represents the Headers record for the operation: getOnlineInvoice
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetOrganisationActionsHeaders
Represents the Headers record for the operation: getOrganisationActions
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetOrganisationCISSettingsHeaders
Represents the Headers record for the operation: getOrganisationCISSettings
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetOrganisationsHeaders
Represents the Headers record for the operation: getOrganisations
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetOverpaymentHeaders
Represents the Headers record for the operation: getOverpayment
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetOverpaymentHistoryHeaders
Represents the Headers record for the operation: getOverpaymentHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetOverpaymentsHeaders
Represents the Headers record for the operation: getOverpayments
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetOverpaymentsQueries
Represents the Queries record for the operation: getOverpayments
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- references? string[] - Filter by a comma-separated list of References
- pageSize? int - Number of records to retrieve per page
- 'where? string - Filter by an any element
- page? int - e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
- 'order? string - Order by an any element
xero.accounts: GetPaymentHeaders
Represents the Headers record for the operation: getPayment
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetPaymentHistoryHeaders
Represents the Headers record for the operation: getPaymentHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetPaymentServicesHeaders
Represents the Headers record for the operation: getPaymentServices
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetPaymentsHeaders
Represents the Headers record for the operation: getPayments
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetPaymentsQueries
Represents the Queries record for the operation: getPayments
Fields
- pageSize? int - Number of records to retrieve per page
- 'where? string - Filter by an any element
- page? int - Up to 100 payments will be returned in a single API call
- 'order? string - Order by an any element
xero.accounts: GetPrepaymentHeaders
Represents the Headers record for the operation: getPrepayment
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetPrepaymentHistoryHeaders
Represents the Headers record for the operation: getPrepaymentHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetPrepaymentsHeaders
Represents the Headers record for the operation: getPrepayments
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetPrepaymentsQueries
Represents the Queries record for the operation: getPrepayments
Fields
- invoiceNumbers? string[] - Filter by a comma-separated list of InvoiceNumbers
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- references? string[] - Filter by a comma-separated list of References
- pageSize? int - Number of records to retrieve per page
- 'where? string - Filter by an any element
- page? int - e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each prepayment
- 'order? string - Order by an any element
xero.accounts: GetPurchaseOrderAsPdfHeaders
Represents the Headers record for the operation: getPurchaseOrderAsPdf
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetPurchaseOrderAttachmentByFileNameHeaders
Represents the Headers record for the operation: getPurchaseOrderAttachmentByFileName
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetPurchaseOrderAttachmentByIdHeaders
Represents the Headers record for the operation: getPurchaseOrderAttachmentById
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetPurchaseOrderAttachmentsHeaders
Represents the Headers record for the operation: getPurchaseOrderAttachments
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetPurchaseOrderByNumberHeaders
Represents the Headers record for the operation: getPurchaseOrderByNumber
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetPurchaseOrderHeaders
Represents the Headers record for the operation: getPurchaseOrder
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetPurchaseOrderHistoryHeaders
Represents the Headers record for the operation: getPurchaseOrderHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetPurchaseOrdersHeaders
Represents the Headers record for the operation: getPurchaseOrders
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetPurchaseOrdersQueries
Represents the Queries record for the operation: getPurchaseOrders
Fields
- status? "DRAFT"|"SUBMITTED"|"AUTHORISED"|"BILLED"|"DELETED" - Filter by purchase order status
- dateFrom? string - Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
- pageSize? int - Number of records to retrieve per page
- page? int - To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned
- dateTo? string - Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
- 'order? string - Order by an any element
xero.accounts: GetQuoteAsPdfHeaders
Represents the Headers record for the operation: getQuoteAsPdf
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetQuoteAttachmentByFileNameHeaders
Represents the Headers record for the operation: getQuoteAttachmentByFileName
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetQuoteAttachmentByIdHeaders
Represents the Headers record for the operation: getQuoteAttachmentById
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetQuoteAttachmentsHeaders
Represents the Headers record for the operation: getQuoteAttachments
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetQuoteHeaders
Represents the Headers record for the operation: getQuote
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetQuoteHistoryHeaders
Represents the Headers record for the operation: getQuoteHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetQuotesHeaders
Represents the Headers record for the operation: getQuotes
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetQuotesQueries
Represents the Queries record for the operation: getQuotes
Fields
- status? string - Filter for quotes of a particular Status
- quoteNumber? string - Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001)
- dateFrom? string - Filter for quotes after a particular date
- expiryDateTo? string - Filter for quotes before a particular date
- contactID? string - Filter for quotes belonging to a particular contact
- page? int - e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote
- dateTo? string - Filter for quotes before a particular date
- expiryDateFrom? string - Filter for quotes expiring after a particular date
- 'order? string - Order by an any element
xero.accounts: GetReceiptAttachmentByFileNameHeaders
Represents the Headers record for the operation: getReceiptAttachmentByFileName
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetReceiptAttachmentByIdHeaders
Represents the Headers record for the operation: getReceiptAttachmentById
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetReceiptAttachmentsHeaders
Represents the Headers record for the operation: getReceiptAttachments
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReceiptHeaders
Represents the Headers record for the operation: getReceipt
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReceiptHistoryHeaders
Represents the Headers record for the operation: getReceiptHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReceiptQueries
Represents the Queries record for the operation: getReceipt
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
xero.accounts: GetReceiptsHeaders
Represents the Headers record for the operation: getReceipts
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReceiptsQueries
Represents the Queries record for the operation: getReceipts
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- 'where? string - Filter by an any element
- 'order? string - Order by an any element
xero.accounts: GetRepeatingInvoiceAttachmentByFileNameHeaders
Represents the Headers record for the operation: getRepeatingInvoiceAttachmentByFileName
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetRepeatingInvoiceAttachmentByIdHeaders
Represents the Headers record for the operation: getRepeatingInvoiceAttachmentById
Fields
- xeroTenantId string - Xero identifier for Tenant
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
xero.accounts: GetRepeatingInvoiceAttachmentsHeaders
Represents the Headers record for the operation: getRepeatingInvoiceAttachments
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetRepeatingInvoiceHeaders
Represents the Headers record for the operation: getRepeatingInvoice
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetRepeatingInvoiceHistoryHeaders
Represents the Headers record for the operation: getRepeatingInvoiceHistory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetRepeatingInvoicesHeaders
Represents the Headers record for the operation: getRepeatingInvoices
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetRepeatingInvoicesQueries
Represents the Queries record for the operation: getRepeatingInvoices
Fields
- 'where? string - Filter by an any element
- 'order? string - Order by an any element
xero.accounts: GetReportAgedPayablesByContactHeaders
Represents the Headers record for the operation: getReportAgedPayablesByContact
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReportAgedPayablesByContactQueries
Represents the Queries record for the operation: getReportAgedPayablesByContact
Fields
- date? string - The date of the Aged Payables By Contact report
- fromDate? string - filter by the from date of the report e.g. 2021-02-01
- contactId string - Unique identifier for a Contact
- toDate? string - filter by the to date of the report e.g. 2021-02-28
xero.accounts: GetReportAgedReceivablesByContactHeaders
Represents the Headers record for the operation: getReportAgedReceivablesByContact
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReportAgedReceivablesByContactQueries
Represents the Queries record for the operation: getReportAgedReceivablesByContact
Fields
- date? string - The date of the Aged Receivables By Contact report
- fromDate? string - filter by the from date of the report e.g. 2021-02-01
- contactId string - Unique identifier for a Contact
- toDate? string - filter by the to date of the report e.g. 2021-02-28
xero.accounts: GetReportBalanceSheetHeaders
Represents the Headers record for the operation: getReportBalanceSheet
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReportBalanceSheetQueries
Represents the Queries record for the operation: getReportBalanceSheet
Fields
- date? string - The date of the Balance Sheet report
- timeframe? "MONTH"|"QUARTER"|"YEAR" - The period size to compare to (MONTH, QUARTER, YEAR)
- trackingOptionID1? string - The tracking option 1 for the Balance Sheet report
- trackingOptionID2? string - The tracking option 2 for the Balance Sheet report
- paymentsOnly? boolean - return a cash basis for the Balance Sheet report
- periods? int - The number of periods for the Balance Sheet report
- standardLayout? boolean - The standard layout boolean for the Balance Sheet report
xero.accounts: GetReportBankSummaryHeaders
Represents the Headers record for the operation: getReportBankSummary
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReportBankSummaryQueries
Represents the Queries record for the operation: getReportBankSummary
Fields
- fromDate? string - filter by the from date of the report e.g. 2021-02-01
- toDate? string - filter by the to date of the report e.g. 2021-02-28
xero.accounts: GetReportBudgetSummaryHeaders
Represents the Headers record for the operation: getReportBudgetSummary
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReportBudgetSummaryQueries
Represents the Queries record for the operation: getReportBudgetSummary
Fields
- date? string - The date for the Bank Summary report e.g. 2018-03-31
- timeframe? int - The period size to compare to (1=month, 3=quarter, 12=year)
- periods? int - The number of periods to compare (integer between 1 and 12)
xero.accounts: GetReportExecutiveSummaryHeaders
Represents the Headers record for the operation: getReportExecutiveSummary
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReportExecutiveSummaryQueries
Represents the Queries record for the operation: getReportExecutiveSummary
Fields
- date? string - The date for the Bank Summary report e.g. 2018-03-31
xero.accounts: GetReportFromIdHeaders
Represents the Headers record for the operation: getReportFromId
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReportProfitAndLossHeaders
Represents the Headers record for the operation: getReportProfitAndLoss
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReportProfitAndLossQueries
Represents the Queries record for the operation: getReportProfitAndLoss
Fields
- fromDate? string - filter by the from date of the report e.g. 2021-02-01
- timeframe? "MONTH"|"QUARTER"|"YEAR" - The period size to compare to (MONTH, QUARTER, YEAR)
- trackingCategoryID? string - The trackingCategory 1 for the ProfitAndLoss report
- trackingOptionID2? string - The tracking option 2 for the ProfitAndLoss report
- paymentsOnly? boolean - Return cash only basis for the ProfitAndLoss report
- trackingCategoryID2? string - The trackingCategory 2 for the ProfitAndLoss report
- toDate? string - filter by the to date of the report e.g. 2021-02-28
- periods? int - The number of periods to compare (integer between 1 and 12)
- trackingOptionID? string - The tracking option 1 for the ProfitAndLoss report
- standardLayout? boolean - Return the standard layout for the ProfitAndLoss report
xero.accounts: GetReportsListHeaders
Represents the Headers record for the operation: getReportsList
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReportTenNinetyNineHeaders
Represents the Headers record for the operation: getReportTenNinetyNine
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReportTenNinetyNineQueries
Represents the Queries record for the operation: getReportTenNinetyNine
Fields
- reportYear? string - The year of the 1099 report
xero.accounts: GetReportTrialBalanceHeaders
Represents the Headers record for the operation: getReportTrialBalance
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetReportTrialBalanceQueries
Represents the Queries record for the operation: getReportTrialBalance
Fields
- date? string - The date for the Trial Balance report e.g. 2018-03-31
- paymentsOnly? boolean - Return cash only basis for the Trial Balance report
xero.accounts: GetTaxRateByTaxTypeHeaders
Represents the Headers record for the operation: getTaxRateByTaxType
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetTaxRatesHeaders
Represents the Headers record for the operation: getTaxRates
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetTaxRatesQueries
Represents the Queries record for the operation: getTaxRates
Fields
- 'where? string - Filter by an any element
- 'order? string - Order by an any element
xero.accounts: GetTrackingCategoriesHeaders
Represents the Headers record for the operation: getTrackingCategories
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetTrackingCategoriesQueries
Represents the Queries record for the operation: getTrackingCategories
Fields
- includeArchived? boolean - e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response
- 'where? string - Filter by an any element
- 'order? string - Order by an any element
xero.accounts: GetTrackingCategoryHeaders
Represents the Headers record for the operation: getTrackingCategory
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetUserHeaders
Represents the Headers record for the operation: getUser
Fields
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetUsersHeaders
Represents the Headers record for the operation: getUsers
Fields
- ifModifiedSince? string - Only records created or modified since this timestamp will be returned
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: GetUsersQueries
Represents the Queries record for the operation: getUsers
Fields
- 'where? string - Filter by an any element
- 'order? string - Order by an any element
xero.accounts: HistoryRecord
Fields
- changes? string - Name of branding theme
- details? string - Details of the history record or note
- user? string - has a value of 0
- dateUTC? string - UTC timestamp of creation date of branding theme
xero.accounts: HistoryRecords
Fields
- historyRecords? HistoryRecord[] - List of history records
xero.accounts: ImportSummary
A summary of the import from setup endpoint
Fields
- organisation? ImportSummaryOrganisation - Import summary of the organisation details
- accounts? ImportSummaryAccounts - Import summary of the accounts
xero.accounts: ImportSummaryAccounts
A summary of the accounts changes
Fields
- 'new? Signed32 - The number of new accounts created
- locked? Signed32 - The number of locked accounts
- updated? Signed32 - The number of accounts updated
- errored? Signed32 - The number of accounts that had an error
- total? Signed32 - The total number of accounts in the org
- newOrUpdated? Signed32 - The number of new or updated accounts
- deleted? Signed32 - The number of accounts deleted
- present? boolean - Whether accounts are present in the organisation
- system? Signed32 - The number of system accounts
xero.accounts: ImportSummaryObject
Fields
- ImportSummary? ImportSummary - Summary of the setup import
xero.accounts: ImportSummaryOrganisation
Fields
- present? boolean - Whether the organisation details are present
xero.accounts: Invoice
Fields
- brandingThemeID? string - See BrandingThemes
- currencyRate? decimal - The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6])
- updatedDateUTC? string - UTC timestamp of last update to the invoice
- validationErrors? ValidationError[] - Displays array of validation error messages from the API
- amountPaid? decimal - Sum of payments received for invoice
- amountCredited? decimal - Sum of all credit notes, over-payments and pre-payments applied to invoice
- payments? Payment[] - See Payments
- creditNotes? CreditNote[] - Details of credit notes that have been applied to an invoice
- subTotal? decimal - Total of invoice excluding taxes. Calculated automatically by Xero from the invoice's line items. Only for ACCPAY and ACCREC invoices, where this opt-in capability is enabled for your organisation, can SubTotal be supplied on write – on a SUBMITTED or AUTHORISED invoice supplied together with TotalTax and Total, it is validated against the calculated line item totals (see RoundingAmount); it is ignored in all other cases. This write behaviour, and the returned value reflecting it, only applies to the Create and Update endpoints (POST/PUT) and to retrieving a single invoice by ID (GET by ID) – it does not apply when listing invoices (GET)
- attachments? Attachment[] - Displays array of attachments from the API
- url? string - URL link to a source document – shown as “Go to [appName]” in the Xero app
- currencyCode? CurrencyCode - Currency code of the invoice
- updatedDateUTCString? string - UTC ISO-8601 formatted timestamp of last update to the invoice
- plannedPaymentDate? string - Shown on bills (Accounts Payable) when this has been set
- invoiceAddresses? InvoiceAddress[] - An array of addresses used to auto calculate sales tax
- totalTax? decimal - Total tax on invoice. Calculated automatically by Xero from the invoice's line items. Only for ACCPAY and ACCREC invoices, where this opt-in capability is enabled for your organisation, can TotalTax be supplied on write – on a SUBMITTED or AUTHORISED invoice supplied together with SubTotal and Total, it is validated against the calculated line item totals (see RoundingAmount); it is ignored in all other cases. This write behaviour, and the returned value reflecting it, only applies to the Create and Update endpoints (POST/PUT) and to retrieving a single invoice by ID (GET by ID) – it does not apply when listing invoices (GET)
- invoiceNumber? string - ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255)
- dueDate? string - Date invoice is due – YYYY-MM-DD
- status? "DRAFT"|"SUBMITTED"|"DELETED"|"AUTHORISED"|"PAID"|"VOIDED" - See Invoice Status Codes
- lineItems? LineItem[] - See LineItems
- amountDue? decimal - Amount remaining to be paid on invoice
- statusAttributeString? string - A string to indicate if a invoice status
- reference? string - ACCREC only – additional reference number
- cISRate? decimal - CIS Deduction rate for the organisation
- hasAttachments boolean(default false) - boolean to indicate if an invoice has an attachment
- prepayments? Prepayment[] - See Prepayments
- sentToContact? boolean - Boolean to set whether the invoice in the Xero app should be marked as “sent”. This can be set only on invoices that have been approved
- enteredTotal? decimal - The total amount as originally entered for the invoice, before any RoundingAmount adjustment is applied. Only applies to ACCPAY and ACCREC invoices, and only if this opt-in capability has been enabled for your organisation. Can only be set while the invoice is DRAFT; once the invoice is no longer DRAFT this reflects Total. This field is only settable and only returned via the Create and Update endpoints (POST/PUT) and when retrieving a single invoice by ID (GET by ID) – it is not returned when listing invoices (GET)
- invoiceID? string - Xero generated unique identifier for invoice
- date? string - Date invoice was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation
- contact? Contact - Contact associated with the invoice
- lineAmountTypes? LineAmountTypes - Whether line amounts of the invoice are tax exclusive, tax inclusive or have no tax
- cISDeduction? decimal - CIS deduction for UK contractors
- expectedPaymentDate? string - Shown on sales invoices (Accounts Receivable) when this has been set
- 'type? "ACCPAY"|"ACCPAYCREDIT"|"APOVERPAYMENT"|"APPREPAYMENT"|"ACCREC"|"ACCRECCREDIT"|"AROVERPAYMENT"|"ARPREPAYMENT" - See Invoice Types
- fullyPaidOnDate? string - The date the invoice was fully paid. Only returned on fully paid invoices
- total? decimal - Total of Invoice tax inclusive (i.e. SubTotal + TotalTax + RoundingAmount). Calculated automatically by Xero from the invoice's line items. Only for ACCPAY and ACCREC invoices, where this opt-in capability is enabled for your organisation, can Total be supplied on write – on a SUBMITTED or AUTHORISED invoice supplied together with SubTotal and TotalTax, it is validated against the calculated line item totals plus RoundingAmount; in all other cases this will be ignored if it does not equal the sum of the LineAmounts. This write behaviour, and the returned value reflecting it, only applies to the Create and Update endpoints (POST/PUT) and to retrieving a single invoice by ID (GET by ID) – it does not apply when listing invoices (GET)
- overpayments? Overpayment[] - See Overpayments
- repeatingInvoiceID? string - Xero generated unique identifier for repeating invoices
- isDiscounted? boolean - boolean to indicate if an invoice has a discount
- hasErrors boolean(default false) - A boolean to indicate if a invoice has an validation errors
- warnings? ValidationError[] - Displays array of warning messages from the API
- totalDiscount? decimal - Total of discounts applied on the invoice line items
- roundingAmount? decimal - An optional rounding adjustment added to SubTotal + TotalTax to give Total (i.e. Total = SubTotal + TotalTax + RoundingAmount). Only applies to ACCPAY and ACCREC invoices, and only if this opt-in capability has been enabled for your organisation. Not validated while the invoice is DRAFT. For SUBMITTED and AUTHORISED invoices, RoundingAmount is only applied when SubTotal, TotalTax and Total are all supplied together, and must be between -0.10 and 0.10 – values outside this range are rejected with a validation error (on DRAFT invoices, an out-of-range value is ignored instead). This field is only settable and only returned via the Create and Update endpoints (POST/PUT) and when retrieving a single invoice by ID (GET by ID) – it is not returned when listing invoices (GET)
xero.accounts: InvoiceAddress
Fields
- invoiceAddressType? "FROM"|"TO" - Indicates whether the address is defined as origin (FROM) or destination (TO)
- addressLine3? string - Third line of a physical address
- addressLine2? string - Second line of a physical address
- addressLine1? string - First line of a physical address
- addressLine4? string - Fourth line of a physical address
- region? string - Region or state of a physical address
- postalCode? string - Postal code of a physical address
- country? string - Country of a physical address
- city? string - City of a physical address
xero.accounts: InvoiceReminder
Fields
- enabled? boolean - setting for on or off
xero.accounts: InvoiceReminders
Fields
- invoiceReminders? InvoiceReminder[] - List of invoice reminder settings
xero.accounts: Invoices
Fields
- pagination? Pagination - Pagination details of the returned page of results
- invoices? Invoice[] - List of invoices
- warnings? ValidationError[] - Displays array of warning messages from the API
xero.accounts: Item
Fields
- salesDetails? Purchase - Sales details for the item
- description? string - The sales description of the item (max length = 4000)
- statusAttributeString? string - Status of object
- updatedDateUTC? string - Last modified date in UTC format
- validationErrors? ValidationError[] - Displays array of validation error messages from the API
- isPurchased? boolean - Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled
- isTrackedAsInventory? boolean - True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set
- inventoryAssetAccountCode? string - The inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item
- quantityOnHand? decimal - The quantity of the item on hand. This will be 0 if
QuantityOnBackOrderis greater than 0
- code string - User defined item code (max length = 30)
- purchaseDescription? string - The purchase description of the item (max length = 4000)
- totalCostPool? decimal - The value of the item on hand. Calculated using average cost accounting
- itemID? string - The Xero identifier for an Item
- name? string - The name of the item (max length = 50)
- isSold? boolean - Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled
- purchaseDetails? Purchase - Purchase details for the item
- quantityOnBackOrder? decimal - The quantity of the item on backorder. This will be 0 if
QuantityOnHandis greater than 0
- quantityAvailable? decimal - The quantity of the item available. This is equal to
QuantityOnHand-QuantityOnBackOrder. This value will be negative ifQuantityOnBackOrderis greater than 0
xero.accounts: Items
Fields
- items? Item[] - List of items
xero.accounts: Journal
Fields
- createdDateUTC? string - Created date UTC format
- journalDate? string - Date the journal was posted
- journalID? string - Xero identifier
- reference? string - reference field for additional indetifying information
- sourceID? string - The identifier for the source transaction (e.g. InvoiceID)
- sourceType? "ACCREC"|"ACCPAY"|"ACCRECCREDIT"|"ACCPAYCREDIT"|"ACCRECPAYMENT"|"ACCPAYPAYMENT"|"ARCREDITPAYMENT"|"APCREDITPAYMENT"|"CASHREC"|"CASHPAID"|"TRANSFER"|"ARPREPAYMENT"|"APPREPAYMENT"|"AROVERPAYMENT"|"APOVERPAYMENT"|"EXPCLAIM"|"EXPPAYMENT"|"MANJOURNAL"|"PAYSLIP"|"WAGEPAYABLE"|"INTEGRATEDPAYROLLPE"|"INTEGRATEDPAYROLLPT"|"EXTERNALSPENDMONEY"|"INTEGRATEDPAYROLLPTPAYMENT"|"INTEGRATEDPAYROLLCN" - The journal source type. The type of transaction that created the journal
- journalNumber? int - Xero generated journal number
- journalLines? JournalLine[] - See JournalLines
xero.accounts: JournalLine
Fields
- journalLineID? string - Xero identifier for Journal
- taxType? string - The tax type from taxRates
- taxAmount? decimal - Total tax on a journal line
- accountID? string - See Accounts
- description? string - The description from the source transaction line item. Only returned if populated
- trackingCategories? TrackingCategory[] - Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements
- netAmount? decimal - Net amount of journal line. This will be a positive value for a debit and negative for a credit
- taxName? string - see TaxRates
- accountCode? string - See Accounts
- accountType? AccountType - Type of the account the journal line is posted to
- grossAmount? decimal - Gross amount of journal line (NetAmount + TaxAmount)
- accountName? string - See AccountCodes
xero.accounts: Journals
Fields
- journals? Journal[] - List of journals
- warnings? ValidationError[] - Displays array of warning messages from the API
xero.accounts: LineItem
Fields
- itemCode? string - Code of the item used on the line item (see Items)
- description? string - Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character
- accountID? string - The associated account ID related to this line item
- tracking? LineItemTracking[] - Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements
- quantity? decimal - LineItem Quantity
- unitAmount? decimal - LineItem Unit Amount
- discountRate? decimal - Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts
- discountAmount? decimal - Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts
- salesTaxCodeId? decimal - The ID of the sales tax code
- taxBreakdown? TaxBreakdownComponent[] - An array of tax components defined for this line item
- taxType? string - The tax type from TaxRates
- item? LineItemItem - Item details of the line item
- taxAmount? decimal - The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct
- accountCode? string - See Accounts
- lineAmount? decimal - If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount
- repeatingInvoiceID? string - The Xero identifier for a Repeating Invoice
- taxability? "TAXABLE"|"NON_TAXABLE"|"EXEMPT"|"PART_TAXABLE"|"NOT_APPLICABLE" - The type of taxability
- lineItemID? string - LineItem unique ID
xero.accounts: LineItemItem
Fields
- Code? string - User defined item code (max length = 30)
- Name? string - The name of the item (max length = 50)
- ItemID? string - The Xero identifier for an Item
xero.accounts: LineItemTracking
Fields
- trackingCategoryID? string - The Xero identifier for a tracking category
- trackingOptionID? string - The Xero identifier for a tracking category option
- option? string - See Tracking Options
- name? string - The name of the tracking category
xero.accounts: LinkedTransaction
Fields
- status? "APPROVED"|"DRAFT"|"ONDRAFT"|"BILLED"|"VOIDED" - Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED
- targetTransactionID? string - Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice
- 'type? "BILLABLEEXPENSE" - This will always be BILLABLEEXPENSE. More types may be added in future
- updatedDateUTC? string - The last modified date in UTC format
- validationErrors? ValidationError[] - Displays array of validation error messages from the API
- sourceLineItemID? string - The line item identifier from the source transaction
- sourceTransactionTypeCode? "ACCPAY"|"SPEND" - The Type of the source tranasction. This will be ACCPAY if the linked transaction was created from an invoice and SPEND if it was created from a bank transaction
- sourceTransactionID? string - Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice
- linkedTransactionID? string - The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9
- contactID? string - Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED
- targetLineItemID? string - The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID
xero.accounts: LinkedTransactions
Fields
- linkedTransactions? LinkedTransaction[] - List of linked transactions (billable expenses)
xero.accounts: ManualJournal
Fields
- status? "DRAFT"|"POSTED"|"DELETED"|"VOIDED"|"ARCHIVED" - See Manual Journal Status Codes
- statusAttributeString? string - A string to indicate if a invoice status
- updatedDateUTC? string - Last modified date UTC format
- narration string - Description of journal being posted
- validationErrors? ValidationError[] - Displays array of validation error messages from the API
- hasAttachments boolean(default false) - Boolean to indicate if a manual journal has an attachment
- attachments? Attachment[] - Displays array of attachments from the API
- date? string - Date journal was posted – YYYY-MM-DD
- url? string - Url link to a source document – shown as “Go to [appName]” in the Xero app
- lineAmountTypes? LineAmountTypes - Whether line amounts of the manual journal are tax exclusive, tax inclusive or have no tax
- manualJournalID? string - The Xero identifier for a Manual Journal
- warnings? ValidationError[] - Displays array of warning messages from the API
- journalLines? ManualJournalLine[] - See JournalLines
- showOnCashBasisReports? boolean - Boolean – default is true if not specified
xero.accounts: ManualJournalLine
Fields
- taxType? string - The tax type from TaxRates
- taxAmount? decimal - The calculated tax amount based on the TaxType and LineAmount
- isBlank? boolean - is the line blank
- accountID? string - See Accounts
- description? string - Description for journal line
- tracking? TrackingCategory[] - Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements
- accountCode? string - See Accounts
- lineAmount? decimal - total for line. Debits are positive, credits are negative value
xero.accounts: ManualJournals
Fields
- pagination? Pagination - Pagination details of the returned page of results
- manualJournals? ManualJournal[] - List of manual journals
- warnings? ValidationError[] - Displays array of warning messages from the API
xero.accounts: OAuth2RefreshTokenGrantConfig
Closed record
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://identity.xero.com/connect/token") - Refresh URL
xero.accounts: OnlineInvoice
Fields
- onlineInvoiceUrl? string - the URL to an online invoice
xero.accounts: OnlineInvoices
Fields
- onlineInvoices? OnlineInvoice[] - List of online invoices
xero.accounts: Organisation
Fields
- timezone? TimeZone - Time zone of the organisation
- organisationID? string - Unique Xero identifier
- paymentTerms? PaymentTerm - Default payment terms of the organisation
- name? string - Display name of organisation shown in Xero
- employerIdentificationNumber? string - Shown if set. US Only
- addresses? AddressForOrganisation[] - Address details for organisation – see Addresses
- defaultPurchasesTax? string - The default for LineAmountTypes on purchase transactions
- endOfYearLockDate? string - Shown if set. See lock dates
- phones? Phone[] - Phones details for organisation – see Phones
- version? "AU"|"NZ"|"GLOBAL"|"UK"|"US"|"AUONRAMP"|"NZONRAMP"|"GLOBALONRAMP"|"UKONRAMP"|"USONRAMP" - See Version Types
- paysTax? boolean - Boolean to describe if organisation is registered with a local tax authority i.e. true, false
- registrationNumber? string - Shows for New Zealand, Australian and UK organisations
- organisationStatus? string - Will be set to ACTIVE if you can connect to organisation via the Xero API
- taxNumber? string - Shown if set. Displays in the Xero UI as Tax File Number (AU), GST Number (NZ), VAT Number (UK) and Tax ID Number (US & Global)
- countryCode? CountryCode - Country code of the organisation
- externalLinks? ExternalLink[] - Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn. You can also add link to your website here. Shown if Organisation settings is updated in Xero. See ExternalLinks below
- defaultSalesTax? string - The default for LineAmountTypes on sales transactions
- organisationEntityType? "ACCOUNTING_PRACTICE"|"COMPANY"|"CHARITY"|"CLUB_OR_SOCIETY"|"INDIVIDUAL"|"LOOK_THROUGH_COMPANY"|"NOT_FOR_PROFIT"|"PARTNERSHIP"|"S_CORPORATION"|"SELF_MANAGED_SUPERANNUATION_FUND"|"SOLE_TRADER"|"SUPERANNUATION_FUND"|"TRUST"|"PERSONAL"|"SINGLEMEMBERLLC"|"CCORPORATIONLLC"|"PARTNERSHIPLLC"|"SCORPORATIONLLC"|"LLC"|"NOTLLC"|"UNSPECIFIED" - Organisation Entity Type
- shortCode? string - A unique identifier for the organisation. Potential uses
- legalName? string - Organisation name shown on Reports
- periodLockDate? string - Shown if set. See lock dates
- organisationType? "ACCOUNTING_PRACTICE"|"COMPANY"|"CHARITY"|"CLUB_OR_SOCIETY"|"INDIVIDUAL"|"LOOK_THROUGH_COMPANY"|"NOT_FOR_PROFIT"|"PARTNERSHIP"|"S_CORPORATION"|"SELF_MANAGED_SUPERANNUATION_FUND"|"SOLE_TRADER"|"SUPERANNUATION_FUND"|"TRUST"|"PERSONAL"|"SINGLEMEMBERLLC"|"CCORPORATIONLLC"|"PARTNERSHIPLLC"|"SCORPORATIONLLC"|"LLC"|"NOTLLC"|"UNSPECIFIED" - Organisation Type
- salesTaxBasis? "PAYMENTS"|"INVOICE"|"NONE"|"CASH"|"ACCRUAL"|"FLATRATECASH"|"FLATRATEACCRUAL"|"ACCRUALS" - The accounting basis used for tax returns. See Sales Tax Basis
- edition? "BUSINESS"|"PARTNER" - BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing)
- financialYearEndMonth? int - Calendar Month e.g. 1-12
- createdDateUTC? string - Timestamp when the organisation was created in Xero
- aPIKey? string - Display a unique key used for Xero-to-Xero transactions
- salesTaxPeriod? "MONTHLY"|"QUARTERLY1"|"QUARTERLY2"|"QUARTERLY3"|"ANNUALLY"|"ONEMONTHS"|"TWOMONTHS"|"SIXMONTHS"|"1MONTHLY"|"2MONTHLY"|"3MONTHLY"|"6MONTHLY"|"QUARTERLY"|"YEARLY"|"NONE" - The frequency with which tax returns are processed. See Sales Tax Period
- isDemoCompany? boolean - Boolean to describe if organisation is a demo company
- financialYearEndDay? int - Calendar day e.g. 0-31
- lineOfBusiness? string - Description of business type as defined in Organisation settings
- baseCurrency? CurrencyCode - Base currency of the organisation
- 'class? "DEMO"|"TRIAL"|"STARTER"|"STANDARD"|"PREMIUM"|"PREMIUM_20"|"PREMIUM_50"|"PREMIUM_100"|"LEDGER"|"GST_CASHBOOK"|"NON_GST_CASHBOOK"|"ULTIMATE"|"LITE"|"ULTIMATE_10"|"ULTIMATE_20"|"ULTIMATE_50"|"ULTIMATE_100"|"IGNITE"|"GROW"|"COMPREHENSIVE"|"SIMPLE"|"BASICLITE"|"ULTRA" - Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)
xero.accounts: Organisations
Fields
- organisations? Organisation[] - List of organisations
xero.accounts: Overpayment
Fields
- status? "AUTHORISED"|"PAID"|"VOIDED" - See Overpayment Status Codes
- lineItems? LineItem[] - See Overpayment Line Items
- allocations? Allocation[] - See Allocations
- updatedDateUTC? string - UTC timestamp of last update to the overpayment
- currencyRate? decimal - The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used
- hasAttachments boolean(default false) - boolean to indicate if a overpayment has an attachment
- reference? string - An optional description for Overpayment
- appliedAmount? decimal - The amount of applied to an invoice
- payments? Payment[] - See Payments
- subTotal? decimal - The subtotal of the overpayment excluding taxes
- attachments? Attachment[] - See Attachments
- date? string - The date the overpayment is created YYYY-MM-DD
- contact? Contact - Contact associated with the overpayment
- lineAmountTypes? LineAmountTypes - Whether line amounts of the overpayment are tax exclusive, tax inclusive or have no tax
- updatedDateUTCString? string - UTC ISO-8601 formatted timestamp of last update to the overpayment
- currencyCode? CurrencyCode - Currency code of the overpayment
- 'type? "RECEIVE-OVERPAYMENT"|"SPEND-OVERPAYMENT"|"AROVERPAYMENT" - See Overpayment Types
- remainingCredit? decimal - The remaining credit balance on the overpayment
- totalTax? decimal - The total tax on the overpayment
- total? decimal - The total of the overpayment (subtotal + total tax)
- overpaymentID? string - Xero generated unique identifier
xero.accounts: Overpayments
Fields
- pagination? Pagination - Pagination details of the returned page of results
- overpayments? Overpayment[] - List of overpayments
- warnings? ValidationError[] - Displays array of warning messages from the API
xero.accounts: Pagination
Fields
- pageCount? int - Total number of pages available
- pageSize? int - Number of items returned per page
- page? int - Current page number
- itemCount? int - Total number of items available
xero.accounts: Payment
Fields
- account? Account - Account the payment is made from or to
- invoice? Invoice - Invoice the payment is applied to
- currencyRate? decimal - Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500
- updatedDateUTC? string - UTC timestamp of last update to the payment
- batchPaymentID? string - Present if the payment was created as part of a batch
- validationErrors? ValidationError[] - Displays array of validation error messages from the API
- creditNote? CreditNote - Credit note the payment is applied to
- paymentID? string - The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
- batchPayment? BatchPayment - Batch payment the payment belongs to
- updatedDateUTCString? string - UTC ISO-8601 formatted timestamp of last update to the payment
- particulars? string - The suppliers bank account number the payment is being made to
- paymentType? "ACCRECPAYMENT"|"ACCPAYPAYMENT"|"ARCREDITPAYMENT"|"APCREDITPAYMENT"|"AROVERPAYMENTPAYMENT"|"ARPREPAYMENTPAYMENT"|"APPREPAYMENTPAYMENT"|"APOVERPAYMENTPAYMENT" - See Payment Types
- hasAccount boolean(default false) - A boolean to indicate if a contact has an validation errors
- invoiceNumber? string - Number of invoice or credit note you are applying payment to e.g.INV-4003
- overpayment? Overpayment - Overpayment the payment is applied to
- status? "AUTHORISED"|"DELETED" - The status of the payment
- creditNoteNumber? string - Number of invoice or credit note you are applying payment to e.g. INV-4003
- statusAttributeString? string - A string to indicate if a invoice status
- reference? string - An optional description for the payment e.g. Direct Debit
- amount? decimal - The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00
- bankAmount? decimal - The amount of the payment in the currency of the bank account
- isReconciled? boolean - An optional parameter for the payment. A boolean indicating whether you would like the payment to be created as reconciled when using PUT, or whether a payment has been reconciled when using GET
- code? string - Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value)
- date? string - Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
- details? string - The information to appear on the supplier's bank account
- prepayment? Prepayment - Prepayment the payment is applied to
- hasValidationErrors boolean(default false) - A boolean to indicate if a contact has an validation errors
- warnings? ValidationError[] - Displays array of warning messages from the API
- bankAccountNumber? string - The suppliers bank account number the payment is being made to
xero.accounts: PaymentDelete
Fields
- status string(default "DELETED") - The status of the payment
xero.accounts: Payments
Fields
- pagination? Pagination - Pagination details of the returned page of results
- payments? Payment[] - List of payments
- warnings? ValidationError[] - Displays array of warning messages from the API
xero.accounts: PaymentService
Fields
- PaymentServiceID? string - Xero identifier
- PaymentServiceName? string - Name of payment service
- PaymentServiceUrl? string - The custom payment URL
- PayNowText? string - The text displayed on the Pay Now button in Xero Online Invoicing. If this is not set it will default to Pay by credit card
- PaymentServiceType? string - This will always be CUSTOM for payment services created via the API.
- ValidationErrors? ValidationError[] - Displays array of validation error messages from the API
xero.accounts: PaymentServices
Fields
- paymentServices? PaymentService[] - List of payment services
xero.accounts: PaymentTerm
Fields
- sales? Bill - Default payment terms for sales invoices
- bills? Bill - Default payment terms for bills
xero.accounts: Phone
Fields
- phoneAreaCode? string - max length = 10
- phoneCountryCode? string - max length = 20
- phoneType? "DEFAULT"|"DDI"|"MOBILE"|"FAX"|"OFFICE" - Type of the phone number
- phoneNumber? string - max length = 50
xero.accounts: PostSetupHeaders
Represents the Headers record for the operation: postSetup
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: Prepayment
Fields
- status? "AUTHORISED"|"PAID"|"VOIDED" - See Prepayment Status Codes
- lineItems? LineItem[] - See Prepayment Line Items
- brandingThemeID? string - The unique identifier of the branding template applied to a receive prepayment
- allocations? Allocation[] - See Allocations
- updatedDateUTC? string - UTC timestamp of last update to the prepayment
- currencyRate? decimal - The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used
- reference? string - Returns Invoice number field. Reference field isn't available
- hasAttachments boolean(default false) - boolean to indicate if a prepayment has an attachment
- appliedAmount? decimal - The amount of applied to an invoice
- payments? Payment[] - See Payments
- subTotal? decimal - The subtotal of the prepayment excluding taxes
- attachments? Attachment[] - See Attachments
- date? string - The date the prepayment is created YYYY-MM-DD
- contact? Contact - Contact associated with the prepayment
- lineAmountTypes? LineAmountTypes - Whether line amounts of the prepayment are tax exclusive, tax inclusive or have no tax
- updatedDateUTCString? string - UTC ISO-8601 formatted timestamp of last update to the prepayment
- currencyCode? CurrencyCode - Currency code of the prepayment
- 'type? "RECEIVE-PREPAYMENT"|"SPEND-PREPAYMENT"|"ARPREPAYMENT"|"APPREPAYMENT" - See Prepayment Types
- prepaymentID? string - Xero generated unique identifier
- remainingCredit? decimal - The remaining credit balance on the prepayment
- totalTax? decimal - The total tax on the prepayment
- total? decimal - The total of the prepayment(subtotal + total tax)
- invoiceNumber? string - Returns Invoice number for prepayment receive document only
xero.accounts: Prepayments
Fields
- pagination? Pagination - Pagination details of the returned page of results
- prepayments? Prepayment[] - List of prepayments
- warnings? ValidationError[] - Displays array of warning messages from the API
xero.accounts: Purchase
Fields
- taxType? string - The tax type from TaxRates
- unitPrice? decimal - Unit Price of the item. By default UnitPrice is rounded to two decimal places. You can use 4 decimal places by adding the unitdp=4 querystring parameter to your request
- accountCode? string - Default account code to be used for purchased/sale. Not applicable to the purchase details of tracked items
- cOGSAccountCode? string - Cost of goods sold account. Only applicable to the purchase details of tracked items
xero.accounts: PurchaseOrder
Fields
- brandingThemeID? string - See BrandingThemes
- deliveryInstructions? string - A free text feild for instructions (500 characters max)
- telephone? string - The phone number for the person accepting the delivery
- currencyRate? decimal - The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used
- updatedDateUTC? string - Last modified date UTC format
- validationErrors? ValidationError[] - Displays array of validation error messages from the API
- deliveryAddress? string - The address the goods are to be delivered to
- deliveryDate? string - Date the goods are to be delivered – YYYY-MM-DD
- subTotal? decimal - Total of purchase order excluding taxes
- attachments? Attachment[] - Displays array of attachments from the API
- currencyCode? CurrencyCode - Currency code of the purchase order
- attentionTo? string - The person that the delivery is going to
- totalTax? decimal - Total tax on purchase order
- purchaseOrderID? string - Xero generated unique identifier for purchase order
- status? "DRAFT"|"SUBMITTED"|"AUTHORISED"|"BILLED"|"DELETED" - See Purchase Order Status Codes
- lineItems? LineItem[] - See LineItems
- expectedArrivalDate? string - The date the goods are expected to arrive
- purchaseOrderNumber? string - Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)
- statusAttributeString? string - A string to indicate if a invoice status
- reference? string - Additional reference number
- hasAttachments boolean(default false) - boolean to indicate if a purchase order has an attachment
- sentToContact? boolean - Boolean to set whether the purchase order should be marked as “sent”. This can be set only on purchase orders that have been approved or billed
- date? string - Date purchase order was issued – YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation
- contact? Contact - Contact associated with the purchase order
- lineAmountTypes? LineAmountTypes - Whether line amounts of the purchase order are tax exclusive, tax inclusive or have no tax
- total? decimal - Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax)
- warnings? ValidationError[] - Displays array of warning messages from the API
- totalDiscount? decimal - Total of discounts applied on the purchase order line items
xero.accounts: PurchaseOrders
Fields
- pagination? Pagination - Pagination details of the returned page of results
- purchaseOrders? PurchaseOrder[] - List of purchase orders
- warnings? ValidationError[] - Displays array of warning messages from the API
xero.accounts: Quote
Fields
- status? QuoteStatusCodes - Status of the quote
- lineItems? LineItem[] - See LineItems
- expiryDate? string - Date the quote expires – YYYY-MM-DD
- brandingThemeID? string - See BrandingThemes
- statusAttributeString? string - A string to indicate if a invoice status
- currencyRate? decimal - The currency rate for a multicurrency quote
- updatedDateUTC? string - Last modified date UTC format
- quoteID? string - QuoteID GUID is automatically generated and is returned after create or GET
- validationErrors? ValidationError[] - Displays array of validation error messages from the API
- reference? string - Additional reference number
- terms? string - Terms of the quote
- title? string - Title text for the quote
- subTotal? decimal - Total of quote excluding taxes
- date? string - Date quote was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation
- contact? Contact - Contact associated with the quote
- lineAmountTypes? QuoteLineAmountTypes - Whether line amounts of the quote are tax exclusive, tax inclusive or have no tax
- currencyCode? CurrencyCode - Currency code of the quote
- quoteNumber? string - Unique alpha numeric code identifying a quote (Max Length = 255)
- totalTax? decimal - Total tax on quote
- dateString? string - Date the quote was issued (YYYY-MM-DD)
- total? decimal - Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts
- summary? string - Summary text for the quote
- expiryDateString? string - Date the quote expires – YYYY-MM-DD
- totalDiscount? decimal - Total of discounts applied on the quote line items
xero.accounts: Quotes
Fields
- quotes? Quote[] - List of quotes
xero.accounts: Receipt
Fields
- status? "DRAFT"|"SUBMITTED"|"AUTHORISED"|"DECLINED"|"VOIDED" - Current status of receipt – see status types
- lineItems? LineItem[] - Line items of the receipt
- user? User - User who created the receipt
- updatedDateUTC? string - Last modified date UTC format
- validationErrors? ValidationError[] - Displays array of validation error messages from the API
- reference? string - Additional reference number
- hasAttachments boolean(default false) - boolean to indicate if a receipt has an attachment
- subTotal? decimal - Total of receipt excluding taxes
- attachments? Attachment[] - Displays array of attachments from the API
- date? string - Date of receipt – YYYY-MM-DD
- url? string - URL link to a source document – shown as “Go to [appName]” in the Xero app
- contact? Contact - Contact associated with the receipt
- lineAmountTypes? LineAmountTypes - Whether line amounts of the receipt are tax exclusive, tax inclusive or have no tax
- receiptID? string - Xero generated unique identifier for receipt
- totalTax? decimal - Total tax on receipt
- total? decimal - Total of receipt tax inclusive (i.e. SubTotal + TotalTax)
- warnings? ValidationError[] - Displays array of warning messages from the API
- receiptNumber? string - Xero generated sequence number for receipt in current claim for a given user
xero.accounts: Receipts
Fields
- receipts? Receipt[] - List of receipts
xero.accounts: RepeatingInvoice
Fields
- status? "DRAFT"|"AUTHORISED"|"DELETED" - One of the following - DRAFT or AUTHORISED – See Invoice Status Codes
- lineItems? LineItem[] - See LineItems
- brandingThemeID? string - See BrandingThemes
- reference? string - ACCREC only – additional reference number
- hasAttachments boolean(default false) - Boolean to indicate if an invoice has an attachment
- approvedForSending boolean(default false) - Boolean to indicate whether the invoice has been approved for sending
- subTotal? decimal - Total of invoice excluding taxes
- attachments? Attachment[] - Displays array of attachments from the API
- contact? Contact - Contact associated with the repeating invoice template
- lineAmountTypes? LineAmountTypes - Whether line amounts of the repeating invoice template are tax exclusive, tax inclusive or have no tax
- includePDF boolean(default false) - Boolean to indicate whether to include PDF attachment
- currencyCode? CurrencyCode - Currency code of the repeating invoice template
- sendCopy boolean(default false) - Boolean to indicate whether a copy is sent to sender's email
- 'type? "ACCPAY"|"ACCREC" - See Invoice Types
- totalTax? decimal - Total tax on invoice
- schedule? Schedule - Schedule on which the repeating invoice is created
- total? decimal - Total of Invoice tax inclusive (i.e. SubTotal + TotalTax)
- repeatingInvoiceID? string - Xero generated unique identifier for repeating invoice template
- iD? string - Xero generated unique identifier for repeating invoice template
- markAsSent boolean(default false) - Boolean to indicate whether the invoice in the Xero app displays as "sent"
xero.accounts: RepeatingInvoices
Fields
- repeatingInvoices? RepeatingInvoice[] - List of repeating invoices
xero.accounts: Report
Fields
- ReportName? string - See Prepayment Types
- ReportType? "AgedPayablesByContact" - See Prepayment Types
- ReportTitle? string - See Prepayment Types
- ReportDate? string - Date of report
- UpdatedDateUTC? string - Updated Date
- Contacts? TenNinetyNineContact[] - Contacts included in the 1099 report
xero.accounts: ReportAttribute
Fields
- Id? string - Identifier of the report attribute
- Value? string - Value of the report attribute
xero.accounts: ReportCell
Fields
- value? string - Value of the report cell
- attributes? ReportAttribute[] - Attributes of the report cell
xero.accounts: ReportFields
Fields
- description? string - Description of the report field
- fieldID? string - Identifier of the report field
- value? string - Value of the report field
xero.accounts: ReportRow
Fields
- rowType? RowType - Type of the report row
- title? string - Title of the report row
- cells? ReportCell[] - Cells of the report row
xero.accounts: ReportRows
Fields
- rowType? RowType - Type of the report row
- title? string - Title of the report row
- cells? ReportCell[] - Cells of the report row
- rows? ReportRow[] - Nested rows of the report section
xero.accounts: Reports
Fields
- reports? Report[] - List of reports
xero.accounts: ReportWithRow
Fields
- ReportID? string - ID of the Report
- ReportName? string - Name of the report
- ReportTitle? string - Title of the report
- ReportType? string - The type of report (BalanceSheet,ProfitLoss, etc)
- ReportTitles? string[] - Report titles array (3 to 4 strings with the report name, orgnisation name and time frame of report)
- ReportDate? string - Date of report
- Rows? ReportRows[] - Rows of the report
- UpdatedDateUTC? string - Updated Date
- Fields? ReportFields[] - Fields of the report
xero.accounts: ReportWithRows
Fields
- reports? ReportWithRow[] - List of reports
xero.accounts: RequestEmpty
Fields
- status? string - Need at least one field to create an empty JSON payload
xero.accounts: SalesTrackingCategory
Fields
- trackingCategoryName? string - The default sales tracking category name for contacts
- trackingOptionName? string - The default purchase tracking category name for contacts
xero.accounts: Schedule
Fields
- startDate? string - Date the first invoice of the current version of the repeating schedule was generated (changes when repeating invoice is edited)
- nextScheduledDate? string - The calendar date of the next invoice in the schedule to be generated
- period? int - Integer used with the unit e.g. 1 (every 1 week), 2 (every 2 months)
- dueDateType? "DAYSAFTERBILLDATE"|"DAYSAFTERBILLMONTH"|"DAYSAFTERINVOICEDATE"|"DAYSAFTERINVOICEMONTH"|"OFCURRENTMONTH"|"OFFOLLOWINGMONTH" - the payment terms
- unit? "WEEKLY"|"MONTHLY" - One of the following - WEEKLY or MONTHLY
- dueDate? int - Integer used with due date type e.g 20 (of following month), 31 (of current month)
- endDate? string - Invoice end date – only returned if the template has an end date set
xero.accounts: Setup
Fields
- ConversionDate? ConversionDate - Conversion date from which balances are recorded
- ConversionBalances? ConversionBalances[] - Balance supplied for each account that has a value as at the conversion date.
- Accounts? Account[] - Chart of accounts to set up
xero.accounts: TaxBreakdownComponent
Fields
- exemptAmount? decimal - The amount that is exempt
- jurisdictionRegion? string - Name identifying the region within the country
- 'type? "SYSGST/USCOUNTRY"|"SYSGST/USSTATE"|"SYSGST/USCOUNTY"|"SYSGST/USCITY"|"SYSGST/USSPECIAL" - The type of the jurisdiction
- taxAmount? decimal - The amount of the tax
- taxPercentage? decimal - The percentage of the tax
- taxableAmount? decimal - The amount that is taxable
- taxComponentId? string - The unique ID number of this component
- stateAssignedNo? string - The state assigned number of the jurisdiction
- nonTaxableAmount? decimal - The amount that is not taxable
- name? string - The name of the jurisdiction
xero.accounts: TaxComponent
Fields
- isCompound? boolean - Boolean to describe if Tax rate is compounded
- rate? decimal - Tax Rate (up to 4dp)
- isNonRecoverable? boolean - Boolean to describe if tax rate is non-recoverable. Non-recoverable rates are only applicable to Canadian organisations
- name? string - Name of Tax Component
xero.accounts: TaxRate
Fields
- status? "ACTIVE"|"DELETED"|"ARCHIVED"|"PENDING" - See Status Codes
- taxType? string - The tax type
- canApplyToExpenses? boolean - Boolean to describe if tax rate can be used for expense accounts i.e. true,false
- canApplyToAssets? boolean - Boolean to describe if tax rate can be used for asset accounts i.e. true,false
- taxComponents? TaxComponent[] - See TaxComponents
- canApplyToLiabilities? boolean - Boolean to describe if tax rate can be used for liability accounts i.e. true,false
- displayTaxRate? decimal - Tax Rate (decimal to 4dp) e.g 12.5000
- effectiveRate? decimal - Effective Tax Rate (decimal to 4dp) e.g 12.5000
- reportTaxType? "AVALARA"|"BASEXCLUDED"|"CAPITALSALESOUTPUT"|"CAPITALEXPENSESINPUT"|"ECOUTPUT"|"ECOUTPUTSERVICES"|"ECINPUT"|"ECACQUISITIONS"|"EXEMPTEXPENSES"|"EXEMPTINPUT"|"EXEMPTOUTPUT"|"GSTONIMPORTS"|"INPUT"|"INPUTTAXED"|"MOSSSALES"|"NONE"|"NONEOUTPUT"|"OUTPUT"|"PURCHASESINPUT"|"SALESOUTPUT"|"EXEMPTCAPITAL"|"EXEMPTEXPORT"|"CAPITALEXINPUT"|"GSTONCAPIMPORTS"|"GSTONCAPITALIMPORTS"|"REVERSECHARGES"|"PAYMENTS"|"INVOICE"|"CASH"|"ACCRUAL"|"FLATRATECASH"|"FLATRATEACCRUAL"|"ACCRUALS"|"TXCA"|"SRCAS"|"DSOUTPUT"|"BLINPUT2"|"EPINPUT"|"IMINPUT2"|"MEINPUT"|"IGDSINPUT2"|"ESN33OUTPUT"|"OPINPUT"|"OSOUTPUT"|"TXN33INPUT"|"TXESSINPUT"|"TXREINPUT"|"TXPETINPUT"|"NRINPUT"|"ES33OUTPUT"|"ZERORATEDINPUT"|"ZERORATEDOUTPUT"|"DRCHARGESUPPLY"|"DRCHARGE"|"CAPINPUT"|"CAPIMPORTS"|"IMINPUT"|"INPUT2"|"CIUINPUT"|"SRINPUT"|"OUTPUT2"|"SROUTPUT"|"CAPOUTPUT"|"SROUTPUT2"|"CIUOUTPUT"|"ZROUTPUT"|"ZREXPORT"|"ACC28PLUS"|"ACCUPTO28"|"OTHEROUTPUT"|"SHOUTPUT"|"ZRINPUT"|"BADDEBT"|"OTHERINPUT"|"BADDEBTRELIEF"|"IGDSINPUT3"|"SROVR"|"TOURISTREFUND"|"TXRCN33"|"TXRCRE"|"TXRCESS"|"TXRCTS"|"CAPEXINPUT"|"UNDEFINED"|"CAPEXOUTPUT"|"ZEROEXPOUTPUT"|"GOODSIMPORT"|"NONEINPUT"|"NOTREPORTED"|"SROVRRS"|"SROVRLVG"|"SRLVG"|"IM"|"IMESS"|"IMN33"|"IMRE"|"BADDEBTRECOVERY"|"USSALESTAX"|"BLINPUT3" - See ReportTaxTypes
- canApplyToEquity? boolean - Boolean to describe if tax rate can be used for equity accounts i.e true,false
- name? string - Name of tax rate
- canApplyToRevenue? boolean - Boolean to describe if tax rate can be used for revenue accounts i.e. true,false
xero.accounts: TaxRates
Fields
- taxRates? TaxRate[] - List of tax rates
xero.accounts: TenNinetyNineContact
Fields
- Box1? decimal - Box 1 on 1099 Form
- Box2? decimal - Box 2 on 1099 Form
- Box3? decimal - Box 3 on 1099 Form
- Box4? decimal - Box 4 on 1099 Form
- Box5? decimal - Box 5 on 1099 Form
- Box6? decimal - Box 6 on 1099 Form
- Box7? decimal - Box 7 on 1099 Form
- Box8? decimal - Box 8 on 1099 Form
- Box9? decimal - Box 9 on 1099 Form
- Box10? decimal - Box 10 on 1099 Form
- Box11? decimal - Box 11 on 1099 Form
- Box13? decimal - Box 13 on 1099 Form
- Box14? decimal - Box 14 on 1099 Form
- Name? string - Contact name on 1099 Form
- FederalTaxIDType? string - Contact Fed Tax ID type
- City? string - Contact city on 1099 Form
- Zip? string - Contact zip on 1099 Form
- State? string - Contact State on 1099 Form
- Email? string - Contact email on 1099 Form
- StreetAddress? string - Contact address on 1099 Form
- TaxID? string - Contact tax id on 1099 Form
- ContactId? string - Contact contact id
- LegalName? string - Contact legal name
- BusinessName? string - Contact business name
- FederalTaxClassification? "SOLE_PROPRIETOR"|"PARTNERSHIP"|"TRUST_OR_ESTATE"|"NONPROFIT"|"C_CORP"|"S_CORP"|"OTHER" - Contact federal tax classification
xero.accounts: TrackingCategories
Fields
- trackingCategories? TrackingCategory[] - List of tracking categories
xero.accounts: TrackingCategory
Fields
- status? "ACTIVE"|"ARCHIVED"|"DELETED" - The status of a tracking category
- options? TrackingOption[] - See Tracking Options
- trackingCategoryID? string - The Xero identifier for a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
- trackingOptionID? string - The Xero identifier for a tracking option e.g. dc54c220-0140-495a-b925-3246adc0075f
- option? string - The option name of the tracking option e.g. East, West (max length = 100)
- name? string - The name of the tracking category e.g. Department, Region (max length = 100)
xero.accounts: TrackingOption
Fields
- status? "ACTIVE"|"ARCHIVED"|"DELETED" - The status of a tracking option
- trackingCategoryID? string - Filter by a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
- trackingOptionID? string - The Xero identifier for a tracking option e.g. ae777a87-5ef3-4fa0-a4f0-d10e1f13073a
- name? string - The name of the tracking option e.g. Marketing, East (max length = 100)
xero.accounts: TrackingOptions
Fields
- options? TrackingOption[] - List of tracking options
xero.accounts: TrackingReference
Fields
- trackingCategoryID string - The Xero identifier for a tracking category
- trackingOptionID string - The Xero identifier for a tracking category option
- option? string - See Tracking Options
- name? string - The name of the tracking category
xero.accounts: UpdateAccountAttachmentByFileNameHeaders
Represents the Headers record for the operation: updateAccountAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateAccountHeaders
Represents the Headers record for the operation: updateAccount
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateBankTransactionAttachmentByFileNameHeaders
Represents the Headers record for the operation: updateBankTransactionAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateBankTransactionHeaders
Represents the Headers record for the operation: updateBankTransaction
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateBankTransactionQueries
Represents the Queries record for the operation: updateBankTransaction
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
xero.accounts: UpdateBankTransferAttachmentByFileNameHeaders
Represents the Headers record for the operation: updateBankTransferAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateContactAttachmentByFileNameHeaders
Represents the Headers record for the operation: updateContactAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateContactGroupHeaders
Represents the Headers record for the operation: updateContactGroup
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateContactHeaders
Represents the Headers record for the operation: updateContact
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateCreditNoteAttachmentByFileNameHeaders
Represents the Headers record for the operation: updateCreditNoteAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateCreditNoteHeaders
Represents the Headers record for the operation: updateCreditNote
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateCreditNoteQueries
Represents the Queries record for the operation: updateCreditNote
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
xero.accounts: UpdateExpenseClaimHeaders
Represents the Headers record for the operation: updateExpenseClaim
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateInvoiceAttachmentByFileNameHeaders
Represents the Headers record for the operation: updateInvoiceAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateInvoiceHeaders
Represents the Headers record for the operation: updateInvoice
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateInvoiceQueries
Represents the Queries record for the operation: updateInvoice
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- allowBackorders? boolean - Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative
xero.accounts: UpdateItemHeaders
Represents the Headers record for the operation: updateItem
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateItemQueries
Represents the Queries record for the operation: updateItem
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
xero.accounts: UpdateLinkedTransactionHeaders
Represents the Headers record for the operation: updateLinkedTransaction
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateManualJournalAttachmentByFileNameHeaders
Represents the Headers record for the operation: updateManualJournalAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateManualJournalHeaders
Represents the Headers record for the operation: updateManualJournal
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateOrCreateBankTransactionsHeaders
Represents the Headers record for the operation: updateOrCreateBankTransactions
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateOrCreateBankTransactionsQueries
Represents the Queries record for the operation: updateOrCreateBankTransactions
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: UpdateOrCreateContactsHeaders
Represents the Headers record for the operation: updateOrCreateContacts
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateOrCreateContactsQueries
Represents the Queries record for the operation: updateOrCreateContacts
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: UpdateOrCreateCreditNotesHeaders
Represents the Headers record for the operation: updateOrCreateCreditNotes
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateOrCreateCreditNotesQueries
Represents the Queries record for the operation: updateOrCreateCreditNotes
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: UpdateOrCreateInvoicesHeaders
Represents the Headers record for the operation: updateOrCreateInvoices
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateOrCreateInvoicesQueries
Represents the Queries record for the operation: updateOrCreateInvoices
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- allowBackorders? boolean - Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: UpdateOrCreateItemsHeaders
Represents the Headers record for the operation: updateOrCreateItems
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateOrCreateItemsQueries
Represents the Queries record for the operation: updateOrCreateItems
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: UpdateOrCreateManualJournalsHeaders
Represents the Headers record for the operation: updateOrCreateManualJournals
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateOrCreateManualJournalsQueries
Represents the Queries record for the operation: updateOrCreateManualJournals
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: UpdateOrCreatePurchaseOrdersHeaders
Represents the Headers record for the operation: updateOrCreatePurchaseOrders
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateOrCreatePurchaseOrdersQueries
Represents the Queries record for the operation: updateOrCreatePurchaseOrders
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: UpdateOrCreateQuotesHeaders
Represents the Headers record for the operation: updateOrCreateQuotes
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateOrCreateQuotesQueries
Represents the Queries record for the operation: updateOrCreateQuotes
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: UpdateOrCreateRepeatingInvoicesHeaders
Represents the Headers record for the operation: updateOrCreateRepeatingInvoices
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateOrCreateRepeatingInvoicesQueries
Represents the Queries record for the operation: updateOrCreateRepeatingInvoices
Fields
- summarizeErrors boolean(default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
xero.accounts: UpdatePurchaseOrderAttachmentByFileNameHeaders
Represents the Headers record for the operation: updatePurchaseOrderAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdatePurchaseOrderHeaders
Represents the Headers record for the operation: updatePurchaseOrder
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateQuoteAttachmentByFileNameHeaders
Represents the Headers record for the operation: updateQuoteAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateQuoteHeaders
Represents the Headers record for the operation: updateQuote
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateReceiptAttachmentByFileNameHeaders
Represents the Headers record for the operation: updateReceiptAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateReceiptHeaders
Represents the Headers record for the operation: updateReceipt
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateReceiptQueries
Represents the Queries record for the operation: updateReceipt
Fields
- unitdp? int - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
xero.accounts: UpdateRepeatingInvoiceAttachmentByFileNameHeaders
Represents the Headers record for the operation: updateRepeatingInvoiceAttachmentByFileName
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateRepeatingInvoiceHeaders
Represents the Headers record for the operation: updateRepeatingInvoice
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateTaxRateHeaders
Represents the Headers record for the operation: updateTaxRate
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateTrackingCategoryHeaders
Represents the Headers record for the operation: updateTrackingCategory
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: UpdateTrackingOptionsHeaders
Represents the Headers record for the operation: updateTrackingOptions
Fields
- idempotencyKey? string - This allows you to safely retry requests without the risk of duplicate processing. 128 character max
- xeroTenantId string - Xero identifier for Tenant
xero.accounts: User
Fields
- isSubscriber? boolean - Boolean to indicate if user is the subscriber
- updatedDateUTC? string - Timestamp of last change to user
- userID? string - Xero identifier
- firstName? string - First name of user
- lastName? string - Last name of user
- emailAddress? string - Email address of user
- organisationRole? "READONLY"|"INVOICEONLY"|"STANDARD"|"FINANCIALADVISER"|"MANAGEDCLIENT"|"CASHBOOKCLIENT"|"UNKNOWN"|"REMOVED" - User role that defines permissions in Xero and via API (READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, etc)
xero.accounts: Users
Fields
- users? User[] - List of users
xero.accounts: ValidationError
Fields
- message? string - Validation error message
Union types
xero.accounts: CurrencyCode
CurrencyCode
3 letter alpha code for the currency – see list of currency codes
xero.accounts: TimeZone
TimeZone
Timezone specifications
xero.accounts: QuoteLineAmountTypes
QuoteLineAmountTypes
Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types
xero.accounts: RowType
RowType
xero.accounts: CountryCode
CountryCode
xero.accounts: AccountType
AccountType
See Account Types
xero.accounts: LineAmountTypes
LineAmountTypes
Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types
xero.accounts: QuoteStatusCodes
QuoteStatusCodes
The status of the quote
xero.accounts: PaymentTermType
PaymentTermType