Documentation Index

Fetch the complete documentation index at: https://www.bloxs.io/llms.txt

Use this file to discover all available pages before exploring further.

Get a journal

Prev Next
Get
/api/v1/finance/journals

Get an existing journal.

Get a Journal

Retrieves the full record of a single existing journal.

A journal is master data configured in the financial administration, identified by a code, and used to categorize the type of transaction when posting journal entries (see journalCode on Get a Journal Post).

A journal can either apply generally or be specific to a single owner. A developer calls this endpoint to look up a journal's details, typically to resolve a journalCode to its name and associated ledger account.


Request Fields

Field

Type

Required

Description

code

string

Required

The internal identifier (code) of the journal.


Response Fields

Field

Type

Required

Description

code

string, max 12, nullable

Optional

The internal identifier (code) of the journal, used as journalCode on journal posts.

name

string, max 256, nullable

Optional

The name of the journal.

ledgerAccountCode

string, max 12, nullable

Optional

The general ledger account code associated with this journal.

specificForOwnerReference

string, nullable

Optional

The internal identifier of the owner this journal is specific to, if it isn't a generally applicable journal. Null if the journal applies across owners.

lastModified

string (date-time)

Optional

The date and time this journal was last modified, formatted as ISO 8601.

Security
Query parameters
code
stringRequired

The internal identifier of the model (i.e. Reference, Code, Name, depends on model).

Responses
200

OK

object
code
string | null
Min length0
Max length12
name
string | null
Min length0
Max length256
ledgerAccountCode
string | null
Min length0
Max length12
specificForOwnerReference
string | null
lastModified
string (date-time)
404

The requested journal was not found.