Skip to main content

MonthlyPaymentFilterDTO

Request body for POST /v1/open-api/monthly-payment/filter. Send contractIds: [1024] for a single contract's schedule; several IDs fetch many contracts' schedules in one call — each row carries contractId so the client groups them itself. Always returns only the active schedule (a contract has at most one active schedule at a time), so there is no schedule-status filter.

pageint32

Page number, 1-based (min 1).

Possible values: >= 1

Default value: 1
Example: 1
sizeint32

Page size (min 1, max 100 — higher than most other filters).

Possible values: >= 1 and <= 100

Default value: 15
Example: 50
orders object

Sort order. Each key is a sort field (see MonthlyPaymentOrderField) and each value a direction. Keys are applied in the order they appear in the JSON object. A row-id tie-breaker is always appended internally (there is no ID sort key — the row id is never exposed). Omit (or send {}) to keep the default order — DATE ASC.

property name*string

Possible values: [ASC, DESC]

contractIdsinteger[]

Contract IDs; empty/omitted — all of the company's contracts.

Example: [1024,1025,1026]
dateFromstringnullable

Lower bound (inclusive) of the schedule date (dd.MM.yyyy). No epoch-seconds pair — the underlying column has no time part.

Example: 01.01.2025
dateTostringnullable

Upper bound (inclusive) of the schedule date (dd.MM.yyyy).

Example: 31.03.2025
paidDateFromstringnullable

Lower bound (inclusive) of the actual paid date (dd.MM.yyyy).

Example: 01.02.2025
paidDateTostringnullable

Upper bound (inclusive) of the actual paid date (dd.MM.yyyy).

Example: 28.02.2025
createdTimestampFromint64nullable

Lower bound (inclusive) of when the schedule row was created, epoch seconds.

Example: 1735689600
createdTimestampToint64nullable

Upper bound (inclusive) of when the schedule row was created, epoch seconds.

Example: 1767207599
paidbooleannullable

true — only paid rows, false — only unpaid rows, null (omit) — all.

prepaymentbooleannullable

true — only prepayment rows, false — the rest.

typesContractPaymentType[]

Filter by row type.

Possible values: [MONTHLY_PAYMENT, PREPAYMENT, MORTGAGE, REMAINING]

Example: ["PREPAYMENT"]
MonthlyPaymentFilterDTO
{
  "page": 1,
  "size": 50,
  "orders": {
    "CONTRACT_ID": "ASC",
    "DATE": "ASC"
  },
  "contractIds": [
    1024,
    1025,
    1026
  ],
  "dateFrom": "01.01.2025",
  "dateTo": "31.03.2025",
  "paidDateFrom": "01.02.2025",
  "paidDateTo": "28.02.2025",
  "createdTimestampFrom": 1735689600,
  "createdTimestampTo": 1767207599,
  "paid": true,
  "prepayment": true,
  "types": [
    "PREPAYMENT"
  ]
}