View source for Xero Accounting Endpoint: TrialBalanceMultiPeriodTable

== Overview ==

The Xero '''TrialBalanceMultiPeriodTable''' [[Xero Accounting Endpoints|endpoint]] provides a series of trial balance totals for a given date range.

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

Note this endpoint is an alternate format of the [[Xero Accounting Endpoint: TrialBalance|TrialBalance]] 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 TrialBalanceMultiPeriodTable 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.


== Fields ==

The following fields are available for the TrialBalanceMultiPeriodTable 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 date used to produce the values.
:This will match the Date entered as [[#Parameters|parameter]].

;PaymentsOnly
:A [[Field Type: Boolean|true/false field]] that indicates if only payments are included.
:This will match the PaymentsOnly 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 value totalling all accounts.

;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 account type.

;DebitAmount
:A [[Field Type: Decimal|decimal field]] that provides the total debit for the month as at the date.

;CreditAmount
:A [[Field Type: Decimal|decimal field]] that provides the total credit for the month as at the date.

;DebitAmountYTD
:A [[Field Type: Decimal|decimal field]] that provides the total year-to-date debit as at the date.

;CreditAmountYTD
:A [[Field Type: Decimal|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 [https://developer.xero.com/documentation/api/accounting/reports/#trial-balance Xero API].


== Related Fields ==

:None


== Related Endpoints ==

:[[Xero Accounting Endpoint: Accounts|Accounts]]
:[[Xero Accounting Endpoint: TrialBalance|TrialBalance]]
:[[Xero Accounting Endpoint: TrialBalanceTable|TrialBalanceTable]]


== Related Topics ==

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