GET /experimental/reports/journal

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.

Servers

https://api-sandbox.rebilly.com/organizations/{organizationId}
https://api.rebilly.com/organizations/{organizationId}

Query parameters

Name	Type	Required	Description
`limit`	Integer	No	Limits the number of collection items to be returned.
`bookedFrom`	String	No	Year and month from which revenue is booked. If this value is omitted, booked revenue is recorded from the first booked amount.
`filter`	String	No	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.
`bookedTo`	String	No	Year and month in which revenue is booked until. If this value is omitted, booked revenue is recorded until the most recently booked amount.
`currency`	String	No	Revenue currency. If no value is provided, the organization reporting currency is used.
`recognizedAt`	String	No	Year and month when revenue is recognized. If this value is omitted, current month is used.
`aggregationField`	String	No	Report aggregation field. If no value is provided, the report aggregates by `product.id`. Valid values: `"plan.id"` `"product.accountingCode"` `"product.id"`
`offset`	Integer	No	Specifies the starting point within the collection of items to be returned.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.