Xero Accounting Endpoint: BalanceSheetAdvanced

From OdataLink
Jump to navigation Jump to search

Overview

The Xero BalanceSheetAdvanced endpoint provides closing balance sheet values for a range of parameters to produce a number of different values.

It is a function that accepts a series of parameters.


Parameters

The BalanceSheetAdvanced is a function that accepts the following parameters.

FromDate
A date field that determines the start date for which to produce values.
If omitted, it will use the first date of the last calendar month.
ToDate
A date field that determines the end 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.
Periods
A whole number field that determines the number of additional periods to include on the report. It must be used in conjunction with the TimeFrame parameter.
If omitted, it will not include additional periods.
Possible values are 1 to 11.
TimeFrame
A text field that specifies what type of periods to compare. It must be used in conjunction with the Periods parameter.
If omitted, it will not include additional periods.
Possible values are:
  • Month
  • Quarter
  • Year
TrackingOptionID
A guid field that specifies the specific tracking category option.
If omitted, OdataLink will choose one present within Xero.
TrackingOptionID2
A guid field that specifies a secondary list tracking category options.
If omitted, OdataLink will only provide data for a single tracking category option as specified by TrackingCategoryID and TrackingOptionID.


Fields

The following fields are available for the BalanceSheetAdvanced endpoint.

DataFileID
A guid field that provides the id of the xero data file as setup in OdataLink.
DataFileName
A text field provides the name of the xero data file as setup in OdataLink.
DataFileCode
A text field provides the code of the xero data file as setup in OdataLink.
Date
A date field that indicates the end date used to produce the values.
This will match the ToDate entered as parameter.
Period
A text field that indicates the periods that are being queried.
Possible values are:
  • Month
  • Quarter
  • Year
PaymentsOnly
A true/false field that indicates if only payments are included.
This will match the PaymentsOnly entered as parameter.
StandardLayout
A true/false field that indicates if values are produced only for accounts that are in the accounts endpoint.
This will match the StandardLayout entered as parameter.
Periods
A whole number field that indicates the number of additional comparison periods to include.
This will match the Periods entered as parameter.
TimeFrame
A table field that indicates what type of periods to compare.
This will match the TimeFrame entered as parameter.
TrackingOptionID
A guid field that indicates the tracking option used.
This will match the TrackingOptionID entered as parameter.
TrackingOptionID2
A guid field that indicates the tracking option used.
This will match the TrackingOptionID2 entered as parameter.
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.
AccountName
A text field that provides the account name or the name of a header or total.
AccountLineType
A text field that provides the a descriptive field to indicate the type of account or row.
LineDescription
A text field that provides the generic description for this amount.
Amount
A decimal field that provides the value for the row.


Xero API

For a detailed run through of the endpoint, you can see the Xero API.


Related Fields

None


Related Endpoints

Accounts
BalanceSheet
BalanceSheetByMonth
BalanceSheetTable
BalanceSheetMultiPeriodTable
BalanceSheetByTrackingOption


Related Topics

Xero Accounting Models
Xero Accounting Endpoints