Get an existing journal post.
Description
This endpoint retrieves existing journal posts from the financial accounting administration by utilizing the reference. A journal post will consist of multiple transactions, the minimum being 2.
Use Case
The user wants to retrieve an individual journal post by specifying its reference. To obtain the reference of a particular journal post, the user can first use the POST Get journal posts filtered and paged endpoint.
Request fields
The request contains the following fields:
| Field | Description |
|---|---|
| reference | The unique identifier for this journal post within Bloxs. This is unique (per client specific environment) for all journal posts. This identifier is generated by the Bloxs system. |
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.
| Field | Description |
|---|---|
| reference | The unique identifier for this journal post within Bloxs. This is unique (per client specific environment) for all journal posts. This identifier is generated by the Bloxs system. |
| ownerReference | This is the reference of the owner of the object. |
| journalCode | Code of the journal in which the entry is recorded. Indicates the category or type of transaction. |
| workflowState | 1 = Draft Concept status. Edits are still possible. 2 = OnHold This means that an invoice is on hold before it can be approved, for example due to a dispute with the supplier. 3 = Cancelled This invoice was, for example, not needed or created in error. 4 = ApprovalWorkflow Submitted for approval. For example, the invoice is pending approval by person X. This may involve a simple or extended approval chain of multiple people. 7 = Final This is the most relevant status for integration partners. Bookings & invoices are then fully processed (and potentially sent). 9 = Disapproved The invoice has been returned by an approver for adjustments by the creator. 10 = OwnerApprovalWorkflow Submitted for approval by the owner. The invoice is then awaiting the owner’s approval via the owners’ portal. This is in addition to the normal approval process but is linked to the use of the owners’ portal. 11 = DisapprovedByOwner Disapproved by the owner. This requires further review. |
| financialYear | Financial year to which the entry belongs. |
| financialPeriodIndex | Indicates the financial period in which the transaction is recorded. The posting period can be defined manually. |
| createdAt | Timestamp of when the transaction was entered into the system. |
| lastModified | Timestamp of the last modification within Bloxs (determined by Bloxs). |
| transactionDate | Date of the posting line. |
| description | Free text, description of the entry. |
| amount | Amount of the journal post. Decimals are separated with a period (.) |
| legerAccountCode | General ledger account code. |
| relationReference | Reference to the associated relationt. |
| realEstateObjectReference | Reference to the associated real estate object. |
| salesInvoiceReference | Invoice number. |
| purchaseInvoiceReference | Reference to the associated purchase invoice. |
| salesContractReference | Reference to the associated sales contract, which may be general, private, or commercial. |
| purchaseContractReference | Reference to the associated purchase contract. |
| financingContractReference | Reference to the associated financing or payment agreement. |
| serviceCostsYear | In Bloxs, service cost periods can be defined by the user. For example, costs such as annual energy bills received in April are allocated to the previous service cost year. |
| serviceCostsPeriodIndex | Indicates the service cost period index, usually defined in months (0–12). |
Please enter a valid token
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
OK
The requested journal post was not found.