Difference between revisions of "Xero Accounting Endpoint: BalanceSheetTable"
Jump to navigation
Jump to search
(Created page with "== Overview == The Xero '''BalanceSheetTable''' endpoint provides closing balance sheet values as at a given date. Note an alternate endpoint n...") |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
The Xero '''BalanceSheetTable''' [[Xero Accounting Endpoints|endpoint]] provides closing balance sheet values as at a given date. | The Xero '''BalanceSheetTable''' [[Xero Accounting Endpoints|endpoint]] provides closing balance sheet values as at a given date. | ||
Note an alternate | Note this endpoint is an alternate format of the [[Xero Accounting Endpoint: BalanceSheet|BalanceSheet]] endpoint. It provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory. | ||
It is a [[Function Endpoints|function]] that accepts a series of parameters. | It is a [[Function Endpoints|function]] that accepts a series of parameters. | ||
| Line 87: | Line 87: | ||
:[[Xero Accounting Endpoint: BalanceSheet|BalanceSheet]] | :[[Xero Accounting Endpoint: BalanceSheet|BalanceSheet]] | ||
:[[Xero Accounting Endpoint: BalanceSheetByMonth|BalanceSheetByMonth]] | :[[Xero Accounting Endpoint: BalanceSheetByMonth|BalanceSheetByMonth]] | ||
:[[Xero Accounting Endpoint: BalanceSheetMultiPeriodTable|BalanceSheetMultiPeriodTable]] | |||
:[[Xero Accounting Endpoint: BalanceSheetByTrackingOption|BalanceSheetByTrackingOption]] | |||
:[[Xero Accounting Endpoint: BalanceSheetAdvanced|BalanceSheetAdvanced]] | |||
Latest revision as of 22:27, 4 September 2024
Overview
The Xero BalanceSheetTable endpoint provides closing balance sheet values as at a given date.
Note this endpoint is an alternate format of the BalanceSheet endpoint. It 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 BalanceSheetTable 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.
- 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 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.
- 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.
- 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
- BalanceSheetMultiPeriodTable
- BalanceSheetByTrackingOption
- BalanceSheetAdvanced