Шаблон:Документ! - API3 Объект — различия между версиями

Материал из razgovorov.ru
Перейти к: навигация, поиск
(Новая страница: « ===Объект=== Тип: Документ '''Легенда:''' * <span style="color:#000000">Реквизиты черного цвета поддержив…»)
 
 
(не показаны 22 промежуточные версии 4 участников)
Строка 3: Строка 3:
 
Тип: Документ
 
Тип: Документ
  
−
'''Легенда:'''
+
{{Легенда_-_API3_Объект}}
−
* <span style="color:#000000">Реквизиты черного цвета поддерживаются синхронизацией в обоих направлениях</span>
+
 
−
* <span style="color:#077F0B">Реквизиты зеленого цвета поддерживаются синхронизацией только в СБИС</span>
 
−
* <span style="color:#0000FF">Реквизиты синего цвета поддерживаются синхронизацией только из СБИС</span>
 
  
 
'''Структура:'''
 
'''Структура:'''
−
* ИдИС  - идентификатор документа в ИС (строка)
+
* <span style="color:#E70000">Автор</span> — объект [[ЧастноеЛицо_-_API3_Объект|ЧастноеЛицо]]
−
* Номер* - номер документа (строка)
+
<div class="mw-collapsible mw-collapsed">
−
* Дата* - дата документа (строка в формате "ДД.ММ.ГГГГ")
+
* Вложение — массив с данными файлов, прилагаемых к документу
−
* НашаОрганизация* - объект [[НашаОрганизация_-_API3_Объект|НашаОрганизация]]
+
<div class="mw-collapsible-content">
−
* Регламент - строка, название регламента
+
:* Идентификатор — идентификатор файла в хранилище СБИС Диск
−
* Комментарий - строка
+
:* Тип - строка, название типа [https://sbis.ru/help/integration/catalog/guide#3 формализованного вложения]
−
* Сумма - сумма документа (для документов, где данная информация имеется по контексту)
+
:* ПодТип - строка, название подтипа формализованного вложения
−
* СуммаВалютная - сумма валютная документа (для документов, где данная информация имеется по контексту)
+
:* ВерсияФормата - строка, версия формата
−
* Валюта - объект [[Валюта_-_API3_Объект|Валюта]] (для документов, где данная информация имеется по контексту)
+
:* ПодверсияФормата - строка, подверсия формата
−
* Ответственный - объект [[ЧастноеЛицо_-_API3_Объект|ЧастноеЛицо]]
+
:* Файл
−
* СчетУчетаКонтрагент - объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]]
+
:** Имя
−
* СчетУчетаАванс - объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]]
+
</div></div>
−
* Параметры - массив
+
* Дата* — дата документа, строка в формате "ДД.ММ.ГГГГ"
−
** Название - строка, название параметра
+
* <span style="color:#077F0B">ЗапуститьЭДО</span> — флаг необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается '''новый''' документ, действие на этапе не требует выбора ответственного или подписания, булево
−
** Значение - строка, значение параметра
+
* ВнешнийИдентификатор — внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей
−
* Основание - массив
+
* ИдИС — идентификатор документа в ИС, строка
−
** Документ - объект документа-основания
+
* ИдСБИС — идентификатор документа в СБИС, строка
−
** ВидСвязи - вид связи с документом-основания
+
* ИмяСБИС — имя api3 объекта
−
* <span style="color:#0000FF">Идентификатор</span> - ИдентификаторВИ
+
* Комментарий — строка
−
* <span style="color:#0000FF">Состояние</span> - код состояния документа
+
* Название — представление объекта
−
* <span style="color:#0000FF">Автор</span> - объект [[ЧастноеЛицо_-_API3_Объект|ЧастноеЛицо]]
+
* НашаОрганизация* — объект [[НашаОрганизация_-_API3_Объект|НашаОрганизация]]
−
* <span style="color:#0000FF">Название</span> - текст названия документа
+
* Номер* — номер документа, строка
−
* <span style="color:#0000FF">Пометки</span> - словарь
+
<div class="mw-collapsible mw-collapsed">
−
** <span style="color:#0000FF">Проведён</span> - булевская величина
+
* Основание — список объектов документы основания (массив)
−
** <span style="color:#0000FF">Удалён</span> - булевская величина
+
<div class="mw-collapsible-content">
−
** <span style="color:#0000FF">Важный</span> - булевская величина
+
:* ВидСвязи — вид связи с документом-основания
−
** <span style="color:#0000FF">Плюс</span> - булевская величина
+
:* Документ — объект документа-основания
−
** <span style="color:#0000FF">Срочно</span> - булевская величина
+
:* Сумма — сумма связи
−
** <span style="color:#0000FF">НеТребуется</span> - булевская величина
+
</div></div>
−
** <span style="color:#0000FF">Просмотрен</span> - булевская величина
+
* Ответственный — объект [[ЧастноеЛицо_-_API3_Объект|ЧастноеЛицо]]
−
** <span style="color:#0000FF">Значительный</span> - булевская величина
+
<div class="mw-collapsible mw-collapsed">
−
** <span style="color:#0000FF">ЗакрытоОтИзменений</span> - булевская величина
+
* Параметры — массив именованных параметров ключ / значение
 +
