> ## 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 journal post > Get an existing journal post. ## OpenAPI ````json GET /api/v1/journalposts/journalpost { "openapi": "3.0.4", "info": { "title": "Invoices V1", "description": "Welcome to BETA version of the new Invoices API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.", "version": "v1" }, "security": [ {} ], "tags": [ { "name": "Budgets" }, { "name": "Compactions" }, { "name": "ConceptPurchaseInvoices" }, { "name": "JournalPosts" }, { "name": "Journals" }, { "name": "LedgerAccounts" }, { "name": "Metadata" }, { "name": "PaymentReminders" }, { "name": "PurchaseInvoices" }, { "name": "PurchaseOrders" }, { "name": "SalesInvoices" }, { "name": "SalesInvoiceServices" } ], "paths": { "/api/v1/journalposts/journalpost": { "get": { "tags": [ "JournalPosts" ], "summary": "Get a journal post", "description": "Get an existing journal post.", "operationId": "GetJournalPost", "parameters": [ { "name": "reference", "in": "query", "description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalPostDetail" } } } }, "404": { "description": "The requested journal post was not found." } }, "x-d360-narrative-url": "

Get a Journal Post

Retrieves the full record of a single existing journal post from the financial accounting administration.

A journal post consists of multiple transactions, with a minimum of two, reflecting standard double-entry bookkeeping.

A developer calls this endpoint to look up a journal post already registered in Bloxs, typically to verify its transactions and financial period. To find the reference of a specific journal post, use Get Journal Posts Filtered and Paged first.

Request Fields

Field

Type

Required

Description

reference

string

Required

The internal identifier of the journal post.

Response Fields

Field

Type

Required

Description

reference

string, max 100, nullable

Optional

The internal identifier (Reference/Code) of the journal post, unique per client-specific environment.

ownerReference

string, max 100, nullable

Optional

The internal identifier (Reference/Code) of the owner whose financial administration this journal post belongs to.

journalCode

string, max 12, nullable

Optional

The code of the journal this entry is recorded in, indicating the category or type of transaction.

workflowState

integer (enum)

Required

The workflow state of this journal post. Allowed values: 1 = Draft (concept status, edits still possible), 2 = OnHold (held before approval, for example due to a dispute with the supplier), 3 = Cancelled (not needed or created in error), 4 = ApprovalWorkflow (submitted for approval, potentially through a chain of multiple approvers), 7 = Final (the most relevant status for integration partners; fully processed and potentially sent), 9 = Disapproved (returned by an approver for adjustment by the creator), 10 = OwnerApprovalWorkflow (submitted for approval by the owner via the owners' portal, in addition to the normal approval process), 11 = DisapprovedByOwner (disapproved by the owner, requiring further review).

financialYear

integer

Optional

The financial year this journal post belongs to.

financialPeriodIndex

integer

Optional

The financial period this journal post is recorded in. The posting period can be defined manually.

createdAt

string (date-time)

Optional

The date and time this journal post was entered into the system, formatted as ISO 8601.

lastModified

string (date-time)

Optional

The date and time this journal post was last modified within Bloxs, formatted as ISO 8601.

transactions

array of objects, nullable

Optional

The journal post's individual transaction lines, minimum two. See sub-fields below.

transactions.transactionDate

string (date)

Optional

The date of this posting line, formatted as ISO 8601 (YYYY-MM-DD).

transactions.description

string, max 512, nullable

Optional

Free-text description of this transaction line.

transactions.amount

number (double)

Optional

The amount of this transaction line, in the administration's base currency (major units, decimals separated with a period). Sign follows debit/credit convention: positive represents a debit, negative represents a credit.

transactions.ledgerAccountCode

string, max 12, nullable

Optional

The general ledger account code this transaction line is booked to.

transactions.relationReference

string, max 100, nullable

Optional

The internal identifier of the relation associated with this transaction line, if any.

transactions.realEstateObjectReference

string, max 100, nullable

Optional

The internal identifier of the real estate object associated with this transaction line, if any.

transactions.salesInvoiceReference

string, max 100, nullable

Optional

The invoice number of the sales invoice associated with this transaction line, if any.

transactions.purchaseInvoiceReference

string, max 100, nullable

Optional

The internal identifier of the purchase invoice associated with this transaction line, if any.

transactions.salesContractReference

string, max 100, nullable

Optional

The internal identifier of the sales contract (general, private, or commercial) associated with this transaction line, if any.

transactions.purchaseContractReference

string, max 100, nullable

Optional

The internal identifier of the purchase contract associated with this transaction line, if any.

transactions.financingContractReference

string, max 100, nullable

Optional

The internal identifier of the financing or payment agreement associated with this transaction line, if any. This refers to a contract entity with no dedicated endpoints in this API.

transactions.serviceCostsYear

integer

Optional

The service cost year this transaction line's cost counts toward. Service cost periods are user-defined in Bloxs; for example, an annual energy bill received in April may be allocated to the previous service cost year.

transactions.serviceCostsPeriodIndex

integer

Optional

The service cost period index within serviceCostsYear, usually expressed in months (0 to 12).

" } } }, "components": { "schemas": { "JournalPostDetail": { "type": "object", "properties": { "reference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "ownerReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "journalCode": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "workflowState": { "type": "integer", "description": "Draft = 1\nOnHold = 2\nCancelled = 3\nApprovalWorkflow = 4\nFinal = 7\nDisapproved = 9\nOwnerApprovalWorkflow = 10\nDisapprovedByOwner = 11", "format": "int32", "x-enumNames": [ "Draft", "OnHold", "Cancelled", "ApprovalWorkflow", "Final", "Disapproved", "OwnerApprovalWorkflow", "DisapprovedByOwner" ] }, "financialYear": { "type": "integer", "format": "int32" }, "financialPeriodIndex": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastModified": { "type": "string", "format": "date-time" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/JournalPostTransactionDetail" }, "nullable": true } }, "additionalProperties": false }, "JournalPostTransactionDetail": { "type": "object", "properties": { "transactionDate": { "type": "string", "format": "date" }, "description": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "ledgerAccountCode": { "maxLength": 12, "minLength": 0, "type": "string", "nullable": true }, "relationReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "realEstateObjectReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "salesInvoiceReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "purchaseInvoiceReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "salesContractReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "purchaseContractReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "financingContractReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "serviceCostsYear": { "type": "integer", "format": "int32" }, "serviceCostsPeriodIndex": { "type": "integer", "format": "int32" } }, "additionalProperties": false } } } } ````