> ## 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. # Update a concept private rent contract > Update an existing concept private rent contract. ## OpenAPI ````json PUT /api/v1/contracts/conceptprivaterent { "openapi": "3.0.4", "info": { "title": "Concept SalesContracts V1", "description": "Welcome to BETA version of the new Sales Concept Contracts 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": "CommercialRentContracts" }, { "name": "Concept CommercialRent" }, { "name": "Concept PrivateRent" }, { "name": "GeneralSalesContracts" }, { "name": "Metadata" }, { "name": "PrivateRentContracts" }, { "name": "SupplierContracts" } ], "paths": { "/api/v1/contracts/conceptprivaterent": { "put": { "tags": [ "Concept PrivateRent" ], "summary": "Update a concept private rent contract", "description": "Update an existing concept private rent contract.", "operationId": "UpdateConceptPrivateRentContract", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConceptPrivateRentContractAPIModel" } } } }, "responses": { "200": { "description": "A concept private rent contract was updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConceptPrivateRentContractAPIDetailModel" } } } }, "400": { "description": "The concept private rent contract data has validation issues", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorMessageModel" } } } } }, "x-d360-narrative-url": "

Update a concept private rent contract

This endpoint updates an existing draft residential lease contract.

This endpoint can only be used before the contract is finalized in the Bloxs application; there is no API endpoint to finalize a contract.

This operation fully overwrites the concept contract. Any field not included in the request will be cleared, not left unchanged.

Request Fields

Field

Type

Required

Description

externalIdentifier

string

Yes

Identifier of the concept contract to update, within the integrating system's own system. Not generated by Bloxs. Maximum length 100 characters.

name

string

No

Free-text name of the contract, intended to help with search. Maximum length 256 characters.

ownerReference

string

Yes

Reference of the owner of the object subject to the contract.

relationReference

string

No

Reference of the primary tenant who is financially responsible for the contract.

extraRelations

array of string

No

References of co-tenants on the contract.

startDate

string (date)

No

Start date of the contract. ISO 8601 format.

endDate

string (date)

No

End date of the contract, if set.

automaticExtends

boolean

No

Indicates whether the contract renews automatically. Default value is false.

notifyOnExpiration

boolean

No

Indicates whether the user should be notified when the rental period expires. Default value is false.

notifyOnExpirationMonths

integer

No

Number of months in advance the expiration notification is triggered. Minimum 1, maximum 9999.

paymentMethod

integer

No

Payment method for the contract. Valid values are 1 (Direct Debit) or 2 (Bank Transfer).

paymentTermInDays

integer

No

Payment term in days, calculated from the start of the rental period. Must be filled in within Bloxs before the contract can be finalized.

invoiceInterval

integer

No

Billing frequency. Valid values are 1 (monthly), 3 (quarterly), 6 (semi-annual), or 12 (annual); no other values are valid.

automaticInvoicingFrom

string (date)

No

Date from which automated invoicing begins. Must be on or after the contract start date.

indexationInfo.indexationMethodName

string

Yes (within indexationInfo)

Indexation method applied to the contract, for example a fixed yearly percentage or a rate linked to inflation figures processed automatically by Bloxs. Values are configurable in the Bloxs application.

indexationInfo.nextIndexDate

string (date)

Yes (within indexationInfo)

Next date the indexation method is applied. Subsequent indexations follow annually from this date.

indexationInfo.indexationUseOverrules

boolean

Yes (within indexationInfo)

Indicates whether the overrule fields below should apply to the indexation method. Default value is false.

indexationInfo.indexationOverrule_MinimumIndexRate

number (double)

No

Minimum indexation rate applied regardless of the underlying method's outcome. 1 equals 100%. Only applied when indexationUseOverrules is true. Minimum -1, maximum 1.

indexationInfo.indexationOverrule_MaximumIndexRate

number (double)

No

Maximum indexation rate applied regardless of the underlying method's outcome. 1 equals 100%. Only applied when indexationUseOverrules is true. Minimum -1, maximum 1.

indexationInfo.indexationOverrule_IncrementRate

number (double)

No

Fixed additional rate applied on top of the method's outcome. Can still be bounded by the minimum/maximum overrules. Only applied when indexationUseOverrules is true. Minimum -1, maximum 1.

sendInvoices

boolean

No

Indicates whether invoices should be sent. Default value is false.

extraInvoiceText

string

No

Extra text to add to the invoice, for example the contract or relation number.

remarks

string

No

Free text remarks for internal use. Not included on the invoice.

