Journal

​

API operations

​

Data model

​

Attributes

​

Relationships

​

System-computed

• journal_id is generated server-side via PostgreSQL gen_random_uuid() (defaultRaw) and mirrored in the ORM entity initializer randomUUID(). Never supplied by the client.
• created_at is set once by the MikroORM onCreate lifecycle hook at insert time. The database column is NOT NULL DEFAULT now(). Not writable by the client.
• updated_at is set by both onCreate and onUpdate MikroORM lifecycle hooks. The database column is NOT NULL DEFAULT now(), so it is always populated from the moment of insert. Reflects the timestamp of the last ORM flush touching this entity.
• deleted_at is null on active records. Set to the current timestamp on soft-delete. All repository queries must include deleted_at: null as a filter predicate.
• The combination (workspace_pk, code) carries a plain database-level UNIQUE constraint (defined in the DDL as UNIQUE(workspace_pk, code) and mirrored by @Unique({ properties: ['workspace', 'code'] }) on the entity). This constraint applies to all rows, including soft-deleted ones.
• source_entity_id carries a PARTIAL UNIQUE INDEX journals_workspace_source_entity_id_unique on (workspace_pk, source_entity_id) WHERE source_entity_id IS NOT NULL AND deleted_at IS NULL. This enables idempotent upserts by the financial sync pipeline without conflicting on NULL values for manually created journals.
• sourceWorkspaceConnector (→ source_workspace_connector_pk FK column) is set by the ingestion pipeline when a journal is created via connector sync (e.g. Pennylane). NULL indicates manual creation. Presence signals that the record is pipeline-owned and should not be edited without understanding sync implications. A partial index idx_journals_source_wc on (source_workspace_connector_pk) WHERE source_workspace_connector_pk IS NOT NULL supports provenance queries.
• Journals are reachable from a Company via the Hasura computed field company_journals(company_row, hasura_session), which traverses the 3-hop path: companies → journal_entry_lines (company_pk) → journal_entries (journal_entry_pk) → journals (journal_pk). No direct company_pk FK exists on the journals table itself.
• is_active defaults to true at creation. The pipeline or a workspace admin may flip it to false to retire a journal while preserving historical entries.

​

Example

{
  "data": {
    "type": "journal",
    "id": "a3f1c2d4-7e8b-4a9c-b5f6-0d1e2f3a4b5c",
    "attributes": {
      "journal_id": "a3f1c2d4-7e8b-4a9c-b5f6-0d1e2f3a4b5c",
      "code": "VT",
      "name": "Ventes — Clients France",
      "journal_type": "SALES",
      "source_entity_id": "pnl_jnl_00042",
      "is_active": true,
      "created_at": "2026-01-15T09:23:11.000Z",
      "updated_at": "2026-03-04T14:07:55.000Z",
      "deleted_at": null
    },
    "relationships": {
      "workspace": {
        "data": { "type": "workspace", "id": "d5e6f7a8-b9c0-4d1e-a2f3-b4c5d6e7f8a9" }
      },
      "default_debit_account": {
        "data": { "type": "ledger_account", "id": "b1c2d3e4-f5a6-4b7c-8d9e-0f1a2b3c4d5e" }
      },
      "default_credit_account": {
        "data": { "type": "ledger_account", "id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f" }
      },
      "source_workspace_connector": {
        "data": { "type": "workspace_connector", "id": "e3f4a5b6-c7d8-4e9f-a0b1-c2d3e4f5a6b7" }
      }
    }
  }
}