Create a new journal post.
Create a journal post
This endpoint creates a new journal post.
Developers call it to book corrections, reclassifications or other direct ledger movements, allocating each transaction line to a ledger account and, where relevant, to a relation, a real estate object or a service charge period. It is typically used by integrators that need to post financial entries into Bloxs outside the standard invoicing flows, for example when migrating historical bookings or applying manual adjustments.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
externalIdentifier | String (max 100 characters) | Required | External identifier supplied by the caller, used by the integrating system to reference this journal post outside Bloxs. |
ownerReference | String (max 100 characters) | Required | Reference to the owner, the administration the journal post is booked against. |
journalCode | String (max 12 characters) | Required | Code of the journal the entry is posted to. |
financialYear | Integer | Optional | Financial year the journal post is booked in. |
financialPeriodIndex | Integer | Optional | Financial period index within the financial year the journal post is booked in. |
transactions | Array of objects | Optional | The individual transaction lines that together make up the journal post. |
transactions[].transactionDate | Date (ISO 8601, format YYYY-MM-DD) | Optional | Date of the transaction line. Example: 2026-08-14. |
transactions[].description | String (max 512 characters) | Optional | Free text description of the transaction line. |
transactions[].amount | Decimal | Optional | Amount of the transaction line, in major currency units. |
transactions[].ledgerAccountCode | String (max 12 characters) | Optional | Code of the ledger account the transaction line is booked to. |
transactions[].relationReference | String (max 100 characters) | Optional | Reference to the relation the transaction line is allocated to, when applicable. |
transactions[].realEstateObjectReference | String (max 100 characters) | Optional | Reference to the real estate object the transaction line is allocated to, when applicable. |
transactions[].salesInvoiceReference | String (max 100 characters) | Optional | Reference to the sales invoice the transaction line relates to, when applicable. |
transactions[].purchaseInvoiceReference | String (max 100 characters) | Optional | Reference to the purchase invoice the transaction line relates to, when applicable. |
transactions[].salesContractReference | String (max 100 characters) | Optional | Reference to the sales contract the transaction line relates to, when applicable. |
transactions[].purchaseContractReference | String (max 100 characters) | Optional | Reference to the purchase contract the transaction line relates to, when applicable. |
transactions[].financingContractReference | String (max 100 characters) | Optional | Reference to the financing contract the transaction line relates to, when applicable. |
transactions[].serviceCostsYear | Integer | Optional | Service charge year the transaction line is allocated to, when the line relates to service charges. |
transactions[].serviceCostsPeriodIndex | Integer | Optional | Service charge period index within the service charge year the transaction line is allocated to. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
externalIdentifier | String (max 100 characters) | Required | External identifier of the journal post, as supplied on creation. |
ownerReference | String (max 100 characters) | Required | Reference to the owner, the administration the journal post is booked against. |
journalCode | String (max 12 characters) | Required | Code of the journal the entry is posted to. |
financialYear | Integer | Optional | Financial year the journal post is booked in. |
financialPeriodIndex | Integer | Optional | Financial period index within the financial year the journal post is booked in. |
transactions | Array of objects | Optional | The individual transaction lines that together make up the journal post. |
transactions[].transactionDate | Date (ISO 8601, format YYYY-MM-DD) | Optional | Date of the transaction line. |
transactions[].description | String (max 512 characters) | Optional | Description of the transaction line. |
transactions[].amount | Decimal | Optional | Amount of the transaction line, in major currency units. |
transactions[].ledgerAccountCode | String (max 12 characters) | Optional | Code of the ledger account the transaction line is booked to. |
transactions[].relationReference | String (max 100 characters) | Optional | Reference to the relation the transaction line is allocated to, when applicable. |
transactions[].realEstateObjectReference | String (max 100 characters) | Optional | Reference to the real estate object the transaction line is allocated to, when applicable. |
transactions[].salesInvoiceReference | String (max 100 characters) | Optional | Reference to the sales invoice the transaction line relates to, when applicable. |
transactions[].purchaseInvoiceReference | String (max 100 characters) | Optional | Reference to the purchase invoice the transaction line relates to, when applicable. |
transactions[].salesContractReference | String (max 100 characters) | Optional | Reference to the sales contract the transaction line relates to, when applicable. |
transactions[].purchaseContractReference | String (max 100 characters) | Optional | Reference to the purchase contract the transaction line relates to, when applicable. |
transactions[].financingContractReference | String (max 100 characters) | Optional | Reference to the financing contract the transaction line relates to, when applicable. |
transactions[].serviceCostsYear | Integer | Optional | Service charge year the transaction line is allocated to, when the line relates to service charges. |
transactions[].serviceCostsPeriodIndex | Integer | Optional | Service charge period index within the service charge year the transaction line is allocated to. |
OK
The journal post data has validation issues