Skip to main content

ContractFilterDTO

Request body for the contract filter endpoint. All filter fields are optional except pagination; omitted list filters match everything. Deleted contracts are excluded.

pageint32

Page number, 1-based (min 1).

Possible values: >= 1

Default value: 1
Example: 1
sizeint32

Page size (min 1, max 50).

Possible values: >= 1 and <= 50

Default value: 15
Example: 15
searchstring

Free-text match over contract number, pay number and client name

Example: CNT-2023
contractNumberstring

Filter by contract number (contains)

Example: CNT-2023-001
startDatestring

Lower bound of contract creation date (dd.MM.yyyy)

Example: 01.01.2025
finishDatestring

Upper bound of contract creation date (dd.MM.yyyy)

Example: 31.12.2025
responsibleByIdsinteger[]

Filter by responsible employee IDs.

Example: [201,202]
currenciesinteger[]

Filter by currency IDs.

Example: [1,2]
statusesContractStatus[]

Filter by contract statuses.

Possible values: [STARTED, ACTIVE, CANCELLED, FINISHED, TRANSFERRED]

Example: ["ACTIVE","STARTED"]
ContractFilterDTO
{
"page": 1,
"size": 15,
"search": "CNT-2023",
"contractNumber": "CNT-2023-001",
"startDate": "01.01.2025",
"finishDate": "31.12.2025",
"responsibleByIds": [
201,
202
],
"currencies": [
1,
2
],
"statuses": [
"ACTIVE",
"STARTED"
]
}