Skip to main content

MonthlyPaymentTableDTO

Row returned by POST /v1/open-api/monthly-payment/filter. Has every field of MonthlyPaymentPartDTO plus which contract it belongs to — when several contracts are requested together, the client groups rows by contractId. Internal IDs (monthly_payment, monthly_payment_part) are never returned; a row is uniquely identified by contractId + date.

contractIdint32

Contract ID — for grouping rows.

Example: 1024
contractNumberstring

Contract number

Example: CNT-2025-001
datestring

Scheduled date (dd.MM.yyyy) — matches the dateFrom/dateTo filter.

Example: 15.03.2025
amountdouble

Amount scheduled for this date

Example: 2000
paymentdouble

Amount actually paid toward this row

Example: 2000
prepaymentboolean

Whether it's a prepayment row

Example: false
paidboolean

Whether paid

Example: true
typeContractPaymentTypenullable

Row type.

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

Example: MONTHLY_PAYMENT
paidDatestringnullable

Actual paid date (dd.MM.yyyy).

Example: 10.03.2025
MonthlyPaymentTableDTO
{
  "contractId": 1024,
  "contractNumber": "CNT-2025-001",
  "date": "15.03.2025",
  "amount": 2000,
  "payment": 2000,
  "prepayment": false,
  "paid": true,
  "type": "MONTHLY_PAYMENT",
  "paidDate": "10.03.2025"
}