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

Клиенты (account)

Клиенты (account)

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

В веб-интерфейсе платформы: раздел Клиенты в левом меню платформы.

Клиенты

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

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

Регистрация клиента

Функция: register

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

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

Подробнее см. в статье Интеграция с сайтом.

Чтобы зарегистрировать клиента в BILLmanager, выполняется перенаправление пользователя с сайта на форму регистрации:

Регистрация в BILLmanager
https://IP-address:port/billmgr?func=register
Подробнее

Для регистрации клиента на сайте без перехода в BILLmanager используется функция register, удалённый вызов которой зарегистрирует клиента в биллинговой платформе. Функция имеет следующие параметры:

ПараметрТипОбязательныйЗначение
sokСтрокадаЗначение ok подтверждает выполнение операции. Без этого параметра изменения не будут применены.
emailСтрокадаЛогин и Email нового клиента.
passwdСтрокадаПароль нового клиента.
realnameСтроканетФИО клиента.
phoneСтроканетНомер телефона.
conditions_agreeФлагнетУстановите значение on, если для регистрации необходимо принятие условий использования.
offer_xxxФлагнетУстановите значение on, если используется принятие договора-оферты при регистрации, где xxx — id оферты.
countryСтроканетКод страны в соответствии со справочником BILLmanager.
stateСтроканетКод региона или области в соответствии со справочником BILLmanager.
projectПоложительное целое числонетid провайдера.
recoveryФлагнетУстановите значение on, если необходимо в письме о регистрации отправить клиенту ссылку на сброс пароля.
_gaСтроканетКод привязки к Google Analytics.
partnerСтроканетПри использовании реферальной программы сайт должен запоминать 'PARTNER_ID' (код партнера), если клиент пришёл по реферальной ссылке. Обычно этот параметр сохраняют в cookies.
sesidСтроканетЕсли используется реферальная программа. Идентификатор клика.
tzoffsetСтроканетСмещение часового пояса клиента относительно GMT, в BILLmanager выставляется через JavaScript.

Написать запрос клиенту

Функция: ticket.write.account

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

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

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

Платежи (account.payment)

Функция: account.payment

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

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

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

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор платежа.
numberСтроканетНомер платежа.
create_dateДата и времянетДата создания платежа.
pay_dateДата и времянетДата оплаты.
sender_nameСтроканетПлательщик.
recipient_nameСтроканетПолучатель.
projectПоложительное целое числонетПровайдер.
account_nameСтроканетКлиент.
paymethod_nameСтроканетМетод оплаты.
subaccountamount_isoСтроканетСумма.
paymethodamount_isoСтроканетСумма в валюте платежа.
statusСтрока (список)нетФлаги статуса платежа.

Свойства платежа

Функция: payment.edit

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

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

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

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

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • elid — уникальный идентификатор (элемент id из функции account.payment).
  • Результат: список параметров объекта.

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • elid — уникальный идентификатор (элемент id из функции account.payment);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

ПараметрТипОбязательныйЗначение
numberСтроканетНомер счёта для оплаты.
createdateДата и времянетДата и время создания счёта на оплату.
paydateДата и времянетДата оплаты счёта или зачисления платежа.
documentnumberСтроканет№ платёжного документа.
documentdateДата и времянетДата платёжного документа.
descriptionСтроканетНазначение платежа.
senderПоложительное целое числонетПлательщик клиента, от имени которого совершена оплата.
subaccountamountСтроканетСумма платежа, зачисляемая на счёт клиента.
usedamountСтроканетСумма израсходованных средств.
paymethodamountСтроканетСумма в валюте платёжной системы.
commissionamountСтроканетКомиссия, добавляемая к сумме платежа при оплате.
taxamount_readonlyСтроканетСумма налога.
statusСтрока (перечисление)нетСтатус платежа.
paymethodПоложительное целое числонетМетод оплаты.
restrictrefundФлагнетЗапретить возврат средств с данного платежа. Чтобы включить данную опцию, используйте значение on.
infoСтроканетИнформация о платеже. Дополнительная информация о платеже, полученная от платёжной системы.
noteСтроканетКомментарий сотрудника.

Зачислить платёж на лицевой счёт клиента

Функция: payment.setpaid

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

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

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой. Уникальный идентификатор — элемент id из функции account.payment.

Пример API вызова для зачисления платежа на лицевой счёт клиента:

Пример API вызова
https://IP-address:port/billmgr?authinfo=username:password&elid=3&func=payment.setpaid&out=xml
Подробнее

Отправить счёт на e-mail

Функция: payment.send

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

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

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой. Уникальный идентификатор — элемент id из функции account.payment.

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

Функция: account.payment.filter

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

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

Отмена платежа

Функция: payment.refund

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

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

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

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

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • elid — уникальный идентификатор (элемент id из функции account.payment).
  • Результат: список параметров объекта.

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • elid — уникальный идентификатор (элемент id из функции account.payment);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

