Get Deferred Revenue Rollforward

GET

ledger

deferred-rollforward

Deferred-revenue rollforward

curl --request GET \
  --url https://billing.example.com/v1/ledger/deferred-rollforward \
  --header 'Authorization: Bearer <token>'

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

fetch('https://billing.example.com/v1/ledger/deferred-rollforward', 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/ledger/deferred-rollforward",
  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/ledger/deferred-rollforward"

	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/ledger/deferred-rollforward")

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>"
  }
}

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

Returns the movement of the Deferred Revenue account (code 2100) over a calendar month, sourced straight from the ledger: the balance carried in at the start of the month, new deferrals booked during it (credits), amounts recognized or reversed out of it (debits), and the closing balance. The identity is always opening + added - released == closing. This is the rollforward an auditor ties to the Deferred Revenue line of the trial balance. For the schedule-sourced view of the same balance — what the recognition schedules say is still deferred — use the revenue recognition report. The month-end close pack returns both and reports whether they tie.

Query Parameters

Parameter	Type	Required	Description
`month`	integer	Yes	Calendar month, `1`–`12`.
`year`	integer	Yes	Calendar year, `2000` or later.

The period runs from 00:00:00 UTC on the first of the month up to, but not including, the first of the next month.

Example Request

curl "https://api.recurso.dev/v1/ledger/deferred-rollforward?month=8&year=2026" \
  -H "Authorization: Bearer $API_KEY"

Response

{
  "data": {
    "tenant_id": "0b7a3f7e-4a2b-4c1d-9e8f-1a2b3c4d5e6f",
    "period_start": "2026-08-01T00:00:00Z",
    "period_end": "2026-09-01T00:00:00Z",
    "opening": 2900000,
    "added": 1400000,
    "released": 800000,
    "closing": 3500000,
    "reporting_currency": "INR"
  }
}

Fields

Field	Type	Description
`tenant_id`	string (uuid)	The tenant the rollforward belongs to
`period_start`	string (date-time)	First instant of the month (inclusive)
`period_end`	string (date-time)	First instant of the following month (exclusive)
`opening`	integer	Deferred Revenue balance at `period_start`, minor units
`added`	integer	New deferrals booked in the period — credits to Deferred Revenue, minor units
`released`	integer	Amounts recognized or reversed out in the period — debits to Deferred Revenue, minor units
`closing`	integer	`opening + added - released`, minor units
`reporting_currency`	string	The tenant’s base currency; use its exponent to format the minor-unit amounts

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

Errors

Status	Code	When	Fix
`400`	`validation_failed`	`month` missing or outside `1`–`12`	Pass `month=1`…`12`
`400`	`validation_failed`	`year` missing, not an integer, or before 2000	Pass a four-digit year, `2000` or later
`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.

Query Parameters

month

integer

required

Required range: 1 <= x <= 12

year

integer

required

Response

Deferred-revenue rollforward.

data

object

Deferred-revenue rollforward

curl --request GET \
  --url https://billing.example.com/v1/ledger/deferred-rollforward \
  --header 'Authorization: Bearer <token>'

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

fetch('https://billing.example.com/v1/ledger/deferred-rollforward', 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/ledger/deferred-rollforward",
  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/ledger/deferred-rollforward"

	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/ledger/deferred-rollforward")

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>"
  }
}

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

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Get Deferred Revenue Rollforward

Query Parameters

Example Request

Response

Fields

Errors

Authorizations

Query Parameters

Response

​Query Parameters

​Example Request

​Response

​Fields

​Errors

Authorizations

Query Parameters

Response

Query Parameters

Example Request

Response

Fields

Errors