Represents a Service Price in SOFT4Spaces.
Note
For information about enabling APIs for Business Central see Overview.
API endpoint
| API | Path |
| servicePrice | businesscentralPrefix/soft4/soft4spaces/v3.0/companies({{companyId}})/servicePrices |
Methods
| Method | Return Type | Description |
| GET servicePrice | servicePrice | Gets a service price object. |
| DELETE servicePrice | none | Deletes a service price object. |
| POST servicePrice | servicePrice | Creates a service price object. |
| PATCH servicePrice | servicePrice | Updates a service price object. |
Properties
| Property | Type | Description |
| id | GUID | The unique ID of the service price. Non-editable. |
| type | string | Specifies the service price type. It can be “All Contracts”, “Building”, “Contract”, “Lease Unit”. |
| code | string | Specifies the record to which the price applies, based on the selected type, e.g. If the Type is Lease Unit, specify the Lease Unit number. |
| quantityType | string | Specifies how the price is calculated. It can be “Fixed”, “Area”, “Turnover”, “Meter”. |
| useQuantity | boolean | Specifies whether charges should be calculated based on a variable Quantity defined in the Lease Contract, e.g. parking spaces. |
| serviceNo | string | Specifies the Service number to which the price will be applied. |
| daysperYear360 | boolean | Specifies whether a price is set for a year but the Customer is invoiced monthly. The system will calculate equal amounts for each month when creating Service Journal lines. |
| effectiveDate | date | Specifies the service price starting date. |
| expirationDate | date | Specifies the service price ending date. |
| priceForPeriod | string | Specifies the period for which the price applies. It can be „ “, “Day”, “Week”, “Month”, “Year”, “Quarter”. |
| unitPrice | decimal | Specifies the price to be applied. |
| comparativeTurnoverPercentage | decimal | Specifies the comparative turnover percentage. |
| turnoverRentServiceNo | string | Specifies the turnover rent service number to which the price will be applied. |
| indexPrice | boolean | Specifies whether the price indexation should be applied. |
| priceIndexingCode | string | Specifies the appropriate indexing code from Price Indexing Code table. |
| indexingStartingDate | date | Specifies the first date when the first indexation began. |
| indexingEndingDate | date | Specifies the date after which the price should no longer be indexed. |
| indexingCalcStartingDate | date | Specifies the next scheduled indexation date. The valid index value will be applied according to this date. |
| createdNewIndexedPriceLine | boolean | Specifies whether the new indexed price line should be created. |
| minIndexValue | decimal | Specifies the minimum index value, if required. For example, if the minimum index value for a customer is 2%, the Min Index Value should be set to 2. |
| maxIndexValue | decimal | Specifies the maximum index value, if required. For example, if the maximum index value for a customer is 5%, the Max Index Value should be set to 5. |
| systemCreatedAt | datetime | The datetime the service price was created. |
| systemCreatedBy | GUID | The ID of the user who created the service price. |
| systemModifiedAt | datetime | The last datetime the service price was modified. |
| systemModifiedBy | GUID | The ID of the user who modified the service price. |