Skip to main content
PATCH
Only draft journals can be edited. 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 or lines. To post the journal, use Post 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

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

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.

Response

The request succeeded.

data
object
required