Договор - API3 Объект

Объект

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

Легенда:

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

Структура:

• Валюта — объект Валюта, валюта документа

• Вложение — массив, массив с данными файлов, прилагаемых к документу

• Идентификатор — строка, идентификатор файла в хранилище СБИС Диск
• Тип - строка, название типа формализованного вложения
• ПодТип - строка, название подтипа формализованного вложения
• ВерсияФормата - строка, версия формата
• ПодверсияФормата - строка, подверсия формата
• Файл
  • Имя

• ВнешнийИдентификатор — строка, внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей
• Дата* — строка в формате "ДД.ММ.ГГГГ", дата документа
• ЗапуститьЭДО — булево, признак необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается новый документ, действие на этапе не требует выбора ответственного или подписания. Актуально только для документов с фазами ЭДО
• ИдентификаторВИ — ПОЛЕ УСТАРЕЛО, использовать поле ВнешнийИдентификатор
• ИдентификаторДокумента — строка, идентификатор ЭДО
• Комментарий — строка, комментарий к документу
• Курс — число строкой, курс документа
• Название — строка, представление документа
• НашаОрганизация* — объект НашаОрганизация, организация документа
• Номер* — строка, номер документа

• Основание — массив, массив документов основания

• ВидСвязи — число строкой, код вида связи с документом-основания [1]
• Документ — объект документа-основания (любой объект с типом Документ)
• Сумма — число строкой, сумма связи в валюте учета
• СуммаВалютная — число строкой, сумма связи в валюте документа

• Ответственный — объект ЧастноеЛицо, ответственный за документ

• Параметры — массив, массив именованных параметров ключ / значение

• Значение — строка или объект, значение параметра
• Название — строка, название параметра
• Тип — строка, тип параметра [Текст, Многострочный текст, Число, Флаг, Логическое, Дата, Период, Время, Список, Группа флагов, Объект]

• Пометки — словарь, пометки по документу

• Проведён — Признак проведения документа, булево
• Важный — отметка Флажок на документе СБИС, булево
• Плюс — отметка Плюс на документе СБИС, булево
• Срочно — отметка Красный круг на документе СБИС, булево
• НеТребуется — отметка Зеленый круг на документе СБИС, булево
• Просмотрен — отметка Синий круг на документе СБИС, булево
• Значительный — отметка Желтый круг на документе СБИС, булево
• ЗакрытоОтИзменений — отметка серая галка на документе СБИС, булево

• Проведён — булево, признак необходимости провести документ. Актуально только для документов с движениями
• Регламент — строка, название регламента
• Состояние — число строкой, код состояния документа
• Сумма — число строкой, сумма документа
• СчетУчетаКонтрагент — объект ПоказательУчета, счет учета с контрагентом
• СчетУчетаАванс — объект ПоказательУчета, счет учета авансов
• Удалён — булево, признак удаленности документа. По умолчанию считаем что документ не помечен на удаление
• ГруппаРегламентов - строка, группа регламентов к которой относится регламент договора
• Контрагент* - объект Контрагент
• ОплатаВВалюте - булево, флаг проведения оплаты в валюте

Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону

Пример:

{
    "Валюта": {"ИдСБИС": "RUB"},
    "ВнешнийИдентификатор": "3f63c7a1-0e00-11e7-adce-080027358f3f",
    "Дата": "01.01.2025",
    "Комментарий": "full_case, версия 1",
    "НашаОрганизация": {"ИдСБИС": "258"},
    "Номер": "full_case1",
    "Регламент": "Договор",
    "Удалён": false,
    "Контрагент": {"ИдСБИС": "398"},
    "ОплатаВВалюте": false
}

Естественные ключи

• Ключ1 - номер документа + дата документа + контрагент + организация(вес = 3)
  • Ключ1_1 - строка, номер документа
  • Ключ1_2 - строка в формате "ДД.ММ.ГГГГ", дата документа
  • Ключ1_3 - строка, идентификатор организации
  • Ключ1_4 - строка, идентификатор контрагента
• Ключ2 - не используется
• Ключ3 - строка, идентификатор внешней системы

Зависит от объектов

• Контрагент
• НашаОрганизация

Используемые методы БЛ

• ДоговорДок.Прочитать
• ДоговорДок.Записать
• ДоговорДок.Создать
• ДоговорДок.СписокХраним