noticePeriod

integer

No

Notice period of the contract, in months. Relevant when automaticExtends is true.

depositTypeName

string

No

Type of deposit applying to the contract. Values are configurable in the Bloxs application and cannot be managed through the API.

depositAmount

number (double)

No

Deposit amount. Decimals are separated with a period.

contractRealEstateObjects

array of string

Yes

References of the real estate object(s) subject to the contract.

extensionPeriods

array of object

No

Automatic renewal periods for the contract.

extensionPeriods.numberOfMonths

integer

No

Number of months the contract is automatically renewed for, when automaticExtends is true, for example 6 for a contract that renews every six months. Minimum 1, maximum 9999.

doNotTakeOverTheoreticalRent

boolean

No

Indicates whether to deviate from the object's theoretical rent value, for example when a unit differs from others in the same complex (ground floor with garden). Default value is false, meaning the theoretical rent is applied.

doNotTakeOverInitialCosts

boolean

No

Indicates whether to deviate from the object's theoretical initial costs, for example when a unit requires extra keys not shared by others in the complex. Default value is false, meaning the theoretical initial costs are applied.

Response Fields

Field

Type

Required

Description

externalIdentifier

string

No

Identifier of the concept contract within the integrating system's own system.

name

string

No

Free-text name of the contract.

ownerReference

string

No

Reference of the owner of the object subject to the contract.

relationReference

string

No

Reference of the primary tenant financially responsible for the contract.

extraRelations

array of string

No

References of co-tenants on the contract.

startDate

string (date)

No

Start date of the contract.

endDate

string (date)

No

End date of the contract, if set.

automaticExtends

boolean

No

Indicates whether the contract renews automatically.

notifyOnExpiration

boolean

No

Indicates whether the user should be notified when the rental period expires.

notifyOnExpirationMonths

integer

No

Number of months in advance the expiration notification is triggered. Minimum 1, maximum 9999.

paymentMethod

integer

No

Payment method for the contract. Valid values are 1 (Direct Debit) or 2 (Bank Transfer).

ownerBankAccount

string

No

IBAN the rent amount should be transferred to. Not settable through this request; populated by Bloxs.

paymentTermInDays

integer

No

Payment term in days, calculated from the start of the rental period.

invoiceInterval

integer

No

Billing frequency. Valid values are 1 (monthly), 3 (quarterly), 6 (semi-annual), or 12 (annual).

automaticInvoicingFrom

string (date)

No

Date from which automated invoicing begins.

indexationInfo.indexationMethodName

string

No

Indexation method applied to the contract.

indexationInfo.nextIndexDate

string (date)

No

Next date the indexation method is applied.

indexationInfo.indexationUseOverrules

boolean

No

Indicates whether the overrule fields apply.

indexationInfo.indexationOverrule_MinimumIndexRate

number (double)

No

Minimum indexation rate. 1 equals 100%.

indexationInfo.indexationOverrule_MaximumIndexRate

number (double)

No

Maximum indexation rate. 1 equals 100%.

indexationInfo.indexationOverrule_IncrementRate

number (double)

No

Fixed additional rate on top of the method's outcome.

sendInvoices

boolean

No

Indicates whether invoices should be sent.

extraInvoiceText

string

No

Extra text added to the invoice.

remarks

string

No

Free text remarks for internal use.

noticePeriod

integer

No

Notice period of the contract, in months.

depositTypeName

string

No

Type of deposit applying to the contract.

depositAmount

number (double)

No

Deposit amount.

contractRealEstateObjects

array of string

No

References of the real estate object(s) subject to the contract.

extensionPeriods

array of object

No

Automatic renewal periods for the contract.

extensionPeriods.numberOfMonths

integer

No

Number of months the contract is automatically renewed for.

