Skip to main content
POST
Sync journals
Entendre groups the journals by legal entity and accounting period, and queues one provider job for each group. One request can return several jobs. The destination comes from the legal entity of each journal; there is no connection_id parameter. Read the results with List journal sync jobs.

Preview a sync

Set dry_run=true to check which journals can be assigned to sync jobs. Nothing is sent to the provider. Journals without a general-ledger configuration or provider company mapping are listed in failed. To sync, send the same journal_entry_ids and the confirm_count of the preview. confirm_count checks only the number of distinct IDs. It does not check which journals they are, or whether they changed after the preview. A preview does not guarantee that the provider accepts the journals.

Sync

A sync that queues work returns HTTP 202. If the general ledger rejects the credentials, the request returns HTTP 409 and sends no journal.

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Headers

Idempotency-Key
string

Unique key for this operation. Retry with the same key and request body after a timeout. Keys are retained for at least 24 hours.

Required string length: 1 - 255

Body

application/json
journal_entry_ids
string[]
required

Journals to sync. Duplicates are accepted and collapsed. The destination is resolved per journal from its legal entity; there is no connection parameter.

Required array length: 1 - 5000 elements

Journal ID (je_…).

confirm_count
integer

Safety check. When supplied it must equal the number of distinct IDs in journal_entry_ids, otherwise the request is rejected before any journal is sent.

Required range: x >= 0
dry_run
boolean

Preview only. Runs the same validation and routing and reports which journals would be queued, without sending anything. Returns 200, not 202.

agent_instance_id
string

Attributes the sync to an agent instead of the API-key user. Must be sent together with agent_name.

Minimum string length: 1
agent_name
string

Display name of the initiating agent. Must be sent together with agent_instance_id.

Minimum string length: 1

Response

Dry-run preview. Nothing was sent to the provider.

data
object
required

The sync result.