logo

Retrieve a journal report

Retrieve a journal report which reflects a per-account revenue. It is a more-granular step of a revenue waterfall report.

SecuritySecretApiKey or JWT
Request
query Parameters
currency
required
string (CurrencyCode) = 3 characters

Revenue currency.

Example: currency=USD
recognizedAt
required
string^\d{4}-\d{2}$

A year and month in which revenue was recognized.

Example: recognizedAt=2022-04
aggregationField
required
string

Report aggregation field.

Enum: "product.accountingCode" "product.id" "plan.id"
bookedFrom
string^\d{4}-\d{2}$

A year and month from which revenue is booked. If omitted then booked revenue starts from the first booked amount.

Example: bookedFrom=2022-01
bookedTo
string^\d{4}-\d{2}$

A year and month in which revenue is booked until. If omitted then booked revenue is taken until the most recently booked amount.

Example: bookedTo=2022-01
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

Responses
200

Report successfully retrieved.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

Example: 2
Response Schema: application/json
aggregationField
string

The report data is grouped by the aggregation field.

Enum: "product.accountingCode" "product.id" "plan.id"
currency
string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

bookedFrom
string^\d{4}-\d{2}$

A year and month from which revenue is booked. If empty then booked revenue starts from the first booked amount.

bookedTo
string^\d{4}-\d{2}$

A year and month in which revenue is booked until. If empty then booked revenue is taken until the most recently booked amount.

recognizedAt
string^\d{4}-\d{2}$

A year and month in which revenue was recognized.

Array of objects
Array
aggregationValue
string

The aggregation field value.

bookedMonth
string^\d{4}-\d{2}$

Month in which revenue is booked.

bookedAmount
number <double>

Revenue amount which is booked for recognition.

recognizedAmount
number <double>

Recognized revenue amount.

remainingAmount
number <double>

Remaining revenue amount to be recognized.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/journal
Request samples
const params = {
    currency: 'USD',
    bookedFrom: '2022-01',
    bookedTo: '2022-06',
    recognizedAt: '2022-06',
    aggregationField: 'product.accountingCode',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getJournal(params);
Response samples
application/json
{
  • "aggregationField": "product.accountingCode",
  • "currency": "USD",
  • "bookedFrom": "2022-01",
  • "bookedTo": "2022-01",
  • "recognizedAt": "2022-01",
  • "data": [
    ]
}
➔ Next to Retrieve a KYC acceptance summary report