Get a ledger account

Prev Next
Get
/api/v1/finance/ledgeraccounts

Get an existing ledger account.

Description

This endpoint retrieves existing ledger accounts from the financial accounting administration by utilizing the ledger account code. The ledger account codes are standard available in the Bloxs application and get be configured to some extend. 

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

Use Case

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

Request fields

The request contains the following fields:

FieldDescription
codeledger account code.

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
codeLedger account code.
nameLedger account name.
compactionCode

A ledger account can be part of a compaction. This field contains the compaction code.

specificForOwnerReferenceIf the general ledger account is restricted to a single user within Bloxs, the reference of that relation is entered here. This field can contain only one reference or remain empty. If the account is linked to a journal, this value is the same as the specificForOwnerReference in the journal.
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
compactionCode
string | null
Min length0
Max length12
specificForOwnerReference
string | null
lastModified
string (date-time)
404

The requested ledger account was not found.