leaseContractInsurance resource type

Table of Contents

Note API endpoint Methods GET leaseContractInsurances GET leaseContractInsurance GET [filter] leaseContractInsurances POST leaseContractInsurance PATCH leaseContractInsurance DELETE leaseContractInsurance Properties JSON Representation

Represents a Lease Contract Insurance in SOFT4Spaces. Lease contract insurances are used to register insurance policies related to the lease contract. On the Lease Contract Card, these records are shown in the Insurances section.

Note

For information about enabling APIs for Business Central see Overview.

API endpoint

API Path
leaseContractInsurance businesscentralPrefix/soft4/soft4spaces/v3.0/companies({{companyId}})/leaseContractInsurances

Methods

Method Return Type Description
GET leaseContractInsurances leaseContractInsurance Gets lease contract insurance objects.
GET leaseContractInsurance leaseContractInsurance Gets a lease contract insurance object.
POST leaseContractInsurance leaseContractInsurance Creates a lease contract insurance object.
PATCH leaseContractInsurance leaseContractInsurance Updates a lease contract insurance object.
DELETE leaseContractInsurance none Deletes a lease contract insurance object.

GET leaseContractInsurances

Description

Retrieves existing lease contract insurance records from Business Central.

HTTP Request

GET

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

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 insurance records.

Example Response

JSON

{
   "value": [
      {
         "id": "8e416095-2b7e-f111-a056-000d3aba387d",
         "leaseContractNo": "LC00001",
         "policyNo": "POL-2026-001",
         "insuranceType": "PROPERTY",
         "effectiveDate": "2026-11-01",
         "expirationDate": "2027-10-31",
         "reminderEntryNo": 0,
         "amount": 100000,
         "broker": "Insurance Broker Ltd",
         "contactName": "Jane Doe",
         "contactPhone": "+37060000001",
         "contactEmail": "jane@broker.com",
         "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 leaseContractInsurance

Description

Retrieves an existing lease contract insurance record from Business Central.

HTTP Request

GET

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

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 insurance record.

Example Response

JSON

{
   "id": "8e416095-2b7e-f111-a056-000d3aba387d",
   "leaseContractNo": "LC00001",
   "policyNo": "POL-2026-001",
   "insuranceType": "PROPERTY",
   "effectiveDate": "2026-11-01",
   "expirationDate": "2027-10-31",
   "reminderEntryNo": 0,
   "amount": 100000,
   "broker": "Insurance Broker Ltd",
   "contactName": "Jane Doe",
   "contactPhone": "+37060000001",
   "contactEmail": "jane@broker.com",
   "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] leaseContractInsurances

Description

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

HTTP Request

GET

https://{{businesscentralPrefix}}/{{APIGroup}}/{{version}}/companies({{companyId}})/leaseContractInsurances?$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 insurance records of the lease contract.

 

POST leaseContractInsurance

Description

Creates a new lease contract insurance in Business Central.

HTTP Request

POST

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

Request Headers

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

Request Body

Provide a JSON object with lease contract insurance data.

JSON

{
   "leaseContractNo": "LC00001",
   "policyNo": "POL-2026-001",
   "effectiveDate": "2026-11-01",
   "expirationDate": "2027-10-31",
   "amount": 100000,
   "broker": "Insurance Broker Ltd",
   "contactName": "Jane Doe",
   "contactPhone": "+37060000001",
   "contactEmail": "jane@broker.com"
}

Response

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

 

PATCH leaseContractInsurance

Description

Updates an existing lease contract insurance in Business Central.

HTTP Request

PATCH

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

Request Headers

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

Request Body

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

JSON

{
   "expirationDate": "2027-12-31"
}

Response

Returns a 200 OK status code and the updated object.

 

DELETE leaseContractInsurance

Description

Deletes an existing lease contract insurance from Business Central.

HTTP Request

DELETE

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

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 insurance. Non-editable.
leaseContractNo string Specifies the number of the lease contract to which the insurance belongs.
policyNo string Specifies the insurance policy number.
insuranceType string Specifies the insurance type.
effectiveDate date Specifies the date from which the insurance policy is valid.
expirationDate date Specifies the date on which the insurance policy expires.
reminderEntryNo integer Specifies the number of the related reminder entry. Non-editable.
amount decimal Specifies the insured amount.
broker string Specifies the insurance broker.
contactName string Specifies the contact person name.
contactPhone string Specifies the contact person phone number.
contactEmail string Specifies the contact person email address.
systemCreatedAt datetime The datetime the lease contract insurance was created.
systemCreatedBy GUID The ID of the user who created the lease contract insurance.
systemModifiedAt datetime The last datetime the lease contract insurance was modified.
systemModifiedBy GUID The ID of the user who modified the lease contract insurance.

JSON Representation

{
   "id": "GUID",
   "leaseContractNo": "string",
   "policyNo": "string",
   "insuranceType": "string",
   "effectiveDate": "date",
   "expirationDate": "date",
   "reminderEntryNo": "integer",
   "amount": "decimal",
   "broker": "string",
   "contactName": "string",
   "contactPhone": "string",
   "contactEmail": "string",
   "systemCreatedAt": "datetime",
   "systemCreatedBy": "GUID",
   "systemModifiedAt": "datetime",
   "systemModifiedBy": "GUID"
}