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