Xero Accounting Endpoint: ProfitAndLoss

Disclaimer

The ProfitAndLossMultiPeriodTable is the recommend endpoint for building Profit and Loss reports. We recommend using it over the ProfitAndLoss endpoint.

Overview

The Xero ProfitAndLoss endpoint provides profit and loss values for a given date.

Note an alternate endpoint named ProfitAndLossTable is available which 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.

You may also use the ProfitAndLossByMonth which provides a similar data set but for 12-months of a given financial year.

Parameters

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

Fields

The following fields are available for the ProfitAndLoss 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.

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.