Retrieve a revenue waterfall report

Retrieve a revenue waterfall report.

SecuritySecretApiKey or JWT
Request
query Parameters
currency
required
string (CurrencyCode) = 3 characters

Revenue currency.

Example: currency=USD
issuedFrom
required
string^\d{4}-\d{2}$

Revenue invoice issued from month.

Example: issuedFrom=2022-01
issuedTo
required
string^\d{4}-\d{2}$

Revenue invoice issued to month.

Example: issuedTo=2022-04
recognizedTo
required
string^\d{4}-\d{2}$

Revenue recognized up to month.

Example: recognizedTo=2022-04
Responses
200

Report was retrieved successfully.

Response Schema: application/json
Array
issuedMonth
string^\d{4}-\d{2}$

Revenue invoice issue month.

booked
number <double>

The revenue amount booked at issue month.

recognized
number <double>

Recognized revenue amount up to, and including, the recognizedTo month.

remaining
number <double>

The revenue amount remaining to be recognized after recognizedTo month.

Array of objects

Per month recognized revenue waterfall.

Array
recognizedMonth
string^\d{4}-\d{2}$

Revenue recognition month.

amount
number <double>

The revenue amount recognized at recognizedMonth.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/revenue-waterfall
Request samples
const report = await api.reports.getRevenueWaterfall({
    issuedFrom: '2016-09',
    issuedTo: '2017-09',
    recognizedTo: '2017-09',
    limit: 20,
    offset: 0,
    tz: 0
});
Response samples
application/json
[
  • {
    }
]