<div class="mw-collapsible-content">
 +
:* Значение — значение параметра, строка
 +
:* Название — название параметра, строка
 +
:* Тип — тип параметра [Текст, Многострочный текст, Число, Флаг, Логическое, Дата, Период, Время, Список, Группа флагов, Объект], строка
 +
</div></div>
 +
<div class="mw-collapsible mw-collapsed">
 +
* <span style="color:#E70000">Пометки</span> — пометки по документу
 +
<div class="mw-collapsible-content">
 +
:* <span style="color:#E70000">Проведён</span> — Признак проведения документа, булево
 +
:* <span style="color:#E70000">Удалён</span> — Признак перемещения документа в удаленные, булево
 +
:* <span style="color:#E70000">Важный</span> — отметка Флажок на документе СБИС, булево
 +
:* <span style="color:#E70000">Плюс</span> — отметка Плюс на документе СБИС, булево
 +
:* <span style="color:#E70000">Срочно</span> — отметка Красный круг на документе СБИС, булево
 +
:* <span style="color:#E70000">НеТребуется</span> — отметка Зеленый круг на документе СБИС, булево
 +
:* <span style="color:#E70000">Просмотрен</span> — отметка Синий круг на документе СБИС, булево
 +
:* <span style="color:#E70000">Значительный</span> — отметка Желтый круг на документе СБИС, булево
 +
:* <span style="color:#E70000">ЗакрытоОтИзменений</span> — отметка серая галка на документе СБИС, булево
 +
</div></div>
 +
* <span style="color:#077F0B">Провести</span> — флаг необходимости провести документ. Документы проводятся в СБИС по умолчанию, булево
 +
* <span style="color:#077F0B">Удалён</span> — признак удаленности документа в ИС. По умолчанию считаем что документ не помечен на удаление, булево
 +
* Регламент — название регламента, строка
 +
* <span style="color:#E70000">Состояние</span> — код состояния документа
 +
* СчетУчетаКонтрагент — объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]]
 +
* СчетУчетаАванс — объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]]
 +
 
 +
[[Категория:SBIS API3 Объект]]

Текущая версия на 22:06, 25 ноября 2024

Объект

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

Легенда:

  • Реквизиты черного цвета поддерживаются синхронизацией в обоих направлениях
  • Реквизиты зеленого цвета поддерживаются синхронизацией только в СБИС
  • Реквизиты красного цвета поддерживаются синхронизацией только из СБИС


Структура:

  • Вложение — массив с данными файлов, прилагаемых к документу
  • Идентификатор — идентификатор файла в хранилище СБИС Диск
  • Тип - строка, название типа формализованного вложения
  • ПодТип - строка, название подтипа формализованного вложения
  • ВерсияФормата - строка, версия формата
  • ПодверсияФормата - строка, подверсия формата
  • Файл
    • Имя
  • Дата* — дата документа, строка в формате "ДД.ММ.ГГГГ"
  • ЗапуститьЭДО — флаг необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается новый документ, действие на этапе не требует выбора ответственного или подписания, булево
  • ВнешнийИдентификатор — внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей
  • ИдИС — идентификатор документа в ИС, строка
  • ИдСБИС — идентификатор документа в СБИС, строка
  • ИмяСБИС — имя api3 объекта
  • Комментарий — строка
  • Название — представление объекта
  • НашаОрганизация* — объект НашаОрганизация
  • Номер* — номер документа, строка
  • Основание — список объектов документы основания (массив)
  • ВидСвязи — вид связи с документом-основания
  • Документ — объект документа-основания
  • Сумма — сумма связи
  • Параметры — массив именованных параметров ключ / значение
  • Значение — значение параметра, строка
  • Название — название параметра, строка
  • Тип — тип параметра [Текст, Многострочный текст, Число, Флаг, Логическое, Дата, Период, Время, Список, Группа флагов, Объект], строка
  • Пометки — пометки по документу
  • Проведён — Признак проведения документа, булево
  • Удалён — Признак перемещения документа в удаленные, булево
  • Важный — отметка Флажок на документе СБИС, булево
  • Плюс — отметка Плюс на документе СБИС, булево
  • Срочно — отметка Красный круг на документе СБИС, булево
  • НеТребуется — отметка Зеленый круг на документе СБИС, булево
  • Просмотрен — отметка Синий круг на документе СБИС, булево
  • Значительный — отметка Желтый круг на документе СБИС, булево
  • ЗакрытоОтИзменений — отметка серая галка на документе СБИС, булево
  • Провести — флаг необходимости провести документ. Документы проводятся в СБИС по умолчанию, булево
  • Удалён — признак удаленности документа в ИС. По умолчанию считаем что документ не помечен на удаление, булево
  • Регламент — название регламента, строка
  • Состояние — код состояния документа
  • СчетУчетаКонтрагент — объект ПоказательУчета
  • СчетУчетаАванс — объект ПоказательУчета
Источник — «http://wiki.razgovorov.ru/index.php?title=Шаблон:Документ!_-_API3_Объект&oldid=6916»