Account — обслуживание абонентов (для обслуживающей организации)

Методы группы Account внешнего программного интерфейса Менеджера сервиса предназначены для обслуживания абонентов

Сводка по методам

МетодНазначение
account/attached_info_for_subscribingДополнительные сведения абонента, нужные для оформления платной подписки
account/confirm_sso_keyПодтвердить получение и активировать ключ SSO авторизации пользователей абонентов
account/truncate_sso_keyУдалить все ключи SSO авторизации, кроме актуального
account/update_sso_keyОтправить запрос на обновление ключа SSO авторизации
account/customer_subscriptions/createСоздать новую подписку обслуживаемого абонента
account/customer_subscriptions/create_enhancedСоздать новую подписку обслуживаемого абонента на расширение тарифа
account/customer_subscriptions/extendСоздать расширяющую подписку обслуживаемого абонента
account/customer_subscriptions/infoИнформация о подписке обслуживаемого абонента
account/customer_subscriptions/listCписок подписок обслуживаемых абонентов
account/customer_subscriptions/prolongСоздать продлевающую подписку обслуживаемого абонента
account/customer_subscriptions/renewВозобновить подписку обслуживаемого абонента с другим сроком действия
account/customer_subscriptions/set_servant_tariffУстановить тариф обслуживающей организации в существующей подписке
account/customers/attached_infoЗначения дополнительных реквизитов и сведений обслуживаемого абонента
account/customers/fill_by_public_idЗаполнение сведений абонента по публичному идентификатору
account/customers/infoСвойства и контактные данные обслуживаемого абонента
account/customers/listCписок обслуживаемых абонентов
account/customers/update_attached_infoОбновить дополнительные реквизиты и сведения обслуживаемого абонента
account/site/listCписок сайтов обслуживающей организации для внешней регистрации

account/attached_info_for_subscribing

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

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код абонента1010
Ответ
errorsБулевоПризнак наличия ошибок заполненияfalse
propertiesСписок (0..*)Дополнительные сведения
  - keyСтрока переменная (100)Имя свойстваТариф
  - name *Строка переменная (75)Заголовок свойстваТариф
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение свойстваБазовый
  - typeСтрока (перечисление)Тип свойства:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
additional_value
  - required *БулевоЗаполнять обязательноtrue
  - tooltip *Строка неограниченной длиныПодсказкаТекст подсказки.
  - error *БулевоПризнак ошибкиfalse
  - message *Строка неограниченной длиныОписание ошибки
fieldsСписок (0..*)Дополнительные реквизиты
  - keyСтрока переменная (100)Имя реквизитаИНН
  - name *Строка переменная (75)Заголовок реквизитаИНН
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение реквизита7799555550
  - typeСтрока (перечисление)Тип реквизита:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
