Help Page Home - Reports

GET Reports/ProfitAndLoss/Summary

Get Profit and Loss (P&L) Summary Report. If no accounting method specified, it will default to accrual mode. If no date range specified, it will default to current financial year. To compare to different period, e.g. prior corresponding period, specify the comparison period from and to date. When doing comparison, the main report period should be later than the comparison period. E.g. To compare the P&L for a particular FY with prior corresponding period (pcp), call the report with the following settings: - Main period: 1 Jul 2022 - 30 Jun 2023. - Comparison period: 1 Jul 2021 - 30 Jun 2022.

Request Information

URI Parameters

Name	Description	Type	Additional information
WsAccessKey	The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access.	string	Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.
FileId	Specifies the file id of the file to perform the operation upon.	integer	Required
FromDate	Filter records with Date greater than or equal to a date (must also specifiy ToDate).	string	None.
ToDate	Filter records with Date less than or equal to a date (must also specifiy FromDate).	string	None.
AccountingMethod	Specifies the accounting method to use when running reports.	string	None.
ComparisonPeriodFromDate	Specifies the prior period to compare to. This is the comparison period 'from date' (must also specifiy ComparisonPeriodToDate).	string	None.
ComparisonPeriodToDate	Specifies the prior period to compare to. This is the comparison period 'to date' (must also specifiy ComparisonPeriodFromDate).	string	None.

Body Parameters

None.

Response Information

Resource Description

Profit and loss summary report. ComparisonAmount, Change and % Change fields are only populated if comparing to different period.

PAndLSummaryReport

Name	Description	Type	Additional information
Incomes	No documentation available.	Collection of PAndLSummaryReportItem	None.
CostOfSales	No documentation available.	Collection of PAndLSummaryReportItem	None.
Expenses	No documentation available.	Collection of PAndLSummaryReportItem	None.
OtherIncomes	No documentation available.	Collection of PAndLSummaryReportItem	None.
OtherExpenses	No documentation available.	Collection of PAndLSummaryReportItem	None.
TotalIncome	No documentation available.	PAndLSummaryReportItem	None.
TotalCostOfSales	No documentation available.	PAndLSummaryReportItem	None.
TotalExpense	No documentation available.	PAndLSummaryReportItem	None.
TotalOtherIncome	No documentation available.	PAndLSummaryReportItem	None.
TotalOtherExpense	No documentation available.	PAndLSummaryReportItem	None.
GrossProfit	No documentation available.	PAndLSummaryReportItem	None.
OperatingProfit	No documentation available.	PAndLSummaryReportItem	None.
NetProfit	No documentation available.	PAndLSummaryReportItem	None.

Response Formats

application/json, text/json

Sample:

