Skip to main content

PaymentFilterDTO

Payment filter request body. All fields are optional.

  • start/finish — filter by payment date (timestamp field).
  • createdStart/createdFinish — filter by the date the payment was entered into the system (createdTimestamp field).
pageint32

Page number, 1-based.

Possible values: >= 1

Default value: 1
Example: 1
sizeint32

Page size (min 1, max 100).

Possible values: >= 1 and <= 100

Default value: 10
Example: 20
basesPaymentBase[]

Filter by payment source (optional).

Possible values: [CONTRACT, SURCHARGE, CLIENT, BOOKING, CASHBACK]

Example: ["CONTRACT","BOOKING"]
typesPaymentType[]

Filter by payment method (optional).

Possible values: [CARD, CASH, TRANSFER, BALANCE, BANK, PAYME, MY_UZCARD, UZUM, PAYLOV, UYSOT_PAY, ATMOS, OTHERS, CUSTOM, CASHBACK, CLICK]

Example: ["CASH","CARD"]
debitPaymentDebit

Payment direction enum.

  • INCOME — Income
  • OUTCOME — Outcome

Possible values: [INCOME, OUTCOME]

Example: INCOME
amountFromdouble

Minimum payment amount (optional).

Possible values: >= 0

Example: 1000000
amountTodouble

Maximum payment amount (optional).

Possible values: >= 0

Example: 50000000
startint64

Payment date lower bound (epoch seconds, optional).

Example: 1700000000
finishint64

Payment date upper bound (epoch seconds, optional).

Example: 1750000000
createdStartint64

System-entry date lower bound (epoch seconds, optional).

Example: 1700000000
createdFinishint64

System-entry date upper bound (epoch seconds, optional).

Example: 1750000000
currencyIdsint32[]

Filter by currency IDs (optional).

Example: [1,2]
contractIdint64

Filter by contract ID (optional).

Example: 1409
clientIdint64

Filter by client ID (optional).

Example: 3001
bookingIdint64

Filter by booking ID (optional).

Example: 512
branchIdsint32[]

Filter by branch IDs (optional).

Example: [1,2]
houseIdsint32[]

Filter by house (residential complex) IDs (optional).

Example: [1,2]
buildingIdsint32[]

Filter by building IDs (optional).

Example: [10,11]
paymentViewPaymentViewStatus

Payment visibility filter for POST /v1/open-api/payment/filter.

  • ALL — All payments (default)
  • ACTIVE — Only active (non-cancelled) payments
  • CANCELLED — Only cancelled payments

Possible values: [ALL, ACTIVE, CANCELLED]

Example: ALL
PaymentFilterDTO
{
  "page": 1,
  "size": 20,
  "bases": [
    "CONTRACT",
    "BOOKING"
  ],
  "types": [
    "CASH",
    "CARD"
  ],
  "debit": "INCOME",
  "amountFrom": 1000000,
  "amountTo": 50000000,
  "start": 1700000000,
  "finish": 1750000000,
  "createdStart": 1700000000,
  "createdFinish": 1750000000,
  "currencyIds": [
    1,
    2
  ],
  "contractId": 1409,
  "clientId": 3001,
  "bookingId": 512,
  "branchIds": [
    1,
    2
  ],
  "houseIds": [
    1,
    2
  ],
  "buildingIds": [
    10,
    11
  ],
  "paymentView": "ALL"
}