string
  - required *БулевоЗаполнять обязательноtrue
  - tooltip *Строка неограниченной длиныПодсказкаТекст подсказки.
  - error *БулевоПризнак ошибкиfalse
  - message *Строка неограниченной длиныОписание ошибки
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/attached_info_for_subscribing
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1010,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "errors": false,
  "properties": [
    {
      "key": "Тариф",
      "name": "Тариф",
      "value": "Базовый",
      "type": "additional_value",
      "required": true,
      "tooltip": "Текст подсказки.",
      "error": false,
      "message": ""
    }
  ],
  "fields": [
    {
      "key": "ИНН",
      "name": "ИНН",
      "value": "7799555550",
      "type": "string",
      "required": true,
      "tooltip": "Текст подсказки.",
      "error": false,
      "message": ""
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/confirm_sso_key

Подтвердить получение и активировать ключ SSO авторизации пользователей абонентов

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код обслуживающей организации1000
key_idУникальный идентификаторИдентификатор ключа SSO авторизацииabf7c2a7-1df7-4646-9327-2866804b6ce2
Ответ
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/confirm_sso_key
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1000,
  "key_id": "abf7c2a7-1df7-4646-9327-2866804b6ce2",
  "auth": {
    "account": 1000
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/truncate_sso_key

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

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код обслуживающей организации1000
actual_key_idУникальный идентификаторИдентификатор актуального ключа SSO авторизацииabf7c2a7-1df7-4646-9327-2866804b6ce2
Ответ: account (0..*)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/truncate_sso_key
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1000,
  "actual_key_id": "abf7c2a7-1df7-4646-9327-2866804b6ce2",
  "auth": {
    "account": 1000
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/update_sso_key

Отправить запрос на обновление ключа SSO авторизации

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код обслуживающей организации1000
key_idУникальный идентификаторИдентификатор ключа SSO авторизацииabf7c2a7-1df7-4646-9327-2866804b6ce3
max_ageЧисло (+7.0)Срок жизни ключа SSO авторизации1800
Ответ: key_id (1)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/update_sso_key
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1000,
  "key_id": "abf7c2a7-1df7-4646-9327-2866804b6ce3",
  "max_age": 1800,
  "auth": {
    "account": 1000
  }
}
Пример ответа  Развернуть
{
  "key_id": "abf7c2a7-1df7-4646-9327-2866804b6ce3",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/customer_subscriptions/create

Создать новую подписку обслуживаемого абонента

ПараметрТипОписаниеПример
Запрос
servantЧисло (+12.0)Код ведущего абонента1000
accountЧисло (+12.0)Код обслуживаемого абонента1010
startДата и время в строке формата ISOНачало действия19.09.2024 0:00:00
completion *Дата и время в строке формата ISOЗавершение действия18.09.2025 23:59:59
servant_tariff *Строка переменная (9)Код тарифа обслуживающей организацииSERV00001
tariff *Строка переменная (9)Код тарифа - обязательно, если не указан servant_tariff (Код тарифа обслуживающей организации)PROV00001
period *Строка переменная (10)Код периода действия1YR
accept_intersections *БулевоДопустимо наличие пересечений по периоду действия с имеющимися подписками на тот же тарифtrue
Ответ
id *Строка переменная (9)Номер созданной подписки000000002
completion *Дата и время в строке формата ISOЗавершение действия18.09.2025 23:59:59
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/customer_subscriptions/create
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "servant": 1000,
  "account": 1010,
  "start": "2024-09-19T00:00:00",
  "completion": "2025-09-18T23:59:59",
  "servant_tariff": "SERV00001",
  "tariff": "PROV00001",
  "period": "1YR",
  "accept_intersections": true,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "id": "000000002",
  "completion": "2025-09-18T23:59:59",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/customer_subscriptions/create_enhanced

Создать новую подписку обслуживаемого абонента на расширение тарифа

ПараметрТипОписаниеПример
Запрос
servantЧисло (+12.0)Код ведущего абонента1000
accountЧисло (+12.0)Код обслуживаемого абонента1010
start *Дата и время в строке формата ISOНачало действия19.09.2024 0:00:00
completion *Дата и время в строке формата ISOЗавершение действия18.09.2025 23:59:59
period *Строка переменная (10)Код периода действия1YR
tariffСтрока переменная (9)Код расширяющего тарифа000000002
servant_tariff *Строка переменная (9)Код тарифа обслуживающей организацииSERV00001
parentСтрока переменная (9)Номер основной подписки000000001
amount *Число (+3.0)Количество создаваемых подписок1
Ответ
subscriptionСписок (0..*)Список номеров созданных подписок["000000002"]
subscription_infoСписок (0..*)Список завершений созданных подписок
  - idСтрока переменная (9)Номер созданной подписки000000002
  - completionДата и время в строке формата ISOЗавершение действия18.09.2025 23:59:59
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/customer_subscriptions/create_enhanced
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "servant": 1000,
  "account": 1010,
  "start": "2024-09-19T00:00:00",
  "completion": "2025-09-18T23:59:59",
  "period": "1YR",
  "tariff": "000000002",
  "servant_tariff": "SERV00001",
  "parent": "000000001",
  "amount": 1,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "subscription": [
    "000000002"
  ],
  "subscription_info": [
    {
      "id": "000000002",
      "completion": "2025-09-18T23:59:59"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/customer_subscriptions/extend

Создать расширяющую подписку обслуживаемого абонента

ПараметрТипОписаниеПример
Запрос
servantЧисло (+12.0)Код ведущего абонента1000
accountЧисло (+12.0)Код обслуживаемого абонента1010
idСтрока переменная (9)Номер основной подписки000000001
Ответ: id (1)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/customer_subscriptions/extend
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "servant": 1000,
  "account": 1010,
  "id": "000000001",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "id": "000000002",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/customer_subscriptions/info

Информация о подписке обслуживаемого абонента

ПараметрТипОписаниеПример
Запрос
servant *Число (+12.0)Код ведущего абонента1000
account *Число (+12.0)Код обслуживаемого абонента1010
idСтрока переменная (9)Номер подписки000000001
Ответ: subscription (1)
idСтрока переменная (9)Номер подписки000000001
createdДата и время в строке формата ISOДата оформления подписки28.02.2019 10:00:00
updated *Дата и время в строке формата ISOДата изменения подписки28.02.2019 10:00:00
startДата и время в строке формата ISOНачало действия19.09.2024 0:00:00
completionДата и время в строке формата ISOЗавершение действия18.09.2025 23:59:59
accountЧисло (+12.0)Код обслуживаемого абонента1010
servantЧисло (+12.0)Код ведущего абонента1000
servant_tariff *Строка переменная (9)Код тарифа обслуживающей организацииSERV00001
tariffСтрока переменная (9)Код тарифаPROV00001
period *Строка переменная (10)Код периода действия1YR
parent *Строка переменная (9)Номер основной подписки
typeСтрока (перечисление)Тип подписки:
  • basic (Основная)
  • extending (Расширяющая)
  • prolonging (Продлевающая)
basic
amountЧисло (+10.0)Количество1
bill *Строка переменная (9)Номер счета на оплату000000001
bill_id *Строка переменная (36)Идентификатор счета на оплату00000000-0000-0000-0000-000000000000
servicesСписок (0..*)Услуги
  - idСтрока переменная (9)Код услуги000000001
  - nameСтрока переменная (100)Наименование услугиКоличество прав пользователей на запуск приложений
  - service_idСтрока переменная (50)Идентификатор услугиКоличествоПравПользователейНаЗапускПриложений
  - provider_nameСтрока переменная (150)Наименование поставщика услугиМенеджер сервиса
  - provider_idСтрока переменная (50)Идентификатор поставщика услугиsm
  - description *Строка неограниченной длиныОписание
  - typeСтрока (перечисление)Тип услуги:
  • limited (Лимитированная)
  • unique (Уникальная)
  • unlimited (Безлимитная)
limited
  - activation_status *Строка (перечисление)Состояние активации:
  • activated (Активирована)
  • error (Ошибка при активации)
  • in_process (В процессе активации)
activated
  - amountЧисло (+10.0)Количество лицензий1
  - start_date *Дата и время в строке формата ISOДата подключения01.01.2020 0:00:00
  - end_date *Дата и время в строке формата ISOДата отключения28.02.2020 0:00:00
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/customer_subscriptions/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "servant": 1000,
  "account": 1010,
  "id": "000000001",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "subscription": {
    "id": "000000001",
    "created": "2019-02-28T10:00:00",
    "updated": "2019-02-28T10:00:00",
    "start": "2024-09-19T00:00:00",
    "completion": "2025-09-18T23:59:59",
    "account": 1010,
    "servant": 1000,
    "servant_tariff": "SERV00001",
    "tariff": "PROV00001",
    "period": "1YR",
    "parent": "",
    "type": "basic",
    "amount": 1,
    "bill": "000000001",
    "bill_id": "00000000-0000-0000-0000-000000000000",
    "services": [
      {
        "id": "000000001",
        "name": "Количество прав пользователей на запуск приложений",
        "service_id": "КоличествоПравПользователейНаЗапускПриложений",
        "provider_name": "Менеджер сервиса",
        "provider_id": "sm",
        "description": "",
        "type": "limited",
        "activation_status": "activated",
        "amount": 1,
        "start_date": "2020-01-01T00:00:00",
        "end_date": "2020-02-28T00:00:00"
      }
    ]
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/customer_subscriptions/list

Cписок подписок обслуживаемых абонентов

ПараметрТипОписаниеПример
Запрос
scope *Массив из Строка (перечисление)Параметры получения данных:
  • services (Включать услуги)
["services"]
servantЧисло (+12.0)Код ведущего абонента1000
account *Число (+12.0)Код обслуживаемого абонента1010
active *БулевоПолучение только активных подписокtrue
basic *БулевоПолучение только основных подписокfalse
start_date *Дата и время в строке формата ISOДата создания подписки. Начальная, для отбора по периоду01.01.2020 0:00:00
end_date *Дата и время в строке формата ISOДата создания подписки. Конечная, для отбора по периоду28.02.2020 0:00:00
Ответ: subscription (0..*)
idСтрока переменная (9)Номер подписки000000001
createdДата и время в строке формата ISOДата оформления подписки28.02.2019 10:00:00
updated *Дата и время в строке формата ISOДата изменения подписки28.02.2019 10:00:00
startДата и время в строке формата ISOНачало действия19.09.2024 0:00:00
completionДата и время в строке формата ISOЗавершение действия18.09.2025 23:59:59
accountЧисло (+12.0)Код обслуживаемого абонента1010
servantЧисло (+12.0)Код ведущего абонента1000
servant_tariff *Строка переменная (9)Код тарифа обслуживающей организацииSERV00001
tariffСтрока переменная (9)Код тарифаPROV00001
period *Строка переменная (10)Код периода действия1YR
parent *Строка переменная (9)Номер основной подписки
typeСтрока (перечисление)Тип подписки:
  • basic (Основная)
  • extending (Расширяющая)
  • prolonging (Продлевающая)
basic
amountЧисло (+10.0)Количество1
bill *Строка переменная (9)Номер счета на оплату000000001
bill_id *Строка переменная (36)Идентификатор счета на оплату00000000-0000-0000-0000-000000000000
servicesСписок (0..*)Услуги
  - idСтрока переменная (9)Код услуги000000001
  - nameСтрока переменная (100)Наименование услугиКоличество прав пользователей на запуск приложений
  - service_idСтрока переменная (50)Идентификатор услугиКоличествоПравПользователейНаЗапускПриложений
  - provider_nameСтрока переменная (150)Наименование поставщика услугиМенеджер сервиса
  - provider_idСтрока переменная (50)Идентификатор поставщика услугиsm
  - description *Строка неограниченной длиныОписание
  - typeСтрока (перечисление)Тип услуги:
  • limited (Лимитированная)
  • unique (Уникальная)
  • unlimited (Безлимитная)
limited
  - activation_status *Строка (перечисление)Состояние активации:
  • activated (Активирована)
  • error (Ошибка при активации)
  • in_process (В процессе активации)
activated
  - amountЧисло (+10.0)Количество лицензий1
  - start_date *Дата и время в строке формата ISOДата подключения01.01.2020 0:00:00
  - end_date *Дата и время в строке формата ISOДата отключения28.02.2020 0:00:00
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/customer_subscriptions/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "servant": 1000,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "subscription": [
    {
      "id": "000000001",
      "created": "2019-02-28T10:00:00",
      "updated": "2019-02-28T10:00:00",
      "start": "2024-09-19T00:00:00",
      "completion": "2025-09-18T23:59:59",
      "account": 1010,
      "servant": 1000,
      "servant_tariff": "SERV00001",
      "tariff": "PROV00001",
      "period": "1YR",
      "parent": "",
      "type": "basic",
      "amount": 1,
      "bill": "000000001",
      "bill_id": "00000000-0000-0000-0000-000000000000",
      "services": [
        {
          "id": "000000001",
          "name": "Количество прав пользователей на запуск приложений",
          "service_id": "КоличествоПравПользователейНаЗапускПриложений",
          "provider_name": "Менеджер сервиса",
          "provider_id": "sm",
          "description": "",
          "type": "limited",
          "activation_status": "activated",
          "amount": 1,
          "start_date": "2020-01-01T00:00:00",
          "end_date": "2020-02-28T00:00:00"
        }
      ]
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/customer_subscriptions/prolong

Создать продлевающую подписку обслуживаемого абонента

ПараметрТипОписаниеПример
Запрос
servantЧисло (+12.0)Код ведущего абонента1000
accountЧисло (+12.0)Код обслуживаемого абонента1010
idСтрока переменная (9)Номер основной подписки000000001
Ответ: id (1)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/customer_subscriptions/prolong
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "servant": 1000,
  "account": 1010,
  "id": "000000001",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "id": "000000002",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/customer_subscriptions/renew

Возобновить подписку обслуживаемого абонента с другим сроком действия

ПараметрТипОписаниеПример
Запрос
servantЧисло (+12.0)Код ведущего абонента1000
accountЧисло (+12.0)Код обслуживаемого абонента1010
start *Дата и время в строке формата ISOНачало действия19.09.2024 0:00:00
completion *Дата и время в строке формата ISOЗавершение действия18.09.2025 23:59:59
idСтрока переменная (9)Номер основной подписки000000001
period *Строка переменная (10)Код периода действия1YR
accept_intersections *БулевоДопустимо наличие пересечений по периоду действия с имеющимися подписками на тот же тарифtrue
Ответ
id *Строка переменная (9)Номер созданной подписки000000002
completion *Дата и время в строке формата ISOЗавершение действия18.09.2025 23:59:59
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/customer_subscriptions/renew
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "servant": 1000,
  "account": 1010,
  "start": "2024-09-19T00:00:00",
  "completion": "2025-09-18T23:59:59",
  "id": "000000001",
  "period": "1YR",
  "accept_intersections": true,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "id": "000000002",
  "completion": "2025-09-18T23:59:59",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/customer_subscriptions/set_servant_tariff

Установить тариф обслуживающей организации в существующей подписке

ПараметрТипОписаниеПример
Запрос
servantЧисло (+12.0)Код ведущего абонента1000
accountЧисло (+12.0)Код обслуживаемого абонента1010
idСтрока переменная (9)Номер подписки000000001
servant_tariffСтрока переменная (9)Код тарифа обслуживающей организацииSERV00001
Ответ
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/customer_subscriptions/set_servant_tariff
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "servant": 1000,
  "account": 1010,
  "id": "000000001",
  "servant_tariff": "SERV00001",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/customers/attached_info

Значения дополнительных реквизитов и сведений обслуживаемого абонента

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код ведущего абонента1000
accountЧисло (+12.0)Код обслуживаемого абонента1010
Ответ
public_id *Строка переменная (36)Публичный идентификатор7713754211
propertiesСписок (0..*)Дополнительные сведения
  - keyСтрока переменная (100)Имя свойстваТариф
  - name *Строка переменная (75)Заголовок свойстваТариф
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение свойстваБазовый
  - typeСтрока (перечисление)Тип свойства:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
additional_value
fieldsСписок (0..*)Дополнительные реквизиты
  - keyСтрока переменная (100)Имя реквизитаИНН
  - name *Строка переменная (75)Заголовок реквизитаИНН
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение реквизита7799555550
  - typeСтрока (перечисление)Тип реквизита:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
string
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/customers/attached_info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1000,
  "account": 1010,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "public_id": "7713754211",
  "properties": [
    {
      "key": "Тариф",
      "name": "Тариф",
      "value": "Базовый",
      "type": "additional_value"
    }
  ],
  "fields": [
    {
      "key": "ИНН",
      "name": "ИНН",
      "value": "7799555550",
      "type": "string"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/customers/fill_by_public_id

Заполнение сведений абонента по публичному идентификатору

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код ведущего абонента1000
accountЧисло (+12.0)Код обслуживаемого абонента1010
public_idСтрока переменная (36)Публичный идентификатор7713754211
Ответ
public_idСтрока переменная (36)Публичный идентификатор7713754211
propertiesСписок (0..*)Дополнительные сведения
  - keyСтрока переменная (100)Имя свойстваТариф
  - name *Строка переменная (75)Заголовок свойстваТариф
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение свойстваБазовый
  - typeСтрока (перечисление)Тип свойства:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
additional_value
fieldsСписок (0..*)Дополнительные реквизиты
  - keyСтрока переменная (100)Имя реквизитаИНН
  - name *Строка переменная (75)Заголовок реквизитаИНН
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение реквизита7799555550
  - typeСтрока (перечисление)Тип реквизита:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
string
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/customers/fill_by_public_id
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1000,
  "account": 1010,
  "public_id": "7713754211",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "public_id": "7713754211",
  "properties": [
    {
      "key": "Тариф",
      "name": "Тариф",
      "value": "Базовый",
      "type": "additional_value"
    }
  ],
  "fields": [
    {
      "key": "ИНН",
      "name": "ИНН",
      "value": "7799555550",
      "type": "string"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/customers/info

Свойства и контактные данные обслуживаемого абонента

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код ведущего абонента1000
accountЧисло (+12.0)Код обслуживаемого абонента1010
Ответ: customer (1)
name *Строка переменная (64)Наименование абонентаКонфетпром
idЧисло (+12.0)Код абонента1010
city *Строка переменная (500)ГородМосква
site *Строка переменная (500)Сайтwww.example.com
email *Строка переменная (500)Почтаabramov@example.com
phone *Строка переменная (500)Телефон+7 (495) 123-45-67
site_id *Число (+9.0)Идентификатор сайта123
invitation_id *Строка переменная (9)Номер приглашения для регистрации000000123
comment *Строка переменная (255)КомментарийПример комментария
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/customers/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1000,
  "account": 1010,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "customer": {
    "name": "Конфетпром",
    "id": 1010,
    "city": "Москва",
    "site": "www.example.com",
    "email": "abramov@example.com",
    "phone": "+7 (495) 123-45-67",
    "site_id": 123,
    "invitation_id": "000000123",
    "comment": "Пример комментария"
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/customers/list

Cписок обслуживаемых абонентов

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код ведущего абонента1000
Ответ: customer (0..*)
idЧисло (+12.0)Код абонента1010
nameСтрока переменная (64)Наименование абонентаКонфетпром
public_id *Строка переменная (36)Публичный идентификатор123
email *Строка переменная (500)Адрес электронной почтыinfo@example.com
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/customers/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1000,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "customer": [
    {
      "id": 1010,
      "name": "Конфетпром",
      "public_id": "123",
      "email": "info@example.com"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/customers/update_attached_info

Обновить дополнительные реквизиты и сведения обслуживаемого абонента

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код ведущего абонента1000
accountЧисло (+12.0)Код обслуживаемого абонента1010
public_id *Строка переменная (36)Публичный идентификатор7713754211
properties *
Дополнительные сведения
  - keyСтрока переменная (100)Имя свойстваТариф
  - name *Строка переменная (75)Заголовок свойстваТариф
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение свойстваБазовый
  - type *Строка (перечисление)Тип свойства:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
additional_value
fields *
Дополнительные реквизиты
  - keyСтрока переменная (100)Имя реквизитаИНН
  - name *Строка переменная (75)Заголовок реквизитаИНН
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение реквизита7799555550
  - type *Строка (перечисление)Тип реквизита:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
string
Ответ: customer (0..*)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/customers/update_attached_info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1000,
  "account": 1010,
  "public_id": "7713754211",
  "properties": [
    {
      "key": "Тариф",
      "name": "Тариф",
      "value": "Базовый",
      "type": "additional_value"
    }
  ],
  "fields": [
    {
      "key": "ИНН",
      "name": "ИНН",
      "value": "7799555550",
      "type": "string"
    }
  ],
  "auth": {
    "account": 1000
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/site/list

Cписок сайтов обслуживающей организации для внешней регистрации

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код обслуживающей организации1000
Ответ: sites (0..*)
site_idЧисло (+9.0)Код страницы внешней регистрации123
nameСтрока переменная (64)Наименование страницы внешней регистрации1С_ОбслуживающаяОрганизация
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/site/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1000,
  "auth": {
    "account": 1000
  }
}
Пример ответа  Развернуть
{
  "sites": [
    {
      "site_id": 123,
      "name": "1С_ОбслуживающаяОрганизация"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх