Режим фокусировки

Тарифные планы (pricelist)

pricelist

Результат: список элементов

Тарифные планы

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор тарифного плана.
nameСтроканетНаименование тарифного плана.
employee_nameСтроканетВнутреннее имя (наименование для сотрудников).
itemtype_nameСтроканетТип услуги, к которому относится тарифный план.
projectПоложительное целое числонетПровайдер тарифного плана.
statusСтрока (перечисление)нетДополнительная информация по тарифному плану.
proratadayПоложительное целое числонетКалендарное списание средств. Переходный день.
noteСтроканетСлужебные заметки к тарифу для сотрудников.
accessnameСтроканетГруппы доступа, которым разрешён или запрещён заказ тарифа.
processingmodulesСтроканетОбработчики, подключённые к тарифному плану.
orderpriorityПоложительное целое числонетПриоритет тарифа при сортировке (по возрастанию).
pricelist_costСтроканетБазовая стоимость периодов заказа тарифного плана.

Создать тарифный план

Функция: pricelist.add

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → кнопка Создать.

Параметры создания совпадают с параметрами функции pricelist.edit.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
nameСтрокадаНаименование создаваемого тарифного плана.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Редактировать тарифный план

Функция: pricelist.edit

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Изменить.

Позволяет просмотреть, изменить или создать объект.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаУникальный идентификатор редактируемого тарифного плана.
nameСтроканетНаименование тарифного плана.
employee_nameСтроканетВнутреннее имя для сотрудников.
intnameСтроканетВнутреннее служебное имя. Используется для получения значений по умолчанию из обработчика.
projectПоложительное целое числонетПровайдер тарифного плана.
processingmoduleПоложительное целое числонетОбработчик услуг, подключённый к тарифному плану.
billdailyФлагнетЕжедневное списание. При включении оплата снимается ежедневно пропорционально стоимости дня.
billhourlyФлагнетПочасовое списание. Клиент получает права на запуск и остановку услуг.
billprorataФлагнетКалендарное списание средств. Выравнивает срок действия услуги по календарному месяцу.
proratadayПоложительное целое числонетПереходный день для календарного списания средств.
autocalcdayФлагнетАвтоматический расчёт стоимости дня из стоимости месяца.
chargestopedФлагнетСписывать средства при остановке. При выключении клиент получает компенсацию за часы простоя.
quickorderФлагнетБыстрый заказ. Включает возможность заказа услуги без указания параметров.
accessПоложительное целое числонетГруппа доступа. Выбор группы клиентов, для которой тариф доступен для заказа.
minperiodtypeПоложительное целое числонетТип минимального периода заказа.
minperiodlenПоложительное целое числонетДлина минимального периода.
trialПоложительное целое числонетДлина триального периода в днях.
trial_itemmaxПоложительное целое числонетМаксимальное количество триальных услуг для одного клиента.
itemmaxПоложительное целое числонетМаксимальное количество активных услуг для одного клиента.
suspendperiodПоложительное целое числонетПериод автоудаления (дней).
suspendpenaltytypeПоложительное целое числонетТип штрафа за просрочку продления услуги. Принимает значения:
  • 0 — без штрафа;
  • 1 — фиксированная сумма;
  • 2 — процент от стоимости периода просрочки;
  • 3 — продление с даты остановки.
suspendpenaltypercentСтроканетПроцент стоимости услуги, взимаемый как штраф.
changepolicyПоложительное целое числонет

Политика смены тарифа. Принимает значения:

  • 0 — изменение периода действия;
  • 1 — доплата или возврат средств;
  • 2 — смена тарифа запрещена;
  • 3 — только доплата, при понижении нет возврата;
  • 4 — полная оплата нового тарифа.
changeprolongpolicyПоложительное целое числонет

Политика продления услуги на новый тарифный план. Принимает значения:

  • 0 — с текущей даты;
  • 1 — с даты, когда закончится срок действия услуги.
orderpolicyПоложительное целое числонетПолитика заказа дополнительных ресурсов. Принимает значения:
  • 0 — стоимость до окончания срока действия услуги;
  • 1 — полная стоимость за период.