ПараметрТипОбязательныйЗначение
amountСтрокадаСумма возврата. Сумма в валюте метода оплаты, которая будет возвращена клиенту.
descriptionСтроканетПричина возврата для передачи в платёжную систему.

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

Функция: payment.history

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

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

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

ПараметрТипОбязательныйЗначение
changedateДата и времянетДата изменения.
descСтроканетИзменение.
userСтроканетПользователь.
ipСтроканетIP-адрес.
actionСтроканетФункция.

Вывод информации о платеже в виде, удобном для печати

Функция: payment.print

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

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

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

Скачать документ в формате PDF

Функция: payment.print.pdf

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

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

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

Распределение суммы расхода по платежам

Функция: payment.expense

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

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

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

ПараметрТипОбязательныйЗначение
expenseПоложительное целое числонетКод расхода.
expense_locale_nameСтроканетРасход.
amount_isoСтроканетСумма.
invoiceПоложительное целое числонетКод акта.
invoice_numberСтроканетАкт.

Редактирование распределения

Функция: payment.expense.edit

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

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

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

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

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account.payment);
    • elid — уникальный идентификатор (элемент expense из функции payment.expense).
  • Результат: список параметров объекта.

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account.payment);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account.payment);
    • elid — уникальный идентификатор (элемент expense из функции payment.expense);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

ПараметрТипОбязательныйЗначение
expenseПоложительное целое числонетКод расхода.
amountСтроканетСумма, которая будет списана с платежа.

Удалить

Функция: payment.expense.delete

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

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

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой. Уникальный идентификатор — элемент expense из функции payment.expense.

Удалить выбранные платежи. Доступно только для неоплаченных платежей

Функция: payment.delete

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

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

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой. Уникальный идентификатор — элемент id из функции account.payment.

Создать

Функция: payment.add

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

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

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

Содержание счёта

Функция: payment.orderinfo

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

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

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

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

Изменение содержания счёта

Функция: payment.orderinfo.edit

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

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

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

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

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account.payment);
    • elid — уникальный идентификатор (элемент id из функции payment.orderinfo).
  • Результат: список параметров объекта.

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account.payment);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account.payment);
    • elid — уникальный идентификатор (элемент id из функции payment.orderinfo);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

ПараметрТипОбязательныйЗначение
nameСтроканетОписание позиции счёта.

Написать запрос клиенту

Функция: ticket.write.payment

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

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

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

Группы клиента

Функция: account.group

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

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

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

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

Включить

Функция: account.group.resume

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

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

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой. Уникальный идентификатор — элемент id из функции account.group.

Выключить

Функция: account.group.suspend

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

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

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой. Уникальный идентификатор — элемент id из функции account.group.

Редактирование группы

Функция: account.group.edit

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

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

Удалить группу

Функция: account.group.delete

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

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

Лицевые счета

Функция: subaccount

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

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

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

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор счёта.
projectПоложительное целое числонетПровайдер.
balanceСтроканетБаланс лицевого счета клиента.
creditlimitСтроканетКредитный лимит.
statusСтрока (список)нетСостояние.

Редактирование лицевого счета

Функция: subaccount.edit

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

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

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

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

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • elid — уникальный идентификатор (элемент id из функции subaccount).
  • Результат: список параметров объекта.

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • elid — уникальный идентификатор (элемент id из функции subaccount);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

ПараметрТипОбязательныйЗначение
subaccount_projectПоложительное целое числонетПровайдер создаваемого счёта.
subaccount_currencyСтроканетВалюта создаваемого счёта.
allowpostpaidФлагнетОпция включает возможность клиенту оплачивать с данного счёта услуги в долг. Чтобы включить данную опцию, используйте значение on.
creditlimitСтроканетКредитный лимит. Позволяет клиенту уходить в долг в пределах указанной суммы.
refererПоложительное целое числонетПривлечён клиентом по реферальной программе. Укажите код клиента, который привел клиента по реферальной программе.
activeФлагнетСчёт клиента активен. У клиента может быть только один активный счёт у провайдера. Чтобы включить данную опцию, используйте значение on.
incident_limitПоложительное целое числонетМаксимальное использование обращений в поддержку клиентом за всё время.

Выключить

Функция: subaccount.suspend

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

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

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой. Уникальный идентификатор — элемент id из функции subaccount.

Вывод средств со счёта

Функция: subaccount.refund

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

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

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

Включить

Функция: subaccount.resume

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

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

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой. Уникальный идентификатор — элемент id из функции subaccount.

Скидки

Функция: account.discount

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

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

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

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

Создать

Функция: account.discount.add

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

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

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

Удалить

Функция: account.discount.delete

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

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

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой.

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

