Skip to main content

ContractTableDTO

Compact contract row returned by the contract filter endpoint.

idint32

Contract ID

Example: 5001
numberstring

Contract number

Example: CNT-2023-001
payNumberstring

Unique payment number

Example: PAY-2023-001
createdTimestampint64

Creation time (epoch seconds)

Example: 1672531200
statusContractStatus

Contract status enum.

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

Example: ACTIVE
responsibleBy object

Compact employee reference.

idint32

Employee ID

Example: 201
fullNamestring

Employee full name

Example: David Wilson
avatarstringnullable

Avatar URL/key (nullable)

Example: avatars/201.png
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
dealPricedouble

Deal price (amount − discount)

Example: 45000
paidAmountdouble

Paid amount

Example: 15000
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.

Example: [101,102]
signatureStatusSignatureStatus

Online contract signature status enum.

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

Example: SIGNED
fields object[]

Custom field values.

  • Array [
    • fieldIdint64

    Field ID

    Example: 1
    valuestring

    Custom field value

    Example: VIP Client
    namestring

    Custom field name

    Example: Client Type
    requiredboolean

    Whether value is mandatory

    Example: true
    oldValuestring

    Previous value (if changed)

    Example: Regular Client
  • ]
    • canceledBy object

    Compact employee reference.

    idint32

    Employee ID

    Example: 201
    fullNamestring

    Employee full name

    Example: David Wilson
    avatarstringnullable

    Avatar URL/key (nullable)

    Example: avatars/201.png
    canceledTimestampint64

    Cancellation time (epoch seconds)

    Example: 1672617600
    ContractTableDTO
    {
      "id": 5001,
      "number": "CNT-2023-001",
      "payNumber": "PAY-2023-001",
      "createdTimestamp": 1672531200,
      "status": "ACTIVE",
      "responsibleBy": {
        "id": 201,
        "fullName": "David Wilson",
        "avatar": "avatars/201.png"
      },
      "client": {
        "id": 1001,
        "name": "John Doe",
        "inn": "123456789",
        "status": "ACTIVE"
      },
      "amount": 50000,
      "prepayment": 10000,
      "discount": 5000,
      "dealPrice": 45000,
      "paidAmount": 15000,
      "currency": {
        "id": 1,
        "value": 1,
        "updateTimestamp": 1672531200,
        "basic": true,
        "ccy": "USD"
      },
      "flatIds": [
        101,
        102
      ],
      "signatureStatus": "SIGNED",
      "fields": [
        {
          "fieldId": 1,
          "value": "VIP Client",
          "name": "Client Type",
          "required": true,
          "oldValue": "Regular Client"
        }
      ],
      "canceledBy": {
        "id": 201,
        "fullName": "David Wilson",
        "avatar": "avatars/201.png"
      },
      "canceledTimestamp": 1672617600
    }