journal resource type

Important: Currently all requests to API v2.0 must append $schemaversion=2.0 to the request URL to work properly. This is to uptake the new improved $metadata model avaliable from Business Central 17. An update will be applied shortly to apply the schemaversion automatically to API v2.0. For all other APIs $schemaversion=1.0 will be the default, unless specified in the request URL with $schemaversion=2.0. A solution is being worked on, where the schemaversion will be defined in the extension.

Represents a journal in Dynamics 365 Business Central.


For information about enabling APIs for Dynamics NAV see Enabling the APIs for Dynamics 365 Business Central.


Method Return Type Description
GET journal journal Gets a journal object.
DELETE journal none Deletes a journal object.
POST journal journal Creates a journal object.
PATCH journal journal Updates a journal object.

Bound Actions

The journal resource type offers a bound action called post which posts the corresponding journal batch. This is illustrated in the following example: POST https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/journals({id})/

The response has no content; the response code is 204.

Navigation Return Type Description
account account Gets the account of the journal.
journalLines journalLines Gets the journallines of the journal.


Property Type Description
id GUID The unique ID of the journal. Non-editable.
code string The code of the journal.
displayName string Specifies the journal's name. This name will appear on all sales documents for the journal.
lastModifiedDateTime datetime The last datetime the journal was modified. Read-Only.
balancingAccountId GUID The balancing G/L Account ID.
balancingAccountNumber string The balancing G/L Account number.

JSON representation

Here is a JSON representation of the journal resource.

    "id": "GUID",
    "code": "string",
    "displayName": "string",
    "lastModifiedDateTime": "datetime",
    "balancingAccountId": "GUID",
    "balancingAccountNumber": "string"

See Also

GET journal DELETE journal POST journal PATCH journal