ContractTableDTO

Compact contract row returned by the contract filter endpoint.

idint32

Contract ID

Example: 5001

numberstring

Contract number

Example: CNT-2023-001

payNumberstringnullable

Unique payment number

Example: PAY-2023-001

createdTimestampint64

Contract date (epoch seconds) — matches the contractTimestampFrom/To filter.

Example: 1672531200

registeredTimestampint64

Time the contract was entered into the system (epoch seconds) — matches the registeredTimestampFrom/To filter and the REGISTERED_DATE sort key. Incremental sync cursors resume from this value.

Example: 1672534800

statusContractStatus

Contract status enum.

Possible values: [STARTED, ACTIVE, CANCELLED, FINISHED, TRANSFERRED]

Example: ACTIVE

formalboolean

Formal (true) or informal (false) contract — matches the formal filter.

Example: true

responsibleBy objectnullable

Responsible employee.

idint32

Employee ID

Example: 201

fullNamestring

Employee full name

Example: David Wilson

createdBy object

Compact employee reference.

idint32

Employee ID

Example: 201

fullNamestring

Employee full name

Example: David Wilson

broker objectnullable

Broker.

idint32

Employee ID

Example: 201

fullNamestring

Employee full name

Example: David Wilson

updatedBy objectnullable

Employee who last modified the contract. No timestamp is exposed — updatedTimestamp does not exist in the source system yet.

idint32

Employee ID

Example: 201

fullNamestring

Employee full name

Example: David Wilson

client object

Company client information object.

idint64

Client ID

Example: 1001

namestring

Client name (individual or legal entity)

Example: John Doe

innstring

