Обновление информации о Клиенте

Метод Update an Account позволяет обновить информацию о существующем Клиенте.

PUT /api/vendor/v1/accounts/{account_id}.json?api_token={api_token}

Аргументы

Название

Тип параметров

Тип данных

Обязательный/Опциональный

Описание

account_id

path

integer

ОбязательныйID Клиента
api_tokenquerystringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике в ActivePlatform. Руководство по Панели управления Оператора)
account_class_id

form

integer

Опциональный

ID Правила обслуживания Клиента

primary_name

form

string

Опциональный

Основное имя Клиента (например, название организации для юридических лиц)

first_name

form

string

Опциональный

Имя лица, уполномоченного на заключение договора

middle_name

form

string

Опциональный

Отчество лица, уполномоченного на заключение договора

last_name

form

string

Опциональный

Фамилия лица, уполномоченного на заключение договора

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

Опциональный

Контакты: Телефон в международном формате:

  • + < код страны > < код города или сети > < номер телефона >
  • 00 < код страны > < код города или сети > < номер телефона >

email

form

string

Опциональный

Email лица, уполномоченного на заключение договора

account_type_id

form

integer

Опциональный

ID Типа Клиента, например, юридическое или физическое лицо (см. Создание типа клиентов)

manager_id

form

integer

Опциональный

ID Менеджера, который будет прикреплен к данному Клиенту

financial_blocking_threshold_use_systemformboolОпциональный

Использование значения Порога срабатывания финансовой блокировки из Правила обслуживания:

  • true – используется системное значение Порога срабатывания финансовой блокировки из Правила обслуживания;
  • false – используется значение Порога срабатывания финансовой блокировки из параметра financial_blocking_threshold, переопределенное на уровне Клиента
financial_blocking_thresholdformfloatОпциональныйЗначение Порога срабатывания финансовой блокировки, переопределенное на уровне Клиента (если financial_blocking_threshold_use_system = false)
subscription_credit_limit_use_systemformboolОпциональный

Использование значения Кредитного лимита по подписке из Правила обслуживания:

  • true – используется системное значение Кредитного лимита по подписке из Правила обслуживания;
  • false – используется значение Кредитного лимита по подписке из параметра subscription_credit_limit, переопределенное на уровне Клиента
subscription_credit_limitformfloatОпциональныйЗначение Кредитного лимита по подписке, переопределенное на уровне Клиента (если subscription_credit_limit_use_system = false)
custom_attributesformarray of objectsОпциональныйДополнительные параметры Клиента (см. Настройка дополнительных параметров)

key

form

string

Зависит от Типа клиентаКлюч, который используется для обозначения параметра в API (см. Создание дополнительного параметра)

value

form

Зависит от Типа клиента
Зависит от Типа клиента

Значение Дополнительного параметра

Модель ответа

Название

Тип данных

Описание

idintegerУникальный идентификатор Клиента
namestringИмя Клиента
account_class_idintegerУникальный идентификатор Правила обслуживания Клиента (см. Правила обслуживания)
account_classstring

Наименование Правила обслуживания, по которому будет обслуживаться данный Клиент

primary_namestringОсновное название Клиента (например, название организации для юридических лиц)
first_namestringИмя лица, уполномоченного на заключение договора
middle_namestringОтчество лица, уполномоченного на заключение договора
last_namestringФамилия лица, уполномоченного на заключение договора
countrystringКонтакты: Код страны ISO 3166-1 alpha-2
regionstringКонтакты: Область
citystringКонтакты: Город
streetstringКонтакты: Улица
buildingstringКонтакты: Номер дома
officestringКонтакты: Номер офиса
zipstringКонтакты: Индекс
phonestring

Контакты: Телефон в международном формате:

  • + < код страны > < код города или сети > < номер телефона >
  • 00 < код страны > < код города или сети > < номер телефона >
emailstring

Адрес электронной почты

statusstring

Текущий статус Клиента:

balancefloatТекущее состояние Баланса Клиента
account_type_idinteger

Уникальный идентификатор Типа клиента (см. Типы клиентов)

account_typestringНаименование Типа клиента

default_payment_model

string

Модель оплаты по умолчанию для данного Клиента, заданная в Правиле обслуживания. Возможные значения:

  • prepay – Предоплата.
  • postpay – Постоплата.

current_debt

floatВеличина текущей задолженности по всем Подпискам Клиента с моделью оплаты Постоплата

financial_blocking_threshold_use_system

bool

Использование системного значения Порога срабатывания финансовой блокировки:

  • true – используется системное значение кредитного лимита из Правила обслуживания.
  • false – используется значение, переопределенное на уровне Клиента.

financial_blocking_threshold

floatВеличина Порога срабатывания финансовой блокировки, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента

subscription_credit_limit_use_system

bool

Использование системного значения Кредитного лимита по подписке:

  • true – используется системное значение кредитного лимита из Правила обслуживания.
  • false – используется значение, переопределенное на уровне Клиента.

subscription_credit_limit

floatВеличина Кредитного лимита по подписке, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента
manager_idinteger

ID Сотрудника Оператора, который будет прикреплен к данному Клиенту

owner_idinteger

ID Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента

new_owner_first_name

stringИмя созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента

new_owner_last_name

stringФамилия созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента

new_owner_middle_name

stringОтчество созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента

new_owner_email

stringEmail созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента
tech_user_idintegerID Пользователя, который является техническим контактом
bill_user_idintegerID Пользователя, который является финансовым контактом
custom_attributesarray of objects

Дополнительные параметры позволяют добавлять в ActivePlatform дополнительную информацию (см. Настройка дополнительных параметров)


namestringИмя дополнительного параметра

valueЗависит от атрибутаЗначение дополнительного параметра
created_atdateДата и время создания Клиента
updated_atdateДата и время последнего изменения информации о Клиенте

Пример запроса

PUT /api/vendor/v1/accounts/505.json?api_token=vY5fwetestK3gJXZH5uHCw
{
    "id": 550,
    "account_class_id": 1,
    "primary_name": "ACME",
    "first_name": "Marcelo",
    "middle_name": "",
    "last_name": "Ivanou",
    "country": "BY",
    "region": "5",
    "city": "Minsk",
    "street": "Lenina",
    "building": "1",
    "office": "",
    "zip": "220007",
    "phone": "+375295555555",
    "email": "test@example.com",
    "account_type_id": 1,
    "manager_id": 50,
    "financial_blocking_threshold_use_system": true,
    "subscription_credit_limit_use_system": false,
    "subscription_credit_limit": 11000,
        "custom_attributes": [
        {
            "key": "personal_number",
            "value": "A4411111BB1199"
        }
    ]
}

Пример ответа

{
    "id": 505,
    "name": "Marcelo  Ivanou",
    "account_class_id": 1,
    "account_class": "Default",
    "primary_name": "ACME",
    "first_name": "Marcelo",
    "middle_name": "",
    "last_name": "Ivanou",
    "country": "BY",
    "region": "5",
    "city": "Minsk",
    "street": "Lenina",
    "building": "1",
    "office": "",
    "zip": "220007",
    "phone": "+375295555555",
    "email": "test@example.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": false,
    "subscription_credit_limit": 11000.0,
    "manager_id": 50,
    "owner_id": 874,
    "new_owner_first_name": null,
    "new_owner_last_name": null,
    "new_owner_middle_name": null,
    "new_owner_email": null,
    "tech_user_id": 874,
    "bill_user_id": 874,
        "custom_attributes": [
        {
            "key": "personal_number",
            "value": "A4411111BB1199"
        }
    ],
    "created_at": "2019-10-15T13:08:36.440+03:00",
    "updated_at": "2019-10-18T15:52:57.884+03:00"
}