Get Revenue Recognition Waterfall

GET

finance

revrec

waterfall

Revenue recognition waterfall

curl --request GET \
  --url https://billing.example.com/v1/finance/revrec/waterfall \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/finance/revrec/waterfall', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/v1/finance/revrec/waterfall",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/v1/finance/revrec/waterfall"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/finance/revrec/waterfall")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {}
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

Returns the tenant’s full recognized-plus-scheduled revenue curve, one bucket per calendar month that has at least one recognition event: how much revenue each month has already recognized and how much is still scheduled (pending) to recognize in it. Buckets are grouped from the events themselves, so a month with no recognized or pending event is simply absent — the series is ordered but not gap-filled. Past months carry recognized; future months carry scheduled; the current month can carry both. This is the classic rev-rec waterfall an auditor plots to see how deferred revenue releases over time. Read-only. For a single month’s figures plus the still-deferred balance broken down by currency, use the revenue recognition report. For the ledger’s own view of the deferred balance, use the Deferred Revenue rollforward.

Example Request

curl "https://api.recurso.dev/v1/finance/revrec/waterfall" \
  -H "Authorization: Bearer $API_KEY"

Response

{
  "data": {
    "tenant_id": "0b7a3f7e-4a2b-4c1d-9e8f-1a2b3c4d5e6f",
    "buckets": [
      { "year": 2026, "month": 6, "recognized": 700000, "scheduled": 0 },
      { "year": 2026, "month": 7, "recognized": 750000, "scheduled": 0 },
      { "year": 2026, "month": 8, "recognized": 800000, "scheduled": 0 },
      { "year": 2026, "month": 9, "recognized": 0, "scheduled": 750000 },
      { "year": 2026, "month": 10, "recognized": 0, "scheduled": 500000 },
      { "year": 2026, "month": 11, "recognized": 0, "scheduled": 250000 }
    ],
    "total_recognized": 2250000,
    "total_scheduled": 1500000,
    "reporting_currency": "INR"
  }
}

Fields

Field	Type	Description
`tenant_id`	string (uuid)	The tenant the waterfall belongs to
`buckets`	array or null	One entry per calendar month that has at least one `recognized` or `pending` recognition event, oldest first; months without events are omitted — see below. When the tenant has no such events at all the field is `null`, not `[]`
`total_recognized`	integer	Sum of every bucket’s `recognized`, minor units
`total_scheduled`	integer	Sum of every bucket’s `scheduled`, minor units — the still-deferred balance across all schedules
`reporting_currency`	string	The tenant’s base currency, resolved from the ledger after the sums are taken. A label only — amounts are not converted into it (see below)

Bucket Fields

Field	Type	Description
`year`	integer	Calendar year of the bucket
`month`	integer	Calendar month, `1`–`12`
`recognized`	integer	Sum of recognition events with status `recognized` whose recognition date falls in that month, minor units
`scheduled`	integer	Sum of recognition events with status `pending` whose recognition date falls in that month, minor units

A tenant with no recognized or pending recognition events gets "buckets": null (with both totals 0), not an empty array. Guard for null before iterating.

The statuses above are recognition-event statuses, not schedule statuses (active, canceled). Only recognized and pending events are summed; events in any other status (processing, failed, reversed, canceled) are excluded from every bucket. Amounts are a raw sum of each event’s amount across whatever currencies the underlying schedules carry — no FX conversion is applied, so on a multi-currency tenant the figures are not denominated in reporting_currency. Read by_currency on the monthly report for the native split.

Responses are cached per tenant and URL for five minutes; the X-Cache header reports HIT or MISS.

Errors

Status	Code	When	Fix
`401`	`unauthorized`	No `Authorization` bearer token (and no session cookie) was sent	Send `Authorization: Bearer $API_KEY`
`401`	`invalid_api_key`	A bearer token was sent but is not a valid key	Check the key in Developer keys
`401`	`key_mode_mismatch`	The key’s live/test mode does not match this API host	Use a key for the right mode — see Authentication

Errors use the standard envelope — see Errors.

Authorizations

Authorization

string

header

required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Response

Revenue waterfall.

data

object

Revenue recognition waterfall

curl --request GET \
  --url https://billing.example.com/v1/finance/revrec/waterfall \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/finance/revrec/waterfall', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/v1/finance/revrec/waterfall",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/v1/finance/revrec/waterfall"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/finance/revrec/waterfall")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {}
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Get Revenue Recognition Waterfall

Example Request

Response

Fields

Bucket Fields

Errors

Authorizations

Response

​Example Request

​Response

​Fields

​Bucket Fields

​Errors

Authorizations

Response

Example Request

Response

Fields

Bucket Fields

Errors