Get general sales contracts filtered and paged

paging.pageSize

Integer

Optional

Maximum number of general sales contracts returned per page. Minimum 1, maximum 1000.

paging.pageNumber

Integer

Optional

Page number to retrieve, starting at 1. Minimum 1, maximum 9999.

sorting.columnName

String

Optional

Name of the field to sort the results by.

sorting.order

Integer (enum)

Optional

Sort direction. Allowed values: 0 = Ascending, 1 = Descending.

filter.externalIdentifier

String

Optional

Filters on the external identifier of the general sales contract, as supplied by the caller on creation.

filter.reference

String

Optional

Filters on the internal identifier of the general sales contract.

filter.ownerReference

String

Optional

Filters on the owner, the administration the contract is booked against.

filter.relationReference

String

Optional

Filters on the relation, the other party to the contract.

filter.startDate.from

Datetime (ISO 8601)

Optional

Lower bound of the contract start date range to filter on, inclusive.

filter.startDate.to

Datetime (ISO 8601)

Optional

Upper bound of the contract start date range to filter on, inclusive.

filter.endDate.from

Datetime (ISO 8601)

Optional

Lower bound of the contract end date range to filter on, inclusive.

filter.endDate.to

Datetime (ISO 8601)

Optional

Upper bound of the contract end date range to filter on, inclusive.

filter.isStarted

Boolean

Optional

Filters on whether the contract has started.

filter.isEnded

Boolean

Optional

Filters on whether the contract has ended.

filter.automaticExtends

Boolean

Optional

Filters on whether the contract extends automatically after its end date.

filter.noticeDate.from

Datetime (ISO 8601)

Optional

Lower bound of the notice date range to filter on, inclusive.

filter.noticeDate.to

Datetime (ISO 8601)

Optional

Upper bound of the notice date range to filter on, inclusive.

filter.noticePeriod

Integer

Optional

Filters on the notice period configured on the contract.

paging.pageSize

Integer

Optional

Maximum number of general sales contracts returned per page, as applied to this result.

paging.pageNumber

Integer

Optional

Page number returned, as applied to this result.

sorting.columnName

String

Optional

Name of the field the results are sorted by, as applied to this result.

sorting.order

Integer (enum)

Optional

Sort direction applied to this result. Allowed values: 0 = Ascending, 1 = Descending.

contracts

Array of objects

Optional

The general sales contracts matching the filter, for the requested page.

contracts[].reference

String

Optional

Internal identifier of the general sales contract.

contracts[].externalIdentifier

String

Optional

External identifier of the contract, as supplied by the caller on creation.

contracts[].ownerReference

String

Optional

Reference to the owner, the administration the contract is booked against.

contracts[].relationReference

String

Optional

Reference to the relation, the other party to the contract.

contracts[].extraRelationReferences

Array of strings

Optional

References to any additional relations linked to the contract.

contracts[].startDate

Datetime (ISO 8601)

Optional

Date the contract starts.

contracts[].endDate

Datetime (ISO 8601)

Optional

Date the contract ends. Empty for a contract without a fixed end date.

contracts[].isStarted

Boolean

Optional

Indicates whether the contract has started.

contracts[].isEnded

Boolean

Optional

Indicates whether the contract has ended.

contracts[].automaticExtends

Boolean

Optional

Indicates whether the contract extends automatically after its end date.

contracts[].noticeDate

Datetime (ISO 8601)

Optional

Date by which notice must be given to end the contract.

contracts[].noticePeriod

Integer

Optional

Notice period configured on the contract.