Skip to main content
POST
Push one journal to a ledger connection

Authorizations

X-API-KEY
string
header
required

Authorization method required to allow user to access the api endpoints.

Path Parameters

connectionId
string<uuid>
required

Resource identifier.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
date
string
required
Example:

"2026-10-01"

narration
string
required

Journal narration. For a movement, the hash and the note.

Maximum string length: 255
Example:

"0xaaa interest payment"

lines
object[]
required
external_id
string

Provider journal id from a previous push. When set, that journal is updated.

Maximum string length: 64
Example:

"d312dd5e-a53e-46d1-9d51-c569ef4570b7"

Response

200 - application/json
external_id
string
required

Provider journal id. Send it back as external_id to update.

Example:

"d312dd5e-a53e-46d1-9d51-c569ef4570b7"

status
enum<string>
required

Xero returns draft. QuickBooks returns posted, because a QuickBooks journal entry hits the books on create.

Available options:
draft,
posted
Example:

"draft"