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

Материал из razgovorov.ru
Перейти к: навигация, поиск
(Новая страница: « ===Объект=== Тип: Документ '''Легенда:''' * <span style="color:#000000">Реквизиты черного цвета поддержив…»)
 
(не показано 28 промежуточных версий 4 участников)
Строка 3: Строка 3:
 
Тип: Документ
 
Тип: Документ
  
−
'''Легенда:'''
+
{{Легенда_-_API3_Объект}}
−
* <span style="color:#000000">Реквизиты черного цвета поддерживаются синхронизацией в обоих направлениях</span>
+
 
−
* <span style="color:#077F0B">Реквизиты зеленого цвета поддерживаются синхронизацией только в СБИС</span>
 
−
* <span style="color:#0000FF">Реквизиты синего цвета поддерживаются синхронизацией только из СБИС</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> — булево, признак необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается '''новый''' документ, действие на этапе не требует выбора ответственного или подписания. Актуально только для документов с фазами ЭДО
−
* Основание - массив
+
* <span style="color:#E70000">ИдентификаторВИ</span> — ПОЛЕ УСТАРЕЛО, использовать поле ВнешнийИдентификатор
−
** Документ - объект документа-основания
+
* <span style="color:#E70000">ИдентификаторДокумента</span> — строка, идентификатор ЭДО
−
** ВидСвязи - вид связи с документом-основания
+
* Комментарий — строка, комментарий к документу
−
* <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> - булевская величина
+
:* ВидСвязи — число строкой, код вида связи с документом-основания [https://wi.sbis.ru/doc/edo/edo-platform/work-with-docs/doc-card/linked-docs/]
−
** <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">
 +
* Параметры — массив, массив именованных параметров ключ / значение
 +
<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> — отметка серая галка на документе СБИС, булево
 +
</div></div>
 +
* <span style="color:#077F0B">Проведён</span> — булево, признак необходимости провести документ. Актуально только для документов с движениями
 +
* Регламент — строка, название регламента
 +
* <span style="color:#E70000">Состояние</span> — число строкой, код состояния документа
 +
* Сумма — число строкой, сумма документа
 +
* СчетУчетаКонтрагент — объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]], счет учета с контрагентом
 +
* СчетУчетаАванс — объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]], счет учета авансов
 +
* Удалён — булево, признак удаленности документа. По умолчанию считаем что документ не помечен на удаление
 +
 
 +
[[Категория:SBIS API3 Объект]]

Версия 17:51, 15 апреля 2025

Объект

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

Легенда:

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


Структура:

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