Xero Accounting Endpoint: ProfitAndLossByTrackingCategory

Overview

The Xero ProfitAndLossByTrackingCategory endpoint provides profit and loss values for all tracking category options for a given date.

It is a function that accepts a series of parameters.

Video

The following video describes the ProfitAndLossByTrackingCategory endpoint, including fields, parameters and tricks on how to use it.

ProfitAndLossByTrackingCategory endpoint for Xero

Parameters

The ProfitAndLossByTrackingCategory 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.

TrackingCategoryID: A guid field that specifies the list tracking category options.; If omitted, OdataLink will choose one present within Xero.

TrackingCategoryID2: A guid field that specifies a secondary list tracking category options.; If omitted, OdataLink will only provide data for a single set of tracking category options as specified by TrackingCategoryID.

Fields

The following fields are available for the ProfitAndLossByTrackingCategory endpoint.

FromDate: A date field that indicates the start date used to produce the values.; This will match the FromDate entered as parameter.

ToDate: A date field that indicates the end date used to produce the values.; This will match the ToDate 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 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.

TrackingCategoryID: A guid field that indicates the tracking category used.; This will match the TrackingCategoryID entered as parameter.

TrackingCategoryID2: A guid field that indicates the secondary tracking category used.; This will match the TrackingCategoryID2 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.

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.

Amounts: A table field that provides the list of all amounts for each tracking category options.; See Amounts Fields for more information.

Amounts Fields

The Amounts Fields includes the following sub-fields.

TrackingOptionID: A guid field that provides the ID of the tracking option belonging to the 'TrackingCategoryID parameter.

TrackingOptionName: A text field that provides the name of the tracking option belonging to the 'TrackingCategoryID parameter.

TrackingOptionID2: A text field that provides the ID of the secondary tracking option belonging to the 'TrackingCategoryID2 parameter.

TrackingOptionName2: A text field that provides the name of the secondary tracking option belonging to the 'TrackingCategoryID2 parameter.

Amount: A decimal field that provides the value for the row.

Known Issue

Xero provides the tracking option name separated by a comma. OdataLink takes this name and parses it into two separate fields (TrackingOptionName and TrackingOptionName2). It is therefore recommended not to include commas (,) within Tracking Options.

Xero does not validate the GUID specified by the TrackingCategoryID and TrackingCategoryID2 parameters. It is imperitive you use GUID that exists.