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

Документооборот (docflow_connection)

docflow_connection

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

Документооборот

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

ПараметрЗначение
idId
company Компания
module Модуль подключения

Удалить

Функция: docflow_connection.delete

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

Параметры:

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

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

Отправить документы. Получить статусы отправленных документов

Функция: docflow_connection.doc_sync

Отправить документы стоящие в очереди на отправку, а так же получить статусы уже отправленных документов

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

Параметры:

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

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

Плательщик

Функция: docflow_connection.counteragent

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

Список контрагентов

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

ПараметрЗначение
idId
name Плательщик
vatnum ИНН
status Состояние

Выключить

Функция: docflow_connection.counteragent.suspend

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

Параметры:

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

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

Включить

Функция: docflow_connection.counteragent.resume

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

Параметры:

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

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


Функция: docflow_connection.counteragent.docflow_box

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

Загрузка списка контрагентов

Функция: docflow_connection.customer_search_all

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

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

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

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

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

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

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

Обновление списка контрагентов

Функция: docflow_connection.customer_sync_all

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

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

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

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

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

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

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

Ящики

Функция: docflow_connection.docflow_box

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

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

ПараметрЗначение
idId
name Наименование
box_id Код ящика
status Состояние

Включить

Функция: docflow_connection.docflow_box.resume

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

Параметры:

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

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

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

Функция: docflow_connection.edit

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

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

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

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

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

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

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

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

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

ПараметрЗначение
profile Компания подключенная к электронному документообороту
module Модуль подключения к электронному документообороту
document_type Тип документов. Тип отправляемых документов по умолчанию
group_items Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Позиции УПД будут сгруппированы по тарифному плану, периоду оплаты и сумме позиции
autoassign Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Автоматически искать в системе электронного документооборота плательшика при подключении к компании

Создать

Функция: docflow_connection.add

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