ВозвратОтПокупателя - API3 Объект — различия между версиями

Материал из razgovorov.ru
Перейти к: навигация, поиск
(Новая страница: «===Объект=== Тип: Документ '''Структура:''' * Дата* - дата документа * Номер* - номер документа *…»)
 
 
(не показаны 3 промежуточные версии этого же участника)
Строка 1: Строка 1:
===Объект===
+
{{ДокументПродаж_-_API3_Объект}}
Тип: Документ
+
* Грузоотправитель — объект [[Контрагент_-_API3_Объект|Контрагент]]
 
+
* Грузополучатель — объект [[Контрагент_-_API3_Объект|Контрагент]]
'''Структура:'''
+
* ТаблДок — данные о номенклатуре документа
* Дата* - дата документа
+
** ЕдИзм — объект [[ЕдиницаИзмерения_-_API3_Объект|ЕдиницаИзмерения]] (для документов, где данная информация имеется по контексту)
* Номер* - номер документа
+
** Количество
* НашаОрганизация* - объект склад [[НашаОрганизация_-_API3_Объект|НашаОрганизация]])
+
** Номенклатура — объект [[Номенклатура_-_API3_Объект|Номенклатура]]
* Контрагент* - объект склад [[Контрагент_-_API3_Объект|Контрагент]])
+
** НомСредИдентТов — массив маркировок (для документов, где данная информация имеется по контексту)
* Склад - объект [[Склад_-_API3_Объект|Склад]]
+
*** КИЗ
* Регламент - имя регламента
+
*** НомУпак
* Комментарий - комментарий
+
*** Состав — состав, массив
* Параметры
+
*** Статус
** Название
+
** Параметры — массив именованных параметров ключ / значение
** Значение
+
*** Значение — строка, значение параметра
 
+
*** Название — строка, название параметра
* ТаблДок - данные о номенклатуре документа
+
** <span style="color:#E70000">Показатель</span> — объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]]
** Номенклатура - [[Номенклатура_-_API3_Объект|Номенклатура]]
+
** СведПрослеж — информация о прослеживаемости (для документов, где данная информация имеется по контексту), массив
** Количество - фактическое количество единиц на складе
+
*** КолВЕдПрослеж
** Цена - цена за единицу
+
*** НомТовПрослеж
** Параметры
+
** СтавкаНДС — объект [[СтавкаНДС_-_API3_Объект|СтавкаНДС]]
*** Название
+
** Сумма — сумма
*** Значение
+
** <span style="color:#077F0B">СуммаНДС</span> — сумма НДС
 +
** Цена — цена
  
 
'''Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону'''
 
'''Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону'''
Строка 84: Строка 85:
  
 
===Зависит от объектов===
 
===Зависит от объектов===
 +
* Валюта
 +
* Договор
 +
* ЕдиницаИзмерения
 +
* Контрагент
 
* НашаОрганизация
 
* НашаОрганизация
 
* Номенклатура
 
* Номенклатура
 +
* ПоказательУчета
 
* Склад
 
* Склад
* Контрагент
+
* Страна
 +
* СтавкаНДС
 +
* ЧастноеЛицо
  
 
===Используемые методы БЛ===
 
===Используемые методы БЛ===

Текущая версия на 18:38, 19 июля 2024

Объект

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

Легенда:

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


Структура:

  • Вложение — массив с данными файлов, прилагаемых к документу
  • Идентификатор — идентификатор файла в хранилище СБИС Диск
  • Тип - строка, название типа формализованного вложения
  • Подтип - строка, название подтипа формализованного вложения
  • ВерсияФормата - строка, версия формата
  • ПодверсияФормата - строка, подверсия формата
  • Файл
    • Имя
  • Дата* — дата документа, строка в формате "ДД.ММ.ГГГГ"
  • ЗапуститьЭДО — флаг необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается новый документ, действие на этапе не требует выбора ответственного или подписания, булево
  • ВнешнийИдентификатор — внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей
  • ИдИС — идентификатор документа в ИС, строка
  • ИдСБИС — идентификатор документа в СБИС, строка
  • ИмяСБИС — имя 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 - не используется


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

  • Валюта
  • Договор
  • ЕдиницаИзмерения
  • Контрагент
  • НашаОрганизация
  • Номенклатура
  • ПоказательУчета
  • Склад
  • Страна
  • СтавкаНДС
  • ЧастноеЛицо

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