A Journal Report is an accounting artifact that transforms financial activity such as bank transactions or expected payments into double-entry journal entries suitable for export to an ERP or general ledger system.
Each Journal Report aggregates source records (transactions or expected payments) and generates standardized journal entries with balanced debit and credit lines.
| Attribute | Description |
|---|---|
| idstring | Unique identifier for the journal report |
| namestring | Name of the journal report |
| descriptionstring | Optional description |
| grouping_fieldstring | How source items are grouped: by_date_and_internal_account or null |
| source_typestring | Source of data: transaction or expected_payment |
| statusstring | One of draft, ready, published |
| accounting_time_zonestring | Timezone for the journal report |
| entries_countinteger | Number of journal entries in this report |
| metadatastring | Additional data represented as key-value pairs. Both the key and value must be strings. See Metadata. |
| created_atdatetime | The datetime the Journal Report was created. |
| updated_atdatetime | The datetime the Journal Report was last updated. |
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"object": "journal_report",
"live_mode": true,
"name": "Q4 2025 Export",
"description": "Sales transactions",
"grouping_field": "by_date_and_internal_account",
"source_type": "transaction",
"status": "ready",
"accounting_time_zone": "UTC",
"entries_count": 150,
"metadata": {"export_format": "quickbooks"},
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z"
}