{
  "Incomes": [
    {
      "AccountId": 1,
      "AccountName": "sample string 1",
      "ComparisonAmount": 1.0,
      "Amount": 2.0,
      "Change": 1.0,
      "PercentageChange": 1.0
    },
    {
      "AccountId": 1,
      "AccountName": "sample string 1",
      "ComparisonAmount": 1.0,
      "Amount": 2.0,
      "Change": 1.0,
      "PercentageChange": 1.0
    }
  ],
  "CostOfSales": [
    {
      "AccountId": 1,
      "AccountName": "sample string 1",
      "ComparisonAmount": 1.0,
      "Amount": 2.0,
      "Change": 1.0,
      "PercentageChange": 1.0
    },
    {
      "AccountId": 1,
      "AccountName": "sample string 1",
      "ComparisonAmount": 1.0,
      "Amount": 2.0,
      "Change": 1.0,
      "PercentageChange": 1.0
    }
  ],
  "Expenses": [
    {
      "AccountId": 1,
      "AccountName": "sample string 1",
      "ComparisonAmount": 1.0,
      "Amount": 2.0,
      "Change": 1.0,
      "PercentageChange": 1.0
    },
    {
      "AccountId": 1,
      "AccountName": "sample string 1",
      "ComparisonAmount": 1.0,
      "Amount": 2.0,
      "Change": 1.0,
      "PercentageChange": 1.0
    }
  ],
  "OtherIncomes": [
    {
      "AccountId": 1,
      "AccountName": "sample string 1",
      "ComparisonAmount": 1.0,
      "Amount": 2.0,
      "Change": 1.0,
      "PercentageChange": 1.0
    },
    {
      "AccountId": 1,
      "AccountName": "sample string 1",
      "ComparisonAmount": 1.0,
      "Amount": 2.0,
      "Change": 1.0,
      "PercentageChange": 1.0
    }
  ],
  "OtherExpenses": [
    {
      "AccountId": 1,
      "AccountName": "sample string 1",
      "ComparisonAmount": 1.0,
      "Amount": 2.0,
      "Change": 1.0,
      "PercentageChange": 1.0
    },
    {
      "AccountId": 1,
      "AccountName": "sample string 1",
      "ComparisonAmount": 1.0,
      "Amount": 2.0,
      "Change": 1.0,
      "PercentageChange": 1.0
    }
  ],
  "TotalIncome": {
    "AccountId": 1,
    "AccountName": "sample string 1",
    "ComparisonAmount": 1.0,
    "Amount": 2.0,
    "Change": 1.0,
    "PercentageChange": 1.0
  },
  "TotalCostOfSales": {
    "AccountId": 1,
    "AccountName": "sample string 1",
    "ComparisonAmount": 1.0,
    "Amount": 2.0,
    "Change": 1.0,
    "PercentageChange": 1.0
  },
  "TotalExpense": {
    "AccountId": 1,
    "AccountName": "sample string 1",
    "ComparisonAmount": 1.0,
    "Amount": 2.0,
    "Change": 1.0,
    "PercentageChange": 1.0
  },
  "TotalOtherIncome": {
    "AccountId": 1,
    "AccountName": "sample string 1",
    "ComparisonAmount": 1.0,
    "Amount": 2.0,
    "Change": 1.0,
    "PercentageChange": 1.0
  },
  "TotalOtherExpense": {
    "AccountId": 1,
    "AccountName": "sample string 1",
    "ComparisonAmount": 1.0,
    "Amount": 2.0,
    "Change": 1.0,
    "PercentageChange": 1.0
  },
  "GrossProfit": {
    "AccountId": 1,
    "AccountName": "sample string 1",
    "ComparisonAmount": 1.0,
    "Amount": 2.0,
    "Change": 1.0,
    "PercentageChange": 1.0
  },
  "OperatingProfit": {
    "AccountId": 1,
    "AccountName": "sample string 1",
    "ComparisonAmount": 1.0,
    "Amount": 2.0,
    "Change": 1.0,
    "PercentageChange": 1.0
  },
  "NetProfit": {
    "AccountId": 1,
    "AccountName": "sample string 1",
    "ComparisonAmount": 1.0,
    "Amount": 2.0,
    "Change": 1.0,
    "PercentageChange": 1.0
  }
}

application/xml, text/xml

Sample:

