Создание нового лида

POST

Создание нового клиента из лида

При создании Клиента из Лида, ядро само может определить, что это Лид от уже существующего клиента. Ядро считает, что если совпали поля [Фамилия, Имя, Отчество, серия паспорта, номер паспорта] - то это Лид от существующего клиента и ядро добавит заявку к этому клиенту. В противном случае - будет создан новые клиент.

Если при создании лида параметры: firstName, lastName, patronymic, passport.seria, passport.no будут совпадать с уже существующим клиентом, то в этом случае произойдет привязка этого лида к клиенту. Есть валидация в рамках юр. лиц (включается отдельно, по умолчанию валидации нет). Привязка лида к тому или иному юр. лицу происходит по параметру managerId.

При создании нового лида можно передавать полностью заполненную структуру адреса, или можно указать только три поля - идентификатор страны (countryId), идентификатор ФИАС (fiasId) и строка адреса (fullAddressText) (включая номер квартиры) и все остальные поля будут заполнены автоматически. Триггером для отправки отдельного запроса по уточнению адреса является заполненные поля идентификатор ФИАС (fiasId) и строка адреса (fullAddressText). Поле fiasId должно соответствовать строке адреса ФИАС (fullAddressText). Корректные значения получаются методом "Получение адреса и ID ФИАС по строке". Для правильного отображения в интерфейсе адреса необходимо передавать три поля - идентификатор страны (countryId), идентификатор ФИАС (fiasId) и строка адреса (fullAddressText) (включая номер квартиры). Подробнее с примерами описано ниже в параметрах addressData, registrationAddressData и addresses.

Минимально необходимой информацией для создания лида в системе, являются поля "firstName", "mobilePhone".

Для того чтобы определить, какие поля являются обязательными и их нужно обязательно (required) передавать в теле запроса (JSON-объект передаваемый в теле запроса), нужно посмотреть в панели администратора в категории "Редактор моделей". Важно понимать то, что из лида создается клиент, заявка и может быть создан контракт. Следовательно минимальный набор передаваемых в теле запроса полей складывается из обязательных полей клиента (физ. или юр. лица), заявки и контракта. В системе присутствуют как системно-обязательные поля, так и обязательные поля, обязательность которых можно отключить через функционал "Редактор моделей".

Минимальный работающий пример созданного лида и возможно созданные из него объекты клиента и заявки описаны в статьях"Элементарный сценарий по созданию лида", "Создание клиента (физ.лицо) и заявки из лида автоматом". Общее описание работы с методами API описаны в статье "Нюансы при работе с API"

Request Body

application/json

object

Сумма текущей задолженности

Format"double"

Количество активных кредитов

Format"int32"

Сумма текущих просроченных платежей

Format"double"

object

Номер квартиры

object

Номер корпуса

Номер строения

Идентификатор страны

Format"int64"

object

Цепочка адреса ФИАС

Цепочка адреса в формате JSON

Код ФИАС

Строка адреса ФИАС

Номер дома

Тип жилья

Идентификатор адреса

Format"int64"

Название населённого пункта

Ближайшая станция метро

Неактуальный адрес (например, старое название улицы в паспорте)

Почтовый индекс

Дата регистрации (YYYY-MM-DD)

Format"date"

Название региона

Название улицы

Стационарный телефон в цифровом виде международного формата (напр. 74951001112, 37369123456)

object[]

Номер квартиры

object