returnpolicyПоложительное целое числонетПолитика отказа от дополнительных ресурсов. Принимает значения:
  • 0 — возврат средств;
  • 1 — без возврата средств;
  • 2 — изменение при продлении.
opennotifyПоложительное целое числонетШаблон уведомления об открытии услуги. Принимает значение в зависимости от настроенных шаблонов.
licenseПоложительное целое числонетШаблон условий предоставления услуг. Принимает значение в зависимости от настроенных шаблонов.
pricelist_groupПоложительное целое числонетГруппа тарифа. Принимает значение в зависимости от настроенных групп.
orderpriorityПоложительное целое числонетПриоритет тарифа при сортировке (по возрастанию).
show_addon_imageФлагнетОтображать иконки ресурсов. Принимает значения:
  • no — использовать настройки типа продукта;
  • off — не отображать иконки;
  • on — отображать иконки.
descriptionСтроканетHTML-описание тарифного плана.
description_markdownСтроканетMarkdown-описание тарифного плана.
siteinfoСтроканетСлужебная информация для интеграции с внешним сайтом (витриной).
labelСтроканетМетки тарифа для фильтрации. Каждая метка указывается с новой строки.
allownosuitableФлагнетРазрешить заказ при отсутствии свободных ресурсов. Принимает значения on и off.
nostopholidaysФлагнетПереопределить политику остановки услуг в выходные. Принимает значения:
  • no — использовать настройки типа продукта;
  • off — останавливать услуги;
  • on — не останавливать услуги.
allowpostpaidФлагнетРазрешить списание средств за перерасход без учёта баланса. Принимает значения on и off.
restrictclientchangeФлагнетМожет ли клиент изменять ресурс после заказа. Принимает значения on и off.
create_addonФлагнетАвтоматически создать все доступные дополнения при создании тарифа. Принимает значения on и off.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Удалить тарифный план

Функция: pricelist.delete

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Удалить.

Поддерживает удаление нескольких тарифных планов через запятую.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id тарифных планов через запятую. Например, 12,34,56.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Скопировать выделенный тариф

Функция: pricelist.clone

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Клон.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid тарифного плана для копирования.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Импортировать тариф со стороннего сервера

Функция: pricelist.import

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Импорт.

Загрузка конфигурации тарифного плана с внешнего сервера.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
urlСтрокадаURL-адрес удалённого сервера для импорта.
authСтроканетДанные авторизации на удалённом сервере.

Включить тарифный план

Функция: pricelist.resume

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Вкл.

Активирует тарифный план для заказа. Поддерживает групповую операцию.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id тарифных планов через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Выключить тарифный план

Функция: pricelist.suspend

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Выкл.

Деактивирует тарифный план. Поддерживает групповую операцию.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id тарифных планов через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Содержание тарифного плана

Функция: pricelist.detail

Результат: список элементов

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг.

Возвращает список конфигурируемых дополнений (ресурсов), привязанных к тарифному плану.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор дополнения.
nameСтроканетНаименование дополнения.
priceСтроканетЦены дополнения.
orderpriorityПоложительное целое числонетПриоритет дополнения при сортировке (по возрастанию).
statusСтрока (перечисление)нетСостояние дополнения.

Редактирование ресурса

Функция: pricelist.detail.edit

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → список дополнений → кнопка Изменить.

Позволяет просмотреть, изменить или создать объект.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
plidПоложительное целое числодаУникальный идентификатор родительского тарифного плана.
elidПоложительное целое числонетУникальный идентификатор дополнения для редактирования.
billtypeПоложительное целое числонетТип учёта. Способ списания средств с клиента за дополнение. Принимает значения:
  • 1 — не учитывать;
  • 2 — на основе заказанных значений;
  • 3 — на основе статистики;
  • 5 — на основе значения других ресурсов.
