Get general sales contract objects filtered and paged

paging.pageSize

integer

No

Maximum number of results to return per page. Defaults to 100 when not given. Minimum 1, maximum 1000.

paging.pageNumber

integer

No

Page number to retrieve. Defaults to 1 when not given. Minimum 1, maximum 9999.

sorting.columnName

string

No

Field the results are sorted on.

sorting.order

integer

No

Sort direction for columnName. Valid values are 0 (Ascending) or 1 (Descending).

filter.reference

string

No

Filters results on the internal identifier of the contract.

filter.externalIdentifier

string

No

Filters results on the external identifier of the contract.

filter.ownerReference

string

No

Filters results on the reference of the owner of the object subject to the contract.

filter.relationReference

string

No

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

filter.realEstateObjectReference

string

No

Filters results on the reference of the real estate object linked to the contract.

filter.startDate.from

string (date-time)

No

Earliest startDate to include in the selection. ISO 8601 format.

filter.startDate.to

string (date-time)

No

Latest startDate to include in the selection. ISO 8601 format.

filter.endDate.from

string (date-time)

No

Earliest endDate to include in the selection. ISO 8601 format.

filter.endDate.to

string (date-time)

No

Latest endDate to include in the selection. ISO 8601 format.

filter.isStarted

boolean

No

Filters results on whether the contract has started.

filter.isEnded

boolean

No

Filters results on whether the contract has ended.

filter.automaticExtends

boolean

No

Filters results on whether the contract renews automatically.

filter.noticeDate.from

string (date-time)

No

Earliest noticeDate to include in the selection. ISO 8601 format.

filter.noticeDate.to

string (date-time)

No

Latest noticeDate to include in the selection. ISO 8601 format.

filter.noticePeriod

integer

No

Filters results on the notice period, in months.

paging.pageSize

integer

No

Page size used for this result set. Minimum 1, maximum 1000.

paging.pageNumber

integer

No

Page number returned in this result set. Minimum 1, maximum 9999.

sorting.columnName

string

No

Field the results are sorted on.

sorting.order

integer

No

Sort direction for columnName. 0 is Ascending, 1 is Descending.

contractObjects

array of object

No

The list of contract-to-object links matching the filter, for the requested page. Empty or omitted when none match.

contractObjects.salesContractReference

string

No

Internal identifier of the contract, generated by Bloxs.

contractObjects.salesContractExternalIdentifier

string

No

External identifier of the contract, as set by the integrating system.

contractObjects.ownerReference

string

No

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

contractObjects.relationReference

string

No

Reference of the primary tenant financially responsible for the contract.

contractObjects.realEstateObjectReference

string

No

Reference of the real estate object linked to the contract.

contractObjects.startDate

string (date-time)

Yes

Start date of the contract for this object.

contractObjects.endDate

string (date-time)

No

End date of the contract for this object, if set.

contractObjects.isStarted

boolean

Yes

Indicates whether the contract has started.

contractObjects.isEnded

boolean

Yes

Indicates whether the contract has ended.

contractObjects.automaticExtends

boolean

No

Indicates whether the contract renews automatically.

contractObjects.noticeDate

string (date-time)

No

Latest date the contract can be cancelled before an automatic extension takes effect.

contractObjects.noticePeriod

integer

No

Notice period of the contract, in months.