GET Reports/ProfitAndLoss/SummaryByAccountType

Get Profit and Loss (P&L) Summary Report, grouped by account type. If no accounting method specified, it will default to accrual mode. If no date range specified, it will default to current financial year.

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 for the specified the date range, grouped by account type.

PAndLSummaryByAccountTypeReport
Name Description Type Additional information
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: 
{
  "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: 
<PAndLSummaryByAccountTypeReport 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>
</PAndLSummaryByAccountTypeReport>