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 ledger account

Prev Next
Get
/api/v1/finance/ledgeraccounts

Get an existing ledger account.

Get a Ledger Account

Retrieves the full record of a single existing ledger account.

A ledger account is master data configured in the financial administration, identified by a code, and referenced throughout this API wherever ledgerAccountCode appears, for example on budget lines, purchase invoice lines, and journal post transactions, to indicate where an amount is booked.

A ledger account can either apply generally or be specific to a single owner.


Request Fields

Field

Type

Required

Description

code

string

Required

The code of the ledger account.


Response Fields

Field

Type

Required

Description

code

string, nullable

Optional

The code of the ledger account.

name

string, nullable

Optional

The name of the ledger account.

compactionCode

string, nullable

Optional

The code of the compaction this account is grouped under, if applicable.

specificForOwnerReference

string, nullable

Optional

The owner this account is specific to, if any. Null if generally applicable.

lastModified

date-time

Optional

When this account was last modified.

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
compactionCode
string | null
Min length0
Max length12
specificForOwnerReference
string | null
lastModified
string (date-time)
404

The requested ledger account was not found.