Функция: account.discount.edit

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

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

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

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

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • elid — уникальный идентификатор (элемент idname из функции account.discount).
  • Результат: список параметров объекта.

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • elid — уникальный идентификатор (элемент idname из функции account.discount);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

ПараметрТипОбязательныйЗначение
fromdateДата и времянетС даты. Первый день действия скидки.
todateДата и времянетПо дату. Последний день действия скидки.
typeСтрока (перечисление)нетТип скидки. Способ предоставления скидки.
percentageСтроканетСкидка в % на стоимость услуги или товара.
priorityПоложительное целое числонетПриоритет скидки. По умолчанию скидки заданные клиенту персонально имеют больший приоритет, чем скидки указанные в промоакциях. Если задать скидке отрицательный приоритет, она будет применена только при отсутствии подходящих скидок из промоакций.
actiontypeСтрока (перечисление)нетВыберите, на что действует скидка. Обратите внимание, что скидка на продление не будет действовать на тарифы с ежедневным списанием.
periodСтрока (перечисление)нетПериод заказа, на который распространяется скидка.
noteСтроканетКомментарий к скидке.

История изменений скидки

Функция: account.discount.history

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

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

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

Отправка СМС сообщения

Функция: account.sms

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

Для работы опции должен быть настроен СМС-шлюз.

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

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

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

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции account).
  • Результат: список параметров объекта.

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • elid — уникальный идентификатор (элемент id из функции account);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

ПараметрТипОбязательныйЗначение
typeПоложительное целое числонетВыбор номера телефона, на который будет отправлено сообщение.
phoneСтрокадаНомер телефона, на который будет отправлено сообщение.
messageСтрокадаСообщение.

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

Функция: account.setfilter

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

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

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

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

Функция: account.filter

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

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

Курс валют

Функция: account.currencyrate

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

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

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

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

Курс валют

Функция: account.currencyrate.edit

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

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

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

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

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • elid — уникальный идентификатор (элемент id из функции account.currencyrate).
  • Результат: список параметров объекта.

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • elid — уникальный идентификатор (элемент id из функции account.currencyrate);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

ПараметрТипОбязательныйЗначение
currency_baseСтроканетБазовая валюта, в которую проводится конвертация.
currency_relateСтроканетКонвертируемая валюта. Валюта, которая конвертируется в базовую.
rateСтроканетЗначение курса валюты на указанную дату за указанное количество единиц.
amountСтроканетКоличество единиц базовой валюты, за которое указан курс конвертации.
ratedateДата и времянетДата, с которой действует курс.

Удалить

Функция: account.currencyrate.delete

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

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

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой. Уникальный идентификатор — элемент id из функции account.currencyrate.

Расходы

Функция: subaccount.expense

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

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

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

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор расхода.
locale_nameСтроканетНаименование.
realdateДата и времянетДата списания.
cdateДата и времянетДата оказания услуги.
amountСтроканетСумма.
notpaydФлагнетНе оплачено.
discountamountСтроканетСумма скидки.
paymentsСтрока (список)нетОплачено платежами.
discountПоложительное целое числонетКод скидки.
taxamountСтроканетНалог.

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

Функция: subaccount.expense.filter

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

В веб-интерфейсе платформы: раздел КлиентыКлиенты → выберите клиента → кнопка Расходы → меню Фильтр.

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

Функция: subaccount.expense.edit

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

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

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

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

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • elid — уникальный идентификатор (элемент id из функции subaccount.expense).
  • Результат: список параметров объекта.

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • elid — уникальный идентификатор (элемент id из функции subaccount.expense);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

ПараметрТипОбязательныйЗначение
subaccountПоложительное целое числонетПровайдер / id счёта (id плательщика).
itemПоложительное целое числонетid услуги. Выберите услугу, за которую будет создан расход.
operationСтрока (перечисление)нетОперация, на основании которой будет расход. Например: prolong, billdaily, changeaddon.
amountСтроканетСумма расхода.
taxrateСтроканетСтавка налога. Процент налогов. Сумма налога включена в сумму расхода и высчитывается по формуле: СУММА — (СУММА / ((100 + СТАВКА) / 100))
postpaidФлагнетЕсли опция установлена, то при нехватке средств на счёте расход будет создан в долг. Чтобы включить данную опцию, используйте значение on.
nameСтроканетНаименование. Вы можете указать собственное наименование. Если вы не укажете наименование, то оно будет сгенерировано автоматически на основе операции.
realdateДата и времянетФактическая дата списания.
cdateДата и времянетДата начала оказание услуги.
plidПоложительное целое числонетid клиента.
Пример запроса
https://<адрес_биллинга>/billmgr?func=subaccount.expense.edit&authinfo=xxx:xxx&amount=<сумма>&item=<id_услуги>&name=<Name>&name_ru=<name_ru>&operation=<вид_операции>&plid=<id_клиента>&postpaid=<on>&sok=ok&subaccount=<id_лицевого_счёта>
Параметры

