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

Объект

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

Структура

Общие для документов поля

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

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

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

• ВнешнийИдентификатор — строка, внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей

• Дата — строка в формате "ДД.ММ.ГГГГ", дата документа

• ИдентификаторВИ — ПОЛЕ УСТАРЕЛО, использовать поле ВнешнийИдентификатор

• ИдентификаторДокумента — строка, идентификатор ЭДО

• Комментарий — строка, комментарий к документу

• Курс — число строкой, курс документа

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

• НашаОрганизация * — объект НашаОрганизация, организация документа

• Номер — строка, номер документа

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

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

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

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

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

• Регламент — строка, название регламента

• Сумма — число строкой, сумма документа

• Удалён — булево, признак удаленности документа. По умолчанию считаем что документ не помечен на удаление

Уникальные поля

• ГруппаРегламентов - строка, группа регламентов к которой относится регламент договора
• Контрагент* - объект Контрагент
• ОплатаВВалюте - булево, флаг проведения оплаты в валюте

Объем данных возвращаемых методом 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 - строка, идентификатор внешней системы

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

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

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

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