Перейти к основному содержимому

Управление контрагентами

Перед созданием сделки необходимо создать участников сделки.

Справка

Участниками сделки могут являться:

  • юридические лица (застройщик с представителем или застройщик в лице генерального директора)
  • физические лица (клиенты- покупатели/продавцы объекта недвижимости)

Создание контрагента​

Для создания контрагента по API необходимо предоставить все необходимые персональные данные. Детальное описание полей, необходимых для создания, можно посмотреть здесь.

Создание контрагентов — физических лиц​

Пример запроса
POST https://m2.ru/api/public/deal-api/v1/clients HTTP/1.1
Authorization: Bearer
Content-type: application/json

{
  "data": {
    "@type": "@person",
    "surname": "Назаров",
    "name": "Пётр",
    "patronymic": "Маркович",
    "gender": "MALE",
    "birthDate": "2000-02-14",
    "marriedStatus": "NOT_MARRIED",
    "placeOfBirth": "г Москва",
    "inn": "421720371300",
    "snils": "11697338589",
    "registrationAddress": "город Санкт-Петербург",
    "fallbackRegistrationAddress": "Воронеж",
    "residenceAddress": "Новокузнецк",
    "contactData": {
      "phoneNumber": "79153456789",
      "email": "test-mail@m2.ru"
    },
    "citizenship": "RUSSIA",
    "identityDocument": {
      "@type": "@russian_passport",
      "series": "1111",
      "number": "222333",
      "issuedBy": "отделением УФМС",
      "issuedDate": "2022-02-14",
      "unitCode": "100-200"
    }
  }
}
Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json

{
  "client": {
    "id": "4eed9ef8-e77a-4b2c-a47e-e6054f5b08e5",
    "createdAt": "2022-06-15T07:49:44.919489Z",
    "archivedAt": null,
    "version": {
      "id": "7b0a6167-75ff-406a-9f8d-b0552dfd0d73",
      "versionNumber": 1,
      "createdAt": "2022-06-15T07:49:44.927872Z",
      "data": {
        "@type": "@person",
        "surname": "Назаров",
        "name": "Пётр",
        "patronymic": "Маркович",
        "gender": "MALE",
        "birthDate": "2000-02-14",
        "marriedStatus": "NOT_MARRIED",
        "placeOfBirth": "г Москва",
        "inn": "421720371300",
        "snils": "11697338589",
        "registrationAddress": "город Санкт-Петербург",
        "fallbackRegistrationAddress": "Воронеж",
        "residenceAddress": "Новокузнецк",
        "contactData": {
          "phoneNumber": "79153456789",
          "email": "test-mail@m2.ru"
        },
        "citizenship": "RUSSIA",
        "identityDocument": {
          "@type": "@russian_passport",
          "series": "1111",
          "number": "222333",
          "issuedBy": "отделением УФМС",
          "issuedDate": "2022-02-14",
          "unitCode": "100200"
        },
        "registrationAddressType": "PERMANENT"
      },
      "signature": {
        "id": ""
      }
    }
  }
}

Добавление доверенного лица​

Можно проводить сделки с доверенными лицами — для участников сделки старше 14 лет. Для этого необходимо создать карточки всех участников сделки, в том числе доверенное лицо с помощью метода создания контрагентов.

Дополнительно в запросе на создание сделки: необходимо в блоке agentInfo указать информацию о доверенном лице участника сделки, а также передать документ и информацию о доверенности.

Пример тела запроса
{
  "agentInfo": {
    "client": {
      "id": "string",
      "version": 0
    },
    "letterOfAttorney": {
      "number": "string",
      "startDate": "2022-10-14",
      "endDate": "2022-10-14",
      "notaryName": "string",
      "document": {
        "fileId": "string",
        "type": "LETTER_OF_ATTORNEY",
        "originalName": "string",
        "dateOfIssue": "2022-10-14"
      }
    }
  }
}

Добавление законного представителя​

Можно проводить сделки с законными представителями. В зависимости от возраста участника сделки, допускается вариативность в типах представителей:

  • больше 18 лет — опекун или попечитель, доверенное лицо

  • от 14 до 18 лет — родитель, усыновитель, опекун, попечитель

  • до 14 лет — родитель, усыновитель, опекун

Законного представителя можно создать с помощью метода создания контрагентов. Дополнительно в запросе на создание сделки необходимо в блоке representative указать информацию о законном представителе участника сделки, а также передать документ, подтверждающий право законного представителя.

Пример тела запроса
{
  "representative": {
    "client": {
      "id": "string",
      "version": 0
    },
    "@type": "@trustee"
  }
}

Добавление контрагентов — юридических лиц​

Пример запроса
POST https://m2.ru/api/public/deal-api/v1/clients HTTP/1.1
Authorization: Bearer
Content-type: application/json

{
  "data": {
    "@type": "@company",
    "name": "ООО Ромашка",
    "legalAddress": "Москва",
    "fallbackLegalAddress": "Барнаул",
    "inn": "7736570901",
    "kpp": "773101001",
    "ogrn": "1087746066913",
    "registrationDate": "2022-02-14"
  }
}

Дополнительные методы для работы с контрагентами​

Получение информации по контрагенту​

Метод возвращает данные по уже созданному контрагенту.
При создании клиентов в рамках взаимодействия по API, в ответ приходит его ID. При встраивании данной функции в свою систему можно повторно использовать уже созданную карточку клиента, подставляя ее ID — это позволит не заполнять повторно данные по существующим клиентам.

Пример запроса
GET https://m2.ru/api/public/deal-api/v1/clients/{id} HTTP/1.1
Authorization: Bearer

Обновление контрагентов​

Метод позволяет вносить изменения в карточку уже созданных контрагентов. Например, в случае опечаток или обновления персональных данных у клиента.

ВАЖНО

Вносить изменения в карточку контрагента можно до начала выпуска ему УКЭП.

Пример запроса
PUT https://m2.ru/api/public/deal-api/v1/clients/{id} HTTP/1.1
Authorization: Bearer
Content-type: application/json

Предоставление доступа к контрагенту другой компании​

Данный метод предоставляет права на чтение и запись выбранного контрагента для учетной записи другой компании.

ВАЖНО

Для того чтобы отозвать права на чтение и запись требуется обратиться в поддержку М2.

Пример запроса
PUT https://m2.ru/api/public/deal-api/v1/clients/{id}/share HTTP/1.1
Authorization: Bearer
Content-type: application/json

{
  "partner": {
    "companyId": "string",
    "ClientCompanyType": "M2"
  }
}