Лид - API3 Объект

Объект

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

Легенда:

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

Структура:

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

развернуть

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

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

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

развернуть

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

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

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

развернуть

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

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

развернуть

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

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

• Проведён — булево, признак необходимости провести документ. Актуально только для документов с движениями
• Регламент — строка, название регламента
• Состояние — число строкой, код состояния документа
• Сумма — число строкой, сумма документа
• СчетУчетаКонтрагент — объект ПоказательУчета, счет учета с контрагентом
• СчетУчетаАванс — объект ПоказательУчета, счет учета авансов
• Удалён — булево, признак удаленности документа. По умолчанию считаем что документ не помечен на удаление
• Контрагент — объект Контрагент
• КонтрагентФизическоеЛицо — объект КонтрагентФизическоеЛицо
• События. Массив объектов вида:
  • Название - название перехода (строка)
  • Дата - дата перехода (строка в формате "ДД.ММ.ГГГГ")
  • Время - время перехода (строка в формате "ЧЧ:ММ")
  • Этап - название этапа (строка)
  • Исполнитель - объект ЧастноеЛицо
  • Комментарий - комментарий к переходу (строка)

Пример:

{
  "ИдИС": "7cf838b6-f9e6-11e7-ad08-3497f6377b7e",
  "Номер": "00000000001",
  "Дата": "15.01.2018",
  "НашаОрганизация": {
    "ИдИС": "56c61dec-e570-11e3-893a-005056c00008",
    "ИмяСБИС": "НашаОрганизация"
  },
  "Контрагент": {
    "ИдИС": "b9321b89-2648-11e6-ab23-080027358f3f",
    "ИмяСБИС": "Контрагент"
  },
  "Ответственный": {
    "ИдИС": "30b64f32-9102-4ba3-896d-cf60f1535c4f",
    "ИмяСБИС": "ЧастноеЛицо"
  },
  "Регламент": "Заключение договора"
  "События": [
    {
      "Название": "Первичный контакт",
      "Дата": "11.01.2020",
      "Время": "15:15",
      "Этап": "Звонок",
      "Исполнитель": {
        "ИдИС": "30b64f32-9102-4ba3-896d-cf60f1535c4f",
        "ИмяСБИС": "ЧастноеЛицо"
      },
      "Комментарий": "Не дозвонился"
    }
  ]
}

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

• Ключ1 — номер документа + дата документа + организация + контрагент (вес = 3)
  • Ключ1_1 — номер документа
  • Ключ1_2 — дата документа
  • Ключ1_3 — идентификатор организации в ИС
  • Ключ1_4 — идентификатор контрагента в ИС
• Ключ2 — не используется
• Ключ3 — не используется

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

• Контрагент
• КонтрагентФизическоеЛицо
• ТемаОтношений
• ЧастноеЛицо

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

• Документ.ОтменитьПроведение
• Документ.Провести