> ## Documentation Index > Fetch the complete documentation index at: https://www.bloxs.io/llms.txt > Use this file to discover all available pages before exploring further. # Insert a scoring point total > 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. ## OpenAPI ````json POST /api/v1/realestateobjects/scoringpointtotals { "openapi": "3.0.4", "info": { "title": "RealEstateObjects V1", "description": "Welcome to BETA version of the new RealEstateObjects API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.", "version": "v1" }, "security": [ {} ], "tags": [ { "name": "Admin" }, { "name": "Buildings" }, { "name": "Complexes" }, { "name": "Generic" }, { "name": "Metadata" }, { "name": "PublishObjects" }, { "name": "ScoringPointTotals" }, { "name": "Sections" }, { "name": "Units" } ], "paths": { "/api/v1/realestateobjects/scoringpointtotals": { "post": { "tags": [ "ScoringPointTotals" ], "summary": "Insert a scoring point total", "description": "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.", "operationId": "InsertScoringPointTotal", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScoringPointTotal" } } } }, "responses": { "200": { "description": "The scoring point total was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScoringPointTotalDetails" } } } }, "400": { "description": "The scoring point total data has validation issues", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorMessageModel" } } } } }, "x-d360-narrative-url": "

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.

" } } }, "components": { "schemas": { "ScoringPointTotal": { "required": [ "externalIdentifier", "file_Dutch", "file_English", "finalPrice", "homeType", "pointTotal", "realEstateObjectReference", "timePeriodTitle" ], "type": "object", "properties": { "externalIdentifier": { "maxLength": 100, "minLength": 0, "type": "string" }, "realEstateObjectReference": { "maxLength": 100, "minLength": 0, "type": "string" }, "homeType": { "type": "integer", "description": "Independent = 1\nDependent = 2", "format": "int32", "x-enumNames": [ "Independent", "Dependent" ] }, "timePeriodTitle": { "maxLength": 256, "minLength": 0, "type": "string" }, "pointTotal": { "type": "integer", "format": "int32" }, "finalPrice": { "type": "number", "format": "double" }, "file_Dutch": { "$ref": "#/components/schemas/APIFilePutModel" }, "file_English": { "$ref": "#/components/schemas/APIFilePutModel" } }, "additionalProperties": false }, "ScoringPointTotalDetails": { "required": [ "externalIdentifier", "finalPrice", "homeType", "pointTotal", "realEstateObjectReference", "reference", "timePeriodTitle" ], "type": "object", "properties": { "externalIdentifier": { "maxLength": 100, "minLength": 0, "type": "string" }, "realEstateObjectReference": { "maxLength": 100, "minLength": 0, "type": "string" }, "homeType": { "type": "integer", "description": "Independent = 1\nDependent = 2", "format": "int32", "x-enumNames": [ "Independent", "Dependent" ] }, "timePeriodTitle": { "maxLength": 256, "minLength": 0, "type": "string" }, "pointTotal": { "type": "integer", "format": "int32" }, "finalPrice": { "type": "number", "format": "double" }, "reference": { "maxLength": 100, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "APIErrorMessageModel": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "traceId": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "APIFilePutModel": { "required": [ "base64", "fileName", "mimeType" ], "type": "object", "properties": { "fileName": { "maxLength": 512, "minLength": 1, "type": "string" }, "mimeType": { "maxLength": 100, "minLength": 1, "type": "string" }, "base64": { "minLength": 1, "type": "string" } }, "additionalProperties": false } } } } ````