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

Валюты (currency)

currency

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

Валюты

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

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

Отношения валют

Функция: currency.relate

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

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

ПараметрЗначение
relate Наименование
isoКод
ratedate Дата последнего обновления
rate Текущий курс
status Автоматическая загрузка валют

Динамика курса

Функция: currencyrate

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

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

ПараметрЗначение
idId
ratedate Дата
rate Курс

Значение курса

Функция: currencyrate.edit

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

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

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

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

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

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

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

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

ПараметрЗначение
ratedate Дата с которой действует курс
amount Количество единиц базовой валюты, за которое указан курс конвертации
rate Значение курса влюты на указанную дату за указанное количество единиц

Удалить

Функция: currencyrate.delete

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

Параметры:

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

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

Загрузка курса валют

Функция: currencyrate.upload

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

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

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

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

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

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

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

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

ПараметрЗначение
autoupload Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Курс валют будет загружаться автоматически в указанное время
autotime Время загрузки. Время загрузки указывается в формате чч:мм. Задание обновления курса валют будет запускаться каждый день в указанное время
upload Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Будет запущен процесс обновления курса валют с указанными параметрами
multi Поправочный коэффициент. Умножить загруженный курс на значение указанное в данном поле
sum Увеличить на. Увеличить загруженный курс на значение указанное в данном поле
fromdate С даты. Будут загружены данные начиная с указанной даты. Если значение не указано, загрузка будет произведена начиная с даты последнего обновления курсов валюты
rewrite Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Опция включает перезапись значений уже сохраненных в системе при совпадении даты

Включить

Функция: currency.resume

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

Параметры:

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

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

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

Функция: currency.edit

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

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

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

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

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

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

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

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

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

ПараметрЗначение
name Наименование валюты
isoISO код
symbol UTF символ валюты
code ISO номер

Выключить

Функция: currency.suspend

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

Параметры:

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

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

Обновление курсов валют

Функция: currency.upload

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

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

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

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

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

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

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

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

Удалить

Функция: currency.delete

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

Параметры:

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

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