chargestopedФлагнетПри выключенном флаге клиент получает компенсацию за часы простоя остановленной услуги. Принимает значения on и off.
itemtypeПоложительное целое числонетТип дополнения. Определяет ресурс, который регулируется данным дополнением. Принимает значение в зависимости от настроек платформы. 
addontypeПоложительное целое числонетТип значения. Способ задать значение дополнения к тарифу.Принимает значение в зависимости от настроек платформы. 
scaletypeПоложительное целое числонет

Тип шкалы значений. Параметр используется при расчёте стоимости дополнения. Принимает значения:

  • 0 — по ближайшему значению;
  • 1 — за каждый шаг шкалы;
  • 2 — по пакетам значений;
  • 3 — по вариантам значений.
restrictclientchangeСтрока (перечисление)нетПолитика изменения клиентом ресурса после заказа. Принимает значения:
  • on — изменение запрещено;
  • off — изменение разрешено;
  • uponly — только повышение;
  • downonly —только понижение.
minperiodtypeПоложительное целое числонетМинимальный период, по истечении которого клиент сможет изменить дополнение в сторону уменьшения.
minperiodlenПоложительное целое числонетДлительность минимального периода заказа дополнения.
manualprocessingФлагнетДля обработки ресурса будет создана задача для технического отдела. Принимает значения on и off.
manualprocessing_skipdefaultФлагнетЕсли данная опция включена и для дополнения выбрано значение по умолчанию, то это дополнение не будет добавлено в задачу на ручную обработку. Принимает значения on и off.
manualnameФлагнетПри включённой опции в качестве наименования дополнения будет использовано значение, указанное в параметре name. Принимает значения on и off.
nameСтроканетНаименование тарифного плана или дополнения.
intnameСтроканетСлужебное имя. Указывается при необходимости переопределить стандартное служебное имя для дополнения.
processing_featureСтроканетПроверять возможность. При выборе дополнения с указанной возможностью будет выбран обработчик, у которого есть данная возможность.
roundtypeПоложительное целое числонетСпособ округления рассчитанного значения.
addonstattypeПоложительное целое числонетВыберите, за какой период считать превышение.
addonstatcomparisonПоложительное целое числонетВыберите, как считать, если параметров одного типа несколько. Принимает значения:
  • 1 — суммировать;
  • 2 — наибольшее значение.
addonstatcalculationПоложительное целое числонетУкажите, за что указана цена. Принимает значения:
  • 0 — за каждую единицу;
  • 1 — за единицу в месяц.
addonstatchargestopedФлагнетПри включённой опции списания по данному дополнению будут идти и на остановленной услуге. Принимает значения on и off.
allowpostpaidФлагнетОпция разрешает списание средств за перерасход ресурса без учета баланса клиента. Принимает значения on и off.
summarizeinvoiceФлагнетСуммировать значение параметра за весь период при генерации акта выполненных работ. Принимает значения on и off.
measureПоложительное целое числонетЕдиница измерения, в которой задается дополнение. Значения зависят от типа дополнения.
addonlimitПоложительное целое числонетВключено в тариф. Значение по умолчанию для дополнения.
addonstepПоложительное целое числонетШаг заказа дополнения.
addonminПоложительное целое числонетМинимальное значение для заказа. Не может быть меньше, чем включено в тариф.
addonmaxПоложительное целое числонетМаксимальное доступное для заказа значение ресурса.
addonlimittrialПоложительное целое числонетВключено в тариф на триальном периоде. Значение по умолчанию для дополнения на триальном периоде.
addonmaxtrialПоложительное целое числонетМаксимальное доступное для заказа значение ресурса на триальном периоде.
enumerationПоложительное целое числонетПеречисление, из которого будут браться значения для дополнений к услугам.
enumerationitemПоложительное целое числонетЭлемент перечисления, по умолчанию включённый при заказе услуги.
orderpolicyПоложительное целое числонетСтоимость при изменении. Определяет, как система рассчитывает новую стоимость после изменения дополнения.
addonboolФлагнетЗначение по умолчанию для дополнения. Принимает значения on и off.
orderpriorityПоложительное целое числонетПриоритет дополнения при сортировке (по возрастанию).
descriptionСтроканетHTML-описание дополнения.
description_markdownСтроканетMarkdown-описание дополнения.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Удалить дополнение

