Get a compaction

Prev Next
Get
/api/v1/finance/compactions

Get an existing compaction.

Description

This endpoint retrieves compactions from the financial accounting administration by utilizing the compactions code. The compaction codes are standard available in the Bloxs application and can be configured to some extend. 

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

Use Case

The user wants to retrieve a compaction in order to display its name and the above compaction (parentCode).  

Request fields

The request contains the following fields:

FieldDescription
codeCode for the compaction.

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.
parentCode

Code of the direct parent compaction. For example, if accounts receivable fall under 'Receivables', which in turn fall under 'Current Assets', this field will return the code of 'Receivables'.

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

The requested compaction was not found.