Skip to main content

ContractDTO

Full contract information object. Returned by GET /v1/open-api/contract/{id}.

idint32

Contract ID

Example: 5001
numberstring

Contract number

Example: CNT-2023-001
delayint32

Contract duration in months (0 if only prepayment)

Example: 12
amountdouble

Original contract price (without discount)

Example: 50000
prepaymentdouble

Initial payment (0 if only installment payment)

Example: 10000
prepaymentDatestring

Initial payment date (dd.MM.yyyy)

Example: 15.01.2023
payeddouble

Paid amount

Example: 15000
residuedouble

Remaining amount to be paid (amount − discount − payed)

Example: 35000
discountdouble

Discount amount

Example: 5000
discountDescriptionstring

Discount description

Example: New year discount
surchargedouble

Penalty

Example: 0
createdTimestampint64

Creation time (epoch seconds)

Example: 1672531200
createdBystring

Employee who created the contract

Example: Alice Johnson
cancelledTimestampint64

Cancellation time (epoch seconds)

Example: 1672617600
cancelledBystring

Employee who cancelled the contract

Example: Bob Smith
cancelTextstring

Cancellation reason

Example: Client request
deletedTimestampint64

Deletion time (epoch seconds)

Example: 1672704000
deletedBystring

Employee who deleted the contract

Example: Charlie Brown
baseIdint32

Previous contract ID if client was replaced

Example: 5000
baseNumberstring

Previous contract number if client was replaced

Example: CNT-2022-999
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
flatsinteger[]

Apartment IDs.

Example: [101,102]
flatDetails object[]

Apartments — with building and house names (same rows as flats, expanded).

  • 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 object

    House (project) the contract belongs to — taken from the first apartment in flatDetails.

    idint32

    House ID

    Example: 12
    namestringnullable

    House name

    Example: Green Valley
    payNumberstring

    Unique payment number

    Example: PAY-2023-001
    statusContractStatus

    Contract status enum.

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

    Example: ACTIVE
    commentstring

    Contract comment

    Example: Special conditions apply
    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
  • ]
    • responsibleBystring

    Responsible person full name

    Example: David Wilson
    responsibleByIdint32

    Responsible person ID

    Example: 201
    brokerstring

    Broker name

    Example: Eve Broker
    brokerIdint32

    Broker ID

    Example: 301
    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
    mortgagedouble

    Mortgage amount

    Example: 20000
    mortgagePayeddouble

    Paid mortgage amount

    Example: 5000
    mortgageDatestring

    Mortgage date (dd.MM.yyyy)

    Example: 20.01.2023
    prepaymentParts object[]

    Prepayment parts.

  • Array [
    • idint32

    ID

    Example: 1
    prepaymentdouble

    Payment amount

    Example: 5000
    prepaymentDatestring

    Payment due date (dd.MM.yyyy)

    Example: 15.02.2023
  • ]
    • monthlyPayments object[]

    Active monthly payment schedule.

  • Array [
    • amountdouble

    Scheduled amount

    Example: 2000
    datestring

    Scheduled payment date (dd.MM.yyyy)

    Example: 15.03.2023
    paymentdouble

    Paid amount toward this part

    Example: 2000
    prepaymentboolean

    Whether it's a prepayment part

    Example: false
    paidboolean

    Whether paid

    Example: true
    typeContractPaymentTypenullable

    Schedule row type.

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

    Example: MONTHLY_PAYMENT
    paidDatestringnullable

    Date the part was paid (dd.MM.yyyy)

    Example: 10.03.2023
  • ]
    • lead object

    Compact lead reference embedded in ContractDTO as the lead field. Carries only the lead identity and its current pipeline / responsible state — use GET /v1/open-api/lead/{leadId} with the id for the full lead.

    idint64

    Lead ID

    Example: 1001
    uuiduuid

    Lead UUID value

    Example: 550e8400-e29b-41d4-a716-446655440000
    namestring

    Lead name

    Example: New apartment buyer
    balancedouble

    Lead balance amount

    Example: 5000
    ccystring

    ISO code of the lead balance currency, null when the lead has no currency

    Example: UZS
    pipeStatusIdint64

    Lead pipeline status ID

    Example: 1
    responsibleByIdint32

    Responsible employee ID

    Example: 101
    responsibleBystring

    Responsible employee full name

    Example: Alice Johnson
    ContractDTO
    {
      "id": 5001,
      "number": "CNT-2023-001",
      "delay": 12,
      "amount": 50000,
      "prepayment": 10000,
      "prepaymentDate": "15.01.2023",
      "payed": 15000,
      "residue": 35000,
      "discount": 5000,
      "discountDescription": "New year discount",
      "surcharge": 0,
      "createdTimestamp": 1672531200,
      "createdBy": "Alice Johnson",
      "cancelledTimestamp": 1672617600,
      "cancelledBy": "Bob Smith",
      "cancelText": "Client request",
      "deletedTimestamp": 1672704000,
      "deletedBy": "Charlie Brown",
      "baseId": 5000,
      "baseNumber": "CNT-2022-999",
      "client": {
        "id": 1001,
        "name": "John Doe",
        "inn": "123456789",
        "status": "ACTIVE"
      },
      "flats": [
        101,
        102
      ],
      "flatDetails": [
        {
          "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"
      },
      "payNumber": "PAY-2023-001",
      "status": "ACTIVE",
      "comment": "Special conditions apply",
      "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": []
        }
      ],
      "responsibleBy": "David Wilson",
      "responsibleById": 201,
      "broker": "Eve Broker",
      "brokerId": 301,
      "currency": {
        "id": 1,
        "value": 1,
        "updateTimestamp": 1672531200,
        "basic": true,
        "ccy": "USD"
      },
      "mortgage": 20000,
      "mortgagePayed": 5000,
      "mortgageDate": "20.01.2023",
      "prepaymentParts": [
        {
          "id": 1,
          "prepayment": 5000,
          "prepaymentDate": "15.02.2023"
        }
      ],
      "monthlyPayments": [
        {
          "amount": 2000,
          "date": "15.03.2023",
          "payment": 2000,
          "prepayment": false,
          "paid": true,
          "type": "MONTHLY_PAYMENT",
          "paidDate": "10.03.2023"
        }
      ],
      "lead": {
        "id": 1001,
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "name": "New apartment buyer",
        "balance": 5000,
        "ccy": "UZS",
        "pipeStatusId": 1,
        "responsibleById": 101,
        "responsibleBy": "Alice Johnson"
      }
    }