Добавление нового Клиента

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

code

string

required

Уникальный код клиента, содержащий только буквы и цифры

Match pattern:

^[A-Z0-9]+

firstname

string

required

Имя клиента

surname

string

required

Фамилия клиента

middlename

string

optional

Отчество клиента

birthdate

string <date>

optional

Дата рождения клиента

phone

string | null

optional

Контактный телефон

string <email> | null

optional

Электронный почтовый ящик

additionalPhone

string | null

optional

Добавочный телефон

company

string

required

Название компании

companyUrl

string <uri>

optional

Адрес сайта компании

comment

string

optional

Комментарий

isSeason

boolean

optional

Сезонный клиент

Default:

false

isManagement

boolean

optional

Ведение клиента

Default:

false

isBonus

boolean

optional

Индивидуальный бонус

Default:

false

bonus

number <float>

optional

Бонус %

irs

boolean

optional

Индивидуальная система вознаграждения

serviceAssigned

array [object {2}]

optional

service

string <iri-reference>

optional

Example:

/services/1

assigned

string <iri-reference>

optional

Example:

/users/1

leads

array[string <iri-reference>]

optional

payers

array[string <iri-reference>]

required

recipients

array[string <iri-reference>]

required

partner

string <iri-reference>

optional

Example:

/partners/1

isCuratorships

boolean

optional

Кураторство

Default:

false

percentCuratorships

number <float>

optional

% за кураторство

Example

{
    "code": "string",
    "firstname": "string",
    "surname": "string",
    "middlename": "string",
    "birthdate": "2019-08-24",
    "phone": "string",
    "email": "user@example.com",
    "additionalPhone": "string",
    "company": "string",
    "companyUrl": "http://example.com",
    "comment": "string",
    "isSeason": false,
    "isManagement": false,
    "isBonus": false,
    "bonus": 0,
    "irs": true,
    "serviceAssigned": [
        {
            "service": "/services/1",
            "assigned": "/users/1"
        }
    ],
    "leads": [
        "/leads/1"
    ],
    "payers": [
        "/payers/1"
    ],
    "recipients": [
        "/recipients/1"
    ],
    "partner": "/partners/1",
    "isCuratorships": false,
    "percentCuratorships": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Body

allOf {2}

optional

object (BaseFieldsModel)

optional

deletedAt

string <date-time> | null

required

integer

required

>= 1

object

optional

code

string

required

Уникальный код клиента, содержащий только буквы и цифры

Match pattern:

^[A-Z0-9]+

firstname

string

required

Имя клиента

surname

string

required

Фамилия клиента

middlename

string

optional

Отчество клиента

birthdate

string <date>

optional

Дата рождения клиента

company

string

required

Название компании

companyUrl

string <uri>

optional

Адрес сайта компании

comment

string

optional

Комментарий

serviceAssigned

array [object {2}]

optional

Идентификаторы услуг и идентификаторы ответственых.

isSeason

boolean

optional

Сезонный клиент

isManagement

boolean

optional

Ведение клиента

isBonus

boolean

optional

Индивидуальный бонус

bonus

number <float>

optional

Бонус %

payers

array[object (Плательщики) {28}]

optional

recipients

array[object (Получатели) {20}]

optional

leads

array[object (Лиды) {19}]

optional

lastTodo

allOf {2}

optional

Крайнее дело

phone

string | null

optional

Контактный телефон

string <email> | null

optional

Электронный почтовый ящик

additionalPhone

string | null

optional

Добавочный номер

irs

boolean

optional

Индивидуальная система вознаграждения

partner

object (Партнер)

optional

isCuratorships

boolean

optional

Кураторство

Default:

false

percentCuratorships

number <float>

optional

% за кураторство

Example

🟠400Ошибки 4XX

🔴500Ошибки 5XX