Get concept commercial rent contracts filtered and paged

paging.pageSize

integer (int32)

No

The number of results to return per page. Minimum 1, maximum 1000.

paging.pageNumber

integer (int32)

No

The page of results to return. Minimum 1, maximum 9999.

sorting.columnName

string

No

The name of the field to sort the results by, for example name.

sorting.order

integer (int32)

No

The sort direction for the field named in sorting.columnName. Allowed values: 0 (ascending), 1 (descending).

filter.externalIdentifier

string

No

Filters on the identifier assigned to the contract by the calling system. This identifier is not generated by Bloxs.

filter.name

string

No

Filters on the free-text name of the contract, used for search purposes.

filter.ownerReference

string

No

Filters on the reference of the owner of the real estate object covered by the contract.

filter.relationReference

string

No

Filters on the reference of the primary tenant who is financially responsible for the contract.

filter.indexationMethod

string

No

Filters on the indexation method applied to the contract, for example a fixed yearly percentage or an inflation-linked method. The available methods are configured in Bloxs and can be retrieved through the indexation methods endpoint.

filter.startDate.from

string (date-time)

No

Lower bound of the contract start date range. ISO 8601 format.

filter.startDate.to

string (date-time)

No

Upper bound of the contract start date range. ISO 8601 format.

filter.endDate.from

string (date-time)

No

Lower bound of the contract end date range. ISO 8601 format.

filter.endDate.to

string (date-time)

No

Upper bound of the contract end date range. ISO 8601 format.

filter.nextIndexDate.from

string (date-time)

No

Lower bound of the range for the next date on which indexation is applied. ISO 8601 format.

filter.nextIndexDate.to

string (date-time)

No

Upper bound of the range for the next date on which indexation is applied. ISO 8601 format.

paging.pageSize

integer (int32)

No

The number of results returned per page, echoed back from the request.

paging.pageNumber

integer (int32)

No

The page number returned, echoed back from the request.

sorting.columnName

string

No

The field the results were sorted by, echoed back from the request.

sorting.order

integer (int32)

No

The sort direction applied, echoed back from the request. Allowed values: 0 (ascending), 1 (descending).

conceptSalesContracts.externalIdentifier

string

No

The identifier assigned to the contract by the calling system.

conceptSalesContracts.name

string

No

The free-text name of the contract.

conceptSalesContracts.ownerReference

string

No

The reference of the owner of the real estate object covered by the contract.

conceptSalesContracts.relationReference

string

No

The reference of the primary tenant who is financially responsible for the contract.

conceptSalesContracts.paymentTerm

string

No

The payment term agreed for the contract.

conceptSalesContracts.indexationMethod

string

No

The indexation method applied to the contract, for example a fixed yearly percentage or an inflation-linked method.

conceptSalesContracts.startDate

string (date)

No

The start date of the contract. ISO 8601 date format.

conceptSalesContracts.endDate

string (date)

No

The end date of the contract. ISO 8601 date format.

conceptSalesContracts.nextIndexDate

string (date)

No

The next date on which the indexation method is applied. Further indexations follow annually from this date. ISO 8601 date format.