Skip to main content
PATCH
Update Journal

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

journal_uuid
string
required

Body

application/json

The editable part of a journal. Every field is optional: only the ones actually present in the request body are applied, so omitting a field leaves it untouched.

code, category and sequence_scope are read-only after creation and rejected if sent (a typo in a field name is an error too, not a silent no-op).

name
string | null

Name of the journal.

Required string length: 1 - 255
code
string | null

Read-only after creation.

category
string | null

Read-only after creation.

sequence_scope
string | null

Read-only after creation.

is_default
boolean | null

Makes this the default journal of its category, demoting the previous default of the same category in the same operation. The last default of a category cannot be demoted with false: promote another journal instead.

active
boolean | null

Whether the journal is enabled. A default journal cannot be deactivated: promote another journal of the category first.

start_number
integer | null

First number of the numbering sequence.

numbering_format
string | null

Template applied when numbering a document, or null to clear it and fall back to the default format {code}-{year4}-{seq:5}. must look like '{code}-{year4}-{seq:5}': '{code}', a separator ('-' or '/'), one or more of the tokens {year4}, {year2}, {month}, {fys4}, {fys2}, {fye4}, {fye2}, {fy4}, {fy2}, the same kind of separator, then '{seq:N}' with N a single digit 2-8.

Maximum string length: 255
bank_account_id
string | null

Opaque id of a bank account of the company to tie to this journal, or null to untie it.

Response

Successful Response

An accounting journal of the company, identified by an opaque id.

A journal groups documents of one kind and drives their numbering. bank_account_id only carries a value on the journals it applies to, and is null elsewhere.

id
string
required

Opaque unique identifier of the journal.

name
string | null
required

Name of the journal.

code
string | null
required

Short code of the journal, used as a prefix in the numbering.

category
string
required

What the journal holds. One of: sales_invoice, sales_credit, purchases_invoice, purchases_credit, incoming_sales, incoming_purchases. A few legacy incoming journals with no direction are returned as plain incoming.

is_default
boolean
required

true when this is the journal used by default for its category.

active
boolean
required

false when the journal is disabled and no longer used.

start_number
integer | null
required

First number of the numbering sequence.

numbering_format
string | null
required

Template applied when numbering a document of this journal.

sequence_scope
string
required

How often the numbering restarts: never, monthly, calendar-year or fiscal-year. A legacy journal carrying a value the numbering does not recognise comes out as unknown (and is numbered as never).

bank_account_id
string | null
required

Opaque id of the bank account tied to this journal, resolvable through GET /bank-accounts/{id}. null when the journal has no bank account.