PUT
Rename a journal (organization)
Organization space Accounting module For: Accountant · Permission: journals.update Conditions
  • The accounting module must be included in the plan of the organization.
  • In the organization space the caller needs an accounting access grant on the book named in the URL.
  • The record must belong to the selected book.
  • Only label can be changed; code and type are fixed once the journal exists. Omitted or null label keeps the current value.
Part of Set up the books.

Authorizations

Authorization
string
header
required

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

Path Parameters

journal
string
required

Identifier of the journal (27-character KSUID). The generated path repeats this name: the first segment is the book identifier, the second is the journal. The journal must belong to the book.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, owner_type, code, label, type, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Body

application/json
label
string | null

New display name. Optional; null or omitted keeps the current label.

Response

Resource (only with response=resource).

id

Identifier of the journal (27-character KSUID).

owner_type

Type of book owning the journal: organization, company or client.

code

Short code of the journal, unique within the book (VT, AC, BQ, CA, OD, AN and the closing journal CL for the default ones).

label

Display name of the journal.

type

Kind of journal: sale, purchase, bank, cash, misc or carry_forward (opening and carry-forward entries).

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).