Get an existing compaction.
Get a Compaction
Retrieves the full record of a single existing compaction.
A compaction is master data configured in the financial administration, identified by a code, used to group ledger accounts into a reporting hierarchy (referenced as compactionCode on Get a Ledger Account). Compactions can be nested, since each compaction can itself have a parent compaction, forming a multi-level structure.
A developer calls this endpoint to look up a compaction's details, typically to resolve a compactionCode to its name and position in that hierarchy.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
code | string | Required | The internal identifier (code) of the compaction. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
code | string, max 12, nullable | Optional | The internal identifier (code) of the compaction, used as compactionCode on Get a Ledger Account. |
name | string, max 256, nullable | Optional | The name of the compaction. |
parentCode | string, max 12, nullable | Optional | The internal identifier (code) of the parent compaction this compaction is grouped under, if any. Null if this compaction is at the top level of the hierarchy. |
lastModified | string (date-time) | Optional | The date and time this compaction was last modified, formatted as ISO 8601. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
OK
The requested compaction was not found.