POST
Create a journal (client account)
Client space Accounting module For: Accountant · Permission: journals.create Conditions
  • The accounting module must be included in the plan of the organization.
  • From the client space the book is always the client account’s own book.
  • The book must be set up for accounting (it must have at least one journal).
  • code is required and must be unique among the journals of the book.
  • type is required and must be one of the journal types (sale, purchase, bank, cash, misc, carry_forward).
What else happens
  • Adds a journal to the book; nothing is posted. Journals cannot be deleted through the API, and the type of a journal cannot be changed afterwards.
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.

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
code
string
required

Code of the new journal, unique within the book.

label
string
required

Display name of the journal.

type
enum<string>
required

Kind of journal: sale, purchase, bank, cash, misc or carry_forward. It cannot be changed afterwards.

Available options:
sale,
purchase,
bank,
cash,
misc,
carry_forward

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).