FLflexprice
Revenue Reports

Get revenue waterfall

Changed on

Use when showing revenue per customer, contract or performance obligation and month: actual (posted), pending (earned, not yet posted) and scheduled (invoiced, not yet earned), with optional month-end deferred and unbilled balances. Covers at most 36 months.

post/revenue_reports/waterfall

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/revenue_reports/waterfall
  • Auth
    API key in header x-api-key

Request body

as_ofstring

report date: pending and scheduled split here; defaults to now

contract_idsstring[]
currencystring required
customer_idsstring[]
detailsboolean

month-end deferred and unbilled balances

group_by'customer_id' | 'contract_id' | 'pob_id'
limitinteger

rows per page; totals are never paged

offsetinteger
period_endstring date-time required

YYYY-MM, at most 36 months from period_start

period_startstring date-time required

YYYY-MM

pob_idsstring[]

Response

OK

Changes