Функция: pricelist.detail.delete

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Удалить.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id дополнений через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Включить дополнение

Функция: pricelist.detail.resume

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Вкл.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id дополнений через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Выключить дополнение

Функция: pricelist.detail.suspend

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Выкл.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id дополнений через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Переместить дополнение вверх

Функция: pricelist.detail.up

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Вверх.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid дополнения для перемещения.

Переместить дополнение вниз

Функция: pricelist.detail.down

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Вниз.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid дополнения для перемещения.

Цены на дополнения

Цены при разных количествах

Функция: pricelist.detail.integer

Результат: список элементов

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор записи цены.
valueПоложительное целое числонетКоличество ресурсов.
priceСтроканетСтоимость.

Специальная цена

Функция: pricelist.detail.integer.edit

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены → кнопка Создать или кнопка Изменить.

Позволяет просмотреть, изменить или создать объект.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
plidПоложительное целое числодаУникальный идентификатор родительского дополнения (элемент id из функции pricelist.detail).
elidПоложительное целое числонетУникальный идентификатор записи цены (элемент id из функции pricelist.detail.integer).
valueПоложительное целое числонетКоличество ресурсов, при достижении которого применяется специальная цена.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Удалить специальную цену

Функция: pricelist.detail.integer.delete

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены → кнопка Удалить.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id записей цен через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Цены (для дополнений с типом "Перечисление")

Функция: pricelist.detail.enum

Результат: список элементов

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор элемента.
nameСтроканетНаименование элемента.
priceСтроканетЦена элемента.
orderpriorityПоложительное целое числонетПриоритет дополнения при сортировке (по возрастанию).
statusСтрока (перечисление)нетСостояние элемента.

Включить элемент перечисления

Функция: pricelist.detail.enum.resume

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены → выберите дополнение → кнопка Вкл.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id элементов через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Выключить элемент перечисления

Функция: pricelist.detail.enum.suspend

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены → выберите дополнение → кнопка Выкл.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id элементов через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Переместить элемент перечисления вверх

Функция: pricelist.detail.enum.up

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены → выберите дополнение → кнопка Вверх.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid элемента перечисления.

Переместить элемент перечисления вниз

Функция: pricelist.detail.enum.down

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены → выберите дополнение → кнопка Вниз.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid элемента для перемещения.

Редактировать цену перечисления

Функция: pricelist.detail.enum.edit

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Конфиг. → выберите дополнение → кнопка Цены → выберите дополнение → кнопка Изменить.

Управление стоимостью и приоритетом элементов перечисления.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
plidПоложительное целое числодаУникальный идентификатор родительского дополнения.
elidПоложительное целое числонетУникальный идентификатор элемента перечисления.
orderpriorityПоложительное целое числонетПриоритет цены при сортировке (по возрастанию).
sokСтрокадаЗначение ok подтверждает выполнение операции.

Варианты ресурса

Функция: pricelist.detail.compound

Результат: список элементов

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор варианта.
nameСтроканетНаименование варианта.
priceСтроканетЦены варианта.
orderpriorityПоложительное целое числонетПриоритет ресурса при сортировке (по возрастанию).
statusСтрока (перечисление)нетСостояние варианта.

Переместить вариант ресурса вверх

Функция: pricelist.detail.compound.up

Результат: успешное выполнение операции или сообщение об ошибке

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid варианта ресурса для перемещения.

Переместить вариант ресурса вниз

Функция: pricelist.detail.compound.down

Результат: успешное выполнение операции или сообщение об ошибке

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid варианта ресурса для перемещения.

Настройка зависимостей

Функция: pricelist.reference

Результат: список элементов

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Зависимости.

Позволяет настроить зависимость одного дополнения тарифного плана от другого.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор зависимости.
referencedescСтроканетЗависимость.
referenceСтроканетСоотношение.

Изменение зависимости