Удалить

Функция: subaccount.expense.delete

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

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

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой. Уникальный идентификатор — элемент id из функции subaccount.expense.

Ставки налогов

Функция: account.taxrule

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

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

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

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор правила.
typeСтрока (перечисление)нетТип.
projectПоложительное целое числонетПровайдер.
companyПоложительное целое числонетКомпания.
countryПоложительное целое числонетСтрана плательщика.
taxrateСтроканетСтавка налога.
itemtypeСтрока (перечисление)нетТип продукта.

Удалить правило

Функция: account.taxrule.delete

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

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

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой. Уникальный идентификатор — элемент id из функции account.taxrule.

Специальное правило

Функция: account.taxrule.edit

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

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

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

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

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • elid — уникальный идентификатор (элемент id из функции account.taxrule).
  • Результат: список параметров объекта.

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительского списка (элемент id из функции account);
    • elid — уникальный идентификатор (элемент id из функции account.taxrule);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

ПараметрТипОбязательныйЗначение
projectПоложительное целое числонетНаименование провайдера.
taxrateСтроканетСтавка налога. Укажите налоговую ставку для выбранной страны.
specialitemtypeФлагнетОпция "Только на определенные типы продуктов". Если включена, налогообложению подвергаются не все типы продуктов. Чтобы включить данную опцию, используйте значение on.
itemtypeСтрока (список)нетТипы продуктов. Укажите, какие типы продуктов облагаются налогами.

Редактирование информации о клиенте

Функция: account.edit

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

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

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

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

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции account).
  • Результат: список параметров объекта.

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • elid — уникальный идентификатор (элемент id из функции account);
    • дополнительные параметры запроса.
  • Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

ПараметрТипОбязательныйЗначение
emailСтроканетEmail клиента, также будет использоваться как логин для авторизации в BILLmanager.
verify_emailФлагнетПодтверждение email. Чтобы включить данную опцию, используйте значение on.
projectПоложительное целое числонетПровайдер, к которому будет привязан клиент.
countryПоложительное целое числонетСтрана клиента.
stateПоложительное целое числонетРегион.
realnameСтроканетКонтактное лицо. ФИО клиента или контактного лица организации, для которой создаётся учётная запись.
nameСтроканетНаименование клиента.
settingurlСтроканетURL настроек. URL получения настроек панелями ispmanager.
valid_phoneСтроканетПроверенный номер телефона клиента.
try_phoneСтроканетНомер телефона клиента.
labelСтроканетМетка. Служебная информация, доступная в фильтре.
selfviewСтроканетСвоё пространство имен. Позволяет подменить указываемые в настройках панели сервера имен.
passwdСтроканетПароль доступа в личный кабинет.
confirmСтроканетПодтверждение.
products_pageПоложительное целое числонетСтраница.
registration_dateДата и времянетДата регистрации.
registration_ipСтроканетIP-адрес, с которого произведена регистрация клиента.
attitudeПоложительное целое числонетХарактеристика клиента.
employeeПоложительное целое числонетСотрудник, зарегистрировавший клиента.
nocalcstatФлагнетУслуги клиента не будут отображаться в статистике. Чтобы включить данную опцию, используйте значение on.
noteСтроканетКомментарий к клиенту.
notifyФлагнетОтправить клиенту уведомление о регистрации в BILLmanager. Чтобы включить данную опцию, используйте значение on.
recoveryФлагнетДобавить в уведомление данные для сброса пароля. Чтобы включить данную опцию, используйте значение on.

Войти в панель с правами пользователя

Функция: account.su

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

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

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

Удалить

Функция: account.delete

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

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

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой. Уникальный идентификатор — элемент id из функции account.

Провайдеры, доступные клиенту

Функция: account.project

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

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

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

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

Включить

Функция: account.project.resume

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

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

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

Параметры:

  • plid — уникальный идентификатор родительского списка (элемент id из функции account);
  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой. Уникальный идентификатор — элемент id из функции account.project.

Выключить

Функция: account.project.suspend

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

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

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделённых запятой. Уникальный идентификатор — элемент id из функции account.project.

История изменения параметров клиента

Функция: account.history

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

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

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

Сведения о верификации клиента

Функция: account.validate

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

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

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

Заказы клиента

Функция: account.orders

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

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

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

Валюты клиента

Функция: account.currency

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

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

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

Объединение клиентов

Функция: account.join

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

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

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

Группы клиентов (accountgroup)

Функция: accountgroup

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

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

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

Редактирование группы

Функция: accountgroup.edit

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

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

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

Условия автовключения в группу

Функция: accountgroup.condition

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

В веб-интерфейсе платформы: раздел КлиентыГруппы клиентов кнопка Условия автовключения.

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