Xero Accounting Endpoint: BalanceSheet

Overview

The Xero BalanceSheet endpoint provides closing balance sheet values as at a given date.

Note an alternate endpoint named BalanceSheetTable is available which provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.

You may also use the BalanceSheetByMonth which provides a similar data set but for 12-months of a given financial year.

It is a function that accepts a series of parameters.

Parameters

The BalanceSheet endpoint 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.

StandardLayout: A true/false field that determines if the values are produced only for accounts that are in the accounts endpoint.; If omitted, it will be set to True.

Fields

The following fields are available for the BalanceSheet 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.

StandardLayout: A table field that indicates if values are produced only for accounts that are in the accounts endpoint.; This will match the StandardLayout entered as parameter.

UpdatedDateUTC: A date time field that indicates when the data was calculated.

Lines: A table field that provides the 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 calculated value.

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.