Шаблон:Документ! - API3 Объект — различия между версиями
(не показаны 3 промежуточные версии этого же участника) | |||
Строка 21: | Строка 21: | ||
* ВнешнийИдентификатор — строка, внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей | * ВнешнийИдентификатор — строка, внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей | ||
* Дата* — строка в формате "ДД.ММ.ГГГГ", дата документа | * Дата* — строка в формате "ДД.ММ.ГГГГ", дата документа | ||
− | * <span style="color:#077F0B">ЗапуститьЭДО</span> — булево, признак необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается '''новый''' документ, действие на этапе не требует выбора ответственного или подписания | + | * <span style="color:#077F0B">ЗапуститьЭДО</span> — булево, признак необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается '''новый''' документ, действие на этапе не требует выбора ответственного или подписания. Актуально только для документов с фазами ЭДО |
* <span style="color:#E70000">ИдентификаторВИ</span> — ПОЛЕ УСТАРЕЛО, использовать поле ВнешнийИдентификатор | * <span style="color:#E70000">ИдентификаторВИ</span> — ПОЛЕ УСТАРЕЛО, использовать поле ВнешнийИдентификатор | ||
* <span style="color:#E70000">ИдентификаторДокумента</span> — строка, идентификатор ЭДО | * <span style="color:#E70000">ИдентификаторДокумента</span> — строка, идентификатор ЭДО | ||
* Комментарий — строка, комментарий к документу | * Комментарий — строка, комментарий к документу | ||
− | * Курс — число, курс документа | + | * Курс — число строкой, курс документа |
* Название — строка, представление документа | * Название — строка, представление документа | ||
* НашаОрганизация* — объект [[НашаОрганизация_-_API3_Объект|НашаОрганизация]], организация документа | * НашаОрганизация* — объект [[НашаОрганизация_-_API3_Объект|НашаОрганизация]], организация документа | ||
Строка 32: | Строка 32: | ||
* Основание — массив, массив документов основания | * Основание — массив, массив документов основания | ||
<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_Объект|ЧастноеЛицо]], ответственный за документ | ||
Строка 41: | Строка 41: | ||
* Параметры — массив, массив именованных параметров ключ / значение | * Параметры — массив, массив именованных параметров ключ / значение | ||
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
− | :* Значение — строка, значение параметра | + | :* Значение — строка или объект, значение параметра |
:* Название — строка, название параметра | :* Название — строка, название параметра | ||
:* Тип — строка, тип параметра [Текст, Многострочный текст, Число, Флаг, Логическое, Дата, Период, Время, Список, Группа флагов, Объект] | :* Тип — строка, тип параметра [Текст, Многострочный текст, Число, Флаг, Логическое, Дата, Период, Время, Список, Группа флагов, Объект] | ||
Строка 57: | Строка 57: | ||
:* <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> — число, код состояния документа | + | * <span style="color:#E70000">Состояние</span> — число строкой, код состояния документа |
− | * Сумма — число, сумма документа | + | * Сумма — число строкой, сумма документа |
* СчетУчетаКонтрагент — объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]], счет учета с контрагентом | * СчетУчетаКонтрагент — объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]], счет учета с контрагентом | ||
* СчетУчетаАванс — объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]], счет учета авансов | * СчетУчетаАванс — объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]], счет учета авансов |
Текущая версия на 15:39, 29 апреля 2025
Объект
Тип: Документ
Легенда:
- Реквизиты черного цвета поддерживаются синхронизацией в обоих направлениях
- Реквизиты зеленого цвета поддерживаются синхронизацией только в СБИС
- Реквизиты красного цвета поддерживаются синхронизацией только из СБИС
Структура:
- Валюта — объект Валюта, валюта документа
развернуть
- Вложение — массив, массив с данными файлов, прилагаемых к документу
- ВнешнийИдентификатор — строка, внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей
- Дата* — строка в формате "ДД.ММ.ГГГГ", дата документа
- ЗапуститьЭДО — булево, признак необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается новый документ, действие на этапе не требует выбора ответственного или подписания. Актуально только для документов с фазами ЭДО
- ИдентификаторВИ — ПОЛЕ УСТАРЕЛО, использовать поле ВнешнийИдентификатор
- ИдентификаторДокумента — строка, идентификатор ЭДО
- Комментарий — строка, комментарий к документу
- Курс — число строкой, курс документа
- Название — строка, представление документа
- НашаОрганизация* — объект НашаОрганизация, организация документа
- Номер* — строка, номер документа
развернуть
- Основание — массив, массив документов основания
- Ответственный — объект ЧастноеЛицо, ответственный за документ
развернуть
- Параметры — массив, массив именованных параметров ключ / значение
развернуть
- Пометки — словарь, пометки по документу
- Проведён — булево, признак необходимости провести документ. Актуально только для документов с движениями
- Регламент — строка, название регламента
- Состояние — число строкой, код состояния документа
- Сумма — число строкой, сумма документа
- СчетУчетаКонтрагент — объект ПоказательУчета, счет учета с контрагентом
- СчетУчетаАванс — объект ПоказательУчета, счет учета авансов
- Удалён — булево, признак удаленности документа. По умолчанию считаем что документ не помечен на удаление