/
Retrieve a deferred reven...

Retrieve a deferred revenue report
Experimental

Request

Retrieves a deferred revenue report which displays monthly total liability and liability changes over months.

This deferred revenue report provides a month-by-month overview of deferred revenue recognized revenue and liabilities as of a given report date. It presents the total deferred revenue for each month, the amount recognized as revenue both cumulatively and within the specific month, as well as the remaining deferred revenue liability up to that month.

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

Currency of the revenue. If no value is provided, the reporting currency of the organization is used.

Example:currency=USD
asOfDatestring, (date-time)

Date and time up to which revenue is recognized for the report. If no value is provided, the end of the current month is used.

limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/deferred-revenue?currency=USD&asOfDate=2019-08-24T14%3A15%3A22Z&limit=0&offset=0&filter=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
asOfDatestring, (date)

Date up to which revenue is recognized for the report.

Example:"2024-03-31"
currencystring, = 3 characters(CurrencyCode)

Currency code in ISO 4217 format.

Example:"USD"
bookednumber

Total booked amount as of the report date.

Example:127850
recognizednumber

Total recognized amount as of the report date.

Example:89495
liabilitynumber

Total liability amount as of the report date.

Example:38355
monthsArray of objects

Monthly breakdown data.

Response
{
  "asOfDate": "2024-03-31",
  "currency": "USD",
  "booked": 127850,
  "recognized": 89495,
  "liability": 38355,
  "months": [
    { … }
  ]
}