Get a journal

Prev Next
Get
/api/v1/finance/journals

Get an existing journal.

Description

This endpoint retrieves existing journals from the financial accounting administration by utilizing the journal code. The journal codes are standard available in the Bloxs application and get be configured to some extend. A journal is an umbrella for multiple journal posts.

If the user does not know the correct journal code, the filter can be used to retrieve all available codes.

Use Case

The user wants to retrieve a specific journal in order to display to which ledger account it is related.  

Request fields

The request contains the following fields:

FieldDescription
codeJournal code. In some cases, it can be entered manually.

Response fields

The 200 response contains the fields in the table below. For the GET operation it gives a up-to-date insight in the data that is currently registered in Bloxs.

FieldDescription
codeCode for the compaction.
nameName of the compaction.
ledgerAccountCode

Ledger account code.

specificForOwnerReferenceIf the general ledger account is restricted to a single user within Bloxs, the reference of that relation is entered here. It can contain only one reference or remain empty. This is the same value as 'specificForOwnerReference' in the ledger account if they are linked.
lastModified

Timestamp of the last modification within Bloxs (determined by Bloxs).

Security
HTTP
Type Bearer

Please enter a valid token

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.