Client INN (individual's PINFL)

Example: 123456789

statusClientStatus

Client status enum.

Possible values: [NEW, ACTIVE, PASSIVE, ARCHIVE]

Example: ACTIVE

amountdouble

Original contract price (without discount)

Example: 50000

prepaymentdouble

Initial payment

Example: 10000

discountdouble

Discount amount

Example: 5000

discountPercentdoublenullable

Discount percentage — matches the discounted filter, amount is in discount.

Example: 1.76

dealPricedouble

Deal price (amount − discount)

Example: 45000

paidAmountdouble

Paid amount

Example: 15000

paymentStatusContractPaymentStatusnullable

Payment status (computed) — matches the paymentStatuses filter.

Possible values: [PAID, UN_PAID]

Example: PAID

paymentWaysContractPaymentWaysnullable

Payment way (computed) — matches the paymentWays filter.

Possible values: [MONTHLY_PAYMENT, PREPAYMENT, BOTH]

Example: BOTH

residuedouble

Remaining amount = amount − discount − paidAmount (computed, not a column).

Example: 35000

surchargedouble

Penalty

Example: 0

prepaymentDatestringnullable

Initial payment date (dd.MM.yyyy) — calendar day, no time part.

Example: 15.01.2023

delayint32nullable

Payment delay in days

Example: 0

mortgageAmountdoublenullable

Mortgage amount

Example: 20000

mortgagePayeddoublenullable

Paid mortgage amount

Example: 5000

mortgageDatestringnullable

Mortgage date (dd.MM.yyyy)

Example: 20.01.2023

monthlyPaymentAmountdoublenullable

Monthly payment amount

Example: 2000

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

flatIdsinteger[]

Apartment IDs — derived from flats.

Example: [101,102]

flats object[]

Contract's apartments — with building and house names.

Array [

idint32

Apartment ID

Example: 7781

numberstringnullable

Apartment number

Example: 45

roomsstringnullable

Room count

Example: 3

floorint32nullable

Floor

Example: 5

areadoublenullable

Area, m².

Example: 78.4

repairedbooleannullable

Whether the apartment is repaired

Example: true

buildingIdint32nullable

Building ID

Example: 34

buildingNamestringnullable

Building name

Example: A blok

houseIdint32nullable

House (project) ID

Example: 12

houseNamestringnullable

House (project) name

Example: Green Valley

]

house objectnullable

House (project) the contract belongs to — flats always comes from a single house.

idint32

House ID

Example: 12

namestringnullable

House name

Example: Green Valley

signatureStatusSignatureStatusnullable

Online contract signature status.

Possible values: [UNSIGNED, SIGNED_BY_CLIENT, SIGNED_BY_BUILDER, SIGNED, CANCELED]

Example: SIGNED

fields object[]

Custom field values.

Array [

fieldIdint64

Field ID

Example: 1

valuestringnullable

Custom field value (resolved per type

Example: VIP Client

namestring

Custom field name

Example: Client Type

typeContractFieldType

Contract field type enum (the CONTRACT-family slice of uysot-v2's CustomFieldType). Serialized by name.

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

Example: SELECT

requiredboolean

Whether value is mandatory

Example: true

sortOrderint32nullable

Display order

Example: 1

numberdoublenullable

Numeric value — only for type: NUMBER.

Example: 1500.5

currencyIdint32nullable

Currency ID — only for type: NUMBER.

Example: 1

valuesstring[]

Ordered list of values for multi-row types (MULTI_SELECT/EMPLOYEE/FILE). Always an array, empty when not applicable.

Example: []

latitudedoublenullable

Latitude — only for type: LOCATION.

Example: 41.311081

longitudedoublenullable

Longitude — only for type: LOCATION.

Example: 69.240562

files object[]

Attached files — only for type: FILE. Always an array, empty when not applicable.

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

]

oldValuestringdeprecated

Deprecated, no longer populated by the API — kept only because it shipped in a previous release.

Example: Regular Client

]

canceledBy objectnullable

Employee who cancelled the contract.

idint32

Employee ID

Example: 201

fullNamestring

Employee full name

Example: David Wilson

canceledTimestampint64nullable

Cancellation time (epoch seconds)

Example: 1672617600

deletedTimestampint64nullable

Deletion time (epoch seconds), or absent when not deleted. Only present when the row was returned with includeDeleted: true.

Example: 1672704000

cancelTextstringnullable

Cancellation reason — populated on CANCELLED contracts.

Example: Client request

commentstringnullable

Contract comment

Example: Special conditions apply

deletedBy objectnullable

Employee who deleted the contract — pairs with deletedTimestamp.

idint32

Employee ID

Example: 201

fullNamestring

Employee full name

Example: David Wilson

baseIdint32nullable

Base contract ID — for TRANSFERRED contracts, which contract this one came from.

Example: 5000

baseNumberstringnullable

Base contract number

Example: CNT-2022-999

ContractTableDTO

{
  "id": 5001,
  "number": "CNT-2023-001",
  "payNumber": "PAY-2023-001",
  "createdTimestamp": 1672531200,
  "registeredTimestamp": 1672534800,
  "status": "ACTIVE",
  "formal": true,
  "responsibleBy": {
    "id": 201,
    "fullName": "David Wilson"
  },
  "createdBy": {
    "id": 201,
    "fullName": "David Wilson"
  },
  "broker": {
    "id": 201,
    "fullName": "David Wilson"
  },
  "updatedBy": {
    "id": 201,
    "fullName": "David Wilson"
  },
  "client": {
    "id": 1001,
    "name": "John Doe",
    "inn": "123456789",
    "status": "ACTIVE"
  },
  "amount": 50000,
  "prepayment": 10000,
  "discount": 5000,
  "discountPercent": 1.76,
  "dealPrice": 45000,
  "paidAmount": 15000,
  "paymentStatus": "PAID",
  "paymentWays": "BOTH",
  "residue": 35000,
  "surcharge": 0,
  "prepaymentDate": "15.01.2023",
  "delay": 0,
  "mortgageAmount": 20000,
  "mortgagePayed": 5000,
  "mortgageDate": "20.01.2023",
  "monthlyPaymentAmount": 2000,
  "currency": {
    "id": 1,
    "value": 1,
    "updateTimestamp": 1672531200,
    "basic": true,
    "ccy": "USD"
  },
  "flatIds": [
    101,
    102
  ],
  "flats": [
    {
      "id": 7781,
      "number": "45",
      "rooms": "3",
      "floor": 5,
      "area": 78.4,
      "repaired": true,
      "buildingId": 34,
      "buildingName": "A blok",
      "houseId": 12,
      "houseName": "Green Valley"
    }
  ],
  "house": {
    "id": 12,
    "name": "Green Valley"
  },
  "signatureStatus": "SIGNED",
  "fields": [
    {
      "fieldId": 1,
      "value": "VIP Client",
      "name": "Client Type",
      "type": "SELECT",
      "required": true,
      "sortOrder": 1,
      "number": 1500.5,
      "currencyId": 1,
      "values": [],
      "latitude": 41.311081,
      "longitude": 69.240562,
      "files": []
    }
  ],
  "canceledBy": {
    "id": 201,
    "fullName": "David Wilson"
  },
  "canceledTimestamp": 1672617600,
  "deletedTimestamp": 1672704000,
  "cancelText": "Client request",
  "comment": "Special conditions apply",
  "deletedBy": {
    "id": 201,
    "fullName": "David Wilson"
  },
  "baseId": 5000,
  "baseNumber": "CNT-2022-999"
}