Retrieve a journal summary report
Experimental

Request

Retrieves a journal summary report which displays recognized revenue by journal account name for each calendar month. It includes both monthly and annual journal entries, and sums the revenue per account for each month.

  • Rows: Represent individual journal account names, corresponding to product or revenue categories.
  • Columns: Represent monthly periods, showing the total recognized revenue in each journal account for that month.
Security
SecretApiKey or JWT
Query
periodStartstring^\d{4}-(0[1-9]|1[0-2])$

Year and month from which the report is generated. If no value is provided or is null, the report starts from one year ago.

Example:periodStart=2025-06
periodEndstring^\d{4}-(0[1-9]|1[0-2])$

Year and month up to which the report is generated. If no value is provided or is null, the report ends at the current month.

Example:periodEnd=2025-09
currencystring, = 3 characters(CurrencyCode)
Currency for the journal entries in the report. If no value is provided, the organization reporting currency is used.
Example:currency=USD
aggregationFieldstring

Report aggregation field. If no value is provided, the report aggregates by journalRecord.creditAccountId.

Enum:"journalRecord.creditAccountId""journalRecord.debitAccountId"
amountFieldstring

Report amount field. If no value is provided, the report uses journalRecord.recognizedAmount.

Enum:"journalRecord.estimatedAmount""journalRecord.recognizedAmount"
journalAccountIdsstring
Comma-separated list of journal account IDs to filter the report. If no value is provided, all journal accounts are included.
Example:journalAccountIds=jrn_acc_01JXFPKZP4QE4CR3GTT23K8R5J,jrn_acc_01JXFPM6M3CYJ496E5NSCBPM49
curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/journal-summary?periodStart=2025-06&periodEnd=2025-09&currency=USD&aggregationField=journalRecord.creditAccountId&amountField=journalRecord.estimatedAmount&journalAccountIds=jrn_acc_01JXFPKZP4QE4CR3GTT23K8R5J%2Cjrn_acc_01JXFPM6M3CYJ496E5NSCBPM49' \
  -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
aggregationFieldstring
Journal account by which the report amounts are aggregated.
Enum:"journalRecord.creditAccountId""journalRecord.debitAccountId"
amountFieldstring
Journal record amount field which is used to calculate the report amounts.
Enum:"journalRecord.estimatedAmount""journalRecord.recognizedAmount"
currencystring, = 3 characters(CurrencyCode)
Currency code in ISO 4217 format.
Example:"USD"
periodStartstring^\d{4}-\d{2}$
Year and month from which the report is generated.
Example:"2025-06"
periodEndstring^\d{4}-\d{2}$
Year and month up to which the report is generated.
Example:"2025-09"
journalAccountIdsstring or null

Comma-separated list of journal account IDs which are provided to filter the report. A null value means that no value is provided and all journal accounts are included.

Example:"jrn_acc_01JXFPKZP4QE4CR3GTT23K8R5J,jrn_acc_01JXFPM6M3CYJ496E5NSCBPM49"
dataArray of objects
Journal summary report data.
Response
{
  "aggregationField": "journalRecord.creditAccountId",
  "amountField": "journalRecord.estimatedAmount",
  "currency": "USD",
  "periodStart": "2025-06",
  "periodEnd": "2025-09",
  "journalAccountIds": "jrn_acc_01JXFPKZP4QE4CR3GTT23K8R5J,jrn_acc_01JXFPM6M3CYJ496E5NSCBPM49",
  "data": [
    { … }
  ]
}