Функция: pricelist.reference.edit

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Зависимости → кнопка Изменить.

Настройка логики автоизменения значений зависимых дополнений.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
plidПоложительное целое числодаУникальный идентификатор родительского тарифного плана.
elidПоложительное целое числонетУникальный идентификатор зависимости.
pricelist_baseПоложительное целое числонетОсновное дополнение тарифного плана. При изменении параметра будет изменено значение зависимого дополнения.
base_valueСтроканетЗначение основного дополнения, при котором будет изменено зависимое дополнение.
enumerationitem_baseПоложительное целое числонетЗначения, при выборе одного из которых будет изменено зависимое дополнение.
pricelist_referenceПоложительное целое числонетЗависимое дополнение. Будет изменено при изменении основного дополнения.
reference_valueСтроканетЗначение, которое будет выставлено для зависимого дополнения.
enumerationitem_referenceПоложительное целое числонетЗначения, которые будут доступны при изменении основного дополнения.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Копировать зависимость

Функция: pricelist.reference.clone

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Зависимости → кнопка Клон.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid зависимости для клонирования.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Удалить зависимость

Функция: pricelist.reference.delete

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Зависимости → кнопка Удалить.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id зависимостей через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Правила смены тарифа

Функция: pricelist.change

Результат: список элементов

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Смена тарифа.

Возвращает список тарифов, на которые возможен переход с текущего.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор правила.
nameСтроканетНаименование правила.
statusСтрока (перечисление)нетСостояние правила.

Включить правило смены

Функция: pricelist.change.resume

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Смена тарифа → выберите новый тарифный план → кнопка Вкл.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id правил смены через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Выключить правило смены

Функция: pricelist.change.suspend

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Смена тарифа → выберите новый тарифный план → кнопка Выкл.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id правил смены через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Особые правила смены тарифа

Функция: pricelist.change.rule

Результат: список элементов

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Смена тарифа → раздел Правила.

Возвращает список специальных условий для перехода на другой тариф.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор особого правила.
fromdateДата и времянетДата начала действия правила.
todateДата и времянетДата окончания действия правила.
periodСтрока (перечисление)нетПериод заказа.
discountПоложительное целое числонетСкидка, %.

Особое правило на смену тарифа

Функция: pricelist.change.rule.edit

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Смена тарифа → раздел Правила → кнопка Создать или кнопка Изменить.

Настройка временных рамок, периодов заказа и скидок для перехода.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
plidПоложительное целое числодаУникальный идентификатор родительского правила смены тарифа.
elidПоложительное целое числонетУникальный идентификатор особого правила.
fromdateДата и времянетДата начала периода, в течение которого правило действует для заказов.
todateДата и времянет

Дата окончания периода, в течение которого правило действует для заказов.

periodСтрока (перечисление)нетПериод заказа. На разных периодах заказа (вечный, месяц и т.д.) можно настроить разные правила.
discountПоложительное целое числонетРазмер скидки на новый тариф в процентах. 
sokСтрокадаЗначение ok подтверждает выполнение операции.

Удалить особое правило

Функция: pricelist.change.rule.delete

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Смена тарифа → раздел Правила → кнопка Удалить.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id особых правил через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Настройка правил заказа тарифа

Правила заказа тарифа

Функция: pricelist.orderreference

Результат: список элементов

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Доступ.

Возвращает локальные правила заказа для конкретного тарифа.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор правила.
nameСтроканетНаименование правила.
statusСтрока (перечисление)нетСостояние правила.

Включить правило заказа

Функция: pricelist.orderreference.resume

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Доступ → выберите правило → кнопка Вкл.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id правил заказа через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Выключить правило заказа

Функция: pricelist.orderreference.suspend

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Доступ → выберите правило → кнопка Выкл.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id правил заказа через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Правила заказа тарифа (тип продукта)

Функция: itemtype.orderreference

Результат: список элементов

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы →выберите тарифный план → кнопка Доступ → выберите правило → кнопка Тарифы.

