ВозвратОтПокупателя - API3 Объект

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

Объект

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

Легенда:

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


Структура:

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

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


Пример:

{
  "ИдИС": "ИдИС",
  "Номер": "update1update1",
  "Дата": "05.11.2020",
  "НашаОрганизация": {
    "ИдСБИС": "167"
  },
  "Контрагент": {
    "ИдСБИС": "488"
  },
  "Склад": {
    "ИдСБИС": "3240"
  },
  "Комментарий": "update++++++",
  "Регламент": "для unittest",
  "Параметры": [
    {
      "Название": "допполе1",
      "Значение": "тест"
    }
  ],
  "ТаблДок": [
    {
      "Номенклатура": {
        "ИдСБИС": "2"
      },
      "Количество": "88.0",
      "Цена": "500.00",
      "Параметры": [
        {
          "Название": "допполе2",
          "Значение": "тест"
        }
      ]
    },
    {
      "Номенклатура": {
        "ИдСБИС": "13"
      },
      "Количество": "99.0",
      "Цена": "1000.00"
    }
  ]
}

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

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


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

  • НашаОрганизация
  • Номенклатура
  • Склад
  • Контрагент

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