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

Компании (company)

company

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

Компании

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

ПараметрЗначение
idId
name Наименование

Создать

Функция: company.add

Создать

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

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

Функция: company.project

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

Обслуживаемые провайдеры

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

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

Включить

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

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

Параметры:

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

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

Выключить

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

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

Параметры:

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

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

Образцы договоров

Функция: company.contract

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

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

ПараметрЗначение
idId
name Наименование
contracttypeТип договора
doctmpl_name Шаблон

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

Функция: company.contract.appendix

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

Образцы приложения для договора

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

ПараметрЗначение
idId
name Наименование
doctmpl_name

Редактирование образца приложения

Функция: company.contract.appendix.edit

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

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

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

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

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

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

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

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

ПараметрЗначение
name Наименование образца приложения к договору
project Провайдер. При наличие услуг у выбранного провайдера у клиента появится приложение
itemtype Тип продукта. При наличии услуг выбранного типа у клиента появится данное приложение
nocheck (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отключает необходимость наличия услуг указанного типа у клиента, для генерации приложения к договору
doctmpl Шаблон. Шаблон приложения к договору. Создается и редактируется в резделе 'Шаблоны документов'

Удалить

Функция: company.contract.appendix.delete

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

Параметры:

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

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

Редактирование образца договора

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

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

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

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

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

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

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

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

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

ПараметрЗначение
name Вид договора. Наименование вида образца договора
contracttype Тип договора
accepttype Порядок принятия и отображения оферты клиентом
itemtype Типы продуктов. Договор будет предложен для подписания, если у клиента будут услуги соответствующих типов
accountgroup Группа клиентов, которой будет доступен данный договор
profiletype Юридический статус плательщика
doctmplШаблон договора. Создается и редактируется в резделе 'Шаблоны документов'
suffix Суффикс в номере договора. Добавляется к номеру договора при его создании. Номер договора формируется в виде КОД_ПЛАТЕЛЬШИКА + СУФФИКС. Т.е. для плательщика с кодом 1 при суффиксе '/договор', номер договора будет выглядеть как '1/договор'
start_date Дата начала действия. Дата, с которой вступает в силу договор. Срок действия договора с клиентом выбирается по наибольшему значению: дата создания плательщика клиета в BILLmanager, дата основания компании, для которой создан образец договора, дата начала действия договора
end_dateДата окончания действия. После указанной даты договор перестанет генерироваться клиентам автоматически

Удалить

Функция: company.contract.delete

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

Параметры:

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

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

Удалить

Функция: company.delete

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

Параметры:

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

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

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

Функция: company.edit

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

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

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

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

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

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

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

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

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

ПараметрЗначение
name Наименование компании
email Основной Email компании
www URL сайта компании. Может быть использован в шаблонах печати документов
faxНомер факса
phone Контактный номер телефона
payment_description Назначение авансового платежа. Будет отображаться в качестве наименования авансового платежа в списке платежей
country_legalСтрана регистрации компании
state_legal Регион регистрации компании
postcode_legal Индекс, по адресу регистрации компании
city_legal Город регистрации компании
address_legal Адрес регистрации компании. Включает в себя улицу, дом и номер офиса при наличии
country_physical Страна физического размещения
state_physical Регион физического размещения
postcode_physical Индекс для физического адреса размещения
city_physical Город физического размещения
address_physical Адрес физического размещения. Включает в себя улицу, дом и номер офиса/квартиры при наличии
regdate Дата основания компании
locale Локализация документов. Язык, на котором выписываются документы
doctmpl_payment Шаблон печати счета, выставленного компанией. Может быть переопределен в настройках метода оплаты
numtmpl_paymentШаблон номера счета. Шаблон формирования номера счета, можно использовать макросы {id} — код платежа и {num} — порядковый номер платежа, получателем которого является компания. При отсутствии обоих макросов в шаблоне номера счета к шаблону будет добавлен макрос {num}
nextnum_paymentСледующий порядковый номер платежа, получаетелем которого является компания. Учитывается только при условии заполнения шаблона номера счета и не заполненном шаблоне у метода оплаты
doctmpl_invoiceШаблон акта. Шаблон печати акта выполненых работ, выставленного компанией
numtmpl_invoice Шаблон номера акта. Шаблон формирования номера акта, можно использовать макросы {id} — код акта и {num} — порядковый номер акта, выписанного от имени компании. При отсутствии обоих макросов в шаблоне номера счета к шаблону будет добавлен макрос {num}
nextnum_invoice Следующий порядковый номер акта. Следующий порядковый номер акта, выписанного от имени компании. Учитывается только при условии заполнения шаблона номера акта
doctmpl_envelope Шаблон конверта. Шаблон печати конверта для отправки корреспонденции
doctmpl_reconciliation Шаблон акта сверки. Выберите шаблон акта сверки. Создать или отредактировать его можно в меню "Шаблоны документов". Если не задать шаблон, то клиентам будет недоступна возможность создания акта сверки.
sendcostcurrency Валюта стоимости отправки документов. Укажите валюту, в которой указана стоимость отправки актов сверки.
sendcost Стоимость отправки акта сверки почтой. На указанную сумму при отправке акта будет создан расход