XExeroapi
Accounting

Retrieves report for profit and loss

get/Reports/ProfitAndLoss

Request

  • Base URL
    https://api.xero.com/api.xro/2.0
  • URL
    https://api.xero.com/api.xro/2.0/Reports/ProfitAndLoss
  • Auth
    OAuth 2
    Authorization code: https://login.xero.com/identity/connect/authorize
    Token URL: https://identity.xero.com/connect/token scopes: accounting.reports.read

Query parameters

fromDatestring date

filter by the from date of the report e.g. 2021-02-01

toDatestring date

filter by the to date of the report e.g. 2021-02-28

periodsinteger

The number of periods to compare (integer between 1 and 12)

timeframe'MONTH' | 'QUARTER' | 'YEAR'

The period size to compare to (MONTH, QUARTER, YEAR)

trackingCategoryIDstring

The trackingCategory 1 for the ProfitAndLoss report

trackingCategoryID2string

The trackingCategory 2 for the ProfitAndLoss report

trackingOptionIDstring

The tracking option 1 for the ProfitAndLoss report

trackingOptionID2string

The tracking option 2 for the ProfitAndLoss report

standardLayoutboolean

Return the standard layout for the ProfitAndLoss report

paymentsOnlyboolean

Return cash only basis for the ProfitAndLoss report

Response

Success - return response of type ReportWithRows

Changes

No recorded changes to this operation across all 62 revisions of this API.