View source for Xero Accounting Endpoint: BalanceSheetMultiPeriodTable

== Overview ==

The Xero '''BalanceSheetMultiPeriodTable''' [[Xero Accounting Endpoints|endpoint]] provides closing balance sheet values for a given date. 

This endpoint allows you to query multiple closing balance sheet values broken down either by '''Month''', '''Quarter''' or '''Year'''. Because of this, it is the recommended endpoint to generate Balance Sheet data for Xero.

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.


== Parameters ==

The BalanceSheetMultiPeriodTable is a [[Function Endpoints|function]] that accepts the following parameters.

;FromDate
:A [[Field Type: Date|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 [[Field Type: Date|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.

;Period
:A [[Field Type: Text|text field]] that determines the periods that will be queried
:If omitted, it will be set to Month.
:Possible values are:
:* '''Month'''
:* '''Quarter'''
:* '''Year'''

;PaymentsOnly
:A [[Field Type: Boolean|true/false field]] that determines if only payments are included.
:If omitted, it will be set to False.

;StandardLayout
:A [[Field Type: Boolean|true/false field]] that determines if the values are produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts|accounts]] endpoint.
:If omitted, it will be set to True.


== Fields ==

The following fields are available for the BalanceSheetMultiPeriodTable endpoint.

;DataFileID
:A [[Field Type: GUID|guid field]] that provides the id of the xero data file as setup in OdataLink.

;DataFileName
:A [[Field Type: Text|text field]] provides the name of the xero data file as setup in OdataLink.

;DataFileCode
:A [[Field Type: Text|text field]] provides the code of the xero data file as setup in OdataLink.

;Date
:A [[Field Type: Date|date field]] that indicates the end date used to produce the values.
:This will match the ToDate entered as [[#Parameters|parameter]].

;Period
:A [[Field Type: Text|text field]] that indicates the periods that are being queried.
:Possible values are: 
:* '''Month'''
:* '''Quarter'''
:* '''Year'''

;PaymentsOnly
:A [[Field Type: Boolean|true/false field]] that indicates if only payments are included.
:This will match the PaymentsOnly entered as [[#Parameters|parameter]].

;StandardLayout
:A [[Field Type: Boolean|true/false field]] that indicates if values are produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts|accounts]] endpoint.
:This will match the StandardLayout entered as [[#Parameters|parameter]].

;LineType
:A [[Field Type: Text|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 [[Field Type: GUID|GUID field]] that provides the id of the account.
:This field can be used to link to the [[Xero Accounting Endpoint: Accounts|Accounts]] endpoints.
:This field will be set to null for rows whose '''LineType''' is not set to '''Detail'''.

;AccountName
:A [[Field Type: Text|text field]] that provides the account name or the name of a header or total.

;AccountLineType
:A [[Field Type: Text|text field]] that provides the a descriptive field to indicate the type of account or row.

;Amount
:A [[Field Type: Decimal|decimal field]] that provides the value for the row.


== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/accounting/reports#balance-sheet Xero API].


== Related Fields ==

:None


== Related Endpoints ==

:[[Xero Accounting Endpoint: Accounts|Accounts]]
:[[Xero Accounting Endpoint: BalanceSheet|BalanceSheet]]
:[[Xero Accounting Endpoint: BalanceSheetByMonth|BalanceSheetByMonth]]
:[[Xero Accounting Endpoint: BalanceSheetTable|BalanceSheetTable]]
:[[Xero Accounting Endpoint: BalanceSheetByTrackingOption|BalanceSheetByTrackingOption]]
:[[Xero Accounting Endpoint: BalanceSheetAdvanced|BalanceSheetAdvanced]]


== Related Topics ==

:[[Xero Accounting Models]]
:[[Xero Accounting Endpoints]]