PaymentDTO

Payment information object.

idint64

Payment ID

Example: 10001

numberstring

Payment number

Example: PAY-2023-001

amountdouble

Payment amount

Example: 5000

basePaymentBase

Payment source enum — which entity the payment belongs to.

• CONTRACT — Contract payment
• SURCHARGE — Fine / penalty payment
• CLIENT — Client balance top-up
• BOOKING — Booking (reservation) payment
• CASHBACK — Cashback payment

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

Example: CONTRACT

typePaymentType

Payment method enum.

• CARD — Card
• CASH — Cash
• TRANSFER — Transfer (card to card)
• BALANCE — From client balance
• BANK — Via bank
• PAYME — Payme
• MY_UZCARD — MyUzcard
• UZUM — Uzum
• PAYLOV — Paylov
• UYSOT_PAY — Uysot pay
• ATMOS — Atmos
• OTHERS — Others
• CUSTOM — Custom
• CASHBACK — Cashback
• CLICK — Click

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

Example: CASH

debtPaymentDebit

Payment direction enum.

• INCOME — Income
• OUTCOME — Outcome

Possible values: [INCOME, OUTCOME]

Example: INCOME

createdBy objectnullable

Employee who created the payment. Breaking change: this used to be the employee's name as a plain string; the name now lives in createdByName.

idint32

Employee ID

Example: 201

fullNamestring

Employee full name

Example: David Wilson

canceledBy objectnullable

Employee who cancelled the payment. Present only for a cancelled payment.

idint32

Employee ID

Example: 201

fullNamestring

Employee full name

Example: David Wilson

createdByNamestringnullabledeprecated

Full name of the employee who created the payment. Use createdBy.fullName instead.

Example: Alice Johnson

createdTimestampint64

Creation time (epoch seconds)

Example: 1672531200

canceledTimestampint64

Cancellation time (epoch seconds)

Example: 1672617600

cancelNotestring

Cancellation reason

Example: Duplicate payment

payerIdint64

Payer client ID

Example: 1001

payerstring

Payer name

Example: John Doe

currency object

Currency information object.

idint32

Currency ID

Example: 1

valuedouble

Exchange rate (1 for the basic currency)

Example: 1

updateTimestampint64

Last update time (epoch seconds)

Example: 1672531200

basicboolean

Whether it's the company's basic currency

Example: true

ccystring

Currency code

Example: USD

notestring

Payment note

Example: Advance payment

timestampint64

Payment time (epoch seconds)

Example: 1672531200

mortgageboolean

Whether it is a mortgage payment

Example: false

customTypeNamestring

Custom payment type name (when type is CUSTOM)

Example: PayPal

contractIdint32nullable

Contract ID (present when base is CONTRACT or SURCHARGE)

Example: 1409

bookingIdint64nullable

Booking ID (present when base is BOOKING)

Example: 512

fields object[]nullable

The payment's custom field values — see GET /v1/open-api/payment-field for the field definitions. null when the caller did not load them.

Array [

fieldIdint64

Field ID — matches PaymentFieldDTO.id

Example: 42

valuestringnullable

The resolved value as text (option name, date, URL, …)

Example: Naqd

namestringnullable

Field name

Example: To'lov kanali

typeCustomFieldType

Custom field type, shared by every custom-field family (contract, flat, payment and lead task). Serialized by name. Identical value set to ContractFieldType, which remains as the contract-family alias.

Possible values: [TEXT, EXTENDED_TEXT, DATE, SELECT, MULTI_SELECT, RADIO, TOGGLE_SWITCH, URL, TAG, LOCATION, COUNTER, ADDRESS, EMPLOYEE, FILE, NUMBER]

Example: SELECT

requiredbooleannullable

Whether the field is mandatory

Example: false

sortOrderint32nullable

Display position

Example: 1

numberdoublenullable

Numeric value — NUMBER fields only

Example: 1500000

currencyIdint32nullable

Currency of number — NUMBER fields only

Example: 24

valuesstring[]

Ordered values of a multi-value field (MULTI_SELECT, EMPLOYEE, FILE). Empty for single-value types.

Example: ["Naqd","Karta"]

latitudedoublenullable

Latitude — LOCATION fields only

Example: 41.311081

longitudedoublenullable

Longitude — LOCATION fields only

Example: 69.240562

files object[]

Attached files — FILE fields only. Empty for every other type.

Array [

absolutePathstringnullable

Presigned URL to the full-size file

Example: https://minio.uysot.uz/uysot/files/201/avatar.png?X-Amz-Expires=3600

thumbAbsolutePathstringnullable

Presigned URL to the thumbnail rendition

Example: https://minio.uysot.uz/uysot/files/201/avatar_thumb.png?X-Amz-Expires=3600

smallestAbsolutePathstringnullable

Presigned URL to the smallest rendition

Example: https://minio.uysot.uz/uysot/files/201/avatar_small.png?X-Amz-Expires=3600

]

]

PaymentDTO

{
  "id": 10001,
  "number": "PAY-2023-001",
  "amount": 5000,
  "base": "CONTRACT",
  "type": "CASH",
  "debt": "INCOME",
  "createdBy": {
    "id": 201,
    "fullName": "David Wilson"
  },
  "canceledBy": {
    "id": 201,
    "fullName": "David Wilson"
  },
  "createdTimestamp": 1672531200,
  "canceledTimestamp": 1672617600,
  "cancelNote": "Duplicate payment",
  "payerId": 1001,
  "payer": "John Doe",
  "currency": {
    "id": 1,
    "value": 1,
    "updateTimestamp": 1672531200,
    "basic": true,
    "ccy": "USD"
  },
  "note": "Advance payment",
  "timestamp": 1672531200,
  "mortgage": false,
  "customTypeName": "PayPal",
  "contractId": 1409,
  "bookingId": 512,
  "fields": [
    {
      "fieldId": 42,
      "value": "Naqd",
      "name": "To'lov kanali",
      "type": "SELECT",
      "required": false,
      "sortOrder": 1,
      "number": 1500000,
      "currencyId": 24,
      "values": [
        "Naqd",
        "Karta"
      ],
      "latitude": 41.311081,
      "longitude": 69.240562,
      "files": [
        {
          "absolutePath": "https://minio.uysot.uz/uysot/files/201/avatar.png?X-Amz-Expires=3600",
          "thumbAbsolutePath": "https://minio.uysot.uz/uysot/files/201/avatar_thumb.png?X-Amz-Expires=3600",
          "smallestAbsolutePath": "https://minio.uysot.uz/uysot/files/201/avatar_small.png?X-Amz-Expires=3600"
        }
      ]
    }
  ]
}