Get private rent contract objects filtered and paged

paging.pageSize

integer (int32)

No

The maximum number of results returned 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 field name used to sort the results, for example "startDate".

sorting.order

integer (int32)

No

The sort direction applied to sorting.columnName. Allowed values are 0 for ascending and 1 for descending.

filter.reference

string

No

Filters results to the residential lease contract with this reference, as generated by Bloxs.

filter.externalIdentifier

string

No

Filters results to the residential lease contract with this external identifier, assigned by the requesting party.

filter.ownerReference

string

No

Filters results to contracts belonging to the owner with this reference.

filter.relationReference

string

No

Filters results to contracts where this reference is the primary, financially responsible tenant.

filter.startDate.from

string (date-time)

No

Lower bound for the contract's start date. ISO 8601 date-time format.

filter.startDate.to

string (date-time)

No

Upper bound for the contract's start date. ISO 8601 date-time format.

filter.endDate.from

string (date-time)

No

Lower bound for the contract's end date. ISO 8601 date-time format.

filter.endDate.to

string (date-time)

No

Upper bound for the contract's end date. ISO 8601 date-time format.

filter.isStarted

boolean

No

Filters on whether the contract's start date has already passed.

filter.isEnded

boolean

No

Filters on whether the contract's end date has already passed.

filter.automaticExtends

boolean

No

Filters on whether the contract renews automatically.

filter.noticeDate.from

string (date-time)

No

Lower bound for the contract's notice date. ISO 8601 date-time format.

filter.noticeDate.to

string (date-time)

No

Upper bound for the contract's notice date. ISO 8601 date-time format.

filter.noticePeriod

integer (int32)

No

Filters on the contract's notice period, in months.

filter.depositTypeName

string

No

Filters on the name of the deposit type registered for the contract.

filter.realEstateObjectReference

string

No

Filters results to the real estate object with this reference.

paging.pageSize

integer (int32)

No

The maximum number of results returned per page, as applied to this response.

paging.pageNumber

integer (int32)

No

The page of results returned.

sorting.columnName

string

No

The field name the results were sorted on.

sorting.order

integer (int32)

No

The sort direction applied. 0 for ascending, 1 for descending.

contractObjects.reference

string

No

The reference of the residential lease contract, as generated by Bloxs.

contractObjects.externalIdentifier

string

No

The external identifier of the residential lease contract, assigned by the requesting party.

contractObjects.ownerReference

string

No

The reference of the owner of the real estate object that is subject to the contract.

contractObjects.relationReference

string

No

The reference of the tenant who is the primary, financially responsible party on the contract.

contractObjects.extraRelationReferences

array of string

No

The references of co-tenants on the contract, returned as an array of individual references.

contractObjects.startDate

string (date-time)

Yes

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

contractObjects.endDate

string (date-time)

No

The end date of the contract, or the date on which it is automatically renewed when automaticExtends is true. ISO 8601 date-time format.

contractObjects.isStarted

boolean

Yes

Whether the contract's start date has already passed.

contractObjects.isEnded

boolean

Yes

Whether the contract's end date has already passed.

contractObjects.automaticExtends

boolean

No

Whether the contract renews automatically.

contractObjects.noticeDate

string (date-time)

No

The latest date on which the contract can be cancelled before an automatic extension takes effect. ISO 8601 date-time format.

contractObjects.noticePeriod

integer (int32)

No

The notice period of the contract, in months.

contractObjects.depositTypeName

string

No

The name of the deposit type registered for the contract.

contractObjects.realEstateObjectReference

string

No

The reference of the real estate object linked to this contract.