Account
Результат: список элементов
Клиенты
Уровень доступа: admin
Регистрация клиента
Функция: register
Подробнее см. в статье Интеграция с сайтом.
Чтобы зарегистрировать клиента в BILLmanager, выполняется перенаправление пользователя с сайта на форму регистрации:
https://DOMAIN/billmgr?func=register
Для регистрации клиента на сайте, без перехода в BILLmanager, используется функция register, удаленный вызов которой зарегистрирует клиента в биллинговой платформе. Функция имеет следующие параметры:
Написать запрос клиенту
Функция: ticket.write.account
Уровень доступа: admin
Платежи account.payment
Функция: account.payment
Результат: список элементов
Уровень доступа: admin
Свойства платежа
Функция: payment.edit
Уровень доступа: admin
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:
- Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции account).
- elid — уникальный идентификатор (элемент id из функции account.payment)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции account).
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции account).
- elid — уникальный идентификатор (элемент id из функции account.payment)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см. выше):
Зачислить платеж на лицевой счет клиента
Функция: payment.setpaid
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.payment.
Результат: успешное выполнение операции или сообщение об ошибке.
Пример API вызова для зачисления платежа на лицевой счет клиента:
https://<адрес BILLmamager>?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)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см. выше):
История изменения платежа с номером
Функция: payment.history
Результат: список элементов
Уровень доступа: admin
Вывод информации о платежа в виде удобном для печати
Функция: payment.print
Уровень доступа: admin
Скачать документ в формате PDF
Функция: payment.print.pdf
Уровень доступа: admin
Распределение суммы расхода по платежам
Функция: payment.expense
Результат: список элементов
Уровень доступа: admin
Редактирование распределения
Функция: 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)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см. выше):
Удалить
Функция: payment.expense.delete
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент expense из функции payment.expense.
Результат: успешное выполнение операции или сообщение об ошибке
Удалить выбранные платежи. Доступно только для еще неоплаченных платежей
Функция: payment.delete
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.payment.
Результат: успешное выполнение операции или сообщение об ошибке
Создать
Функция: payment.add
Уровень доступа: admin user
Содержание счета
Функция: payment.orderinfo
Результат: список элементов
Уровень доступа: admin
Изменение содержания счета
Функция: 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)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см. выше):
Написать запрос клиенту
Функция: ticket.write.payment
Уровень доступа: admin
Группы клиента
Функция: account.group
Результат: список элементов
Уровень доступа: admin
Включить
Функция: account.group.resume
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.group.
Результат: успешное выполнение операции или сообщение об ошибке
Выключить
Функция: account.group.suspend
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.group.
Результат: успешное выполнение операции или сообщение об ошибке
Лицевые счета
Функция: subaccount
Результат: список элементов
Уровень доступа: admin
Редактирование лицевого счета
Функция: subaccount.edit
Уровень доступа: admin
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:
- Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции account).
- elid — уникальный идентификатор (элемент id из функции subaccount)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции account).
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции account).
- elid — уникальный идентификатор (элемент id из функции subaccount)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см. выше):
Выключить
Функция: subaccount.suspend
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции subaccount.
Результат: успешное выполнение операции или сообщение об ошибке
Вывод средств со счета
Функция: subaccount.refund
Уровень доступа: admin
Включить
Функция: subaccount.resume
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции subaccount.
Результат: успешное выполнение операции или сообщение об ошибке
Скидки
Функция: account.discount
Результат: список элементов
Уровень доступа: admin
Создать
Функция: 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)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см. выше):
Отправка СМС сообщения
Функция: account.sms
Уровень доступа: admin
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции account)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции account)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см. выше):
Установить фильтр по клиенту
Функция: account.setfilter
Уровень доступа: admin
Установка фильтра
Функция: account.filter
Курс валют
Функция: account.currencyrate
Результат: список элементов
Уровень доступа: admin
Курс валют
Функция: 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)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см. выше):
Удалить
Функция: account.currencyrate.delete
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.currencyrate.
Результат: успешное выполнение операции или сообщение об ошибке
Расходы
Функция: subaccount.expense
Результат: список элементов
Уровень доступа: admin
Установка фильтра.
Функция: subaccount.expense.filter
Редактирование раcхода
Функция: 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)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см. выше):
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
Удалить правило
Функция: 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)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см. выше):
Редактирование информации о клиенте
Функция: account.edit
Уровень доступа: admin
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции account)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции account)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см. выше):
Войти в панель с правами пользователя
Функция: account.su
Уровень доступа: admin
Удалить
Функция: account.delete
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.
Результат: успешное выполнение операции или сообщение об ошибке
Провайдеры, доступные клиенту
Функция: account.project
Результат: список элементов
Уровень доступа: admin
Включить
Функция: account.project.resume
Уровень доступа: admin
Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции user).
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.project.
Результат: успешное выполнение операции или сообщение об ошибке
Выключить
Функция: account.project.suspend
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.project.
Результат: успешное выполнение операции или сообщение об ошибке