Skip to main content
GET
Get 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

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.