# Retrieve a journal summary report

Retrieves a journal summary report which displays recognized revenue by journal account name for each calendar month.
It includes both monthly and annual journal entries, and sums the revenue per account for each month.

- Rows: Represent individual journal account names, corresponding to product or revenue categories.
- Columns: Represent monthly periods, showing the total recognized revenue in each journal account for that month.

Endpoint: GET /experimental/reports/journal-summary
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `periodStart` (string)
    Year and month from which the report is generated. If not provided or null, the report starts from one year ago.
    Example: "2025-06"

  - `periodEnd` (string)
    Year and month up to which the report is generated. If not provided or null, the report ends at the current month.
    Example: "2025-09"

  - `currency` (string)
    Currency for the journal entries in the report.
If no value is provided, the organization reporting currency is used.
    Example: "USD"

  - `aggregationField` (string)
    Report aggregation field. If not provided, the report aggregates by .
    Enum: "journalRecord.creditAccountId", "journalRecord.debitAccountId"

  - `amountField` (string)
    Report amount field. If this value is not provided, the report uses .
    Enum: "journalRecord.estimatedAmount", "journalRecord.recognizedAmount"

  - `journalAccountIds` (string)
    Comma-separated list of journal account IDs to filter the report.
If this value is not provided, all journal accounts are included.
    Example: "jrn_acc_01JXFPKZP4QE4CR3GTT23K8R5J,jrn_acc_01JXFPM6M3CYJ496E5NSCBPM49"

## Response 200 fields (application/json):

  - `aggregationField` (string)
    Journal account by which the report amounts are aggregated.
    Enum: "journalRecord.creditAccountId", "journalRecord.debitAccountId"

  - `amountField` (string)
    Journal record amount field which is used to calculate the report amounts.
    Enum: "journalRecord.estimatedAmount", "journalRecord.recognizedAmount"

  - `currency` (string)
    Currency code in ISO 4217 format.
    Example: "USD"

  - `periodStart` (string)
    Year and month from which the report is generated.
    Example: "2025-06"

  - `periodEnd` (string)
    Year and month up to which the report is generated.
    Example: "2025-09"

  - `journalAccountIds` (string,null)
    Comma-separated list of journal account IDs which are provided to filter the report.
A  value means that no value is provided and all journal accounts are included.
    Example: "jrn_acc_01JXFPKZP4QE4CR3GTT23K8R5J,jrn_acc_01JXFPM6M3CYJ496E5NSCBPM49"

  - `data` (array)
    Journal summary report data.

  - `data.period` (string)
    Journal period month and year.
    Example: "2025-06"

  - `data.totalAmount` (number,null)
    Total summary of journal records amount for the period.

  - `data.breakdown` (array)
    Breakdown of journal records by journal account.

  - `data.breakdown.journalAccountId` (string)
    ID of the journal account.
    Example: "jrn_acc_01JXFPKZP4QE4CR3GTT23K8R5J"

  - `data.breakdown.recognizedAmount` (number,null)
    Amount of revenue recognized for the journal account in the period. This field is present only if the  value is .

  - `data.breakdown.estimatedAmount` (number,null)
    Amount of revenue estimated for the journal account in the period. This field is present only if the  value is .

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.