Create a new lead

POST

Creating a new customer from a lead

When creating a Client from a Lead, the core itself can determine that this is a Lead from an existing client. The kernel thinks that if the fields [Surname, First name, Patronymic, passport series, passport number] match, then this is a Lead from an existing client and the kernel will add an application to this client. Otherwise, new clients will be created.

If, when creating a lead, the parameters: ** firstName, lastName, patronymic, passport.seria, passport.no ** coincide with an existing client, then this lead will be linked to the client. There is validation within the legal framework. persons (included separately, there is no validation by default). Linking a lead to one or another legal entity. face occurs by the parameter ** managerId **.

When creating a new lead, you can send a completely filled address structure, or you can specify only three fields - country identifier ([countryId] (/documentation/page/73)), FIAS identifier (fiasId) and string addresses (fullAddressText) (including the apartment number) and all other fields will be filled in automatically. The trigger for sending a separate request to clarify the address is the filled FIAS identifier (fiasId) and address string (fullAddressText) fields. The fiasId field must correspond to the FIAS address line (fullAddressText). Correct values ​​are obtained by the method "[Retrieving FIAS address and ID by string] (/documentation/page/533)". For correct display of the address in the interface, three fields must be passed - the country identifier ([countryId] (/documentation/page/73)), the FIAS identifier (fiasId) and the address string (fullAddressText) (including the number apartments). More details with examples are described below in the addressData, registrationAddressData and addresses parameters.

The minimum information required to create a lead in the system is the "firstName", "mobilePhone" fields.

In order to determine which fields are required and must be passed in the request body (the JSON object passed in the request body), you need to look in the admin panel in the "Model Editor" category. ** It is important ** to understand that a client, an application is created from a lead and a contract can be created. Consequently, the minimum set of fields transmitted in the request body consists of the required fields of the client (individual or legal entity), application and contract. The system contains both system-required fields and mandatory fields, which can be disabled through the "Model Editor" functionality.

The minimum working example of a created lead and possibly created client objects and applications are described in the articles "[Elementary script for creating a lead] (/documentation/article/336)", "[Creating a client (physical .face) and requests from the lead automatically] (/documentation/article/337) ". A general description of working with API methods is described in the article "[Nuances ofand working with API] (/documentation/article/338) "

Request Body

application/json

object

Amount of current debt

Format"double"

Number of active loans

Format"int32"

Amount of current overdue payments

Format"double"

object

Apartment number

object

Building number

Building number

Record identifier from "Country "

Format"int64"

object

The FIAS address chain. This parameter is optional. When creating a client, you can choose not to transfer

JSON URL string

Address chain

FIAS address string

House number

Housing type

Residence Address ID

Format"int64"

District

Nearest metro station

An outdated address, for example, an old street name in a passport. Used for informational purposes only!

Postal Code

Registration date in YYYY-MM-DD format

Format"date"

Scope

Locality, street, house

Landline telephone in digital form of international format (e.g. 74951001112, 37369123456)

object[]

Apartment number

object