" } } }, "components": { "schemas": { "ConceptPrivateRentContractAPIModel": { "required": [ "contractRealEstateObjects", "externalIdentifier", "ownerReference" ], "type": "object", "properties": { "externalIdentifier": { "maxLength": 100, "minLength": 0, "type": "string" }, "name": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "ownerReference": { "minLength": 1, "type": "string" }, "relationReference": { "type": "string", "nullable": true }, "extraRelations": { "type": "array", "items": { "type": "string" }, "nullable": true }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date", "nullable": true }, "automaticExtends": { "type": "boolean" }, "notifyOnExpiration": { "type": "boolean" }, "notifyOnExpirationMonths": { "maximum": 9999, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "copyAddresToTenant": { "type": "boolean" }, "paymentMethod": { "type": "integer", "description": "DirectDebit = 1\nBankTransfer = 2", "format": "int32", "nullable": true, "x-enumNames": [ "DirectDebit", "BankTransfer" ] }, "paymentTermInDays": { "type": "integer", "format": "int32", "nullable": true }, "invoiceInterval": { "type": "integer", "description": "Month = 1\nQuarter = 3\nHalfYear = 6\nYear = 12", "format": "int32", "nullable": true, "x-enumNames": [ "Month", "Quarter", "HalfYear", "Year" ] }, "automaticInvoicingFrom": { "type": "string", "format": "date", "nullable": true }, "indexationInfo": { "$ref": "#/components/schemas/SalesContractIndexationInfoAPIModel" }, "sendInvoices": { "type": "boolean" }, "extraInvoiceText": { "type": "string", "nullable": true }, "remarks": { "type": "string", "nullable": true }, "noticePeriod": { "type": "integer", "format": "int32", "nullable": true }, "depositTypeName": { "type": "string", "nullable": true }, "depositAmount": { "type": "number", "format": "double", "nullable": true }, "contractRealEstateObjects": { "type": "array", "items": { "type": "string" } }, "extensionPeriods": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptContractExtensionPeriod" }, "nullable": true }, "doNotTakeOverTheoreticalRent": { "type": "boolean" }, "doNotTakeOverInitialCosts": { "type": "boolean" } }, "additionalProperties": false }, "ConceptPrivateRentContractAPIDetailModel": { "type": "object", "properties": { "externalIdentifier": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "ownerReference": { "type": "string", "nullable": true }, "relationReference": { "type": "string", "nullable": true }, "extraRelations": { "type": "array", "items": { "type": "string" }, "nullable": true }, "startDate": { "type": "string", "format": "date", "nullable": true }, "endDate": { "type": "string", "format": "date", "nullable": true }, "automaticExtends": { "type": "boolean" }, "notifyOnExpiration": { "type": "boolean" }, "notifyOnExpirationMonths": { "maximum": 9999, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "copyAddresToTenant": { "type": "boolean" }, "paymentMethod": { "type": "integer", "description": "DirectDebit = 1\nBankTransfer = 2", "format": "int32", "nullable": true, "x-enumNames": [ "DirectDebit", "BankTransfer" ] }, "ownerBankAccount": { "type": "string", "nullable": true }, "paymentTermInDays": { "type": "integer", "format": "int32", "nullable": true }, "invoiceInterval": { "type": "integer", "description": "Month = 1\nQuarter = 3\nHalfYear = 6\nYear = 12", "format": "int32", "nullable": true, "x-enumNames": [ "Month", "Quarter", "HalfYear", "Year" ] }, "automaticInvoicingFrom": { "type": "string", "format": "date", "nullable": true }, "indexationInfo": { "$ref": "#/components/schemas/SalesContractIndexationInfoAPIModel" }, "sendInvoices": { "type": "boolean" }, "extraInvoiceText": { "type": "string", "nullable": true }, "remarks": { "type": "string", "nullable": true }, "noticePeriod": { "type": "integer", "format": "int32", "nullable": true }, "depositTypeName": { "type": "string", "nullable": true }, "depositAmount": { "type": "number", "format": "double", "nullable": true }, "contractRealEstateObjects": { "type": "array", "items": { "type": "string" }, "nullable": true }, "extensionPeriods": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptContractExtensionPeriod" }, "nullable": true } }, "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 }, "SalesContractIndexationInfoAPIModel": { "required": [ "indexationMethodName", "indexationOverrule_IncrementRate", "indexationOverrule_MaximumIndexRate", "indexationOverrule_MinimumIndexRate", "indexationUseOverrules", "nextIndexDate" ], "type": "object", "properties": { "indexationMethodName": { "minLength": 1, "type": "string" }, "nextIndexDate": { "type": "string", "format": "date" }, "indexationUseOverrules": { "type": "boolean" }, "indexationOverrule_MinimumIndexRate": { "maximum": 1, "minimum": -1, "type": "number", "format": "double", "nullable": true }, "indexationOverrule_MaximumIndexRate": { "maximum": 1, "minimum": -1, "type": "number", "format": "double", "nullable": true }, "indexationOverrule_IncrementRate": { "maximum": 1, "minimum": -1, "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "ConceptContractExtensionPeriod": { "type": "object", "properties": { "numberOfMonths": { "maximum": 9999, "minimum": 1, "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false } } } } ````