Xero Accounting Endpoint: TrialBalance
Overview
The Xero TrialBalance endpoint provides a series of trial balance totals for as at a given date.
Note an alternate endpoint named TrialBalanceTable is available which provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.
It is a function that accepts a series of parameters.
Parameters
The TrialBalance is a function that accepts the following parameters.
- Date
- A date field that determines the date for which to produce values.
- If omitted, it will use the last date of the last calendar month.
- PaymentsOnly
- A true/false field that determines if only payments are included.
- If omitted, it will be set to False.
Fields
The following fields are available for the TrialBalance endpoint.
- Date
- A date field that indicates the date used to produce the values.
- This will match the Date entered as parameter.
- PaymentsOnly
- A true/false field that indicates if only payments are included.
- This will match the PaymentsOnly entered as parameter.
- UpdatedDateUTC
- A date time field that indicates when the data was calculated.
- Lines
- A table field that provides a list of values.
- See Lines Fields for more information.
Lines Fields
The Lines Fields include the following sub fields.
- LineType
- A text field that indicates the type of line.
- Possible values are:
- Header: Indicates the row contains a header.
- Detail: Indicates the row contains the value of a given account.
- Total: Indicates the row contains a value totalling all accounts.
- AccountID
- A GUID field that provides the id of the account.
- This field can be used to link to the Accounts endpoints.
- This field will be set to null for rows whose LineType is not set to Detail.
- AccountName
- A text field that provides the account name or the name of a header or total.
- AccountLineType
- A text field that provides the account type.
- DebitAmount
- A decimal field that provides the total debit for the month as at the date.
- CreditAmount
- A decimal field that provides the total credit for the month as at the date.
- DebitAmountYTD
- A decimal field that provides the total year-to-date debit as at the date.
- CreditAmountYTD
- A decimal field that provides the total credit year-to-date as at the date.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None