Документация BILLmanager 6

Провайдеры (project)

project

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

Провайдеры

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

ПараметрЗначение
idId
name Наименование
currency_str Валюта
site URL сайтa
billurl URL биллинга

Восстановление

Функция: project.support

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

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

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

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

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

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

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

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

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

ПараметрЗначение
support_require (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает использование платных обращений в поддержку
new_account_countКоличество новым клиентам. Количество доступных обращений в поддержку, начисляемое при подключении к провайдеру
first_payment_count Количество за первый платеж. Количество доступных обращений в поддержку, начисляемых за первый платеж
first_expense_count Количество за первое списание. Количество доступных обращений в поддержку, начисляемых за первое списание средств с лицевого счета
paid_amount_count Количество при оплате. Количество доступных обращений в поддержку, начисляемое при оплате
paid_amount_amount Сумма пополнения
support_over_limit (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция разрешает сотрудникам провайдера списывать с клиента обращения "в долг". При превышении лимита клиент не сможет писать сообщения в поддержку до погашения долга по обращениям

Удалить

Функция: project.delete

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

Параметры:

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

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

Редактирование провайдера

Функция: project.edit

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

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

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

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

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

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

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

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

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

ПараметрЗначение
name Наименование провайдера, используется в уведомлениях, а также при формировании имени счета клиентов
notifyemail Email для отправки уведомлений. Email адрес, с которого будут отправляться уведомления
supportemail Email поддержки. Используется в сообщениях об активации пользователя/плательщика и восстановлении пароля
site URL адрес Вашего сайта. Может быть ипользован в уведомлениях, отправляемых клиентам
billurlURL биллинга. URL адрес доступа к BILLmanager. Может быть использован в уведомлениях, отправляемых клиентам
clienthelp URL страницы, которая будет открыта при выборе пункта меню "Вызов справки" в интерфейсе пользователя. Макрос {lang} позволяет открывать разные страницы в зависимости от выбранной у клиента локализации
currency Используемые валюты счетов
country_default Страна клиентов по умолчанию. Используется в случае невозможности определить страну по IP адресу или по сохраненному значению
state_default Регион клиентов по умолчанию. Используется в случае невозможности определить регион по сохраненному значению
licenseserverprovider Сервер лицензий для заказа панелей управления к услугам
autoassignitem (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включении данной опции клиентам при присоединении к провайдеру будет автоматически и бесплатно назначаться выбранная услуга
autoassignpricelist Тариф подключаемой услуги
autoassignperiod Период, на который подключается услуга
closeaccounts (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает закрытие счетов клиентов по прошествии выбранного промежутка времени
period_lenght Период бездействия. Укажите период, по прошествии которого будут закрываться счета клиентов
period_type Тип периода
description Описание расхода
activeitem (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает закрытие счетов клиентов даже при наличии активных услуг
ga_counterGoogle Analytics Tracking ID
ga_userid (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает отправку в Google код клиента в качестве User ID
ga_type Тип экспорта. Строить экспорт по расходам или по услугам. По расходам — выгружается информация о всех расходах совершенных клиентами. По услугам — по каждой услуге заказанной клиентом выгрузка происходит только один раз, не зависимо от того сколько по ней было расходов
ga_trial(Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает возможность выгрузки информации о триальных услуги
recaptcha_type reCAPTCHA на форме регистрации. Настройка использования reCAPTCHA на форме регистрации для провайдера
recaptcha_publickey Публичный ключ сервиса reCAPTCHA
recaptcha_privatekey Секретный ключ сервиса reCAPTCHA
recaptcha_auth_type reCAPTCHA на форме авторизации. Настройка использования reCAPTCHA на форме авторизации для провайдера
recaptcha_auth_publickey Публичный ключ сервиса reCAPTCHA
recaptcha_auth_privatekey Секретный ключ сервиса reCAPTCHA
ym_counter Код счетчика. Id счетчика для Яндекс.Метрики
support_require (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает использование платных обращений в поддержку
new_account_count Количество новым клиентам. Количество доступных обращений в поддержку, начисляемое при подключении к провайдеру
first_payment_count Количество за первый платеж. Количество доступных обращений в поддержку, начисляемых за первый платеж
first_expense_count Количество за первое списание. Количество доступных обращений в поддержку, начисляемых за первое списание средств с лицевого счета
paid_amount_count Количество при оплате. Количество доступных обращений в поддержку, начисляемое при оплате
paid_amount_amount Сумма пополнения
support_over_limit (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция разрешает сотрудникам провайдера списывать с клиента обращения "в долг". При превышении лимита клиент не сможет писать сообщения в поддержку до погашения долга по обращениям

Включить

Функция: project.resume

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

Параметры:

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

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

Наименование

Функция: project.currency

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

Валюты доступные у провайдера

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

ПараметрЗначение
idId
name Наименование
iso ISO
status Состояние

Выключить

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

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

Параметры:

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

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

Включить

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

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

Параметры:

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

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

Изменить валюту для новых клиентов по умолчанию

Функция: project.currency.projectdefault

Изменить валюту для новых клиентов по умолчанию

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

Параметры:

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

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

Налоги

Функция: project.taxrule

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

Правила налогообложения

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

ПараметрЗначение
idId
company Компания
country Страна плательщика
taxrate Ставка налога
itemtypeТип продукта

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

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

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

Параметры:

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

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

Настройки налогообложения

Функция: project.taxrule.settings

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

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

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

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

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

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

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

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

ПараметрЗначение
taxexclusive (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включите параметр, если хотите, чтобы цены на товары/услуги увеличивались на величину налога. При этом нельзя будет использовать налоговые ставки с ограничением по компании в которую платит плательщик
taxcustompay (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отображать налог при авансовом пополнение счета. В некоторых странах это необходимо, в некоторых нет. Сверьтесь с системой налогообложения в вашей стране.

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

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

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

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

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

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

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

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

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

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

ПараметрЗначение
company Компания
country Страна плательщика. Выберите страну, для плательщиков которой будет действовать правило налогообложения
state Регион. Если используется двухуровневая система налогообложения, вы можете задать федеральный налог (все) и налог региона. Эти налоги будут суммироваться.
taxrate Ставка налога для выбранной страны
specialitemtype (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Налогообложению подвергаются не все типы продуктов
itemtype Типы продуктов. Укажите какие типы продуктов облагаются налогами

Выключить

Функция: project.suspend

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

Параметры:

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

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

Группы провайдеров

Функция: project.group

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

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

ПараметрЗначение
idId
name Группа
status Состояние

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

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

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

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

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

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

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

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

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

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

ПараметрЗначение
name Наименование
allow_same_phone (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция разрешает использовать для верификации учетной записи один и тот же номер телефона на разных учетных записях

Удаление группы

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

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

Параметры:

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

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

Выключить

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

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

Параметры:

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

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

Восстановление

Функция: project.group.resume_ext

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

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

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

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

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

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

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

Обслуживающие компании

Функция: project.company

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

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

ПараметрЗначение
idId
name Наименование
status Состояние

Включить

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

Включить

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

Параметры:

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

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

Выключить

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

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

Параметры:

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

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

Настройка взаимодействия провайдера и компании

Функция: project.company.edit

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

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

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

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

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

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

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

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

ПараметрЗначение
payment_description Назначение авансового платежа. Будет отображаться в качестве наименования авансового платежа в списке платежей

Провайдеры серверов имён

Функция: project.nsprovider

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

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

ПараметрЗначение
idId
name Наименование
status Состояние

Удалить

Функция: project.nsprovider.delete

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

Параметры:

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

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

Выключить

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

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

Параметры:

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

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

Редактирование провайдера серверов имён

Функция: project.nsprovider.edit

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

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

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

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

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

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

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

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

ПараметрЗначение
name Наименование провайдера серверов имён

Включить

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

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

Параметры:

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

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

Список типов продуктов

Функция: project.itemtype

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

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

  • name — Наименование
  • orderpriority — Приоритет

Переместить тип продукта на одну позицию вверх

Функция: project.itemtype.up

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

Переместить тип продукта на одну позицию вниз

Функция: project.itemtype.down

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