Represents a Turnover Journal in SOFT4Spaces.
Note
For information about enabling APIs for Business Central see Overview.
API endpoint
| API | Path |
| turnoverJournal | https://{{businesscentralPrefix}}/{{APIGroup}}/{{version}}/companies({{companyId}})/turnoverJournal |
Methods
| Method | Return Type | Description |
| GET turnoverJournal | turnover journal line | Gets a turnover journal line object. |
| DELETE turnoverJournal | none | Deletes a turnover journal line object. |
| POST turnoverJournal | turnover journal line | Creates a turnover journal line object. |
| PATCH turnoverJournal | turnover journal line | Updates a turnover journal line object. |
GET turnoverJournal
Description
Retrieves existing turnover journal lines from Business Central.
HTTP Request
GET
https://{{businesscentralPrefix}}/{{APIGroup}}/{{version}}/companies({{companyId}})/turnoverJournal
Request Headers
| Header | Value |
| Authorization | NTLM, OAuth2. Required. |
| Accept | application/json |
Request Body
None.
Response
Returns a 200 OK status code and JSON object representing the turnover journal lines.
Example Response
JSON
|
{ "id": "dc28c1f5-5d48-f111-a820-7ced8d421973", "postingDate": "2026-05-11", "journalTemplateName": "TURNOVER", "journalBatchName": "DEFAULT", "lineNo": 10000, "leaseUnitNo": "PREMISE1", "leaseContractNo": "NS0008", "salesAmount": 5000, "customersNumber": 0, "visitorsNumber": 0, "turnoverPeriod": "Week", "turnoverFromDate": "2026-05-04", "turnoverToDate": "2026-05-10", "analytical": true }, { "id": "3a722914-5e48-f111-a820-7ced8d421973", "postingDate": "2026-05-18", "journalTemplateName": "TURNOVER", "journalBatchName": "DEFAULT", "lineNo": 20000, "leaseUnitNo": "PREMISE1", "leaseContractNo": "NS0008", "salesAmount": 4800, "customersNumber": 0, "visitorsNumber": 0, "turnoverPeriod": "Week", "turnoverFromDate": "2026-05-11", "turnoverToDate": "2026-05-17", "analytical": true } |
GET turnoverJournal
Description
Retrieves an existing turnover journal line from Business Central.
HTTP Request
GET
https://{{businesscentralPrefix}}/{{APIGroup}}/{{version}}/companies({{companyId}})/turnoverJournal({{turnoverJournalLineId}})
Request Headers
| Header | Value |
| Authorization | NTLM, OAuth2. Required. |
| Accept | application/json |
Request Body
None.
Response
Returns a 200 OK status code and JSON object representing the turnover journal line record.
Example Response
JSON
|
{ "id": "dc28c1f5-5d48-f111-a820-7ced8d421973", "postingDate": "2026-05-11", "journalTemplateName": "TURNOVER", "journalBatchName": "DEFAULT", "lineNo": 10000, "leaseUnitNo": "PREMISE1", "leaseContractNo": "NS0008", "salesAmount": 5000, "customersNumber": 0, "visitorsNumber": 0, "turnoverPeriod": "Week", "turnoverFromDate": "2026-05-04", "turnoverToDate": "2026-05-10", "analytical": true } |
POST turnoverJournal
Description
Creates a new turnover journal line in Business Central.
HTTP Request
POST
https://{{businesscentralPrefix}}/{{APIGroup}}/{{version}}/companies({{companyId}})/turnoverJournal
Request Headers
| Header | Value |
| Authorization | NTLM, OAuth2. Required. |
| Accept | application/json |
Request Body
Provide a JSON object with turnover journal line data.
JSON
|
{ "postingDate": "2026-04-23", "leaseUnitNo": "P000030", "leaseContractNo": "", "salesAmount": 666, "customersNumber": 0, "visitorsNumber": 0, "turnoverPeriod": "Month", "turnoverFromDate": "0001-01-01", "turnoverToDate": "0001-01-01", "analytical": false } |
Response
Returns a 201 Created status code and the created turnover journal line object.
PostTurnover turnoverJournal
Description
Post the turnover journal line in Business Central.
HTTP Request
POST
https://{{businesscentralPrefix}}/{{APIGroup}}/{{version}}/companies({{companyId}})/turnoverJournal({{turnoverJournalLineId}})/Microsoft.NAV.PostTurnover
Request Headers
| Header | Value |
| Authorization | NTLM, OAuth2. Required. |
| Accept | application/json |
Request Body
None.
Response
Returns a 200 OK status code if the entry was posted successfully, otherwise, a status code and error message.
Properties
| Property | Type | Description |
| id | GUID | The unique ID of the lease contract. Non-editable. |
| postingDate | date | Specifies the posting date of the turnover journal line. |
| journalTemplateName | string | Specifies the journal template name. When creating an entry, the template is selected automatically from the existing ones. |
| journalBatchName | string | Specifies the journal batch name. When creating an entry, the template is selected automatically from the existing ones. |
| lineNo | integer | Specifies the line no in the journal batch. |
| leaseUnitNo | string | The lease unit number. |
| leaseContractNo | string | The lease contract number. |
| salesAmount | decimal | Specifies the sales amount. |
| customersNumber | integer | The number of customers. |
| visitorsNumber | integer | The number of visitors. |
| turnoverPeriod | string | Specifies the turnover period. It can be: Day, week, Month, Quarter, Year. |
| turnoverFromDate | date | Specifies the turnover from the date. |
| turnoverToDate | date | Specifies the turnover to the date. |
| analytical | boolean | Specifies whether the entry is analytical or not. |
JSON Representation
|
{ "id": GUID, "postingDate": date, "journalTemplateName": string, "journalBatchName": string, "lineNo": integer, "leaseUnitNo": string, "leaseContractNo": string, "salesAmount": decimal, "customersNumber": integer, "visitorsNumber": integer, "turnoverPeriod": string, "turnoverFromDate": date, "turnoverToDate": date, "analytical": boolean } |