Skip to main content
PATCH
A draft or unposted journal accepts the memo, accounting date, tags, legal entity, transaction link and lines. A posted or reversed journal accepts only memos and tags, and keeps the account, amount and side of each line. A journal in a closed period rejects every change. Omitted fields stay unchanged. An empty tag_ids array clears the tags. Changing the accounting date also changes the accounting period. This operation does not accept status. To change the status, use Post journal, Unpost journal or Reverse journal.

Authorizations

X-API-Key
string
header
required

Your organization API key. See Authentication.

Headers

Idempotency-Key
string

Optional key for this request. Retry with the same key and body after a timeout. Keys are kept for at least 24 hours. Reusing a key with a different request returns HTTP 409.

Required string length: 1 - 255

Path Parameters

journal_id
string
required

ID of the journal.

Minimum string length: 1

Body

application/json
memo
string | null

Memo.

accounting_date
string<date-time>

New accounting date. A date in a closed period moves to the current open period and sets period_auto_reassigned. A soft-closed date returns HTTP 400.

tag_ids
string[]

Tag IDs (tag_…). Send [] to clear the tags.

Moves a DRAFT or UNPOSTED entry to this legal entity (le_ prefix). Lines that used the old entity move with it, and the accounting period is re-resolved for the new entity.

transaction_id
string | null

Links a DRAFT or UNPOSTED entry to this transaction (txn_ prefix). null removes the link. The transaction must have no other journal entry.

lines
object[]

All lines of the entry. On a DRAFT or UNPOSTED entry they replace the stored lines and must balance. On a POSTED or REVERSED entry, send every stored line with its id; only memo and tag_ids may differ. A line over $50,000 needs a linked transaction, an entry memo or a line memo of at least 10 characters.

Required array length: 2 - 500 elements

Response

The request succeeded.

data
object
required