Позволяет ограничить заказ выбранного тарифного плана только для тех клиентов, которые уже имеют активные услуги других тарифов.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор правила.
nameСтроканетНаименование правила.
statusСтрока (перечисление)нетСостояние правила.

Включить правило доступа

Функция: itemtype.orderreference.resume

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Доступ → выберите правило → кнопка Тарифы → выберите правило → кнопка Вкл.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id правил доступа через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Выключить правило доступа

Функция: itemtype.orderreference.suspend

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Доступ → выберите правило → кнопка Тарифы→ выберите правило → кнопка Выкл.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id правил доступа через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Обработчики

Подключение к обработчикам тарифного плана

Функция: pricelist.processing

Результат: список элементов

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Обработчики.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор подключения.
nameСтроканетНаименование обработчика.
orderpriorityПоложительное целое числонетПриоритет обработчика при сортировке (по возрастанию).
statusСтрока (перечисление)нетСостояние обработчика.

Включить обработчик

Функция: pricelist.processing.resume

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Обработчики → выберите обработчик → кнопка Вкл.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id подключений через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Выключить обработчик

Функция: pricelist.processing.suspend

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Обработчики → выберите обработчик → кнопка Выкл.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id подключений через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Переместить обработчик вверх

Функция: pricelist.processing.up

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Обработчики → выберите обработчик → кнопка Вверх.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid подключения для перемещения.

Переместить обработчик вниз

Функция: pricelist.processing.down

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка Обработчики → выберите обработчик → кнопка Вниз.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid подключения для перемещения.

История изменения тарифного плана

Функция: pricelist.history

Результат: список элементов

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → выберите тарифный план → кнопка История.

Возвращает хронологию изменений параметров тарифного плана.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
changedateДата и времянетДата изменения.
descСтроканетОписание изменения.
userСтроканетПользователь, внёсший изменение.
ipСтроканетIP-адрес, с которого выполнено изменение.
actionСтроканетВыполненная функция.
history_pricelist_treeСтроканетСвязанные объекты: тарифы (pl_*) или типы продуктов (it_*). Формат: pl_12,it_456.

Архив тарифов

Архивировать

Функция: pricelist.archive

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → кнопка Архивировать.

Перемещает выбранные тарифы в архив. Поддерживает групповую операцию.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id тарифных планов для архивации через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Открыть архив тарифов

Функция: pricelist.archived

Результат: список элементов

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → кнопка Архив.

Возвращает список тарифных планов, перемещённых в архив.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор архивного тарифа.
nameСтроканетНаименование архивного тарифа.

Изменить положение тарифа в списке

Переместить тариф вверх

Функция: pricelist.up

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → кнопка Вверх.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid тарифного плана для перемещения.

Переместить тариф вниз

Функция: pricelist.down

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → кнопка Вниз.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid тарифного плана для перемещения.

Установка фильтра

Функция: pricelist.filter

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел ПродуктыТарифные планы → кнопка Фильтр.

Сохраняет условия отбора, которые применяются при каждом отображении списка до изменения или снятия.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
nameСтроканетПоиск по наименованию тарифа. Поддерживается подстановочный знак *.
itemtype_nameСтрока (перечисление)нетФильтр по типу услуги.
projectПоложительное целое числонетФильтр по провайдеру.
activeФлагнетФильтр по состоянию: on (активен) или off (отключён).
quickorderФлагнетФильтр по возможности быстрого заказа.
resetФлагнетЗначение on сбрасывает все установленные фильтры.
sokСтроканетЗначение ok подтверждает сохранение фильтра.

Сброс флага синхронизации

Функция: pricelist.dropsyncinprogress

Результат: успешное выполнение операции или сообщение об ошибке

Служебная функция, недоступна в интерфейсе. Вызов через API или консоль.

Используется для принудительного сброса параметра sync_in_progress, если тарифный план "завис" в состоянии синхронизации. 

Уровень доступа: root, admin

ПараметрТипОбязательныйЗначение
pricelistПоложительное целое числодаid тарифного плана, для которого необходимо сбросить флаг синхронизации.