/
Retrieve a journal report

Retrieve a journal report
Experimental

Request

Retrieves a journal report which displays revenue for each account.

A revenue journal is a detailed revenue waterfall report that describes revenue recognized in a specific month, aggregated by product ID, product accounting code, or plan ID. It contains information on booked revenue, recognized revenue for each aggregation field in the booked period, and the remaining revenue up to the selected month.

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

Revenue currency. If no value is provided, the organization reporting currency is used.

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

Year and month from which revenue is booked. If this value is omitted, booked revenue is recorded from the first booked amount.

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

Year and month in which revenue is booked until. If this value is omitted, booked revenue is recorded until the most recently booked amount.

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

Year and month when revenue is recognized. If this value is omitted, current month is used.

Example:recognizedAt=2022-04
aggregationFieldstring

Report aggregation field. If no value is provided, the report aggregates by product.id.

Enum:"product.accountingCode""product.id""plan.id"
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

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/journal?currency=USD&bookedFrom=2022-01&bookedTo=2022-01&recognizedAt=2022-04&aggregationField=product.accountingCode&limit=1000&offset=1000&filter=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.

Headers
Pagination-Totalinteger

Total number of items.

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
aggregationFieldstring

Report data grouped by aggregation field.

Enum:"product.accountingCode""product.id""plan.id"
currencystring, = 3 characters(CurrencyCode)

Currency code in ISO 4217 format.

Example:"USD"
bookedFromstring or null^\d{4}-\d{2}$

Year and month when revenue is booked.

Example:"2022-01"
bookedTostring or null^\d{4}-\d{2}$

Year and month when revenue is booked until.

Example:"2022-01"
recognizedAtstring^\d{4}-\d{2}$

Year and month when revenue is recognized.

Example:"2022-01"
dataArray of objects

Revenue data.

Response
{
  "aggregationField": "product.accountingCode",
  "currency": "USD",
  "bookedFrom": "2022-01",
  "bookedTo": "2022-01",
  "recognizedAt": "2022-01",
  "data": [
    { … }
  ]
}