<PAndLSummaryReport xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TotalIncome>
    <AccountId>1</AccountId>
    <AccountName>sample string 1</AccountName>
    <ComparisonAmount>1</ComparisonAmount>
    <Amount>2</Amount>
    <Change>1</Change>
    <PercentageChange>1</PercentageChange>
  </TotalIncome>
  <TotalCostOfSales>
    <AccountId>1</AccountId>
    <AccountName>sample string 1</AccountName>
    <ComparisonAmount>1</ComparisonAmount>
    <Amount>2</Amount>
    <Change>1</Change>
    <PercentageChange>1</PercentageChange>
  </TotalCostOfSales>
  <TotalExpense>
    <AccountId>1</AccountId>
    <AccountName>sample string 1</AccountName>
    <ComparisonAmount>1</ComparisonAmount>
    <Amount>2</Amount>
    <Change>1</Change>
    <PercentageChange>1</PercentageChange>
  </TotalExpense>
  <TotalOtherIncome>
    <AccountId>1</AccountId>
    <AccountName>sample string 1</AccountName>
    <ComparisonAmount>1</ComparisonAmount>
    <Amount>2</Amount>
    <Change>1</Change>
    <PercentageChange>1</PercentageChange>
  </TotalOtherIncome>
  <TotalOtherExpense>
    <AccountId>1</AccountId>
    <AccountName>sample string 1</AccountName>
    <ComparisonAmount>1</ComparisonAmount>
    <Amount>2</Amount>
    <Change>1</Change>
    <PercentageChange>1</PercentageChange>
  </TotalOtherExpense>
  <GrossProfit>
    <AccountId>1</AccountId>
    <AccountName>sample string 1</AccountName>
    <ComparisonAmount>1</ComparisonAmount>
    <Amount>2</Amount>
    <Change>1</Change>
    <PercentageChange>1</PercentageChange>
  </GrossProfit>
  <OperatingProfit>
    <AccountId>1</AccountId>
    <AccountName>sample string 1</AccountName>
    <ComparisonAmount>1</ComparisonAmount>
    <Amount>2</Amount>
    <Change>1</Change>
    <PercentageChange>1</PercentageChange>
  </OperatingProfit>
  <NetProfit>
    <AccountId>1</AccountId>
    <AccountName>sample string 1</AccountName>
    <ComparisonAmount>1</ComparisonAmount>
    <Amount>2</Amount>
    <Change>1</Change>
    <PercentageChange>1</PercentageChange>
  </NetProfit>
  <Incomes>
    <PAndLSummaryReportItem>
      <AccountId>1</AccountId>
      <AccountName>sample string 1</AccountName>
      <ComparisonAmount>1</ComparisonAmount>
      <Amount>2</Amount>
      <Change>1</Change>
      <PercentageChange>1</PercentageChange>
    </PAndLSummaryReportItem>
    <PAndLSummaryReportItem>
      <AccountId>1</AccountId>
      <AccountName>sample string 1</AccountName>
      <ComparisonAmount>1</ComparisonAmount>
      <Amount>2</Amount>
      <Change>1</Change>
      <PercentageChange>1</PercentageChange>
    </PAndLSummaryReportItem>
  </Incomes>
  <CostOfSales>
    <PAndLSummaryReportItem>
      <AccountId>1</AccountId>
      <AccountName>sample string 1</AccountName>
      <ComparisonAmount>1</ComparisonAmount>
      <Amount>2</Amount>
      <Change>1</Change>
      <PercentageChange>1</PercentageChange>
    </PAndLSummaryReportItem>
    <PAndLSummaryReportItem>
      <AccountId>1</AccountId>
      <AccountName>sample string 1</AccountName>
      <ComparisonAmount>1</ComparisonAmount>
      <Amount>2</Amount>
      <Change>1</Change>
      <PercentageChange>1</PercentageChange>
    </PAndLSummaryReportItem>
  </CostOfSales>
  <Expenses>
    <PAndLSummaryReportItem>
      <AccountId>1</AccountId>
      <AccountName>sample string 1</AccountName>
      <ComparisonAmount>1</ComparisonAmount>
      <Amount>2</Amount>
      <Change>1</Change>
      <PercentageChange>1</PercentageChange>
    </PAndLSummaryReportItem>
    <PAndLSummaryReportItem>
      <AccountId>1</AccountId>
      <AccountName>sample string 1</AccountName>
      <ComparisonAmount>1</ComparisonAmount>
      <Amount>2</Amount>
      <Change>1</Change>
      <PercentageChange>1</PercentageChange>
    </PAndLSummaryReportItem>
  </Expenses>
  <OtherIncomes>
    <PAndLSummaryReportItem>
      <AccountId>1</AccountId>
      <AccountName>sample string 1</AccountName>
      <ComparisonAmount>1</ComparisonAmount>
      <Amount>2</Amount>
      <Change>1</Change>
      <PercentageChange>1</PercentageChange>
    </PAndLSummaryReportItem>
    <PAndLSummaryReportItem>
      <AccountId>1</AccountId>
      <AccountName>sample string 1</AccountName>
      <ComparisonAmount>1</ComparisonAmount>
      <Amount>2</Amount>
      <Change>1</Change>
      <PercentageChange>1</PercentageChange>
    </PAndLSummaryReportItem>
  </OtherIncomes>
  <OtherExpenses>
    <PAndLSummaryReportItem>
      <AccountId>1</AccountId>
      <AccountName>sample string 1</AccountName>
      <ComparisonAmount>1</ComparisonAmount>
      <Amount>2</Amount>
      <Change>1</Change>
      <PercentageChange>1</PercentageChange>
    </PAndLSummaryReportItem>
    <PAndLSummaryReportItem>
      <AccountId>1</AccountId>
      <AccountName>sample string 1</AccountName>
      <ComparisonAmount>1</ComparisonAmount>
      <Amount>2</Amount>
      <Change>1</Change>
      <PercentageChange>1</PercentageChange>
    </PAndLSummaryReportItem>
  </OtherExpenses>
</PAndLSummaryReport>