# Retrieve a journal report

Retrieves a journal report which displays revenue for each account.

A revenue journal is a detailed revenue waterfall report that describes revenue recognized in a specific month,
aggregated by product ID, product accounting code, or plan ID.
It contains information on booked revenue,
recognized revenue for each aggregation field in the booked period,
and the remaining revenue up to the selected month.

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

## Query parameters:

  - `currency` (string)
    Revenue currency. If not provided, the organization reporting currency is used.
    Example: "USD"

  - `bookedFrom` (string)
    Year and month from which revenue is booked.
If this value is omitted, booked revenue is recorded from the first booked amount.
    Example: "2022-01"

  - `bookedTo` (string)
    Year and month in which revenue is booked until.
If this value is omitted, booked revenue is recorded until the most recently booked amount.
    Example: "2022-01"

  - `recognizedAt` (string)
    Year and month when revenue is recognized.
If this value is omitted, current month is used.
    Example: "2022-04"

  - `aggregationField` (string)
    Report aggregation field. If not provided, the report aggregates by .
    Enum: "product.accountingCode", "product.id", "plan.id"

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `filter` (string)
    Filters the collection items. This field requires
a special format. Use  for multiple allowed values.  Use  for multiple fields.

For more information, see
Using filter with collections.

## Response 200 fields (application/json):

  - `aggregationField` (string)
    Report data grouped by aggregation field.
    Enum: "product.accountingCode", "product.id", "plan.id"

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

  - `bookedFrom` (string,null)
    Year and month when revenue is booked.
    Example: "2022-01"

  - `bookedTo` (string,null)
    Year and month when revenue is booked until.
    Example: "2022-01"

  - `recognizedAt` (string)
    Year and month when revenue is recognized.
    Example: "2022-01"

  - `data` (array)
    Revenue data.

  - `data.aggregationValue` (string)
    Aggregation field value.

  - `data.bookedMonth` (string)
    Month when revenue is booked.
    Example: "2022-02"

  - `data.bookedAmount` (number)
    Revenue amount which is booked for recognition.
    Example: 25

  - `data.recognizedAmount` (number)
    Amount of recognized revenue.
    Example: 20

  - `data.remainingAmount` (number)
    Remaining revenue amount to be recognized.
    Example: 5

## 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.