Module xero.accounts
ballerinax/xero.accounts Ballerina library
1.5.1
Overview
This is a generated connector for Xero Accounts API v2.14.4 OpenAPI specification.
The Xero Accounting API exposes accounting and related functions of the main Xero application and can be used for a variety of purposes such as creating transactions like invoices and credit notes, right through to extracting accounting data via our reports endpoint.
Clients
xero.accounts: Client
Isolated
This is a generated connector for Xero Accounts API v2.14.4 OpenAPI specification. The Xero Accounting API exposes accounting and related functions of the main Xero application and can be used for a variety of purposes such as creating transactions like invoices and credit notes, right through to extracting accounting data via our reports endpoint.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create a Xero account and obtain tokens following this guide.
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(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order) returns Accounts|errorRetrieves the full chart of accounts
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
createAccount
Isolated FunctionRemote Function
Creates a new chart of accounts
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload Account - Account object in body of request
Return Type
getAccount
Isolated FunctionRemote Function
Retrieves a single chart of accounts by using a unique account Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- accountID string - Unique identifier for Account object
updateAccount
Isolated FunctionRemote Function
function updateAccount(string xeroTenantId, string accountID, Accounts payload) returns Accounts|errorUpdates a chart of accounts
Parameters
- xeroTenantId string - Xero identifier for Tenant
- accountID string - Unique identifier for Account object
- payload Accounts - Request of type Accounts array with one Account
Return Type
deleteAccount
Isolated FunctionRemote Function
Deletes a chart of accounts
Parameters
- xeroTenantId string - Xero identifier for Tenant
- accountID string - Unique identifier for Account object
Return Type
getAccountAttachments
Isolated FunctionRemote Function
function getAccountAttachments(string xeroTenantId, string accountID) returns Attachments|errorRetrieves attachments for a specific accounts by using a unique account Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- accountID string - Unique identifier for Account object
Return Type
- Attachments|error - Success - return response of type Attachments array of Attachment
getAccountAttachmentById
Isolated FunctionRemote Function
function getAccountAttachmentById(string xeroTenantId, string accountID, string attachmentID, string contentType) returns string|errorRetrieves a specific attachment from a specific account using a unique attachment Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- accountID string - Unique identifier for Account object
- attachmentID string - Unique identifier for Attachment object
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
getAccountAttachmentByFileName
Isolated FunctionRemote Function
function getAccountAttachmentByFileName(string xeroTenantId, string accountID, string fileName, string contentType) returns string|errorRetrieves an attachment for a specific account by filename
Parameters
- xeroTenantId string - Xero identifier for Tenant
- accountID string - Unique identifier for Account object
- fileName string - Name of the attachment
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
createAccountAttachmentByFileName
Isolated FunctionRemote Function
function createAccountAttachmentByFileName(string xeroTenantId, string accountID, string fileName, byte[] payload) returns Attachments|errorCreates an attachment on a specific account
Parameters
- xeroTenantId string - Xero identifier for Tenant
- accountID string - Unique identifier for Account object
- fileName string - Name of the attachment
- 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 xeroTenantId, string accountID, string fileName, byte[] payload) returns Attachments|errorUpdates attachment on a specific account by filename
Parameters
- xeroTenantId string - Xero identifier for Tenant
- accountID string - Unique identifier for Account object
- fileName string - Name of the attachment
- 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(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order) returns BatchPayments|errorRetrieves either one or many batch payments for invoices
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
Return Type
- BatchPayments|error - Success - return response of type BatchPayments array of BatchPayment objects
createBatchPayment
Isolated FunctionRemote Function
function createBatchPayment(string xeroTenantId, BatchPayments payload, boolean summarizeErrors) returns BatchPayments|errorCreates one or many batch payments for invoices
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload BatchPayments - BatchPayments with an array of Payments in body of request
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
Return Type
- BatchPayments|error - Success - return response of type BatchPayments array of BatchPayment objects
getBatchPaymentHistory
Isolated FunctionRemote Function
function getBatchPaymentHistory(string xeroTenantId, string batchPaymentID) returns HistoryRecords|errorRetrieves history from a specific batch payment
Parameters
- xeroTenantId string - Xero identifier for Tenant
- batchPaymentID string - Unique identifier for BatchPayment
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createBatchPaymentHistoryRecord
Isolated FunctionRemote Function
function createBatchPaymentHistoryRecord(string xeroTenantId, string batchPaymentID, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific batch payment
Parameters
- xeroTenantId string - Xero identifier for Tenant
- batchPaymentID string - Unique identifier for BatchPayment
- 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(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order, int? page, int? unitdp) returns BankTransactions|errorRetrieves any spent or received money transactions
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
- page int? (default ()) - Up to 100 bank transactions will be returned in a single API call with line items details
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
- BankTransactions|error - Success - return response of type BankTransactions array with 0 to n BankTransaction
createBankTransactions
Isolated FunctionRemote Function
function createBankTransactions(string xeroTenantId, BankTransactions payload, boolean summarizeErrors, int? unitdp) returns BankTransactions|errorCreates one or more spent or received money transaction
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload BankTransactions - BankTransactions with an array of BankTransaction objects
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
- BankTransactions|error - Success - return response of type BankTransactions array with new BankTransaction
updateOrCreateBankTransactions
Isolated FunctionRemote Function
function updateOrCreateBankTransactions(string xeroTenantId, BankTransactions payload, boolean summarizeErrors, int? unitdp) returns BankTransactions|errorUpdates or creates one or more spent or received money transaction
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload BankTransactions - BankTransactions with an array of BankTransaction objects
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
- BankTransactions|error - Success - return response of type BankTransactions array with new BankTransaction
getBankTransaction
Isolated FunctionRemote Function
function getBankTransaction(string xeroTenantId, string bankTransactionID, int? unitdp) returns BankTransactions|errorRetrieves a single spent or received money transaction by using a unique bank transaction Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
- BankTransactions|error - Success - return response of type BankTransactions array with a specific BankTransaction
updateBankTransaction
Isolated FunctionRemote Function
function updateBankTransaction(string xeroTenantId, string bankTransactionID, BankTransactions payload, int? unitdp) returns BankTransactions|errorUpdates a single spent or received money transaction
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- payload BankTransactions - BankTransactions with an array of BankTransaction objects
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
- BankTransactions|error - Success - return response of type BankTransactions array with updated BankTransaction
getBankTransactionAttachments
Isolated FunctionRemote Function
function getBankTransactionAttachments(string xeroTenantId, string bankTransactionID) returns Attachments|errorRetrieves any attachments from a specific bank transactions
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransactionID string - Xero generated unique identifier for a bank transaction
Return Type
- Attachments|error - Success - return response of type Attachments array with 0 to n Attachment
getBankTransactionAttachmentById
Isolated FunctionRemote Function
function getBankTransactionAttachmentById(string xeroTenantId, string bankTransactionID, string attachmentID, string contentType) returns string|errorRetrieves specific attachments from a specific BankTransaction using a unique attachment Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- attachmentID string - Unique identifier for Attachment object
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
Return Type
getBankTransactionAttachmentByFileName
Isolated FunctionRemote Function
function getBankTransactionAttachmentByFileName(string xeroTenantId, string bankTransactionID, string fileName, string contentType) returns string|errorRetrieves a specific attachment from a specific bank transaction by filename
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- fileName string - Name of the attachment
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
Return Type
createBankTransactionAttachmentByFileName
Isolated FunctionRemote Function
function createBankTransactionAttachmentByFileName(string xeroTenantId, string bankTransactionID, string fileName, byte[] payload) returns Attachments|errorCreates an attachment for a specific bank transaction by filename
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- fileName string - Name of the attachment
- 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 xeroTenantId, string bankTransactionID, string fileName, byte[] payload) returns Attachments|errorUpdates a specific attachment from a specific bank transaction by filename
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- fileName string - Name of the attachment
- 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 xeroTenantId, string bankTransactionID) returns HistoryRecords|errorRetrieves history from a specific bank transaction using a unique bank transaction Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransactionID string - Xero generated unique identifier for a bank transaction
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createBankTransactionHistoryRecord
Isolated FunctionRemote Function
function createBankTransactionHistoryRecord(string xeroTenantId, string bankTransactionID, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific bank transactions
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransactionID string - Xero generated unique identifier for a bank transaction
- 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(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order) returns BankTransfers|errorRetrieves all bank transfers
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
Return Type
- BankTransfers|error - Success - return response of BankTransfers array of 0 to N BankTransfer
createBankTransfer
Isolated FunctionRemote Function
function createBankTransfer(string xeroTenantId, BankTransfers payload) returns BankTransfers|errorCreates a bank transfer
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload BankTransfers - BankTransfers with array of BankTransfer objects in request body
Return Type
- BankTransfers|error - Success - return response of BankTransfers array of one BankTransfer
getBankTransfer
Isolated FunctionRemote Function
function getBankTransfer(string xeroTenantId, string bankTransferID) returns BankTransfers|errorRetrieves specific bank transfers by using a unique bank transfer Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransferID string - Xero generated unique identifier for a bank transfer
Return Type
- BankTransfers|error - Success - return response of BankTransfers array with one BankTransfer
getBankTransferAttachments
Isolated FunctionRemote Function
function getBankTransferAttachments(string xeroTenantId, string bankTransferID) returns Attachments|errorRetrieves attachments from a specific bank transfer
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransferID string - Xero generated unique identifier for a bank transfer
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 xeroTenantId, string bankTransferID, string attachmentID, string contentType) returns string|errorRetrieves a specific attachment from a specific bank transfer using a unique attachment ID
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransferID string - Xero generated unique identifier for a bank transfer
- attachmentID string - Unique identifier for Attachment object
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
Return Type
getBankTransferAttachmentByFileName
Isolated FunctionRemote Function
function getBankTransferAttachmentByFileName(string xeroTenantId, string bankTransferID, string fileName, string contentType) returns string|errorRetrieves a specific attachment on a specific bank transfer by file name
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransferID string - Xero generated unique identifier for a bank transfer
- fileName string - Name of the attachment
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
Return Type
createBankTransferAttachmentByFileName
Isolated FunctionRemote Function
function createBankTransferAttachmentByFileName(string xeroTenantId, string bankTransferID, string fileName, byte[] payload) returns Attachments|errorParameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransferID string - Xero generated unique identifier for a bank transfer
- fileName string - Name of the attachment
- 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 xeroTenantId, string bankTransferID, string fileName, byte[] payload) returns Attachments|errorParameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransferID string - Xero generated unique identifier for a bank transfer
- fileName string - Name of the attachment
- 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 xeroTenantId, string bankTransferID) returns HistoryRecords|errorRetrieves history from a specific bank transfer using a unique bank transfer Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransferID string - Xero generated unique identifier for a bank transfer
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createBankTransferHistoryRecord
Isolated FunctionRemote Function
function createBankTransferHistoryRecord(string xeroTenantId, string bankTransferID, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific bank transfer
Parameters
- xeroTenantId string - Xero identifier for Tenant
- bankTransferID string - Xero generated unique identifier for a bank transfer
- 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(string xeroTenantId) returns BrandingThemes|errorRetrieves all the branding themes
Parameters
- xeroTenantId string - Xero identifier for Tenant
Return Type
- BrandingThemes|error - Success - return response of type BrandingThemes
getBrandingTheme
Isolated FunctionRemote Function
function getBrandingTheme(string xeroTenantId, string brandingThemeID) returns BrandingThemes|errorRetrieves a specific branding theme using a unique branding theme Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- brandingThemeID string - Unique identifier for a Branding Theme
Return Type
- BrandingThemes|error - Success - return response of type BrandingThemes with one BrandingTheme
getBrandingThemePaymentServices
Isolated FunctionRemote Function
function getBrandingThemePaymentServices(string xeroTenantId, string brandingThemeID) returns PaymentServices|errorRetrieves the payment services for a specific branding theme
Parameters
- xeroTenantId string - Xero identifier for Tenant
- brandingThemeID string - Unique identifier for a Branding Theme
Return Type
- PaymentServices|error - Success - return response of type PaymentServices array with 0 to N PaymentService
createBrandingThemePaymentServices
Isolated FunctionRemote Function
function createBrandingThemePaymentServices(string xeroTenantId, string brandingThemeID, PaymentService payload) returns PaymentServices|errorCreates a new custom payment service for a specific branding theme
Parameters
- xeroTenantId string - Xero identifier for Tenant
- brandingThemeID string - Unique identifier for a Branding Theme
- payload PaymentService - 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(string xeroTenantId, string[]? iDs, string? dateTo, string? dateFrom) returns Budgets|errorRetrieve a list of budgets
Parameters
- xeroTenantId string - Xero identifier for Tenant
- iDs string[]? (default ()) - Filter by BudgetID. Allows you to retrieve a specific individual budget.
- dateTo string? (default ()) - Filter by start date
- dateFrom string? (default ()) - Filter by end date
getBudget
Isolated FunctionRemote Function
Retrieves a specific budgets, which includes budget lines
Parameters
- xeroTenantId string - Xero identifier for Tenant
- budgetID string - Unique identifier for Budgets
getContacts
Isolated FunctionRemote Function
function getContacts(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order, string[]? iDs, int? page, boolean? includeArchived, boolean summaryOnly) returns Contacts|errorRetrieves all contacts in a Xero organisation
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
- iDs string[]? (default ()) - Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.
- page int? (default ()) - e.g. page=1 - Up to 100 contacts will be returned in a single API call.
- includeArchived boolean? (default ()) - 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.
createContacts
Isolated FunctionRemote Function
function createContacts(string xeroTenantId, Contacts payload, boolean summarizeErrors) returns Contacts|errorCreates multiple contacts (bulk) in a Xero organisation
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload Contacts - Contacts with an array of Contact objects to create in body of request
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
Return Type
updateOrCreateContacts
Isolated FunctionRemote Function
function updateOrCreateContacts(string xeroTenantId, Contacts payload, boolean summarizeErrors) returns Contacts|errorUpdates or creates one or more contacts in a Xero organisation
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload Contacts - Contacts with an array of Contact objects in body
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
Return Type
getContactByContactNumber
Isolated FunctionRemote Function
function getContactByContactNumber(string xeroTenantId, string contactNumber) returns Contacts|errorRetrieves a specific contact by contact number in a Xero organisation
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactNumber string - This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50).
getContact
Isolated FunctionRemote Function
Retrieves a specific contacts in a Xero organisation using a unique contact Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactID string - Unique identifier for a Contact
updateContact
Isolated FunctionRemote Function
function updateContact(string xeroTenantId, string contactID, Contacts payload) returns Contacts|errorUpdates a specific contact in a Xero organisation
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactID string - Unique identifier for a Contact
- payload Contacts - an array of Contacts containing single Contact object with properties to update
Return Type
getContactAttachments
Isolated FunctionRemote Function
function getContactAttachments(string xeroTenantId, string contactID) returns Attachments|errorRetrieves attachments for a specific contact in a Xero organisation
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactID string - Unique identifier for a Contact
Return Type
- Attachments|error - Success - return response of type Attachments array with 0 to N Attachment
getContactAttachmentById
Isolated FunctionRemote Function
function getContactAttachmentById(string xeroTenantId, string contactID, string attachmentID, string contentType) returns string|errorRetrieves a specific attachment from a specific contact using a unique attachment Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactID string - Unique identifier for a Contact
- attachmentID string - Unique identifier for Attachment object
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
getContactAttachmentByFileName
Isolated FunctionRemote Function
function getContactAttachmentByFileName(string xeroTenantId, string contactID, string fileName, string contentType) returns string|errorRetrieves a specific attachment from a specific contact by file name
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactID string - Unique identifier for a Contact
- fileName string - Name of the attachment
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
createContactAttachmentByFileName
Isolated FunctionRemote Function
function createContactAttachmentByFileName(string xeroTenantId, string contactID, string fileName, byte[] payload) returns Attachments|errorParameters
- xeroTenantId string - Xero identifier for Tenant
- contactID string - Unique identifier for a Contact
- fileName string - Name of the attachment
- 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 xeroTenantId, string contactID, string fileName, byte[] payload) returns Attachments|errorParameters
- xeroTenantId string - Xero identifier for Tenant
- contactID string - Unique identifier for a Contact
- fileName string - Name of the attachment
- 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 xeroTenantId, string contactID) returns CISSettings|errorRetrieves CIS settings for a specific contact in a Xero organisation
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactID string - Unique identifier for a Contact
Return Type
- CISSettings|error - Success - return response of type CISSettings for a specific Contact
getContactHistory
Isolated FunctionRemote Function
function getContactHistory(string xeroTenantId, string contactID) returns HistoryRecords|errorRetrieves history records for a specific contact
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactID string - Unique identifier for a Contact
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createContactHistory
Isolated FunctionRemote Function
function createContactHistory(string xeroTenantId, string contactID, HistoryRecords payload) returns HistoryRecords|errorCreates a new history record for a specific contact
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactID string - Unique identifier for a Contact
- 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(string xeroTenantId, string? 'where, string? 'order) returns ContactGroups|errorRetrieves the contact Id and name of each contact group
Parameters
- xeroTenantId string - Xero identifier for Tenant
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
Return Type
- ContactGroups|error - Success - return response of type Contact Groups array of Contact Group
createContactGroup
Isolated FunctionRemote Function
function createContactGroup(string xeroTenantId, ContactGroups payload) returns ContactGroups|errorCreates a contact group
Parameters
- xeroTenantId string - Xero identifier for Tenant
- 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 xeroTenantId, string contactGroupID) returns ContactGroups|errorRetrieves a specific contact group by using a unique contact group Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactGroupID string - Unique identifier for a Contact Group
Return Type
- ContactGroups|error - Success - return response of type Contact Groups array with a specific Contact Group
updateContactGroup
Isolated FunctionRemote Function
function updateContactGroup(string xeroTenantId, string contactGroupID, ContactGroups payload) returns ContactGroups|errorUpdates a specific contact group
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactGroupID string - Unique identifier for a Contact Group
- 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 xeroTenantId, string contactGroupID, Contacts payload) returns Contacts|errorCreates contacts to a specific contact group
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactGroupID string - Unique identifier for a Contact Group
- 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 xeroTenantId, string contactGroupID) returns Response|errorDeletes all contacts from a specific contact group
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactGroupID string - Unique identifier for a Contact Group
deleteContactGroupContact
Isolated FunctionRemote Function
function deleteContactGroupContact(string xeroTenantId, string contactGroupID, string contactID) returns Response|errorDeletes a specific contact from a contact group using a unique contact Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactGroupID string - Unique identifier for a Contact Group
- contactID string - Unique identifier for a Contact
getCreditNotes
Isolated FunctionRemote Function
function getCreditNotes(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order, int? page, int? unitdp) returns CreditNotes|errorRetrieves any credit notes
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
- page int? (default ()) - 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
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
- CreditNotes|error - Success - return response of type Credit Notes array of CreditNote
createCreditNotes
Isolated FunctionRemote Function
function createCreditNotes(string xeroTenantId, CreditNotes payload, boolean summarizeErrors, int? unitdp) returns CreditNotes|errorCreates a new credit note
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload CreditNotes - Credit Notes with array of CreditNote object in body of request
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
- CreditNotes|error - Success - return response of type Credit Notes array of newly created CreditNote
updateOrCreateCreditNotes
Isolated FunctionRemote Function
function updateOrCreateCreditNotes(string xeroTenantId, CreditNotes payload, boolean summarizeErrors, int? unitdp) returns CreditNotes|errorUpdates or creates one or more credit notes
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload CreditNotes - an array of Credit Notes with a single CreditNote object.
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
- CreditNotes|error - Success - return response of type Credit Notes array of newly created CreditNote
getCreditNote
Isolated FunctionRemote Function
function getCreditNote(string xeroTenantId, string creditNoteID, int? unitdp) returns CreditNotes|errorRetrieves a specific credit note using a unique credit note Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- creditNoteID string - Unique identifier for a Credit Note
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
- CreditNotes|error - Success - return response of type Credit Notes array with a unique CreditNote
updateCreditNote
Isolated FunctionRemote Function
function updateCreditNote(string xeroTenantId, string creditNoteID, CreditNotes payload, int? unitdp) returns CreditNotes|errorUpdates a specific credit note
Parameters
- xeroTenantId string - Xero identifier for Tenant
- creditNoteID string - Unique identifier for a Credit Note
- payload CreditNotes - an array of Credit Notes containing credit note details to update
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
- CreditNotes|error - Success - return response of type Credit Notes array with updated CreditNote
getCreditNoteAttachments
Isolated FunctionRemote Function
function getCreditNoteAttachments(string xeroTenantId, string creditNoteID) returns Attachments|errorRetrieves attachments for a specific credit notes
Parameters
- xeroTenantId string - Xero identifier for Tenant
- creditNoteID string - Unique identifier for a Credit Note
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 xeroTenantId, string creditNoteID, string attachmentID, string contentType) returns string|errorRetrieves a specific attachment from a specific credit note using a unique attachment Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- creditNoteID string - Unique identifier for a Credit Note
- attachmentID string - Unique identifier for Attachment object
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
getCreditNoteAttachmentByFileName
Isolated FunctionRemote Function
function getCreditNoteAttachmentByFileName(string xeroTenantId, string creditNoteID, string fileName, string contentType) returns string|errorRetrieves a specific attachment on a specific credit note by file name
Parameters
- xeroTenantId string - Xero identifier for Tenant
- creditNoteID string - Unique identifier for a Credit Note
- fileName string - Name of the attachment
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
createCreditNoteAttachmentByFileName
Isolated FunctionRemote Function
function createCreditNoteAttachmentByFileName(string xeroTenantId, string creditNoteID, string fileName, byte[] payload, boolean includeOnline) returns Attachments|errorCreates an attachment for a specific credit note
Parameters
- xeroTenantId string - Xero identifier for Tenant
- creditNoteID string - Unique identifier for a Credit Note
- fileName string - Name of the attachment
- payload byte[] - Byte array of file in body of request
- includeOnline boolean (default false) - Allows an attachment to be seen by the end customer within their online invoice
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 xeroTenantId, string creditNoteID, string fileName, byte[] payload) returns Attachments|errorUpdates attachments on a specific credit note by file name
Parameters
- xeroTenantId string - Xero identifier for Tenant
- creditNoteID string - Unique identifier for a Credit Note
- fileName string - Name of the attachment
- 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
Retrieves credit notes as PDF files
Parameters
- xeroTenantId string - Xero identifier for Tenant
- creditNoteID string - Unique identifier for a Credit Note
Return Type
createCreditNoteAllocation
Isolated FunctionRemote Function
function createCreditNoteAllocation(string xeroTenantId, string creditNoteID, Allocations payload, boolean summarizeErrors) returns Allocations|errorCreates allocation for a specific credit note
Parameters
- xeroTenantId string - Xero identifier for Tenant
- creditNoteID string - Unique identifier for a Credit Note
- payload Allocations - Allocations with array of Allocation object in body of request.
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
Return Type
- Allocations|error - Success - return response of type Allocations array with newly created Allocation for specific Credit Note
getCreditNoteHistory
Isolated FunctionRemote Function
function getCreditNoteHistory(string xeroTenantId, string creditNoteID) returns HistoryRecords|errorRetrieves history records of a specific credit note
Parameters
- xeroTenantId string - Xero identifier for Tenant
- creditNoteID string - Unique identifier for a Credit Note
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createCreditNoteHistory
Isolated FunctionRemote Function
function createCreditNoteHistory(string xeroTenantId, string creditNoteID, HistoryRecords payload) returns HistoryRecords|errorRetrieves history records of a specific credit note
Parameters
- xeroTenantId string - Xero identifier for Tenant
- creditNoteID string - Unique identifier for a Credit Note
- 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(string xeroTenantId, string? 'where, string? 'order) returns Currencies|errorRetrieves currencies for your Xero organisation
Parameters
- xeroTenantId string - Xero identifier for Tenant
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
Return Type
- Currencies|error - Success - return response of type Currencies array with all Currencies
createCurrency
Isolated FunctionRemote Function
function createCurrency(string xeroTenantId, Currency payload) returns Currencies|errorCreate a new currency for a Xero organisation
Parameters
- xeroTenantId string - Xero identifier for Tenant
- 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
getEmployees
Isolated FunctionRemote Function
function getEmployees(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order) returns Employees|errorRetrieves employees used in Xero payrun
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
createEmployees
Isolated FunctionRemote Function
function createEmployees(string xeroTenantId, Employees payload, boolean summarizeErrors) returns Employees|errorCreates new employees used in Xero payrun
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload Employees - Employees with array of Employee object in body of request
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
updateOrCreateEmployees
Isolated FunctionRemote Function
function updateOrCreateEmployees(string xeroTenantId, Employees payload, boolean summarizeErrors) returns Employees|errorCreates a single new employees used in Xero payrun
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload Employees - Employees with array of Employee object in body of request
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
getEmployee
Isolated FunctionRemote Function
Retrieves a specific employee used in Xero payrun using a unique employee Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- employeeID string - Unique identifier for a Employee
Return Type
getExpenseClaims
Isolated FunctionRemote Function
function getExpenseClaims(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order) returns ExpenseClaims|errorRetrieves expense claims
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
Return Type
- ExpenseClaims|error - Success - return response of type ExpenseClaims array with all ExpenseClaims
createExpenseClaims
Isolated FunctionRemote Function
function createExpenseClaims(string xeroTenantId, ExpenseClaims payload) returns ExpenseClaims|errorCreates expense claims
Parameters
- xeroTenantId string - Xero identifier for Tenant
- 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 xeroTenantId, string expenseClaimID) returns ExpenseClaims|errorRetrieves a specific expense claim using a unique expense claim Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- expenseClaimID string - Unique identifier for a ExpenseClaim
Return Type
- ExpenseClaims|error - Success - return response of type ExpenseClaims array with specified ExpenseClaim
updateExpenseClaim
Isolated FunctionRemote Function
function updateExpenseClaim(string xeroTenantId, string expenseClaimID, ExpenseClaims payload) returns ExpenseClaims|errorUpdates a specific expense claims
Parameters
- xeroTenantId string - Xero identifier for Tenant
- expenseClaimID string - Unique identifier for a ExpenseClaim
- payload ExpenseClaims - ExpenseClaims with an array of ExpenseClaim objects
Return Type
- ExpenseClaims|error - Success - return response of type ExpenseClaims array with updated ExpenseClaim
getExpenseClaimHistory
Isolated FunctionRemote Function
function getExpenseClaimHistory(string xeroTenantId, string expenseClaimID) returns HistoryRecords|errorRetrieves history records of a specific expense claim
Parameters
- xeroTenantId string - Xero identifier for Tenant
- expenseClaimID string - Unique identifier for a ExpenseClaim
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createExpenseClaimHistory
Isolated FunctionRemote Function
function createExpenseClaimHistory(string xeroTenantId, string expenseClaimID, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific expense claim
Parameters
- xeroTenantId string - Xero identifier for Tenant
- expenseClaimID string - Unique identifier for a ExpenseClaim
- 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(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order, string[]? iDs, string[]? invoiceNumbers, string[]? contactIDs, string[]? statuses, int? page, boolean? includeArchived, boolean? createdByMyApp, int? unitdp, boolean summaryOnly) returns Invoices|errorRetrieves sales invoices or purchase bills
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
- iDs string[]? (default ()) - Filter by a comma-separated list of InvoicesIDs.
- invoiceNumbers string[]? (default ()) - Filter by a comma-separated list of InvoiceNumbers.
- contactIDs string[]? (default ()) - Filter by a comma-separated list of ContactIDs.
- statuses string[]? (default ()) - 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.
- page int? (default ()) - e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice
- includeArchived boolean? (default ()) - e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response
- createdByMyApp boolean? (default ()) - When set to true you'll only retrieve Invoices created by your app
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
- 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.
createInvoices
Isolated FunctionRemote Function
function createInvoices(string xeroTenantId, Invoices payload, boolean summarizeErrors, int? unitdp) returns Invoices|errorCreates one or more sales invoices or purchase bills
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload Invoices - Invoices with an array of invoice objects in body of request
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
updateOrCreateInvoices
Isolated FunctionRemote Function
function updateOrCreateInvoices(string xeroTenantId, Invoices payload, boolean summarizeErrors, int? unitdp) returns Invoices|errorUpdates or creates one or more sales invoices or purchase bills
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload Invoices - Invoices with an array of Invoice objects
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
getInvoice
Isolated FunctionRemote Function
Retrieves a specific sales invoice or purchase bill using a unique invoice Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- invoiceID string - Unique identifier for an Invoice
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
updateInvoice
Isolated FunctionRemote Function
function updateInvoice(string xeroTenantId, string invoiceID, Invoices payload, int? unitdp) returns Invoices|errorUpdates a specific sales invoices or purchase bills
Parameters
- xeroTenantId string - Xero identifier for Tenant
- invoiceID string - Unique identifier for an Invoice
- payload Invoices - Invoices with an array of Invoice objects
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
getInvoiceAsPdf
Isolated FunctionRemote Function
Retrieves invoices or purchase bills as PDF files
Parameters
- xeroTenantId string - Xero identifier for Tenant
- invoiceID string - Unique identifier for an Invoice
getInvoiceAttachments
Isolated FunctionRemote Function
function getInvoiceAttachments(string xeroTenantId, string invoiceID) returns Attachments|errorRetrieves attachments for a specific invoice or purchase bill
Parameters
- xeroTenantId string - Xero identifier for Tenant
- invoiceID string - Unique identifier for an Invoice
Return Type
- Attachments|error - Success - return response of type Attachments array of Attachments for specified Invoices
getInvoiceAttachmentById
Isolated FunctionRemote Function
function getInvoiceAttachmentById(string xeroTenantId, string invoiceID, string attachmentID, string contentType) returns string|errorRetrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- invoiceID string - Unique identifier for an Invoice
- attachmentID string - Unique identifier for Attachment object
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
getInvoiceAttachmentByFileName
Isolated FunctionRemote Function
function getInvoiceAttachmentByFileName(string xeroTenantId, string invoiceID, string fileName, string contentType) returns string|errorRetrieves an attachment from a specific invoice or purchase bill by filename
Parameters
- xeroTenantId string - Xero identifier for Tenant
- invoiceID string - Unique identifier for an Invoice
- fileName string - Name of the attachment
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
createInvoiceAttachmentByFileName
Isolated FunctionRemote Function
function createInvoiceAttachmentByFileName(string xeroTenantId, string invoiceID, string fileName, byte[] payload, boolean includeOnline) returns Attachments|errorCreates an attachment for a specific invoice or purchase bill by filename
Parameters
- xeroTenantId string - Xero identifier for Tenant
- invoiceID string - Unique identifier for an Invoice
- fileName string - Name of the attachment
- payload byte[] - Byte array of file in body of request
- includeOnline boolean (default false) - Allows an attachment to be seen by the end customer within their online invoice
Return Type
- Attachments|error - Success - return response of type Attachments array with newly created Attachment
updateInvoiceAttachmentByFileName
Isolated FunctionRemote Function
function updateInvoiceAttachmentByFileName(string xeroTenantId, string invoiceID, string fileName, byte[] payload) returns Attachments|errorUpdates an attachment from a specific invoices or purchase bill by filename
Parameters
- xeroTenantId string - Xero identifier for Tenant
- invoiceID string - Unique identifier for an Invoice
- fileName string - Name of the attachment
- 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 xeroTenantId, string invoiceID) returns OnlineInvoices|errorRetrieves a URL to an online invoice
Parameters
- xeroTenantId string - Xero identifier for Tenant
- invoiceID string - Unique identifier for an Invoice
Return Type
- OnlineInvoices|error - Success - return response of type OnlineInvoice array with one OnlineInvoice
emailInvoice
Isolated FunctionRemote Function
function emailInvoice(string xeroTenantId, string invoiceID, RequestEmpty payload) returns Response|errorSends a copy of a specific invoice to related contact via email
Parameters
- xeroTenantId string - Xero identifier for Tenant
- invoiceID string - Unique identifier for an Invoice
- payload RequestEmpty - Invoices with an array of Invoice objects
getInvoiceHistory
Isolated FunctionRemote Function
function getInvoiceHistory(string xeroTenantId, string invoiceID) returns HistoryRecords|errorRetrieves history records for a specific invoice
Parameters
- xeroTenantId string - Xero identifier for Tenant
- invoiceID string - Unique identifier for an Invoice
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createInvoiceHistory
Isolated FunctionRemote Function
function createInvoiceHistory(string xeroTenantId, string invoiceID, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific invoice
Parameters
- xeroTenantId string - Xero identifier for Tenant
- invoiceID string - Unique identifier for an Invoice
- 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(string xeroTenantId) returns InvoiceReminders|errorRetrieves invoice reminder settings
Parameters
- xeroTenantId string - Xero identifier for Tenant
Return Type
- InvoiceReminders|error - Success - return response of Invoice Reminders
getItems
Isolated FunctionRemote Function
function getItems(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order, int? unitdp) returns Items|errorRetrieves items
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
createItems
Isolated FunctionRemote Function
function createItems(string xeroTenantId, Items payload, boolean summarizeErrors, int? unitdp) returns Items|errorCreates one or more items
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload Items - Items with an array of Item objects in body of request
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
updateOrCreateItems
Isolated FunctionRemote Function
function updateOrCreateItems(string xeroTenantId, Items payload, boolean summarizeErrors, int? unitdp) returns Items|errorUpdates or creates one or more items
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload Items - Items with an array of Item objects
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
getItem
Isolated FunctionRemote Function
Retrieves a specific item using a unique item Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- itemID string - Unique identifier for an Item
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
updateItem
Isolated FunctionRemote Function
function updateItem(string xeroTenantId, string itemID, Items payload, int? unitdp) returns Items|errorUpdates a specific item
Parameters
- xeroTenantId string - Xero identifier for Tenant
- itemID string - Unique identifier for an Item
- payload Items - Items with an array of Item objects
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
deleteItem
Isolated FunctionRemote Function
Deletes a specific item
Parameters
- xeroTenantId string - Xero identifier for Tenant
- itemID string - Unique identifier for an Item
getItemHistory
Isolated FunctionRemote Function
function getItemHistory(string xeroTenantId, string itemID) returns HistoryRecords|errorRetrieves history for a specific item
Parameters
- xeroTenantId string - Xero identifier for Tenant
- itemID string - Unique identifier for an Item
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createItemHistory
Isolated FunctionRemote Function
function createItemHistory(string xeroTenantId, string itemID, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific item
Parameters
- xeroTenantId string - Xero identifier for Tenant
- itemID string - Unique identifier for an Item
- 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(string xeroTenantId, string? ifModifiedSince, int? offset, boolean? paymentsOnly) returns Journals|errorRetrieves journals
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- offset int? (default ()) - Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned
- paymentsOnly boolean? (default ()) - Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default.
getJournal
Isolated FunctionRemote Function
Retrieves a specific journal using a unique journal Id.
Parameters
- xeroTenantId string - Xero identifier for Tenant
- journalID string - Unique identifier for a Journal
getLinkedTransactions
Isolated FunctionRemote Function
function getLinkedTransactions(string xeroTenantId, int? page, string? linkedTransactionID, string? sourceTransactionID, string? contactID, string? status, string? targetTransactionID) returns LinkedTransactions|errorRetrieves linked transactions (billable expenses)
Parameters
- xeroTenantId string - Xero identifier for Tenant
- page int? (default ()) - 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.
- linkedTransactionID string? (default ()) - The Xero identifier for an Linked Transaction
- sourceTransactionID string? (default ()) - Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice
- contactID string? (default ()) - Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer.
- status string? (default ()) - Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status
- targetTransactionID string? (default ()) - Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice
Return Type
- LinkedTransactions|error - Success - return response of type LinkedTransactions array with all LinkedTransaction
createLinkedTransaction
Isolated FunctionRemote Function
function createLinkedTransaction(string xeroTenantId, LinkedTransaction payload) returns LinkedTransactions|errorCreates linked transactions (billable expenses)
Parameters
- xeroTenantId string - Xero identifier for Tenant
- 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 xeroTenantId, string linkedTransactionID) returns LinkedTransactions|errorRetrieves a specific linked transaction (billable expenses) using a unique linked transaction Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- linkedTransactionID string - Unique identifier for a LinkedTransaction
Return Type
- LinkedTransactions|error - Success - return response of type LinkedTransactions array with a specified LinkedTransaction
updateLinkedTransaction
Isolated FunctionRemote Function
function updateLinkedTransaction(string xeroTenantId, string linkedTransactionID, LinkedTransactions payload) returns LinkedTransactions|errorUpdates a specific linked transactions (billable expenses)
Parameters
- xeroTenantId string - Xero identifier for Tenant
- linkedTransactionID string - Unique identifier for a LinkedTransaction
- payload LinkedTransactions - LinkedTransactions with an array of LinkedTransaction objects
Return Type
- LinkedTransactions|error - Success - return response of type LinkedTransactions array with updated LinkedTransaction
deleteLinkedTransaction
Isolated FunctionRemote Function
function deleteLinkedTransaction(string xeroTenantId, string linkedTransactionID) returns Response|errorDeletes a specific linked transactions (billable expenses)
Parameters
- xeroTenantId string - Xero identifier for Tenant
- linkedTransactionID string - Unique identifier for a LinkedTransaction
getManualJournals
Isolated FunctionRemote Function
function getManualJournals(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order, int? page) returns ManualJournals|errorRetrieves manual journals
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
- page int? (default ()) - e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment
Return Type
- ManualJournals|error - Success - return response of type ManualJournals array with a all ManualJournals
createManualJournals
Isolated FunctionRemote Function
function createManualJournals(string xeroTenantId, ManualJournals payload, boolean summarizeErrors) returns ManualJournals|errorCreates one or more manual journals
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload ManualJournals - ManualJournals array with ManualJournal object in body of request
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
Return Type
- ManualJournals|error - Success - return response of type ManualJournals array with newly created ManualJournal
updateOrCreateManualJournals
Isolated FunctionRemote Function
function updateOrCreateManualJournals(string xeroTenantId, ManualJournals payload, boolean summarizeErrors) returns ManualJournals|errorUpdates or creates a single manual journal
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload ManualJournals - ManualJournals array with ManualJournal object in body of request
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
Return Type
- ManualJournals|error - Success - return response of type ManualJournals array with newly created ManualJournal
getManualJournal
Isolated FunctionRemote Function
function getManualJournal(string xeroTenantId, string manualJournalID) returns ManualJournals|errorRetrieves a specific manual journal
Parameters
- xeroTenantId string - Xero identifier for Tenant
- manualJournalID string - Unique identifier for a ManualJournal
Return Type
- ManualJournals|error - Success - return response of type ManualJournals array with a specified ManualJournals
updateManualJournal
Isolated FunctionRemote Function
function updateManualJournal(string xeroTenantId, string manualJournalID, ManualJournals payload) returns ManualJournals|errorUpdates a specific manual journal
Parameters
- xeroTenantId string - Xero identifier for Tenant
- manualJournalID string - Unique identifier for a ManualJournal
- payload ManualJournals - ManualJournals with an array of ManualJournal objects
Return Type
- ManualJournals|error - Success - return response of type ManualJournals array with an updated ManualJournal
getManualJournalAttachments
Isolated FunctionRemote Function
function getManualJournalAttachments(string xeroTenantId, string manualJournalID) returns Attachments|errorRetrieves attachment for a specific manual journal
Parameters
- xeroTenantId string - Xero identifier for Tenant
- manualJournalID string - Unique identifier for a ManualJournal
Return Type
- Attachments|error - Success - return response of type Attachments array with all Attachments for a ManualJournals
getManualJournalAttachmentById
Isolated FunctionRemote Function
function getManualJournalAttachmentById(string xeroTenantId, string manualJournalID, string attachmentID, string contentType) returns string|errorAllows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- manualJournalID string - Unique identifier for a ManualJournal
- attachmentID string - Unique identifier for Attachment object
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
getManualJournalAttachmentByFileName
Isolated FunctionRemote Function
function getManualJournalAttachmentByFileName(string xeroTenantId, string manualJournalID, string fileName, string contentType) returns string|errorRetrieves a specific attachment from a specific manual journal by file name
Parameters
- xeroTenantId string - Xero identifier for Tenant
- manualJournalID string - Unique identifier for a ManualJournal
- fileName string - Name of the attachment
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
createManualJournalAttachmentByFileName
Isolated FunctionRemote Function
function createManualJournalAttachmentByFileName(string xeroTenantId, string manualJournalID, string fileName, byte[] payload) returns Attachments|errorCreates a specific attachment for a specific manual journal by file name
Parameters
- xeroTenantId string - Xero identifier for Tenant
- manualJournalID string - Unique identifier for a ManualJournal
- fileName string - Name of the attachment
- 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 xeroTenantId, string manualJournalID, string fileName, byte[] payload) returns Attachments|errorUpdates a specific attachment from a specific manual journal by file name
Parameters
- xeroTenantId string - Xero identifier for Tenant
- manualJournalID string - Unique identifier for a ManualJournal
- fileName string - Name of the attachment
- 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 xeroTenantId, string manualJournalID) returns HistoryRecords|errorRetrieves history for a specific manual journal
Parameters
- xeroTenantId string - Xero identifier for Tenant
- manualJournalID string - Unique identifier for a ManualJournal
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createManualJournalHistoryRecord
Isolated FunctionRemote Function
function createManualJournalHistoryRecord(string xeroTenantId, string manualJournalID, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific manual journal
Parameters
- xeroTenantId string - Xero identifier for Tenant
- manualJournalID string - Unique identifier for a ManualJournal
- 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(string xeroTenantId) returns Organisations|errorRetrieves Xero organisation details
Parameters
- xeroTenantId string - Xero identifier for Tenant
Return Type
- Organisations|error - Success - return response of type Organisation array with all Organisation
getOrganisationActions
Isolated FunctionRemote Function
Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.
Parameters
- xeroTenantId string - Xero identifier for Tenant
getOrganisationCISSettings
Isolated FunctionRemote Function
function getOrganisationCISSettings(string xeroTenantId, string organisationID) returns CISOrgSettings|errorRetrieves the CIS settings for the Xero organistaion.
Parameters
- xeroTenantId string - Xero identifier for Tenant
- organisationID string - The unique Xero identifier for an organisation
Return Type
- CISOrgSettings|error - Success - return response of type Organisation array with specified Organisation
getOverpayments
Isolated FunctionRemote Function
function getOverpayments(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order, int? page, int? unitdp) returns Overpayments|errorRetrieves overpayments
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
- page int? (default ()) - e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
- Overpayments|error - Success - return response of type Overpayments array with all Overpayments
getOverpayment
Isolated FunctionRemote Function
function getOverpayment(string xeroTenantId, string overpaymentID) returns Overpayments|errorRetrieves a specific overpayment using a unique overpayment Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- overpaymentID string - Unique identifier for a Overpayment
Return Type
- Overpayments|error - Success - return response of type Overpayments array with specified Overpayments
createOverpaymentAllocations
Isolated FunctionRemote Function
function createOverpaymentAllocations(string xeroTenantId, string overpaymentID, Allocations payload, boolean summarizeErrors) returns Allocations|errorCreates a single allocation for a specific overpayment
Parameters
- xeroTenantId string - Xero identifier for Tenant
- overpaymentID string - Unique identifier for a Overpayment
- payload Allocations - Allocations array with Allocation object in body of request
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
Return Type
- Allocations|error - Success - return response of type Allocations array with all Allocation for Overpayments
getOverpaymentHistory
Isolated FunctionRemote Function
function getOverpaymentHistory(string xeroTenantId, string overpaymentID) returns HistoryRecords|errorRetrieves history records of a specific overpayment
Parameters
- xeroTenantId string - Xero identifier for Tenant
- overpaymentID string - Unique identifier for a Overpayment
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createOverpaymentHistory
Isolated FunctionRemote Function
function createOverpaymentHistory(string xeroTenantId, string overpaymentID, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific overpayment
Parameters
- xeroTenantId string - Xero identifier for Tenant
- overpaymentID string - Unique identifier for a Overpayment
- 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(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order, int? page) returns Payments|errorRetrieves payments for invoices and credit notes
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
- page int? (default ()) - Up to 100 payments will be returned in a single API call
createPayments
Isolated FunctionRemote Function
function createPayments(string xeroTenantId, Payments payload, boolean summarizeErrors) returns Payments|errorCreates multiple payments for invoices or credit notes
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload Payments - Payments array with Payment object in body of request
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
Return Type
createPayment
Isolated FunctionRemote Function
Creates a single payment for invoice or credit notes
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload Payment - Request body with a single Payment object
Return Type
getPayment
Isolated FunctionRemote Function
Retrieves a specific payment for invoices and credit notes using a unique payment Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- paymentID string - Unique identifier for a Payment
deletePayment
Isolated FunctionRemote Function
function deletePayment(string xeroTenantId, string paymentID, PaymentDelete payload) returns Payments|errorUpdates a specific payment for invoices and credit notes
Parameters
- xeroTenantId string - Xero identifier for Tenant
- paymentID string - Unique identifier for a Payment
- payload PaymentDelete - Payment detete status
getPaymentHistory
Isolated FunctionRemote Function
function getPaymentHistory(string xeroTenantId, string paymentID) returns HistoryRecords|errorRetrieves history records of a specific payment
Parameters
- xeroTenantId string - Xero identifier for Tenant
- paymentID string - Unique identifier for a Payment
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createPaymentHistory
Isolated FunctionRemote Function
function createPaymentHistory(string xeroTenantId, string paymentID, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific payment
Parameters
- xeroTenantId string - Xero identifier for Tenant
- paymentID string - Unique identifier for a Payment
- 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(string xeroTenantId) returns PaymentServices|errorRetrieves payment services
Parameters
- xeroTenantId string - Xero identifier for Tenant
Return Type
- PaymentServices|error - Success - return response of type PaymentServices array for all PaymentService
createPaymentService
Isolated FunctionRemote Function
function createPaymentService(string xeroTenantId, PaymentServices payload) returns PaymentServices|errorCreates a payment service
Parameters
- xeroTenantId string - Xero identifier for Tenant
- 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(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order, int? page, int? unitdp) returns Prepayments|errorRetrieves prepayments
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
- page int? (default ()) - e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
- Prepayments|error - Success - return response of type Prepayments array for all Prepayment
getPrepayment
Isolated FunctionRemote Function
function getPrepayment(string xeroTenantId, string prepaymentID) returns Prepayments|errorAllows you to retrieve a specified prepayments
Parameters
- xeroTenantId string - Xero identifier for Tenant
- prepaymentID string - Unique identifier for a PrePayment
Return Type
- Prepayments|error - Success - return response of type Prepayments array for a specified Prepayment
createPrepaymentAllocations
Isolated FunctionRemote Function
function createPrepaymentAllocations(string xeroTenantId, string prepaymentID, Allocations payload, boolean summarizeErrors) returns Allocations|errorAllows you to create an Allocation for prepayments
Parameters
- xeroTenantId string - Xero identifier for Tenant
- prepaymentID string - Unique identifier for a PrePayment
- payload Allocations - Allocations with an array of Allocation object in body of request
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
Return Type
- Allocations|error - Success - return response of type Allocations array of Allocation for all Prepayment
getPrepaymentHistory
Isolated FunctionRemote Function
function getPrepaymentHistory(string xeroTenantId, string prepaymentID) returns HistoryRecords|errorRetrieves history record for a specific prepayment
Parameters
- xeroTenantId string - Xero identifier for Tenant
- prepaymentID string - Unique identifier for a PrePayment
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createPrepaymentHistory
Isolated FunctionRemote Function
function createPrepaymentHistory(string xeroTenantId, string prepaymentID, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific prepayment
Parameters
- xeroTenantId string - Xero identifier for Tenant
- prepaymentID string - Unique identifier for a PrePayment
- 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(string xeroTenantId, string? ifModifiedSince, string? status, string? dateFrom, string? dateTo, string? 'order, int? page) returns PurchaseOrders|errorRetrieves purchase orders
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- status string? (default ()) - Filter by purchase order status
- dateFrom string? (default ()) - Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
- dateTo string? (default ()) - Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
- 'order string? (default ()) - Order by an any element
- page int? (default ()) - 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.
Return Type
- PurchaseOrders|error - Success - return response of type PurchaseOrder array of all PurchaseOrder
createPurchaseOrders
Isolated FunctionRemote Function
function createPurchaseOrders(string xeroTenantId, PurchaseOrders payload, boolean summarizeErrors) returns PurchaseOrders|errorCreates one or more purchase orders
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload PurchaseOrders - PurchaseOrders with an array of PurchaseOrder object in body of request
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
Return Type
- PurchaseOrders|error - Success - return response of type PurchaseOrder array for specified PurchaseOrder
updateOrCreatePurchaseOrders
Isolated FunctionRemote Function
function updateOrCreatePurchaseOrders(string xeroTenantId, PurchaseOrders payload, boolean summarizeErrors) returns PurchaseOrders|errorUpdates or creates one or more purchase orders
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload PurchaseOrders - PurchaseOrders with an array of PurchaseOrder objects
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
Return Type
- PurchaseOrders|error - Success - return response of type PurchaseOrder array for specified PurchaseOrder
getPurchaseOrderAsPdf
Isolated FunctionRemote Function
Retrieves specific purchase order as PDF files using a unique purchase order Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- purchaseOrderID string - Unique identifier for an Purchase Order
Return Type
getPurchaseOrder
Isolated FunctionRemote Function
function getPurchaseOrder(string xeroTenantId, string purchaseOrderID) returns PurchaseOrders|errorRetrieves a specific purchase order using a unique purchase order Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- purchaseOrderID string - Unique identifier for an Purchase Order
Return Type
- PurchaseOrders|error - Success - return response of type PurchaseOrder array for specified PurchaseOrder
updatePurchaseOrder
Isolated FunctionRemote Function
function updatePurchaseOrder(string xeroTenantId, string purchaseOrderID, PurchaseOrders payload) returns PurchaseOrders|errorUpdates a specific purchase order
Parameters
- xeroTenantId string - Xero identifier for Tenant
- purchaseOrderID string - Unique identifier for an Purchase Order
- payload PurchaseOrders - PurchaseOrders with an array of PurchaseOrder objects
Return Type
- PurchaseOrders|error - Success - return response of type PurchaseOrder array for updated PurchaseOrder
getPurchaseOrderByNumber
Isolated FunctionRemote Function
function getPurchaseOrderByNumber(string xeroTenantId, string purchaseOrderNumber) returns PurchaseOrders|errorRetrieves a specific purchase order using purchase order number
Parameters
- xeroTenantId string - Xero identifier for Tenant
- purchaseOrderNumber string - Unique identifier for a PurchaseOrder
Return Type
- PurchaseOrders|error - Success - return response of type PurchaseOrder array for specified PurchaseOrder
getPurchaseOrderHistory
Isolated FunctionRemote Function
function getPurchaseOrderHistory(string xeroTenantId, string purchaseOrderID) returns HistoryRecords|errorRetrieves history for a specific purchase order
Parameters
- xeroTenantId string - Xero identifier for Tenant
- purchaseOrderID string - Unique identifier for an Purchase Order
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createPurchaseOrderHistory
Isolated FunctionRemote Function
function createPurchaseOrderHistory(string xeroTenantId, string purchaseOrderID, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific purchase orders
Parameters
- xeroTenantId string - Xero identifier for Tenant
- purchaseOrderID string - Unique identifier for an Purchase Order
- 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 xeroTenantId, string purchaseOrderID) returns Attachments|errorRetrieves attachments for a specific purchase order
Parameters
- xeroTenantId string - Xero identifier for Tenant
- purchaseOrderID string - Unique identifier for an Purchase Order
Return Type
- Attachments|error - Success - return response of type Attachments array of Purchase Orders
getPurchaseOrderAttachmentById
Isolated FunctionRemote Function
function getPurchaseOrderAttachmentById(string xeroTenantId, string purchaseOrderID, string attachmentID, string contentType) returns string|errorRetrieves specific attachment for a specific purchase order using a unique attachment Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- purchaseOrderID string - Unique identifier for an Purchase Order
- attachmentID string - Unique identifier for Attachment object
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
getPurchaseOrderAttachmentByFileName
Isolated FunctionRemote Function
function getPurchaseOrderAttachmentByFileName(string xeroTenantId, string purchaseOrderID, string fileName, string contentType) returns string|errorRetrieves a specific attachment for a specific purchase order by filename
Parameters
- xeroTenantId string - Xero identifier for Tenant
- purchaseOrderID string - Unique identifier for an Purchase Order
- fileName string - Name of the attachment
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
createPurchaseOrderAttachmentByFileName
Isolated FunctionRemote Function
function createPurchaseOrderAttachmentByFileName(string xeroTenantId, string purchaseOrderID, string fileName, byte[] payload) returns Attachments|errorCreates attachment for a specific purchase order
Parameters
- xeroTenantId string - Xero identifier for Tenant
- purchaseOrderID string - Unique identifier for an Purchase Order
- fileName string - Name of the attachment
- 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 xeroTenantId, string purchaseOrderID, string fileName, byte[] payload) returns Attachments|errorUpdates a specific attachment for a specific purchase order by filename
Parameters
- xeroTenantId string - Xero identifier for Tenant
- purchaseOrderID string - Unique identifier for an Purchase Order
- fileName string - Name of the attachment
- 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(string xeroTenantId, string? ifModifiedSince, string? dateFrom, string? dateTo, string? expiryDateFrom, string? expiryDateTo, string? contactID, string? status, int? page, string? 'order, string? quoteNumber) returns Quotes|errorRetrieves sales quotes
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- dateFrom string? (default ()) - Filter for quotes after a particular date
- dateTo string? (default ()) - Filter for quotes before a particular date
- expiryDateFrom string? (default ()) - Filter for quotes expiring after a particular date
- expiryDateTo string? (default ()) - Filter for quotes before a particular date
- contactID string? (default ()) - Filter for quotes belonging to a particular contact
- status string? (default ()) - Filter for quotes of a particular Status
- page int? (default ()) - e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote
- 'order string? (default ()) - Order by an any element
- quoteNumber string? (default ()) - Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001)
createQuotes
Isolated FunctionRemote Function
function createQuotes(string xeroTenantId, Quotes payload, boolean summarizeErrors) returns Quotes|errorCreate one or more quotes
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload Quotes - Quotes with an array of Quote object in body of request
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
Return Type
updateOrCreateQuotes
Isolated FunctionRemote Function
function updateOrCreateQuotes(string xeroTenantId, Quotes payload, boolean summarizeErrors) returns Quotes|errorUpdates or creates one or more quotes
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload Quotes - Quotes with an array of Quote objects
- summarizeErrors boolean (default false) - If false return 200 OK and mix of successfully created objects and any with validation errors
Return Type
getQuote
Isolated FunctionRemote Function
Retrieves a specific quote using a unique quote Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- quoteID string - Unique identifier for an Quote
updateQuote
Isolated FunctionRemote Function
Updates a specific quote
Parameters
- xeroTenantId string - Xero identifier for Tenant
- quoteID string - Unique identifier for an Quote
- payload Quotes - Quotes with an array of Quote objects
getQuoteHistory
Isolated FunctionRemote Function
function getQuoteHistory(string xeroTenantId, string quoteID) returns HistoryRecords|errorRetrieves history records of a specific quote
Parameters
- xeroTenantId string - Xero identifier for Tenant
- quoteID string - Unique identifier for an Quote
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createQuoteHistory
Isolated FunctionRemote Function
function createQuoteHistory(string xeroTenantId, string quoteID, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific quote
Parameters
- xeroTenantId string - Xero identifier for Tenant
- quoteID string - Unique identifier for an Quote
- 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
Retrieves a specific quote as a PDF file using a unique quote Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- quoteID string - Unique identifier for an Quote
getQuoteAttachments
Isolated FunctionRemote Function
function getQuoteAttachments(string xeroTenantId, string quoteID) returns Attachments|errorRetrieves attachments for a specific quote
Parameters
- xeroTenantId string - Xero identifier for Tenant
- quoteID string - Unique identifier for an Quote
Return Type
- Attachments|error - Success - return response of type Attachments array of Attachment
getQuoteAttachmentById
Isolated FunctionRemote Function
function getQuoteAttachmentById(string xeroTenantId, string quoteID, string attachmentID, string contentType) returns string|errorRetrieves a specific attachment from a specific quote using a unique attachment Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- quoteID string - Unique identifier for an Quote
- attachmentID string - Unique identifier for Attachment object
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
getQuoteAttachmentByFileName
Isolated FunctionRemote Function
function getQuoteAttachmentByFileName(string xeroTenantId, string quoteID, string fileName, string contentType) returns string|errorRetrieves a specific attachment from a specific quote by filename
Parameters
- xeroTenantId string - Xero identifier for Tenant
- quoteID string - Unique identifier for an Quote
- fileName string - Name of the attachment
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
createQuoteAttachmentByFileName
Isolated FunctionRemote Function
function createQuoteAttachmentByFileName(string xeroTenantId, string quoteID, string fileName, byte[] payload) returns Attachments|errorCreates attachment for a specific quote
Parameters
- xeroTenantId string - Xero identifier for Tenant
- quoteID string - Unique identifier for an Quote
- fileName string - Name of the attachment
- 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 xeroTenantId, string quoteID, string fileName, byte[] payload) returns Attachments|errorUpdates a specific attachment from a specific quote by filename
Parameters
- xeroTenantId string - Xero identifier for Tenant
- quoteID string - Unique identifier for an Quote
- fileName string - Name of the attachment
- 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(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order, int? unitdp) returns Receipts|errorRetrieves draft expense claim receipts for any user
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
createReceipt
Isolated FunctionRemote Function
Creates draft expense claim receipts for any user
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload Receipts - Receipts with an array of Receipt object in body of request
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
getReceipt
Isolated FunctionRemote Function
Retrieves a specific draft expense claim receipt by using a unique receipt Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- receiptID string - Unique identifier for a Receipt
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Return Type
updateReceipt
Isolated FunctionRemote Function
function updateReceipt(string xeroTenantId, string receiptID, Receipts payload, int? unitdp) returns Receipts|errorUpdates a specific draft expense claim receipts
Parameters
- xeroTenantId string - Xero identifier for Tenant
- receiptID string - Unique identifier for a Receipt
- payload Receipts - Receipts with an array of Receipt objects
- unitdp int? (default ()) - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
getReceiptAttachments
Isolated FunctionRemote Function
function getReceiptAttachments(string xeroTenantId, string receiptID) returns Attachments|errorRetrieves attachments for a specific expense claim receipt
Parameters
- xeroTenantId string - Xero identifier for Tenant
- receiptID string - Unique identifier for a Receipt
Return Type
- Attachments|error - Success - return response of type Attachments array of Attachments for a specified Receipt
getReceiptAttachmentById
Isolated FunctionRemote Function
function getReceiptAttachmentById(string xeroTenantId, string receiptID, string attachmentID, string contentType) returns string|errorRetrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- receiptID string - Unique identifier for a Receipt
- attachmentID string - Unique identifier for Attachment object
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
getReceiptAttachmentByFileName
Isolated FunctionRemote Function
function getReceiptAttachmentByFileName(string xeroTenantId, string receiptID, string fileName, string contentType) returns string|errorRetrieves a specific attachment from a specific expense claim receipts by file name
Parameters
- xeroTenantId string - Xero identifier for Tenant
- receiptID string - Unique identifier for a Receipt
- fileName string - Name of the attachment
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
createReceiptAttachmentByFileName
Isolated FunctionRemote Function
function createReceiptAttachmentByFileName(string xeroTenantId, string receiptID, string fileName, byte[] payload) returns Attachments|errorCreates an attachment on a specific expense claim receipts by file name
Parameters
- xeroTenantId string - Xero identifier for Tenant
- receiptID string - Unique identifier for a Receipt
- fileName string - Name of the attachment
- 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 xeroTenantId, string receiptID, string fileName, byte[] payload) returns Attachments|errorUpdates a specific attachment on a specific expense claim receipts by file name
Parameters
- xeroTenantId string - Xero identifier for Tenant
- receiptID string - Unique identifier for a Receipt
- fileName string - Name of the attachment
- 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 xeroTenantId, string receiptID) returns HistoryRecords|errorRetrieves a history record for a specific receipt
Parameters
- xeroTenantId string - Xero identifier for Tenant
- receiptID string - Unique identifier for a Receipt
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createReceiptHistory
Isolated FunctionRemote Function
function createReceiptHistory(string xeroTenantId, string receiptID, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific receipt
Parameters
- xeroTenantId string - Xero identifier for Tenant
- receiptID string - Unique identifier for a Receipt
- 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(string xeroTenantId, string? 'where, string? 'order) returns RepeatingInvoices|errorRetrieves repeating invoices
Parameters
- xeroTenantId string - Xero identifier for Tenant
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
Return Type
- RepeatingInvoices|error - Success - return response of type Repeating Invoices array for all Repeating Invoice
getRepeatingInvoice
Isolated FunctionRemote Function
function getRepeatingInvoice(string xeroTenantId, string repeatingInvoiceID) returns RepeatingInvoices|errorRetrieves a specific repeating invoice by using a unique repeating invoice Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
Return Type
- RepeatingInvoices|error - Success - return response of type Repeating Invoices array with a specified Repeating Invoice
getRepeatingInvoiceAttachments
Isolated FunctionRemote Function
function getRepeatingInvoiceAttachments(string xeroTenantId, string repeatingInvoiceID) returns Attachments|errorRetrieves attachments from a specific repeating invoice
Parameters
- xeroTenantId string - Xero identifier for Tenant
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
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 xeroTenantId, string repeatingInvoiceID, string attachmentID, string contentType) returns string|errorRetrieves a specific attachment from a specific repeating invoice
Parameters
- xeroTenantId string - Xero identifier for Tenant
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
- attachmentID string - Unique identifier for Attachment object
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
Return Type
getRepeatingInvoiceAttachmentByFileName
Isolated FunctionRemote Function
function getRepeatingInvoiceAttachmentByFileName(string xeroTenantId, string repeatingInvoiceID, string fileName, string contentType) returns string|errorRetrieves a specific attachment from a specific repeating invoices by file name
Parameters
- xeroTenantId string - Xero identifier for Tenant
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
- fileName string - Name of the attachment
- contentType string - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
Return Type
createRepeatingInvoiceAttachmentByFileName
Isolated FunctionRemote Function
function createRepeatingInvoiceAttachmentByFileName(string xeroTenantId, string repeatingInvoiceID, string fileName, byte[] payload) returns Attachments|errorCreates an attachment from a specific repeating invoices by file name
Parameters
- xeroTenantId string - Xero identifier for Tenant
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
- fileName string - Name of the attachment
- 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 xeroTenantId, string repeatingInvoiceID, string fileName, byte[] payload) returns Attachments|errorUpdates a specific attachment from a specific repeating invoices by file name
Parameters
- xeroTenantId string - Xero identifier for Tenant
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
- fileName string - Name of the attachment
- 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 xeroTenantId, string repeatingInvoiceID) returns HistoryRecords|errorRetrieves history record for a specific repeating invoice
Parameters
- xeroTenantId string - Xero identifier for Tenant
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
Return Type
- HistoryRecords|error - Success - return response of HistoryRecords array of 0 to N HistoryRecord
createRepeatingInvoiceHistory
Isolated FunctionRemote Function
function createRepeatingInvoiceHistory(string xeroTenantId, string repeatingInvoiceID, HistoryRecords payload) returns HistoryRecords|errorCreates a history record for a specific repeating invoice
Parameters
- xeroTenantId string - Xero identifier for Tenant
- repeatingInvoiceID string - Unique identifier for a Repeating Invoice
- 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
Retrieve reports for 1099
Parameters
- xeroTenantId string - Xero identifier for Tenant
- reportYear string? (default ()) - The year of the 1099 report
getReportAgedPayablesByContact
Isolated FunctionRemote Function
function getReportAgedPayablesByContact(string xeroTenantId, string contactId, string? date, string? fromDate, string? toDate) returns ReportWithRows|errorRetrieves report for aged payables by contact
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactId string - Unique identifier for a Contact
- date string? (default ()) - The date of the Aged Payables By Contact report
- fromDate string? (default ()) - filter by the from date of the report e.g. 2021-02-01
- toDate string? (default ()) - filter by the to date of the report e.g. 2021-02-28
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportAgedReceivablesByContact
Isolated FunctionRemote Function
function getReportAgedReceivablesByContact(string xeroTenantId, string contactId, string? date, string? fromDate, string? toDate) returns ReportWithRows|errorRetrieves report for aged receivables by contact
Parameters
- xeroTenantId string - Xero identifier for Tenant
- contactId string - Unique identifier for a Contact
- date string? (default ()) - The date of the Aged Receivables By Contact report
- fromDate string? (default ()) - filter by the from date of the report e.g. 2021-02-01
- toDate string? (default ()) - filter by the to date of the report e.g. 2021-02-28
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportBalanceSheet
Isolated FunctionRemote Function
function getReportBalanceSheet(string xeroTenantId, string? date, int? periods, string? timeframe, string? trackingOptionID1, string? trackingOptionID2, boolean? standardLayout, boolean? paymentsOnly) returns ReportWithRows|errorRetrieves report for balancesheet
Parameters
- xeroTenantId string - Xero identifier for Tenant
- date string? (default ()) - The date of the Balance Sheet report
- periods int? (default ()) - The number of periods for the Balance Sheet report
- timeframe string? (default ()) - The period size to compare to (MONTH, QUARTER, YEAR)
- trackingOptionID1 string? (default ()) - The tracking option 1 for the Balance Sheet report
- trackingOptionID2 string? (default ()) - The tracking option 2 for the Balance Sheet report
- standardLayout boolean? (default ()) - The standard layout boolean for the Balance Sheet report
- paymentsOnly boolean? (default ()) - return a cash basis for the Balance Sheet report
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportBankSummary
Isolated FunctionRemote Function
function getReportBankSummary(string xeroTenantId, string? fromDate, string? toDate) returns ReportWithRows|errorRetrieves report for bank summary
Parameters
- xeroTenantId string - Xero identifier for Tenant
- fromDate string? (default ()) - filter by the from date of the report e.g. 2021-02-01
- toDate string? (default ()) - filter by the to date of the report e.g. 2021-02-28
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportFromId
Isolated FunctionRemote Function
function getReportFromId(string xeroTenantId, string reportID) returns ReportWithRows|errorRetrieves a specific report using a unique ReportID
Parameters
- xeroTenantId string - Xero identifier for Tenant
- reportID string - Unique identifier for a Report
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportBudgetSummary
Isolated FunctionRemote Function
function getReportBudgetSummary(string xeroTenantId, string? date, int? periods, int? timeframe) returns ReportWithRows|errorRetrieves report for budget summary
Parameters
- xeroTenantId string - Xero identifier for Tenant
- date string? (default ()) - The date for the Bank Summary report e.g. 2018-03-31
- periods int? (default ()) - The number of periods to compare (integer between 1 and 12)
- timeframe int? (default ()) - The period size to compare to (1=month, 3=quarter, 12=year)
Return Type
- ReportWithRows|error - success- return a Report with Rows object
getReportExecutiveSummary
Isolated FunctionRemote Function
function getReportExecutiveSummary(string xeroTenantId, string? date) returns ReportWithRows|errorRetrieves report for executive summary
Parameters
- xeroTenantId string - Xero identifier for Tenant
- date string? (default ()) - The date for the Bank Summary report e.g. 2018-03-31
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportsList
Isolated FunctionRemote Function
function getReportsList(string xeroTenantId) returns ReportWithRows|errorRetrieves a list of the organistaions unique reports that require a uuid to fetch
Parameters
- xeroTenantId string - Xero identifier for Tenant
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportProfitAndLoss
Isolated FunctionRemote Function
function getReportProfitAndLoss(string xeroTenantId, string? fromDate, string? toDate, int? periods, string? timeframe, string? trackingCategoryID, string? trackingCategoryID2, string? trackingOptionID, string? trackingOptionID2, boolean? standardLayout, boolean? paymentsOnly) returns ReportWithRows|errorRetrieves report for profit and loss
Parameters
- xeroTenantId string - Xero identifier for Tenant
- fromDate string? (default ()) - filter by the from date of the report e.g. 2021-02-01
- toDate string? (default ()) - filter by the to date of the report e.g. 2021-02-28
- periods int? (default ()) - The number of periods to compare (integer between 1 and 12)
- timeframe string? (default ()) - The period size to compare to (MONTH, QUARTER, YEAR)
- trackingCategoryID string? (default ()) - The trackingCategory 1 for the ProfitAndLoss report
- trackingCategoryID2 string? (default ()) - The trackingCategory 2 for the ProfitAndLoss report
- trackingOptionID string? (default ()) - The tracking option 1 for the ProfitAndLoss report
- trackingOptionID2 string? (default ()) - The tracking option 2 for the ProfitAndLoss report
- standardLayout boolean? (default ()) - Return the standard layout for the ProfitAndLoss report
- paymentsOnly boolean? (default ()) - Return cash only basis for the ProfitAndLoss report
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
getReportTrialBalance
Isolated FunctionRemote Function
function getReportTrialBalance(string xeroTenantId, string? date, boolean? paymentsOnly) returns ReportWithRows|errorRetrieves report for trial balance
Parameters
- xeroTenantId string - Xero identifier for Tenant
- date string? (default ()) - The date for the Trial Balance report e.g. 2018-03-31
- paymentsOnly boolean? (default ()) - Return cash only basis for the Trial Balance report
Return Type
- ReportWithRows|error - Success - return response of type ReportWithRows
postSetup
Isolated FunctionRemote Function
function postSetup(string xeroTenantId, Setup payload) returns ImportSummaryObject|errorSets the chart of accounts, the conversion date and conversion balances
Parameters
- xeroTenantId string - Xero identifier for Tenant
- 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(string xeroTenantId, string? 'where, string? 'order, string? taxType) returns TaxRates|errorRetrieves tax rates
Parameters
- xeroTenantId string - Xero identifier for Tenant
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
- taxType string? (default ()) - Filter by tax type
createTaxRates
Isolated FunctionRemote Function
Creates one or more tax rates
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload TaxRates - TaxRates array with TaxRate object in body of request
updateTaxRate
Isolated FunctionRemote Function
Updates tax rates
Parameters
- xeroTenantId string - Xero identifier for Tenant
- payload TaxRates - TaxRates with an array of TaxRate objects
getTrackingCategories
Isolated FunctionRemote Function
function getTrackingCategories(string xeroTenantId, string? 'where, string? 'order, boolean? includeArchived) returns TrackingCategories|errorRetrieves tracking categories and options
Parameters
- xeroTenantId string - Xero identifier for Tenant
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
- includeArchived boolean? (default ()) - e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response
Return Type
- TrackingCategories|error - Success - return response of type TrackingCategories array of TrackingCategory
createTrackingCategory
Isolated FunctionRemote Function
function createTrackingCategory(string xeroTenantId, TrackingCategory payload) returns TrackingCategories|errorCreate tracking categories
Parameters
- xeroTenantId string - Xero identifier for Tenant
- 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 xeroTenantId, string trackingCategoryID) returns TrackingCategories|errorRetrieves specific tracking categories and options using a unique tracking category Id
Parameters
- xeroTenantId string - Xero identifier for Tenant
- trackingCategoryID string - Unique identifier for a TrackingCategory
Return Type
- TrackingCategories|error - Success - return response of type TrackingCategories array of specified TrackingCategory
updateTrackingCategory
Isolated FunctionRemote Function
function updateTrackingCategory(string xeroTenantId, string trackingCategoryID, TrackingCategory payload) returns TrackingCategories|errorUpdates a specific tracking category
Parameters
- xeroTenantId string - Xero identifier for Tenant
- trackingCategoryID string - Unique identifier for a TrackingCategory
- payload TrackingCategory - TrackingCategories with an array of TrackingCategory objects
Return Type
- TrackingCategories|error - Success - return response of type TrackingCategories array of updated TrackingCategory
deleteTrackingCategory
Isolated FunctionRemote Function
function deleteTrackingCategory(string xeroTenantId, string trackingCategoryID) returns TrackingCategories|errorDeletes a specific tracking category
Parameters
- xeroTenantId string - Xero identifier for Tenant
- trackingCategoryID string - Unique identifier for a TrackingCategory
Return Type
- TrackingCategories|error - Success - return response of type TrackingCategories array of deleted TrackingCategory
createTrackingOptions
Isolated FunctionRemote Function
function createTrackingOptions(string xeroTenantId, string trackingCategoryID, TrackingOption payload) returns TrackingOptions|errorCreates options for a specific tracking category
Parameters
- xeroTenantId string - Xero identifier for Tenant
- trackingCategoryID string - Unique identifier for a TrackingCategory
- 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 xeroTenantId, string trackingCategoryID, string trackingOptionID, TrackingOption payload) returns TrackingOptions|errorUpdates a specific option for a specific tracking category
Parameters
- xeroTenantId string - Xero identifier for Tenant
- trackingCategoryID string - Unique identifier for a TrackingCategory
- trackingOptionID string - Unique identifier for a Tracking Option
- payload TrackingOption - TrackingOptios with an array of TrackingOption objects
Return Type
- TrackingOptions|error - Success - return response of type TrackingOptions array of options for a specified category
deleteTrackingOptions
Isolated FunctionRemote Function
function deleteTrackingOptions(string xeroTenantId, string trackingCategoryID, string trackingOptionID) returns TrackingOptions|errorDeletes a specific option for a specific tracking category
Parameters
- xeroTenantId string - Xero identifier for Tenant
- trackingCategoryID string - Unique identifier for a TrackingCategory
- trackingOptionID string - Unique identifier for a Tracking Option
Return Type
- TrackingOptions|error - Success - return response of type TrackingOptions array of remaining options for a specified category
getUsers
Isolated FunctionRemote Function
function getUsers(string xeroTenantId, string? ifModifiedSince, string? 'where, string? 'order) returns Users|errorRetrieves users
Parameters
- xeroTenantId string - Xero identifier for Tenant
- ifModifiedSince string? (default ()) - Only records created or modified since this timestamp will be returned
- 'where string? (default ()) - Filter by an any element
- 'order string? (default ()) - Order by an any element
getUser
Isolated FunctionRemote Function
Retrieves a specific user
Records
xero.accounts: Account
Fields
- Code string? - Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)
- Name string? - Name of account (max length = 150)
- AccountID string? - The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9
- Type AccountType? - See Account Types
- BankAccountNumber string? - For bank accounts only (Account Type BANK)
- Status string? - Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes
- Description string? - Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)
- BankAccountType string? - For bank accounts only. See Bank Account types
- CurrencyCode CurrencyCode? - 3 letter alpha code for the currency – see list of currency codes
- TaxType string? - The tax type from TaxRates
- EnablePaymentsToAccount boolean? - Boolean – describes whether account can have payments applied to it
- ShowInExpenseClaims boolean? - Boolean – describes whether account code is available for use with expense claims
- Class string? - See Account Class Types
- SystemAccount string? - 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.
- ReportingCode string? - Shown if set
- ReportingCodeName string? - Shown if set
- HasAttachments boolean? - boolean to indicate if an account has an attachment (read only)
- UpdatedDateUTC string? - Last modified date UTC format
- AddToWatchlist boolean? - Boolean – describes whether the account is shown in the watchlist widget on the dashboard
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
xero.accounts: Accounts
Fields
- Accounts Account[]? -
xero.accounts: AccountsPayable
The amounts for goods or services received that have not yet been paid for.
Fields
- Outstanding decimal? - total amount that should be given to other organization but not yet given
- Overdue decimal? - KPI that indicates payments that are yet to be given by the organization.
xero.accounts: AccountsReceivable
The balance of money for goods or services delivered or used but not yet paid for by customers.
Fields
- Outstanding decimal? - Total amount currently owed or promised to the organization but not yet received.
- Overdue decimal? - KPI that indicates payments that are yet to be received by the organization.
xero.accounts: Action
Fields
- Name string? - Name of the actions for this organisation
- Status string? - Status of the action for this organisation
xero.accounts: Actions
Fields
- Actions Action[]? -
xero.accounts: Address
Fields
- AddressType string? - define the type of address
- AddressLine1 string? - max length = 500
- AddressLine2 string? - max length = 500
- AddressLine3 string? - max length = 500
- AddressLine4 string? - max length = 500
- City string? - max length = 255
- Region string? - max length = 255
- PostalCode string? - max length = 50
- Country string? - max length = 50, [A-Z], [a-z] only
- AttentionTo string? - max length = 255
xero.accounts: AddressForOrganisation
Fields
- AddressType string? - define the type of address
- AddressLine1 string? - max length = 500
- AddressLine2 string? - max length = 500
- AddressLine3 string? - max length = 500
- AddressLine4 string? - max length = 500
- City string? - max length = 255
- Region string? - max length = 255
- PostalCode string? - max length = 50
- Country string? - max length = 50, [A-Z], [a-z] only
- AttentionTo string? - max length = 255
xero.accounts: Allocation
Fields
- Invoice Invoice -
- Overpayment Overpayment? -
- Prepayment Prepayment? -
- CreditNote CreditNote? -
- Amount decimal - the amount being applied to the invoice
- Date string - the date the allocation is applied YYYY-MM-DD.
- StatusAttributeString string? - A string to indicate if a invoice status
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
xero.accounts: Allocations
Fields
- Allocations Allocation[]? -
xero.accounts: Attachment
Fields
- AttachmentID string? - Unique ID for the file
- FileName string? - Name of the file
- Url string? - URL to the file on xero.com
- MimeType string? - Type of file
- ContentLength int? - Length of the file content
- IncludeOnline boolean? - Include the file with the online invoice
xero.accounts: Attachments
Fields
- Attachments Attachment[]? -
xero.accounts: BalanceDetails
An array to specify multiple currency balances of an account
Fields
- Balance decimal? - The opening balances of the account. Debits are positive, credits are negative values
- 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
xero.accounts: Balances
The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only)
Fields
- AccountsReceivable AccountsReceivable? - The balance of money for goods or services delivered or used but not yet paid for by customers.
- AccountsPayable AccountsPayable? - The amounts for goods or services received that have not yet been paid for.
xero.accounts: BankTransaction
Fields
- Type string - See Bank Transaction Types
- Contact Contact? -
- LineItems LineItem[] - See LineItems
- BankAccount Account -
- IsReconciled boolean? - Boolean to show if transaction is reconciled
- Date string? - Date of transaction – YYYY-MM-DD
- Reference string? - Reference for the transaction. Only supported for SPEND and RECEIVE transactions.
- CurrencyCode CurrencyCode? - 3 letter alpha code for the currency – see list of currency codes
- 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.
- Url string? - URL link to a source document – shown as “Go to App Name”
- Status string? - See Bank Transaction Status Codes
- LineAmountTypes LineAmountTypes? - Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types
- SubTotal decimal? - Total of bank transaction excluding taxes
- TotalTax decimal? - Total tax on bank transaction
- Total decimal? - Total of bank transaction tax inclusive
- BankTransactionID string? - Xero generated unique identifier for bank transaction
- PrepaymentID string? - Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT
- OverpaymentID string? - Xero generated unique identifier for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT
- UpdatedDateUTC string? - Last modified date UTC format
- HasAttachments boolean(default false) - Boolean to indicate if a bank transaction has an attachment
- StatusAttributeString string? - A string to indicate if a invoice status
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
xero.accounts: BankTransactions
Fields
- BankTransactions BankTransaction[]? -
xero.accounts: BankTransfer
Fields
- FromBankAccount Account -
- ToBankAccount Account -
- Amount decimal - amount of the transaction
- Date string? - The date of the Transfer YYYY-MM-DD
- BankTransferID string? - The identifier of the Bank Transfer
- CurrencyRate decimal? - The currency rate
- FromBankTransactionID string? - The Bank Transaction ID for the source account
- ToBankTransactionID string? - The Bank Transaction ID for the destination account
- HasAttachments boolean(default false) - Boolean to indicate if a Bank Transfer has an attachment
- CreatedDateUTC string? - UTC timestamp of creation date of bank transfer
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
xero.accounts: BankTransfers
Fields
- BankTransfers BankTransfer[]? -
xero.accounts: BatchPayment
Fields
- Account Account? -
- 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.
- 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.
- 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.
- 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
- BatchPaymentID string? - The Xero generated unique identifier for the bank transaction (read-only)
- DateString string? - Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
- Date string? - Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
- 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
- Type string? - PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only)
- Status string? - 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.
- TotalAmount string? - The total of the payments that make up the batch (read-only)
- UpdatedDateUTC string? - UTC timestamp of last update to the payment
- IsReconciled string? - Booelan that tells you if the batch payment has been reconciled (read-only)
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
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[]? -
xero.accounts: Bill
Fields
- Day int? - Day of Month (0-31)
- Type PaymentTermType? -
xero.accounts: BrandingTheme
Fields
- BrandingThemeID string? - Xero identifier
- Name string? - Name of branding theme
- LogoUrl string? - The location of the image file used as the logo on this branding theme
- Type string? - Always INVOICE
- SortOrder int? - Integer – ranked order of branding theme. The default branding theme has a value of 0
- CreatedDateUTC string? - UTC timestamp of creation date of branding theme
xero.accounts: BrandingThemes
Fields
- BrandingThemes BrandingTheme[]? -
xero.accounts: Budget
Fields
- BudgetID string? - Xero identifier
- Type string? - Type of Budget. OVERALL or TRACKING
- Description string? - The Budget description
- UpdatedDateUTC string? - UTC timestamp of last update to budget
- BudgetLines BudgetLine[]? -
- Tracking TrackingCategory[]? -
xero.accounts: BudgetBalance
Fields
- Period string? - Period the amount applies to (e.g. “2019-08”)
- Amount int? - LineItem Quantity
- UnitAmount int? - Budgeted amount
- Notes string? - Any footnotes associated with this balance
xero.accounts: BudgetLine
Fields
- AccountID string? - See Accounts
- AccountCode string? - See Accounts
- BudgetBalances BudgetBalance[]? -
xero.accounts: Budgets
Fields
- Budgets Budget[]? -
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[]? -
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[]? -
xero.accounts: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
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? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - 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
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - 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? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
xero.accounts: Contact
Fields
- ContactID string? - Xero identifier
- 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.
- AccountNumber string? - A user defined account number. This can be updated via the API and the Xero UI (max length = 50)
- ContactStatus string? - Current status of a contact – see contact status types
- Name string? - Full name of contact/organisation (max length = 255)
- FirstName string? - First name of contact person (max length = 255)
- LastName string? - Last name of contact person (max length = 255)
- EmailAddress string? - Email address of contact person (umlauts not supported) (max length = 255)
- SkypeUserName string? - Skype user name of contact
- ContactPersons ContactPerson[]? - See contact persons
- BankAccountDetails string? - Bank account number of contact
- 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)
- AccountsReceivableTaxType string? - The tax type from TaxRates
- AccountsPayableTaxType string? - The tax type from TaxRates
- Addresses Address[]? - Store certain address types for a contact – see address types
- Phones Phone[]? - Store certain phone types for a contact – see phone types
- 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.
- 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.
- DefaultCurrency CurrencyCode? - 3 letter alpha code for the currency – see list of currency codes
- XeroNetworkKey string? - Store XeroNetworkKey for contacts.
- SalesDefaultAccountCode string? - The default sales account code for contacts
- PurchasesDefaultAccountCode string? - The default purchases account code for contacts
- SalesTrackingCategories SalesTrackingCategory[]? - The default sales tracking categories for contacts
- PurchasesTrackingCategories SalesTrackingCategory[]? - The default purchases tracking categories for contacts
- TrackingCategoryName string? - The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
- TrackingCategoryOption string? - The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories
- PaymentTerms PaymentTerm? -
- UpdatedDateUTC string? - UTC timestamp of last update to contact
- ContactGroups ContactGroup[]? - Displays which contact groups a contact is included in
- Website string? - Website address for contact (read only)
- BrandingTheme BrandingTheme? -
- BatchPayments BatchPaymentDetails? - Bank details for use on a batch payment stored with each contact
- Discount decimal? - The default discount rate for the contact (read only)
- Balances Balances? - The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only)
- Attachments Attachment[]? - Displays array of attachments from the API
- HasAttachments boolean? - A boolean to indicate if a contact has an attachment
- ValidationErrors ValidationError[]? - Displays validation errors returned from the API
- HasValidationErrors boolean? - A boolean to indicate if a contact has an validation errors
- StatusAttributeString string? - Status of object
xero.accounts: ContactGroup
Fields
- Name string? - The Name of the contact group. Required when creating a new contact group
- Status string? - 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.
xero.accounts: ContactGroups
Fields
- ContactGroups ContactGroup[]? -
xero.accounts: ContactPerson
Fields
- FirstName string? - First name of person
- LastName string? - Last name of person
- EmailAddress string? - Email address of person
- IncludeInEmails boolean? - boolean to indicate whether contact should be included on emails with invoices etc.
xero.accounts: Contacts
Fields
- Contacts Contact[]? -
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
- Balance decimal? - The opening balances of the account. Debits are positive, credits are negative values
- BalanceDetails BalanceDetails[]? - An array to specify multiple currency balances of an account
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: CreditNote
Fields
- Type string? - See Credit Note Types
- Contact Contact? -
- 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
- DueDate string? - Date invoice is due – YYYY-MM-DD
- Status string? - See Credit Note Status Codes
- LineAmountTypes LineAmountTypes? - Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types
- LineItems LineItem[]? - See Invoice Line Items
- SubTotal decimal? - The subtotal of the credit note excluding taxes
- TotalTax decimal? - The total tax on the credit note
- Total decimal? - The total of the Credit Note(subtotal + total tax)
- CISDeduction decimal? - CIS deduction for UK contractors
- CISRate decimal? - CIS Deduction rate for the organisation
- UpdatedDateUTC string? - UTC timestamp of last update to the credit note
- CurrencyCode CurrencyCode? - 3 letter alpha code for the currency – see list of currency codes
- FullyPaidOnDate string? - Date when credit note was fully paid(UTC format)
- 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)
- Reference string? - ACCRECCREDIT only – additional reference number
- SentToContact boolean? - boolean to indicate if a credit note has been sent to a contact via the Xero app (currently read only)
- CurrencyRate decimal? - The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used
- RemainingCredit decimal? - The remaining credit balance on the Credit Note
- Allocations Allocation[]? - See Allocations
- AppliedAmount decimal? - The amount of applied to an invoice
- Payments Payment[]? - See Payments
- BrandingThemeID string? - See BrandingThemes
- StatusAttributeString string? - A string to indicate if a invoice status
- HasAttachments boolean? - boolean to indicate if a credit note has an attachment
- HasErrors boolean? - A boolean to indicate if a credit note has an validation errors
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
- Warnings ValidationError[]? - Displays array of warning messages from the API
xero.accounts: CreditNotes
Fields
- CreditNotes CreditNote[]? -
xero.accounts: Currencies
Fields
- Currencies Currency[]? -
xero.accounts: Currency
Fields
- Code CurrencyCode? - 3 letter alpha code for the currency – see list of currency codes
- Description string? - Name of Currency
xero.accounts: Element
Fields
- ValidationErrors ValidationError[]? - Array of Validation Error message
- BatchPaymentID string? - Unique ID for batch payment object with validation error
- BankTransactionID string? -
- CreditNoteID string? -
- ContactID string? -
- InvoiceID string? -
- ItemID string? -
- PurchaseOrderID string? -
xero.accounts: Employee
Fields
- EmployeeID string? - The Xero identifier for an employee e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
- Status string? - Current status of an employee – see contact status types
- FirstName string? - First name of an employee (max length = 255)
- LastName string? - Last name of an employee (max length = 255)
- ExternalLink ExternalLink? -
- UpdatedDateUTC string? -
- StatusAttributeString string? - A string to indicate if a invoice status
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
xero.accounts: Employees
Fields
- Employees Employee[]? -
xero.accounts: Error
Fields
- ErrorNumber int? - Exception number
- Type string? - Exception type
- Message string? - Exception message
- Elements Element[]? - Array of Elements of validation Errors
xero.accounts: ExpenseClaim
Fields
- ExpenseClaimID string? - Xero generated unique identifier for an expense claim
- Status string? - Current status of an expense claim – see status types
- Payments Payment[]? - See Payments
- User User? -
- Receipts Receipt[]? -
- UpdatedDateUTC string? - Last modified date UTC format
- Total decimal? - The total of an expense claim being paid
- AmountDue decimal? - The amount due to be paid for an expense claim
- AmountPaid decimal? - The amount still to pay for an expense claim
- PaymentDueDate string? - The date when the expense claim is due to be paid YYYY-MM-DD
- ReportingDate string? - The date the expense claim will be reported in Xero YYYY-MM-DD
- ReceiptID string? - The Xero identifier for the Receipt e.g. e59a2c7f-1306-4078-a0f3-73537afcbba9
xero.accounts: ExpenseClaims
Fields
- ExpenseClaims ExpenseClaim[]? -
xero.accounts: ExternalLink
Fields
- LinkType string? - See External link types
- Url string? - URL for service e.g. http://twitter.com/xeroapi
- Description string? -
xero.accounts: HistoryRecord
Fields
- Details string? - details
- Changes string? - Name of branding theme
- User string? - has a value of 0
- DateUTC string? - UTC timestamp of creation date of branding theme
xero.accounts: HistoryRecords
Fields
- HistoryRecords HistoryRecord[]? -
xero.accounts: ImportSummary
A summary of the import from setup endpoint
Fields
- Accounts ImportSummaryAccounts? - A summary of the accounts changes
- Organisation ImportSummaryOrganisation? - A summary of the organization changes
xero.accounts: ImportSummaryAccounts
A summary of the accounts changes
Fields
- Total int? - The total number of accounts in the org
- New int? - The number of new accounts created
- Updated int? - The number of accounts updated
- Deleted int? - The number of accounts deleted
- Locked int? - The number of locked accounts
- System int? - The number of system accounts
- Errored int? - The number of accounts that had an error
- Present boolean? - The availability of accounts
- NewOrUpdated int? - The number of new or updated accounts
xero.accounts: ImportSummaryObject
Fields
- ImportSummary ImportSummary? - A summary of the import from setup endpoint
xero.accounts: ImportSummaryOrganisation
A summary of the organization changes
Fields
- Present boolean? - A summary of the organization changes at present
xero.accounts: Invoice
Fields
- Type string? - See Invoice Types
- Contact Contact? -
- LineItems LineItem[]? - See LineItems
- 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
- DueDate string? - Date invoice is due – YYYY-MM-DD
- LineAmountTypes LineAmountTypes? - Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types
- InvoiceNumber string? - ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255)
- Reference string? - ACCREC only – additional reference number
- BrandingThemeID string? - See BrandingThemes
- Url string? - URL link to a source document – shown as “Go to [appName]” in the Xero app
- CurrencyCode CurrencyCode? - 3 letter alpha code for the currency – see list of currency codes
- 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])
- Status string? - See Invoice Status Codes
- 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
- ExpectedPaymentDate string? - Shown on sales invoices (Accounts Receivable) when this has been set
- PlannedPaymentDate string? - Shown on bills (Accounts Payable) when this has been set
- CISDeduction decimal? - CIS deduction for UK contractors
- CISRate decimal? - CIS Deduction rate for the organisation
- SubTotal decimal? - Total of invoice excluding taxes
- TotalTax decimal? - Total tax on invoice
- Total decimal? - Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts
- TotalDiscount decimal? - Total of discounts applied on the invoice line items
- InvoiceID string? - Xero generated unique identifier for invoice
- RepeatingInvoiceID string? - Xero generated unique identifier for repeating invoices
- HasAttachments boolean? - boolean to indicate if an invoice has an attachment
- IsDiscounted boolean? - boolean to indicate if an invoice has a discount
- Payments Payment[]? - See Payments
- Prepayments Prepayment[]? - See Prepayments
- Overpayments Overpayment[]? - See Overpayments
- AmountDue decimal? - Amount remaining to be paid on invoice
- AmountPaid decimal? - Sum of payments received for invoice
- FullyPaidOnDate string? - The date the invoice was fully paid. Only returned on fully paid invoices
- AmountCredited decimal? - Sum of all credit notes, over-payments and pre-payments applied to invoice
- UpdatedDateUTC string? - Last modified date UTC format
- CreditNotes CreditNote[]? - Details of credit notes that have been applied to an invoice
- Attachments Attachment[]? - Displays array of attachments from the API
- HasErrors boolean? - A boolean to indicate if a invoice has an validation errors
- StatusAttributeString string? - A string to indicate if a invoice status
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
- Warnings ValidationError[]? - Displays array of warning messages from the API
xero.accounts: InvoiceReminder
Fields
- Enabled boolean? - setting for on or off
xero.accounts: InvoiceReminders
Fields
- InvoiceReminders InvoiceReminder[]? -
xero.accounts: Invoices
Fields
- Invoices Invoice[]? -
xero.accounts: Item
Fields
- Code string - User defined item code (max length = 30)
- 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
- 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.
- 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.
- Description string? - The sales description of the item (max length = 4000)
- PurchaseDescription string? - The purchase description of the item (max length = 4000)
- PurchaseDetails Purchase? -
- SalesDetails Purchase? -
- IsTrackedAsInventory boolean? - True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set.
- TotalCostPool decimal? - The value of the item on hand. Calculated using average cost accounting.
- QuantityOnHand decimal? - The quantity of the item on hand
- UpdatedDateUTC string? - Last modified date in UTC format
- ItemID string? - The Xero identifier for an Item
- StatusAttributeString string? - Status of object
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
xero.accounts: Items
Fields
- Items Item[]? -
xero.accounts: Journal
Fields
- JournalID string? - Xero identifier
- JournalDate string? - Date the journal was posted
- JournalNumber int? - Xero generated journal number
- CreatedDateUTC string? - Created date UTC format
- Reference string? - reference field for additional indetifying information
- SourceID string? - The identifier for the source transaction (e.g. InvoiceID)
- SourceType string? - The journal source type. The type of transaction that created the journal
- JournalLines JournalLine[]? - See JournalLines
xero.accounts: JournalLine
Fields
- JournalLineID string? - Xero identifier for Journal
- AccountID string? - See Accounts
- AccountCode string? - See Accounts
- AccountType AccountType? - See Account Types
- AccountName string? - See AccountCodes
- Description string? - The description from the source transaction line item. Only returned if populated.
- NetAmount decimal? - Net amount of journal line. This will be a positive value for a debit and negative for a credit
- GrossAmount decimal? - Gross amount of journal line (NetAmount + TaxAmount).
- TaxAmount decimal? - Total tax on a journal line
- TaxType string? - The tax type from TaxRates
- TaxName string? - see TaxRates
- TrackingCategories TrackingCategory[]? - Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements.
xero.accounts: Journals
Fields
- Journals Journal[]? -
xero.accounts: LineItem
Fields
- LineItemID string? - LineItem unique ID
- 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
- Quantity decimal? - LineItem Quantity
- UnitAmount decimal? - LineItem Unit Amount
- ItemCode string? - See Items
- AccountCode string? - See Accounts
- AccountID string? - The associated account ID related to this line item
- TaxType string? - The tax type from TaxRates
- 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.
- LineAmount decimal? - If you wish to omit either of 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 a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100)
- Tracking LineItemTracking[]? - Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements.
- 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 - ACCPAY invoices and credit notes in Xero do not support discounts.
- RepeatingInvoiceID string? - The Xero identifier for a Repeating Invoice
xero.accounts: LineItemTracking
Fields
- TrackingCategoryID string? - The Xero identifier for a tracking category
- TrackingOptionID string? - The Xero identifier for a tracking category option
- Name string? - The name of the tracking category
- Option string? - See Tracking Options
xero.accounts: LinkedTransaction
Fields
- SourceTransactionID string? - Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice
- SourceLineItemID string? - The line item identifier from the source transaction.
- 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.
- TargetTransactionID string? - Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice
- TargetLineItemID string? - The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID.
- LinkedTransactionID string? - The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9
- Status 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.
- Type string? - This will always be BILLABLEEXPENSE. More types may be added in future.
- UpdatedDateUTC string? - The last modified date in UTC format
- SourceTransactionTypeCode string? - 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.
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
xero.accounts: LinkedTransactions
Fields
- LinkedTransactions LinkedTransaction[]? -
xero.accounts: ManualJournal
Fields
- Narration string - Description of journal being posted
- JournalLines ManualJournalLine[]? - See JournalLines
- Date string? - Date journal was posted – YYYY-MM-DD
- LineAmountTypes LineAmountTypes? - Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types
- Status string? - See Manual Journal Status Codes
- Url string? - Url link to a source document – shown as “Go to [appName]” in the Xero app
- ShowOnCashBasisReports boolean? - Boolean – default is true if not specified
- HasAttachments boolean(default false) - Boolean to indicate if a manual journal has an attachment
- UpdatedDateUTC string? - Last modified date UTC format
- ManualJournalID string? - The Xero identifier for a Manual Journal
- StatusAttributeString string? - A string to indicate if a invoice status
- Warnings ValidationError[]? - Displays array of warning messages from the API
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
- Attachments Attachment[]? - Displays array of attachments from the API
xero.accounts: ManualJournalLine
Fields
- LineAmount decimal? - total for line. Debits are positive, credits are negative value
- AccountCode string? - See Accounts
- AccountID string? - See Accounts
- Description string? - Description for journal line
- TaxType string? - The tax type from TaxRates
- Tracking TrackingCategory[]? - Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements.
- TaxAmount decimal? - The calculated tax amount based on the TaxType and LineAmount
- IsBlank boolean? - is the line blank
xero.accounts: ManualJournals
Fields
- ManualJournals ManualJournal[]? -
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[]? -
xero.accounts: Organisation
Fields
- OrganisationID string? - Unique Xero identifier
- APIKey string? - Display a unique key used for Xero-to-Xero transactions
- Name string? - Display name of organisation shown in Xero
- LegalName string? - Organisation name shown on Reports
- PaysTax boolean? - Boolean to describe if organisation is registered with a local tax authority i.e. true, false
- Version string? - See Version Types
- OrganisationType string? - Organisation Type
- BaseCurrency CurrencyCode? - 3 letter alpha code for the currency – see list of currency codes
- CountryCode CountryCode? -
- IsDemoCompany boolean? - Boolean to describe if organisation is a demo company.
- OrganisationStatus string? - Will be set to ACTIVE if you can connect to organisation via the Xero API
- RegistrationNumber string? - Shows for New Zealand, Australian and UK organisations
- EmployerIdentificationNumber string? - Shown if set. US Only.
- 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).
- FinancialYearEndDay int? - Calendar day e.g. 0-31
- FinancialYearEndMonth int? - Calendar Month e.g. 1-12
- SalesTaxBasis string? - The accounting basis used for tax returns. See Sales Tax Basis
- SalesTaxPeriod string? - The frequency with which tax returns are processed. See Sales Tax Period
- DefaultSalesTax string? - The default for LineAmountTypes on sales transactions
- DefaultPurchasesTax string? - The default for LineAmountTypes on purchase transactions
- PeriodLockDate string? - Shown if set. See lock dates
- EndOfYearLockDate string? - Shown if set. See lock dates
- CreatedDateUTC string? - Timestamp when the organisation was created in Xero
- Timezone TimeZone? - Timezone specifications
- OrganisationEntityType string? - Organisation Entity Type
- ShortCode string? - A unique identifier for the organisation. Potential uses.
- Class string? - Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)
- Edition string? - BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing)
- LineOfBusiness string? - Description of business type as defined in Organisation settings
- Addresses AddressForOrganisation[]? - Address details for organisation – see Addresses
- Phones Phone[]? - Phones details for organisation – see Phones
- 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
- PaymentTerms PaymentTerm? -
xero.accounts: Organisations
Fields
- Organisations Organisation[]? -
xero.accounts: Overpayment
Fields
- Type string? - See Overpayment Types
- Contact Contact? -
- Date string? - The date the overpayment is created YYYY-MM-DD
- Status string? - See Overpayment Status Codes
- LineAmountTypes LineAmountTypes? - Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types
- LineItems LineItem[]? - See Overpayment Line Items
- SubTotal decimal? - The subtotal of the overpayment excluding taxes
- TotalTax decimal? - The total tax on the overpayment
- Total decimal? - The total of the overpayment (subtotal + total tax)
- UpdatedDateUTC string? - UTC timestamp of last update to the overpayment
- CurrencyCode CurrencyCode? - 3 letter alpha code for the currency – see list of currency codes
- OverpaymentID string? - Xero generated unique identifier
- CurrencyRate decimal? - The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used
- RemainingCredit decimal? - The remaining credit balance on the overpayment
- Allocations Allocation[]? - See Allocations
- AppliedAmount decimal? - The amount of applied to an invoice
- Payments Payment[]? - See Payments
- HasAttachments boolean? - boolean to indicate if a overpayment has an attachment
- Attachments Attachment[]? - See Attachments
xero.accounts: Overpayments
Fields
- Overpayments Overpayment[]? -
xero.accounts: Payment
Fields
- Invoice Invoice? -
- CreditNote CreditNote? -
- Prepayment Prepayment? -
- Overpayment Overpayment? -
- InvoiceNumber string? - Number of invoice or credit note you are applying payment to e.g.INV-4003
- CreditNoteNumber string? - Number of invoice or credit note you are applying payment to e.g. INV-4003
- Account Account? -
- 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
- CurrencyRate decimal? - Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500
- 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
- Reference string? - An optional description for the payment e.g. Direct Debit
- 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
- Status string? - The status of the payment.
- PaymentType string? - See Payment Types.
- UpdatedDateUTC string? - UTC timestamp of last update to the payment
- PaymentID string? - The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
- BatchPaymentID string? - Present if the payment was created as part of a batch.
- BankAccountNumber string? - The suppliers bank account number the payment is being made to
- Particulars string? - The suppliers bank account number the payment is being made to
- Details string? - The information to appear on the supplier's bank account
- HasAccount boolean? - A boolean to indicate if a contact has an validation errors
- HasValidationErrors boolean? - A boolean to indicate if a contact has an validation errors
- StatusAttributeString string? - A string to indicate if a invoice status
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
xero.accounts: PaymentDelete
Fields
- Status string - The status of the payment.
xero.accounts: Payments
Fields
- Payments Payment[]? -
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[]? -
xero.accounts: PaymentTerm
Fields
- Bills Bill? -
- Sales Bill? -
xero.accounts: Phone
Fields
- PhoneType string? -
- PhoneNumber string? - max length = 50
- PhoneAreaCode string? - max length = 10
- PhoneCountryCode string? - max length = 20
xero.accounts: Prepayment
Fields
- Type string? - See Prepayment Types
- Contact Contact? -
- Date string? - The date the prepayment is created YYYY-MM-DD
- Status string? - See Prepayment Status Codes
- LineAmountTypes LineAmountTypes? - Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types
- LineItems LineItem[]? - See Prepayment Line Items
- SubTotal decimal? - The subtotal of the prepayment excluding taxes
- TotalTax decimal? - The total tax on the prepayment
- Total decimal? - The total of the prepayment(subtotal + total tax)
- Reference string? - Returns Invoice number field. Reference field isn't available.
- UpdatedDateUTC string? - UTC timestamp of last update to the prepayment
- CurrencyCode CurrencyCode? - 3 letter alpha code for the currency – see list of currency codes
- PrepaymentID string? - Xero generated unique identifier
- CurrencyRate decimal? - The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used
- RemainingCredit decimal? - The remaining credit balance on the prepayment
- Allocations Allocation[]? - See Allocations
- Payments Payment[]? - See Payments
- AppliedAmount decimal? - The amount of applied to an invoice
- HasAttachments boolean? - boolean to indicate if a prepayment has an attachment
- Attachments Attachment[]? - See Attachments
xero.accounts: Prepayments
Fields
- Prepayments Prepayment[]? -
xero.accounts: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
xero.accounts: Purchase
Fields
- 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.
- TaxType string? - The tax type from TaxRates
xero.accounts: PurchaseOrder
Fields
- Contact Contact? -
- LineItems LineItem[]? - See LineItems
- 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
- DeliveryDate string? - Date the goods are to be delivered – YYYY-MM-DD
- LineAmountTypes LineAmountTypes? - Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types
- PurchaseOrderNumber string? - Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)
- Reference string? - Additional reference number
- BrandingThemeID string? - See BrandingThemes
- CurrencyCode CurrencyCode? - 3 letter alpha code for the currency – see list of currency codes
- Status string? - See Purchase Order Status Codes
- 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
- DeliveryAddress string? - The address the goods are to be delivered to
- AttentionTo string? - The person that the delivery is going to
- Telephone string? - The phone number for the person accepting the delivery
- DeliveryInstructions string? - A free text feild for instructions (500 characters max)
- ExpectedArrivalDate string? - The date the goods are expected to arrive.
- PurchaseOrderID string? - Xero generated unique identifier for purchase order
- CurrencyRate decimal? - The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used.
- SubTotal decimal? - Total of purchase order excluding taxes
- TotalTax decimal? - Total tax on purchase order
- Total decimal? - Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax)
- TotalDiscount decimal? - Total of discounts applied on the purchase order line items
- HasAttachments boolean? - boolean to indicate if a purchase order has an attachment
- UpdatedDateUTC string? - Last modified date UTC format
- StatusAttributeString string? - A string to indicate if a invoice status
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
- Warnings ValidationError[]? - Displays array of warning messages from the API
- Attachments Attachment[]? - Displays array of attachments from the API
xero.accounts: PurchaseOrders
Fields
- PurchaseOrders PurchaseOrder[]? -
xero.accounts: Quote
Fields
- QuoteID string? - QuoteID GUID is automatically generated and is returned after create or GET.
- QuoteNumber string? - Unique alpha numeric code identifying a quote (Max Length = 255)
- Reference string? - Additional reference number
- Terms string? - Terms of the quote
- Contact Contact? -
- LineItems LineItem[]? - See LineItems
- 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
- DateString string? - Date the quote was issued (YYYY-MM-DD)
- ExpiryDate string? - Date the quote expires – YYYY-MM-DD.
- ExpiryDateString string? - Date the quote expires – YYYY-MM-DD.
- Status QuoteStatusCodes? - The status of the quote.
- CurrencyCode CurrencyCode? - 3 letter alpha code for the currency – see list of currency codes
- CurrencyRate decimal? - The currency rate for a multicurrency quote
- SubTotal decimal? - Total of quote excluding taxes.
- TotalTax decimal? - Total tax on quote
- 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
- TotalDiscount decimal? - Total of discounts applied on the quote line items
- Title string? - Title text for the quote
- Summary string? - Summary text for the quote
- BrandingThemeID string? - See BrandingThemes
- UpdatedDateUTC string? - Last modified date UTC format
- LineAmountTypes QuoteLineAmountTypes? - Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types
- StatusAttributeString string? - A string to indicate if a invoice status
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
xero.accounts: Quotes
Fields
- Quotes Quote[]? -
xero.accounts: Receipt
Fields
- Date string? - Date of receipt – YYYY-MM-DD
- Contact Contact? -
- LineItems LineItem[]? -
- User User? -
- Reference string? - Additional reference number
- LineAmountTypes LineAmountTypes? - Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types
- SubTotal decimal? - Total of receipt excluding taxes
- TotalTax decimal? - Total tax on receipt
- Total decimal? - Total of receipt tax inclusive (i.e. SubTotal + TotalTax)
- ReceiptID string? - Xero generated unique identifier for receipt
- Status string? - Current status of receipt – see status types
- ReceiptNumber string? - Xero generated sequence number for receipt in current claim for a given user
- UpdatedDateUTC string? - Last modified date UTC format
- HasAttachments boolean? - boolean to indicate if a receipt has an attachment
- Url string? - URL link to a source document – shown as “Go to [appName]” in the Xero app
- ValidationErrors ValidationError[]? - Displays array of validation error messages from the API
- Warnings ValidationError[]? - Displays array of warning messages from the API
- Attachments Attachment[]? - Displays array of attachments from the API
xero.accounts: Receipts
Fields
- Receipts Receipt[]? -
xero.accounts: RepeatingInvoice
Fields
- Type string? - See Invoice Types
- Contact Contact? -
- Schedule Schedule? -
- LineItems LineItem[]? - See LineItems
- LineAmountTypes LineAmountTypes? - Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types
- Reference string? - ACCREC only – additional reference number
- BrandingThemeID string? - See BrandingThemes
- CurrencyCode CurrencyCode? - 3 letter alpha code for the currency – see list of currency codes
- Status string? - One of the following - DRAFT or AUTHORISED – See Invoice Status Codes
- SubTotal decimal? - Total of invoice excluding taxes
- TotalTax decimal? - Total tax on invoice
- 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
- HasAttachments boolean? - boolean to indicate if an invoice has an attachment
- Attachments Attachment[]? - Displays array of attachments from the API
xero.accounts: RepeatingInvoices
Fields
- RepeatingInvoices RepeatingInvoice[]? -
xero.accounts: Report
Fields
- ReportName string? - See Prepayment Types
- ReportType string? - See Prepayment Types
- ReportTitle string? - See Prepayment Types
- ReportDate string? - Date of report
- UpdatedDateUTC string? - Updated Date
- Contacts TenNinetyNineContact[]? -
xero.accounts: ReportAttribute
Fields
- Id string? -
- Value string? -
xero.accounts: ReportCell
Fields
- Value string? -
- Attributes ReportAttribute[]? -
xero.accounts: ReportFields
Fields
- FieldID string? -
- Description string? -
- Value string? -
xero.accounts: ReportRow
Fields
- RowType RowType? -
- Title string? -
- Cells ReportCell[]? -
xero.accounts: ReportRows
Fields
- RowType RowType? -
- Title string? -
- Cells ReportCell[]? -
- Rows ReportRow[]? -
xero.accounts: Reports
Fields
- Reports Report[]? -
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[]? -
- UpdatedDateUTC string? - Updated Date
- Fields ReportFields[]? -
xero.accounts: ReportWithRows
Fields
- Reports ReportWithRow[]? -
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
- Period int? - Integer used with the unit e.g. 1 (every 1 week), 2 (every 2 months)
- Unit string? - 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)
- DueDateType string? - the payment terms
- 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
- EndDate string? - Invoice end date – only returned if the template has an end date set
xero.accounts: Setup
Fields
- ConversionDate ConversionDate? - The date when the organisation starts using Xero
- ConversionBalances ConversionBalances[]? - Balance supplied for each account that has a value as at the conversion date.
- Accounts Account[]? -
xero.accounts: TaxComponent
Fields
- Name string? - Name of Tax Component
- Rate decimal? - Tax Rate (up to 4dp)
- IsCompound boolean? - Boolean to describe if Tax rate is compounded.
- IsNonRecoverable boolean? - Boolean to describe if tax rate is non-recoverable. Non-recoverable rates are only applicable to Canadian organisations
xero.accounts: TaxRate
Fields
- Name string? - Name of tax rate
- TaxType string? - The tax type
- TaxComponents TaxComponent[]? - See TaxComponents
- Status string? - See Status Codes
- ReportTaxType string? - See ReportTaxTypes
- CanApplyToAssets boolean? - Boolean to describe if tax rate can be used for asset accounts i.e. true,false
- CanApplyToEquity boolean? - Boolean to describe if tax rate can be used for equity accounts i.e true,false
- CanApplyToExpenses boolean? - Boolean to describe if tax rate can be used for expense accounts i.e. true,false
- CanApplyToLiabilities boolean? - Boolean to describe if tax rate can be used for liability accounts i.e. true,false
- CanApplyToRevenue boolean? - Boolean to describe if tax rate can be used for revenue 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
xero.accounts: TaxRates
Fields
- TaxRates TaxRate[]? -
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
xero.accounts: TrackingCategories
Fields
- TrackingCategories TrackingCategory[]? -
xero.accounts: TrackingCategory
Fields
- 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
- Name string? - The name of the tracking category e.g. Department, Region (max length = 100)
- Option string? - The option name of the tracking option e.g. East, West (max length = 100)
- Status string? - The status of a tracking category
- Options TrackingOption[]? - See Tracking Options
xero.accounts: TrackingOption
Fields
- 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)
- Status string? - The status of a tracking option
- TrackingCategoryID string? - Filter by a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
xero.accounts: TrackingOptions
Fields
- Options TrackingOption[]? -
xero.accounts: User
Fields
- UserID string? - Xero identifier
- EmailAddress string? - Email address of user
- FirstName string? - First name of user
- LastName string? - Last name of user
- UpdatedDateUTC string? - Timestamp of last change to user
- IsSubscriber boolean? - Boolean to indicate if user is the subscriber
- OrganisationRole string? - User role that defines permissions in Xero and via API (READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, etc)
xero.accounts: Users
Fields
- Users User[]? -
xero.accounts: ValidationError
Fields
- Message string? - Validation error message
String types
xero.accounts: AccountType
AccountType
See Account Types
xero.accounts: CountryCode
CountryCode
xero.accounts: CurrencyCode
CurrencyCode
3 letter alpha code for the currency – see list of currency codes
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: PaymentTermType
PaymentTermType
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: QuoteStatusCodes
QuoteStatusCodes
The status of the quote.
xero.accounts: RowType
RowType
xero.accounts: TaxType
TaxType
See Tax Types – can only be used on update calls
xero.accounts: TimeZone
TimeZone
Timezone specifications