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]

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

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

]

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 [

idint32

ID

Example: 1

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

typeContractPaymentType

Schedule payment type enum.

• MONTHLY_PAYMENT — Monthly payment
• PREPAYMENT — Prepayment
• MORTGAGE — Mortgage
• REMAINING — Remaining payment

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

Example: MONTHLY_PAYMENT

paidDatestring

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

Example: 10.03.2023

]

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
  ],
  "payNumber": "PAY-2023-001",
  "status": "ACTIVE",
  "comment": "Special conditions apply",
  "fields": [
    {
      "fieldId": 1,
      "value": "VIP Client",
      "name": "Client Type",
      "required": true,
      "oldValue": "Regular Client"
    }
  ],
  "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": [
    {
      "id": 1,
      "amount": 2000,
      "date": "15.03.2023",
      "payment": 2000,
      "prepayment": false,
      "paid": true,
      "type": "MONTHLY_PAYMENT",
      "paidDate": "10.03.2023"
    }
  ]
}