Шаблон:SyncDoc - API3 Объект

Материал из razgovorov.ru
Перейти к: навигация, поиск

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

Это общий шаблон документа. Он гибкий и настраивается параметрами. По умолчанию он отображает все поля, которые есть на SyncDoc. Если для вашего объекта поведение изменено, то используйте параметры: Нет[ИмяПоля] - булево, скрывает поле; Обязательность[ИмяПоля] - булево, выводит значок обязательности поля; Цвет[ИмяПоля] - строка, название цвета;


Объект

Тип: Документ

Структура

Общие для документов поля

  • Вложение — массив, массив с данными файлов, прилагаемых к документу
  • Идентификатор — строка, идентификатор файла в хранилище СБИС Диск
  • Тип - строка, название типа формализованного вложения
  • ПодТип - строка, название подтипа формализованного вложения
  • ВерсияФормата - строка, версия формата
  • ПодверсияФормата - строка, подверсия формата
  • Файл
    • Имя

  • ВнешнийИдентификатор — строка, внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей

  • Дата * — строка в формате "ДД.ММ.ГГГГ", дата документа

  • ЗапуститьЭДО — булево, признак необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается новый документ, действие на этапе не требует выбора ответственного или подписания. Актуально только для документов с фазами ЭДО

  • ИдентификаторВИ — ПОЛЕ УСТАРЕЛО, использовать поле ВнешнийИдентификатор

  • ИдентификаторДокумента — строка, идентификатор ЭДО

  • Комментарий — строка, комментарий к документу

  • Курс — число строкой, курс документа

  • Название — строка, представление документа

  • Номер * — строка, номер документа

  • Основание — массив, массив документов основания
  • ВидСвязи — число строкой, код вида связи с документом-основания [1]
  • Документ — объект документа-основания (любой объект с типом Документ)
  • Сумма — число строкой, сумма связи в валюте учета
  • СуммаВалютная — число строкой, сумма связи в валюте документа

  • Ответственный — объект ЧастноеЛицо, ответственный за документ

  • Параметры — массив, дополнительные параметры
  • Значение — строка или объект, значение параметра
  • Название — строка, название параметра
  • Тип — строка, тип параметра [Текст, Многострочный текст, Число, Флаг, Логическое, Дата, Период, Время, Список, Группа флагов, Объект]

  • Пометки — словарь, пометки по документу
  • Проведён — булево, признак проведения документа
  • Важный — булево, отметка Флажок на документе СБИС
  • Плюс — булево, отметка Плюс на документе СБИС
  • Срочно — булево, отметка Красный круг на документе СБИС
  • НеТребуется — булево, отметка Зеленый круг на документе СБИС
  • Просмотрен — булево, отметка Синий круг на документе СБИС
  • Значительный — булево, отметка Желтый круг на документе СБИС
  • ЗакрытоОтИзменений — булево, отметка серая галка на документе СБИС

  • Проведён — булево, признак необходимости провести документ. Актуально только для документов с движениями

  • Регламент — строка, название регламента

  • Состояние — число строкой, код состояния документа

  • Сумма — число строкой, сумма документа

  • Удалён — булево, признак удаленности документа. По умолчанию считаем что документ не помечен на удаление