GET /experimental/reports/journal-summary

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.

Servers

Query parameters

Name Type Required Description
journalAccountIds String No

Comma-separated list of journal account IDs to filter the report. If no value is provided, all journal accounts are included.

periodStart String No

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

periodEnd String No

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.

amountField String No

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

Valid values:

  • "journalRecord.recognizedAmount"
  • "journalRecord.estimatedAmount"
currency String No

Currency for the journal entries in the report. If no value is provided, the organization reporting currency is used.

aggregationField String No

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

Valid values:

  • "journalRecord.creditAccountId"
  • "journalRecord.debitAccountId"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.