Skip to main content

BookingFilterDTO

Booking filter request body. Pagination plus optional filters — every list filter is ignored when empty, and all filters are combined with AND. Bookings carry no custom fields, so there is no fields filter.

pageint32

Page number, 1-based. Min 1.

Possible values: >= 1

Default value: 1
Example: 1
sizeint32

Page size. Min 1, max 100.

Possible values: >= 1 and <= 100

Default value: 15
Example: 15
orders object

Sort order. Each key is a sort field — ID, NUMBER, TIMESTAMP, CANCEL_TIMESTAMP, PREPAYMENT, DEAL_PRICE, DELAY or STATUS (see BookingOrderField) — and each value a direction. Keys are applied in the order they appear in the JSON object. Unless ID is one of the keys, a trailing ID DESC tie-breaker is appended so paging stays stable. Omit (or send {}) to sort by ID DESC only.

property name*string

Possible values: [ASC, DESC]

searchstring

Case-insensitive partial match on the booking number, its note, or the apartment number.

Example: B-2024
idsint64[]

Filter by booking IDs (optional) — useful for bulk re-sync.

Example: [512,513]
numberstring

Booking number — exact match.

Example: B-2024-118
statusesBookingStatus[]

Filter by booking status.

Possible values: [ACTIVE, CONTRACT, CANCELED]

sourcesBookingSource[]

Filter by where the booking came from.

Possible values: [COMPANY, MARKETPLACE, OTHER]

employeeIdsint32[]

Filter by the employee who placed the booking.

Example: [95]
cancelEmployeeIdsint32[]

Filter by the employee who cancelled the booking.

Example: [95]
clientIdsint64[]

Filter by client IDs.

Example: [3001]
flatIdsint32[]

Filter by apartment IDs.

Example: [1024]
buildingIdsint32[]

Filter by building (block) IDs.

Example: [10,11]
houseIdsint32[]

Filter by house (project) IDs — see GET /v1/open-api/house/all.

Example: [144]
branchIdsint32[]

Filter by the branch the booking was created in.

Example: [1]
currencyIdsint32[]

Filter by currency IDs.

Example: [24]
contractIdsint32[]

Filter by the contract the booking turned into (set when status is CONTRACT).

Example: [1409]
cancelReasonIdsint32[]

Filter by cancellation reason IDs — see GET /v1/open-api/booking/cancel-reason. A booking matches when it carries any of the listed reasons.

Example: [3,7]
timestampFromint64

Lower bound (inclusive) for the booking date, epoch seconds.

Example: 1730419200
timestampToint64

Upper bound (inclusive) for the booking date, epoch seconds.

Example: 1733011200
cancelTimestampFromint64

Lower bound (inclusive) for the cancellation time, epoch seconds.

Example: 1730419200
cancelTimestampToint64

Upper bound (inclusive) for the cancellation time, epoch seconds.

Example: 1733011200
prepaymentFromdouble

Lower bound (inclusive) for prePayment.

Possible values: >= 0

Example: 1000000
prepaymentTodouble

Upper bound (inclusive) for prePayment.

Possible values: >= 0

Example: 50000000
dealPriceFromdouble

Lower bound (inclusive) for dealPrice.

Possible values: >= 0

Example: 500000000
dealPriceTodouble

Upper bound (inclusive) for dealPrice.

Possible values: >= 0

Example: 1200000000
delayFromint32

Lower bound (inclusive) for the booking term in days.

Example: 1
delayToint32

Upper bound (inclusive) for the booking term in days.

Example: 14
refundablePaymentbooleannullable

Only bookings whose prepayment is refundable (true) or non-refundable (false). null (omit) — don't filter.

Example: true
hasContractbooleannullable

Only bookings that turned into a contract (true) or that did not (false). null (omit) — don't filter.

Example: true
BookingFilterDTO
{
  "page": 1,
  "size": 15,
  "orders": {
    "TIMESTAMP": "DESC"
  },
  "search": "B-2024",
  "ids": [
    512,
    513
  ],
  "number": "B-2024-118",
  "statuses": [
    "ACTIVE"
  ],
  "sources": [
    "COMPANY"
  ],
  "employeeIds": [
    95
  ],
  "cancelEmployeeIds": [
    95
  ],
  "clientIds": [
    3001
  ],
  "flatIds": [
    1024
  ],
  "buildingIds": [
    10,
    11
  ],
  "houseIds": [
    144
  ],
  "branchIds": [
    1
  ],
  "currencyIds": [
    24
  ],
  "contractIds": [
    1409
  ],
  "cancelReasonIds": [
    3,
    7
  ],
  "timestampFrom": 1730419200,
  "timestampTo": 1733011200,
  "cancelTimestampFrom": 1730419200,
  "cancelTimestampTo": 1733011200,
  "prepaymentFrom": 1000000,
  "prepaymentTo": 50000000,
  "dealPriceFrom": 500000000,
  "dealPriceTo": 1200000000,
  "delayFrom": 1,
  "delayTo": 14,
  "refundablePayment": true,
  "hasContract": true
}