leaseContractDate resource type

Table of Contents

Note API endpoint Methods GET leaseContractDates GET leaseContractDate GET [filter] leaseContractDates POST leaseContractDate PATCH leaseContractDate DELETE leaseContractDate Properties JSON Representation

Represents a Lease Contract Date in SOFT4Spaces. Lease contract dates are used to register important dates of the lease contract, e.g. price review. On the Lease Contract Card, these records are shown in the Contract Diary section.

Note

For information about enabling APIs for Business Central see Overview.

API endpoint

API Path
leaseContractDate businesscentralPrefix/soft4/soft4spaces/v3.0/companies({{companyId}})/leaseContractDates

Methods

Method Return Type Description
GET leaseContractDates leaseContractDate Gets lease contract date objects.
GET leaseContractDate leaseContractDate Gets a lease contract date object.
POST leaseContractDate leaseContractDate Creates a lease contract date object.
PATCH leaseContractDate leaseContractDate Updates a lease contract date object.
DELETE leaseContractDate none Deletes a lease contract date object.

GET leaseContractDates

Description

Retrieves existing lease contract date records from Business Central.

HTTP Request

GET

https://{{businesscentralPrefix}}/{{APIGroup}}/{{version}}/companies({{companyId}})/leaseContractDates

Request Headers

Header Value
Authorization Bearer {token}. Required.
Accept application/json

Request Body

None.

Response

Returns a 200 OK status code and JSON object representing the lease contract date records.

Example Response

JSON

{
   "value": [
      {
         "id": "6c2f4e73-2b7e-f111-a056-000d3aba387d",
         "leaseContractNo": "LC00001",
         "lineNo": 10000,
         "date": "2027-03-01",
         "description": "Price review",
         "reminderEntryNo": 0,
         "systemCreatedAt": "2026-10-13T09:15:00Z",
         "systemCreatedBy": "6ac927c2-1d2f-437f-89ed-3cb0cf930e68",
         "systemModifiedAt": "2026-10-13T09:15:00Z",
         "systemModifiedBy": "6ac927c2-1d2f-437f-89ed-3cb0cf930e68"
      }
   ]
}

 

GET leaseContractDate

Description

Retrieves an existing lease contract date record from Business Central.

HTTP Request

GET

https://{{businesscentralPrefix}}/{{APIGroup}}/{{version}}/companies({{companyId}})/leaseContractDates({{contractDateId}})

Request Headers

Header Value
Authorization Bearer {token}. Required.
Accept application/json

Request Body

None.

Response

Returns a 200 OK status code and JSON object representing the lease contract date record.

Example Response

JSON

{
   "id": "6c2f4e73-2b7e-f111-a056-000d3aba387d",
   "leaseContractNo": "LC00001",
   "lineNo": 10000,
   "date": "2027-03-01",
   "description": "Price review",
   "reminderEntryNo": 0,
   "systemCreatedAt": "2026-10-13T09:15:00Z",
   "systemCreatedBy": "6ac927c2-1d2f-437f-89ed-3cb0cf930e68",
   "systemModifiedAt": "2026-10-13T09:15:00Z",
   "systemModifiedBy": "6ac927c2-1d2f-437f-89ed-3cb0cf930e68"
}

 

GET [filter] leaseContractDates

Description

Retrieves the lease contract date records of a specific lease contract.

HTTP Request

GET

https://{{businesscentralPrefix}}/{{APIGroup}}/{{version}}/companies({{companyId}})/leaseContractDates?$filter=leaseContractNo eq '{{leaseContractNo}}'

Request Headers

Header Value
Authorization Bearer {token}. Required.
Accept application/json

Request Body

None.

Response

Returns a 200 OK status code and JSON object representing the lease contract date records of the lease contract.

 

POST leaseContractDate

Description

Creates a new lease contract date in Business Central.

HTTP Request

POST

https://{{businesscentralPrefix}}/{{APIGroup}}/{{version}}/companies({{companyId}})/leaseContractDates

Request Headers

Header Value
Authorization Bearer {token}. Required.
Accept application/json

Request Body

Provide a JSON object with lease contract date data.

JSON

{
   "leaseContractNo": "LC00001",
   "date": "2027-03-01",
   "description": "Price review"
}

Response

Returns a 201 Created status code and the created lease contract date object.

 

PATCH leaseContractDate

Description

Updates an existing lease contract date in Business Central.

HTTP Request

PATCH

https://{{businesscentralPrefix}}/{{APIGroup}}/{{version}}/companies({{companyId}})/leaseContractDates({{contractDateId}})

Request Headers

Header Value
Authorization Bearer {token}. Required.
Accept application/json

Request Body

Provide the fields of the lease contract date to be updated.

JSON

{
   "date": "2027-04-01"
}

Response

Returns a 200 OK status code and the updated object.

 

DELETE leaseContractDate

Description

Deletes an existing lease contract date from Business Central.

HTTP Request

DELETE

https://{{businesscentralPrefix}}/{{APIGroup}}/{{version}}/companies({{companyId}})/leaseContractDates({{contractDateId}})

Request Headers

Header Value
Authorization Bearer {token}. Required.
Accept application/json

Request Body

None.

Response

Returns a 204 No Content status code.

 

Properties

Property Type Description
id GUID The unique ID of the lease contract date. Non-editable.
leaseContractNo string Specifies the number of the lease contract to which the date belongs.
lineNo integer Specifies the line number. Assigned automatically. Non-editable.
date date Specifies the date.
description string Specifies the description of the date.
reminderEntryNo integer Specifies the number of the related reminder entry. Non-editable.
systemCreatedAt datetime The datetime the lease contract date was created.
systemCreatedBy GUID The ID of the user who created the lease contract date.
systemModifiedAt datetime The last datetime the lease contract date was modified.
systemModifiedBy GUID The ID of the user who modified the lease contract date.

JSON Representation

{
   "id": "GUID",
   "leaseContractNo": "string",
   "lineNo": "integer",
   "date": "date",
   "description": "string",
   "reminderEntryNo": "integer",
   "systemCreatedAt": "datetime",
   "systemCreatedBy": "GUID",
   "systemModifiedAt": "datetime",
   "systemModifiedBy": "GUID"
}