ПользовательскийДокумент - API3 Объект — различия между версиями
Строка 1: | Строка 1: | ||
{{Документ!_-_API3_Объект}} | {{Документ!_-_API3_Объект}} | ||
* <span style="color:#077F0B">ПодТип*</span> — подтип пользовательского документа (для совместимости ищем сначала ПодТип, потом ПодТипДокумента) | * <span style="color:#077F0B">ПодТип*</span> — подтип пользовательского документа (для совместимости ищем сначала ПодТип, потом ПодТипДокумента) | ||
+ | * Контрагент* — объект [[Контрагент_-_API3_Объект|Контрагент]] | ||
'''Пример:''' | '''Пример:''' |
Текущая версия на 15:47, 15 октября 2024
Объект
Тип: Документ
Легенда:
- Реквизиты черного цвета поддерживаются синхронизацией в обоих направлениях
- Реквизиты зеленого цвета поддерживаются синхронизацией только в СБИС
- Реквизиты красного цвета поддерживаются синхронизацией только из СБИС
Структура:
- Автор — объект ЧастноеЛицо
- Вложение — массив с данными файлов, прилагаемых к документу
- Дата* — дата документа, строка в формате "ДД.ММ.ГГГГ"
- ЗапуститьЭДО — флаг необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается новый документ, действие на этапе не требует выбора ответственного или подписания, булево
- Идентификатор — идентификатор файла в хранилище СБИС Диск
- Файл
- Имя
- ВнешнийИдентификатор — внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей
- ИдИС — идентификатор документа в ИС, строка
- ИдСБИС — идентификатор документа в СБИС, строка
- ИмяСБИС — имя api3 объекта
- Комментарий — строка
- Название — представление объекта
- НашаОрганизация* — объект НашаОрганизация
- Номер* — номер документа, строка
- Основание — список объектов документы основания (массив)
- ВидСвязи — вид связи с документом-основания
- Документ — объект документа-основания
- Сумма — сумма связи
- Ответственный — объект ЧастноеЛицо
- Параметры — массив именованных параметров ключ / значение
- Значение — значение параметра, строка
- Название — название параметра, строка
- Тип — тип параметра [Текст, Многострочный текст, Число, Флаг, Логическое, Дата, Период, Время, Список, Группа флагов, Объект], строка
- Пометки — пометки по документу
- Проведён — Признак проведения документа, булево
- Удалён — Признак перемещения документа в удаленные, булево
- Важный — отметка Флажок на документе СБИС, булево
- Плюс — отметка Плюс на документе СБИС, булево
- Срочно — отметка Красный круг на документе СБИС, булево
- НеТребуется — отметка Зеленый круг на документе СБИС, булево
- Просмотрен — отметка Синий круг на документе СБИС, булево
- Значительный — отметка Желтый круг на документе СБИС, булево
- ЗакрытоОтИзменений — отметка серая галка на документе СБИС, булево
- Провести — флаг необходимости провести документ. Документы проводятся в СБИС по умолчанию, булево
- Удалён — признак удаленности документа в ИС. По умолчанию считаем что документ не помечен на удаление, булево
- Регламент — название регламента, строка
- Состояние — код состояния документа
- СчетУчетаКонтрагент — объект ПоказательУчета
- СчетУчетаАванс — объект ПоказательУчета
- ПодТип* — подтип пользовательского документа (для совместимости ищем сначала ПодТип, потом ПодТипДокумента)
- Контрагент* — объект Контрагент
Пример:
{
"ИдИС": "7cf838b6-f9e6-11e7-ad08-3497f6377b7e",
"ИдСБИС": "54565",
"Номер": "00000000001",
"Дата": "15.01.2018",
"Комментарий": "Текст комментария",
"НашаОрганизация": {
"ИдИС": "b9321b89-2648-11e6-ab23-080027358f3f",
"ИмяСБИС": "НашаОрганизация"
},
"Контрагент": {
"ИдИС": "b9321b88-2648-11e6-ab23-080027358f3f",
"ИмяСБИС": "Контрагент"
},
"ПодТип": "БухгалтерскаяСправка"
}
Естественные ключи
- Ключ1 — номер документа + дата документа + организация + контрагент(вес = 3)
- Ключ1_1 — номер документа
- Ключ1_2 — дата документа
- Ключ1_3 — идентификатор организации в ИС
- Ключ1_4 — идентификатор контрагента в ИС
- Ключ2 — не используется
- Ключ3 — не используется
Зависит от объектов
- НашаОрганизация
- Контрагент