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