Update Journal
Update the editable fields of a journal.
Only the fields present in the body are applied; the others keep their value — omitting a
field is how you leave it alone, and sending it as null is refused rather than written,
except on numbering_format and bank_account_id, whose descriptions say what a null
does. code, category and sequence_scope are read-only and rejected if sent. A request
that breaks a rule is refused as a whole: the journal is left completely untouched.
The default journal of a category must stay usable (422 default_journal_required
otherwise): it cannot be deactivated — promote another journal of the category first —
and the last default of a category cannot be demoted, only replaced by promoting another.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
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 of the journal.
1 - 255Read-only after creation.
Read-only after creation.
Read-only after creation.
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.
Whether the journal is enabled. A default journal cannot be deactivated: promote another journal of the category first.
First number of the numbering sequence.
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.
255Opaque 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.
Opaque unique identifier of the journal.
Name of the journal.
Short code of the journal, used as a prefix in the numbering.
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.
true when this is the journal used by default for its category.
false when the journal is disabled and no longer used.
First number of the numbering sequence.
Template applied when numbering a document of this journal.
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).
Opaque id of the bank account tied to this journal, resolvable through GET /bank-accounts/{id}. null when the journal has no bank account.