# Retrieve a revenue waterfall report

Retrieves a revenue waterfall report.

Use revenue waterfall reports to view revenue that is recognized up to a given month.
Revenue waterfall reports contain information on booked revenue,
recognized revenue for the months in the issued period,
and the remaining revenue up to the specified month.

Endpoint: GET /experimental/reports/revenue-waterfall
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `currency` (string, required)
    Revenue currency.
    Example: "USD"

  - `issuedFrom` (string, required)
    Date from which revenue invoice is issued.
    Example: "2022-01"

  - `issuedTo` (string, required)
    Date to which revenue invoice is issued.
    Example: "2022-04"

  - `recognizedTo` (string, required)
    Month up to which revenue is recognized.
    Example: "2022-04"

## Response 200 fields (application/json):

  - `issuedMonth` (string)
    Month when the revenue invoice is issued.
    Example: "2022-02"

  - `booked` (number)
    Month when the revenue amount is booked.
    Example: 25

  - `recognized` (number)
    Amount of recognized revenue amount up to, and including, the  month.
    Example: 20

  - `remaining` (number)
    Amount of revenue that remains to be recognized after the  month.
    Example: 5

  - `waterfall` (array)
    Recognized revenue waterfall for each month.
    Example: [{"recognizedMonth":"2022-02","amount":4.4},{"recognizedMonth":"2022-03","amount":8.33},{"recognizedMonth":"2022-04","amount":7.27}]

  - `waterfall.recognizedMonth` (string)
    Month when revenue is recognized.
    Example: "2022-04"

  - `waterfall.amount` (number)
    Amount of revenue recognized at the .

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