Создание Клиента (v1)
Метод Сreate an Account позволяет создать нового Клиента. Для нового Клиента в качестве Владельца можно указать ID существующего Пользователя или создать нового. В зависимости от Типа клиента может потребоваться указать дополнительную информацию (см. Настройка дополнительных параметров в ActivePlatform. Руководство по Панели управления Оператора).
POST /api/vendor/v1/accounts.json?api_token={api_token}
Аргументы
Название | Тип параметров | Тип данных | Обязательный/Опциональный | Описание | |
---|---|---|---|---|---|
api_token | query | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике в ActivePlatform. Руководство по Панели управления Оператора) | |
account_type_id | form | integer | Обязательный | ID Типа Клиента, например, юридическое или физическое лицо (см. Создание типа клиентов) | |
primary_name | form | string | Опциональный | Основное имя Клиента (например, название организации для юридических лиц) | |
first_name | form | string | Обязательный | Имя лица, уполномоченного на заключение договора | |
middle_name | form | string | Опциональный | Отчество лица, уполномоченного на заключение договора | |
last_name | form | string | Обязательный | Фамилия лица, уполномоченного на заключение договора | |
owner_id | form | integer | Опциональный | ID существующего Сотрудника Оператора, который будет связан с данным Клиентом и получит уровень доступа Владелец в Панель управления Клиента. Указывается, если не требуется создавать нового Пользователя с уровнем доступа Владелец | |
new_owner_first_name | form | string | Опциональный | Имя нового Сотрудника Оператора с уровнем доступа Владелец, который будет создан и прикреплен к данному Клиенту. Указывается, если не задан owner_id существующего Пользователя с уровнем доступа Владелец | |
new_owner_last_name | form | string | Опциональный | Фамилия нового Сотрудника Оператора с уровнем доступа Владелец, который будет создан и прикреплен к данному Клиенту. Указывается, если не задан owner_id существующего Пользователя с уровнем доступа Владелец | |
new_owner_middle_name | form | string | Опциональный | Отчество нового Сотрудника Оператора с уровнем доступа Владелец, который будет создан и прикреплен к данному Клиенту. Указывается, если не задан owner_id существующего Пользователя с уровнем доступа Владелец | |
new_owner_email | form | string | Опциональный | Email нового Сотрудника Оператора с уровнем доступа Владелец, который будет создан и прикреплен к данному Клиенту. Указывается, если не задан owner_id существующего Пользователя с уровнем доступа Владелец | |
manager_id | form | integer | Опциональный | ID Менеджера, который будет прикреплен к данному Клиенту | |
account_class_id | form | integer | Обязательный | ID Правила обслуживания, по которому будет обслуживаться данный Клиент (см. Правила обслуживания). | |
country | form | string | Обязательный | Контакты: Код страны ISO 3166-1 alpha-2 | |
region | form | string | Обязательный | Контакты: Регион | |
city | form | string | Обязательный | Контакты: Город | |
street | form | string | Обязательный | Контакты: Улица | |
building | form | string | Обязательный | Контакты: Дом | |
office | form | string | Обязательный | Контакты: Номер офиса | |
zip | form | string | Обязательный | Контакты: Почтовый индекс | |
phone | form | string | Обязательный | Контакты: Телефон в международном формате:
| |
form | string | Обязательный | Email лица, уполномоченного на заключение договора | ||
billing_day | form | integer | Опциональный | День месяца для выставления счетов | |
custom_attributes | form | array | Опциональный | Дополнительные параметры Клиента (см. Настройка дополнительных параметров). | |
key | form | string | Зависит от Типа клиента | Ключ, который используется для обозначения параметра в API (см. Создание дополнительного параметра) | |
value | form | Зависит от атрибута | Зависит от Типа клиента | Значение дополнительного параметра |
Модель ответа
Название | Тип данных | Описание | |
---|---|---|---|
id | integer | Уникальный идентификатор Клиента | |
name | string | Имя Клиента | |
account_class_id | integer | Уникальный идентификатор Правила обслуживания Клиента (см. Правила обслуживания) | |
account_class | string | Наименование Правила обслуживания, по которому будет обслуживаться данный Клиент | |
primary_name | string | Основное название Клиента (например, название организации для юридических лиц) | |
first_name | string | Имя лица, уполномоченного на заключение договора | |
middle_name | string | Отчество лица, уполномоченного на заключение договора | |
last_name | string | Фамилия лица, уполномоченного на заключение договора | |
country | string | Контакты: Код страны ISO 3166-1 alpha-2 | |
region | string | Контакты: Область | |
city | string | Контакты: Город | |
street | string | Контакты: Улица | |
building | string | Контакты: Номер дома | |
office | string | Контакты: Номер офиса | |
zip | string | Контакты: Индекс | |
phone | string | Контакты: Телефон в международном формате:
| |
string | Адрес электронной почты | ||
status | string | Текущий статус Клиента:
| |
balance | float | Текущее состояние Баланса Клиента | |
account_type_id | integer | Уникальный идентификатор Типа клиента (см. Типы клиентов) | |
account_type | string | Наименование Типа клиента | |
default_payment_model | string | Модель оплаты по умолчанию для данного Клиента, заданная в Правиле обслуживания. Возможные значения:
| |
current_debt | float | Величина текущей задолженности по всем Подпискам Клиента с моделью оплаты Постоплата | |
financial_blocking_threshold_use_system | bool | Использование системного значения Порога срабатывания финансовой блокировки:
| |
financial_blocking_threshold | float | Величина Порога срабатывания финансовой блокировки, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента | |
subscription_credit_limit_use_system | bool | Использование системного значения Кредитного лимита по подписке:
| |
subscription_credit_limit | float | Величина Кредитного лимита по подписке, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента | |
manager_id | integer | ID Сотрудника Оператора, который будет прикреплен к данному Клиенту. | |
owner_id | integer | ID Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента | |
new_owner_first_name | string | Имя созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента | |
new_owner_last_name | string | Фамилия созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента | |
new_owner_middle_name | string | Отчество созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента | |
new_owner_email | string | Email созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента | |
tech_user_id | integer | ID Пользователя, который является техническим контактом | |
bill_user_id | integer | ID Пользователя, который является финансовым контактом | |
custom_attributes | array | Дополнительные параметры позволяют добавлять в ActivePlatform дополнительную информацию (см. Настройка дополнительных параметров) | |
name | string | Имя дополнительного параметра | |
value | Зависит от атрибута | Значение дополнительного параметра | |
created_at | date | Дата и время создания Клиента | |
updated_at | date | Дата и время последнего изменения информации о Клиенте |
Пример запроса
POST /api/vendor/v1/accounts.json?api_token=vY5fwetestK3gJXZH5uHCw
{
"account_type_id": 1,
"first_name": "Mark",
"last_name": "Doe",
"new_owner_first_name": "Backsplace",
"new_owner_last_name": "rdq",
"new_owner_email": "markn1234@activeplatform.com",
"account_class_id": 1,
"country": "BY",
"region": "Minsk",
"city": "Minsk",
"street": "Lenina",
"building": "1",
"office": "1",
"zip": "220007",
"phone": "+375290000000",
"email": "mark771234@activeplatform.com",
"custom_attributes": [
{
"key": "birth_date",
"value": "10.08.2016"
},
{
"key": "passport_date_of_issue",
"value": "01.07.2016"
},
{
"key": "passport_issued_by",
"value": "Goverment"
},
{
"key": "personal_number",
"value": "A4411111BB1122"
},
{
"key": "passport_number",
"value": "1124111111122"
}
]
}
Пример ответа
При успешном создании Клиента (статус 201) метод возвращает:
{
"id": 505,
"name": "Mark Doe",
"account_class_id": 1,
"account_class": "Default",
"primary_name": "",
"first_name": "Mark",
"middle_name": null,
"last_name": "Doe",
"country": "BY",
"region": "Minsk",
"city": "Minsk",
"street": "Lenina",
"building": "1",
"office": "1",
"zip": "220007",
"phone": "+375290000000",
"email": "mark771234@activeplatform.com",
"status": "active",
"balance": "0.0",
"account_type_id": 1,
"account_type": "Personal BLR",
"default_payment_model": "prepay",
"current_debt": 0.0,
"financial_blocking_threshold_use_system": true,
"financial_blocking_threshold": 100.0,
"subscription_credit_limit_use_system": true,
"subscription_credit_limit": 0.0,
"manager_id": null,
"owner_id": 874,
"new_owner_first_name": "Backsplace",
"new_owner_last_name": "rdq",
"new_owner_middle_name": null,
"new_owner_email": "markn1234@activeplatform.com",
"tech_user_id": 874,
"bill_user_id": 874,
"custom_attributes": [
{
"name": "Личный номер",
"value": "A4411111BB1122"
},
{
"name": "Дата рождения",
"value": "10.08.2016"
},
{
"name": "Дата выдачи",
"value": "01.07.2016"
},
{
"name": "Номер паспорта",
"value": "1124111111122"
},
{
"name": "Кем выдан",
"value": "Goverment"
},
{
"name": "Включить новый DNS",
"value": ""
},
{
"name": "Отправлять акты",
"value": ""
},
{
"name": "Tenant Name",
"value": ""
},
{
"name": "Tenant ID",
"value": ""
}
],
"created_at": "2019-10-15T13:08:36.440+03:00",
"updated_at": "2019-10-15T13:08:36.517+03:00"
}
При возникновении ошибок метод возвращает описание ошибок, например (статус 422):
{
"error": {
"location.country": [
"is not included in the list"
],
"location.phone": [
"is not in international format"
],
"custom_attributes.value": [
"can't be blank",
"is not included in the list"
],
"passport_date_of_issue": [
{
"value": [
"can't be blank",
"is not included in the list"
]
}
],
"personal_number": [
{
"value": [
"can't be blank"
]
}
],
"birth_date": [
{
"value": [
"can't be blank",
"is not included in the list"
]
}
],
"passport_number": [
{
"value": [
"can't be blank"
]
}
],
"passport_issued_by": [
{
"value": [
"can't be blank"
]
}
]
}
}