Represents a Lease Contract in SOFT4Spaces.
Note
For information about enabling APIs for Business Central see Overview.
API endpoint
| API | Path |
| leaseContract | businesscentralPrefix/soft4/soft4spaces/v3.0/companies({{companyId}})/leaseContracts |
Methods
| Method | Return Type | Description |
| GET leaseContract | leaseContract | Gets a lease contract object. |
| DELETE leaseContract | none | Deletes a lease contract object. |
| POST leaseContract | leaseContract | Creates a lease contract object. |
| PATCH leaseContract | leaseContract | Updates a lease contract object. |
Properties
| Property | Type | Description |
| id | GUID | The unique ID of the lease contract. Non-editable. |
| number | string | Specifies the number of the lease contract. |
| versionNo | integer | Specifies the version number of lease contract. |
| versionStatus | string | Specifies the version status of lease contract. It can be “New”, “Valid”, “Old”. |
| status | string | Specifies the status of lease contract. It can be “New”, “Ready”, “Reserved”, “Released”, “Terminated” |
| contractDate | date | The lease contract starting date. |
| contractValidUntil | date | The lease contract ending date. |
| handoverDate | date | The lease contract handover date. |
| customerNo | string | The customer's number. |
| customerName | string | The customer's name. |
| customerAddress | string | Specifies the customer's address. |
| customerAddress2 | string | Specifies the customer's address. |
| customerCity | string | Specifies the customer's city. |
| customerPostCode | string | Specifies the customer's postal code. |
| customerCountryRegionCode | string | Specifies the customer's country/region code. |
| customerCounty | string | Specifies the state, province or county as a part of the address. |
| customerBrand | string | Specifies the customer's brand code. |
| contractType | string | Specifies the lease contract type code. |
| buildingNo | string | Specifies the building to which the lease unit or units in the contract belong. |
| requiredDepositAmount | decimal | The deposit amount. |
| depositTerm | date | Specifies the date when the deposit must be paid. |
| eMailInvoice | string | Specifies the lease contract's email address. |
| invoicingCurrencyCode | string | The default currency code for the lease contract. |
| invoicingFrequency | string | Monthly, Quarterly, Yearly, Weekly, Fortnightly, Semi-Annual. |
| minimumTerm | string | Specifies a minimum term of the lease contract, e.g., “3M”, “1Y”. |
| noticePeriod | string | Specifies the shortest notice period for the lease contract termination. |
| salespersonCode | string | The salesperson code for the lease contract. |
| shortcutDimension1Code | string | Specifies the Global Dimension 1 value code. |
| shortcutDimension2Code | string | Specifies the Global Dimension 2 value code. |
| warrantyType | string | Specifies the type warranty for the lease contract. |
| warrantyAmount | decimal | The warranty amount. |
| warrantyValidTo | date | The warranty expiration date. |
| automaticallyExtend | boolean | Specifies whether the lease contract is extended automatically or not. |
| extensionPeriod | string | Specifies the lease contract extension period. |
| automExtendPrice | boolean | Specifies whether the price is extended. |
| sendForewarningEmail | boolean | Specifies whether email notifications need to be sent before extension. |
| forewarningPeriod | string | The forewarning period. |
| emailRecipient | string | Specifies the email address used for sending notifications related to the auto-extension functionality. |
| notifyOnExtensionDate | boolean | Specifies whether an email notification is sent on the extension date. |
| extendPriceIndexation | boolean | Specifies whether the price indexation is extended. |
| systemCreatedAt | datetime | The datetime the lease contract was created. |
| systemCreatedBy | GUID | The ID of the user who created the lease contract. |
| systemModifiedAt | datetime | The last datetime the lease contract was modified. |
| systemModifiedBy | GUID | The ID of the user who modified the lease contract. |
Related API's (expand)
| Name | Type | Description |
| leaseContractLines | Collection(Microsoft.NAV.leaseContractLines) | Gets the leasecontractlines of the leaseContract. |
| customer | Microsoft.NAV.customer | Gets the customer of the leaseContract. |
| leaseUnit | Collection(Microsoft.NAV.leaseUnit) | Gets the leaseunit of the leaseContract. |