turnover ledger entry resource type

Table of Contents

Note API endpoint Methods GET turnoverLedgerEntry Properties JSON Representation

Represents a Turnover Ledger Entries in SOFT4Spaces.

Note

For information about enabling APIs for Business Central see Overview.

 

 

API endpoint

 

API Path
turnoverLedgerEntry https://{{businesscentralPrefix}}/{{APIGroup}}/{{version}}/companies({{companyId}})/turnoverLedgerEntry

 

Methods

 

Method Return Type Description
GET turnoverLedgerEntry turnoverLedgerEntry Gets a turnover ledger entry object.

 

GET turnoverLedgerEntry

Description

Retrieves existing turnover ledger entry records from Business Central.

HTTP Request

GET

https://{{businesscentralPrefix}}/api/{{publisher}}/{{group}}/{{version}}/companies({{companyId}})/turnoverLedgerEntry

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 lease contracts records.

Example Response

JSON

{
           "id": "5739faff-d723-ed11-97e8-000d3adbb467",
           "entryNo": 1,
           "leaseUnitNo": "1A.",
           "postingDate": "2022-07-14",
           "visitorsNumber": 0,
           "customersNumber": 10,
           "salesAmount": 250,
           "userId": "USER",
           "leaseContractNo": "NS0001",
           "customerNo": "N00005",
           "customerName": "Tenant 1",
           "turnoverPeriod": "Day",
           "turnoverFromDate": "2022-07-13",
           "turnoverToDate": "2022-07-14",
           "analytical": true,
           "systemCreatedAt": "2022-08-24T18:10:14.787Z",
           "systemCreatedBy": "5a477047-93d3-4130-a8c2-b05fb7425ffa",
           "systemModifiedAt": "2022-08-24T18:10:14.787Z",
           "systemModifiedBy": "5a477047-93d3-4130-a8c2-b05fb7425ffa"

}

 

Properties

 

Property Type Description
id GUID The unique ID of the lease contract. Non-editable.
entryNo integer Specifies the number of the turnover ledger entry. This value is generated during entry creation.
leaseUnitNo string Specifies the lease unit number.
postingDate date Specifies entry posting date.
visitorsNumber integer Specifies the number of visitors.
customersNumber integer Specifies the number of customers.
salesAmount decimal Specifies sales amount.
userId string Specifies the user ID who entered this entry.
leaseContractNo string Specifies the lease contract number.
customerNo string Specifies the customer number.
customerName string Specifies the customer name.
turnoverPeriod string Specifies turnover period. It can be: Day, week, Month, Quarter, Year.
turnoverFromDate date Specifies the turnover from date.
turnoverToDate date Specifies the turnover to date.
analytical boolean Specifies whether the entry is analytical or not.
systemCreatedAt datetime The datetime the document was created. 
systemCreatedBy GUID The ID of the user who created the document.
systemModifiedAt datetime The last datetime the document was modified. 
systemModifiedBy GUID The ID of the user who last modified the document.

 

JSON Representation 

{

           "id": GUID,
          "entryNo": integer,
          "leaseUnitNo": string,
          "postingDate": date,
          "visitorsNumber": integer,
          "customersNumber": integer,
          "salesAmount": decimal,
          "userId": string,
          "leaseContractNo": string,
          "customerNo": string,
          "customerName": string,
          "turnoverPeriod": string,
          "turnoverFromDate": date,
          "turnoverToDate": date,
          "analytical": boolean,
          "systemCreatedAt": datetime,
          "systemCreatedBy": GUID,
          "systemModifiedAt": datetime,
          "systemModifiedBy": GUID

}