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.

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

Revenue currency.

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

Date from which revenue invoice is issued.

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

Date to which revenue invoice is issued.

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

Month up to which revenue is recognized.

Example: recognizedTo=2022-04
Responses
200

Report retrieved.

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

Month when the revenue invoice is issued.

booked
number <double>

Month when the revenue amount is booked.

recognized
number <double>

Amount of recognized revenue amount up to, and including, the recognizedTo month.

remaining
number <double>

Amount of revenue that remains to be recognized after the recognizedTo month.

Array of objects

Recognized revenue waterfall for each month.

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

Month when revenue is recognized.

amount
number <double>

Amount of revenue recognized at the recognizedMonth.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/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
[
  • {
    }
]