/
Retrieve a revenue waterf...

Retrieve a revenue waterfall report
Experimental

Request

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.

Security
SecretApiKey or JWT
Query
currencystring, = 3 characters(CurrencyCode)required

Revenue currency.

Example:currency=USD
issuedFromstring^\d{4}-(0[1-9]|1[0-2])$

Date from which revenue invoice is issued. If not provided or null, the report starts from the previous month.

Example:issuedFrom=2022-01
issuedTostring^\d{4}-(0[1-9]|1[0-2])$

Date to which revenue invoice is issued. If not provided or null, the report ends at the current month.

Example:issuedTo=2022-04
recognizedTostring^\d{4}-(0[1-9]|1[0-2])$

Month up to which revenue is recognized. If not provided or null, the current month is used.

Example:recognizedTo=2022-04
curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/revenue-waterfall?currency=USD&issuedFrom=2022-01&issuedTo=2022-04&recognizedTo=2022-04' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.

Bodyapplication/json
Array [
issuedMonthstring^\d{4}-\d{2}$

Month when the revenue invoice is issued.

Example:"2022-02"
bookednumber, (double)

Month when the revenue amount is booked.

Example:25
recognizednumber, (double)

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

Example:20
remainingnumber, (double)

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

Example:5
waterfallArray of objects

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
  }
]
]
Response
[
  {
    "issuedMonth": "2022-02",
    "booked": 25,
    "recognized": 20,
    "remaining": 5,
    "waterfall": [ … ]
  }
]