Взаимозачет - API3 Объект

Материал из razgovorov.ru
Перейти к: навигация, поиск

Объект

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

Легенда:

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


Структура:

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

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


Пример:

{
  "ИдСБИС": "25316",
  "ИдИС": "ИдИС",
  "Номер": "3test",
  "Дата": "12.11.2020",
  "НашаОрганизация": {
    "ИдСБИС": "167"
  },
  "Контрагент": {
    "ИдСБИС": "12362"
  },
  "Комментарий": "Обновление (+)",
  "Регламент": "Взаимозачет"
  "СуммыДолга": [{
      "ДокументРасчетов": {
        "ИдСБИС": "1234"
      },
      "Сумма": "1000.99"
    }
  ]
}

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

  • Ключ1 -
    • Ключ1_1 - номер документа
    • Ключ1_2 - дата документа
    • Ключ1_3 - идентификатор организации
    • Ключ1_4 - идентификатор контрагента
  • Ключ2 - не используется
  • Ключ3 - не используется


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

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

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

  • MutualOffsetReal.RemoveAllLinks
  • PaymentLinking.LinkDocuments
  • MutualOffsetReal.LinkedDocsList
  • ОплаченныйСчет.Прочитать
  • MutualOffset.UpdateInnerLink