Insert a new scoring point total for an object and period. Will automatically be activated after insertion, marking any existing scoring point total for the same object and period as revised in the process.
Insert a scoring point total
This endpoint registers a scoring point total for a real estate object and time period.
Within the Bloxs application, detailed point score calculations can be performed. Through the API, however, users can only submit the total point score, the maximum rent amount, and the period to which it applies. Bloxs can use these point totals to determine the maximum allowable rent under the Dutch housing valuation system (WWS), and applies this information directly in the lease contract indexation functionality.
Inserting a new total for an object and period that already has one automatically archives the previous entry and activates the new one as current.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
externalIdentifier | string | Yes | External identifier of this scoring point total entry, as set by the integrating system. This is distinct from the external identifier of the real estate object itself. Maximum length 100 characters. |
realEstateObjectReference | string | Yes | Reference of the real estate object the scoring point total applies to. Maximum length 100 characters. |
homeType | integer | Yes | Type of home the scoring points apply to. Valid values are 1 (Independent), for self-contained living space, and 2 (Dependent), for non-self-contained living space. |
timePeriodTitle | string | Yes | Title of the time period the entry applies to. Must match one of the existing time periods available for scoring points. Maximum length 256 characters. |
pointTotal | integer | Yes | Total scoring points for this time period. The API only accepts a pre-calculated total; a detailed per-category calculation is only available in the Bloxs application. |
finalPrice | number (double) | Yes | Maximum rent price associated with the total scoring points for this time period. |
file_Dutch.fileName | string | Yes | Name of the Dutch-language supporting document for this scoring point total. Maximum length 512 characters. |
file_Dutch.mimeType | string | Yes | MIME type of the Dutch-language supporting document. Only application/pdf is accepted. Maximum length 100 characters. |
file_Dutch.base64 | string | Yes | Base64-encoded content of the Dutch-language supporting document. |
file_English.fileName | string | Yes | Name of the English-language supporting document for this scoring point total. Maximum length 512 characters. |
file_English.mimeType | string | Yes | MIME type of the English-language supporting document. Only application/pdf is accepted. Maximum length 100 characters. |
file_English.base64 | string | Yes | Base64-encoded content of the English-language supporting document. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
externalIdentifier | string | No | External identifier of the scoring point total entry. |
realEstateObjectReference | string | No | Reference of the real estate object the scoring point total applies to. |
homeType | integer | No | Type of home the scoring points apply to. Valid values are 1 (Independent), for self-contained living space, and 2 (Dependent), for non-self-contained living space. |
timePeriodTitle | string | No | Title of the time period the entry applies to. |
pointTotal | integer | No | Total scoring points for this time period. |
finalPrice | number (double) | No | Maximum rent price associated with the total scoring points for this time period. |
reference | string | No | Internal identifier generated by Bloxs for this scoring point total entry. |
Independent = 1 Dependent = 2
The scoring point total was created
Independent = 1 Dependent = 2
The scoring point total data has validation issues