Реализация - API3 Объект
(перенаправлено с «!Реализация - API3 Объект»)
Объект
Тип: Документ
Легенда:
- Реквизиты черного цвета поддерживаются синхронизацией в обоих направлениях
- Реквизиты зеленого цвета поддерживаются синхронизацией только в СБИС
- Реквизиты красного цвета поддерживаются синхронизацией только из СБИС
Структура:
- Автор — объект ЧастноеЛицо
- Вложение — массив с данными файлов, прилагаемых к документу
- Идентификатор — идентификатор файла в хранилище СБИС Диск
- Тип - строка, название типа формализованного вложения
- ПодТип - строка, название подтипа формализованного вложения
- ВерсияФормата - строка, версия формата
- ПодверсияФормата - строка, подверсия формата
- Файл
- Имя
- Дата* — дата документа, строка в формате "ДД.ММ.ГГГГ"
- ЗапуститьЭДО — флаг необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается новый документ, действие на этапе не требует выбора ответственного или подписания, булево
- ВнешнийИдентификатор — внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей
- ИдИС — идентификатор документа в ИС, строка
- ИдСБИС — идентификатор документа в СБИС, строка
- ИмяСБИС — имя api3 объекта
- Комментарий — строка
- Название — представление объекта
- НашаОрганизация* — объект НашаОрганизация
- Номер* — номер документа, строка
- Основание — список объектов документы основания (массив)
- ВидСвязи — вид связи с документом-основания
- Документ — объект документа-основания
- Сумма — сумма связи
- Ответственный — объект ЧастноеЛицо
- Параметры — массив именованных параметров ключ / значение
- Значение — значение параметра, строка
- Название — название параметра, строка
- Тип — тип параметра [Текст, Многострочный текст, Число, Флаг, Логическое, Дата, Период, Время, Список, Группа флагов, Объект], строка
- Пометки — пометки по документу
- Проведён — Признак проведения документа, булево
- Удалён — Признак перемещения документа в удаленные, булево
- Важный — отметка Флажок на документе СБИС, булево
- Плюс — отметка Плюс на документе СБИС, булево
- Срочно — отметка Красный круг на документе СБИС, булево
- НеТребуется — отметка Зеленый круг на документе СБИС, булево
- Просмотрен — отметка Синий круг на документе СБИС, булево
- Значительный — отметка Желтый круг на документе СБИС, булево
- ЗакрытоОтИзменений — отметка серая галка на документе СБИС, булево
- Провести — флаг необходимости провести документ. Документы проводятся в СБИС по умолчанию, булево
- Удалён — признак удаленности документа в ИС. По умолчанию считаем что документ не помечен на удаление, булево
- Регламент — название регламента, строка
- Состояние — код состояния документа
- СчетУчетаКонтрагент — объект ПоказательУчета
- СчетУчетаАванс — объект ПоказательУчета
- Склад — объект Склад
- СуммаВС — сумма внешней системы, всегда True, нужна для передачи данных о Сумме документа, если в нём нет Табличной части
- Валюта — объект Валюта
- Контрагент — объект Контрагент
- Сумма — сумма документа (для документов, где данная информация имеется по контексту)
- Грузоотправитель — объект Контрагент
- Грузополучатель — объект Контрагент
- СуммаВключаетНДС — сумма включает НДС, булево
- СуммаОплатыКартой — сумма оплаты картой (для реализаций розницы по безналу)
- СуммаОплатыКартойВозврат — возвращенная сумма оплаты картой (для реализаций розницы по безналу)
- СкладСписания — склад списания (объект склад Склад)
- ТаблДок — словарь таб.частей
- Товары
- ГТД - словарь
- Номер
- Страна — объект Страна
- ЕдИзм — объект ЕдиницаИзмерения
- Количество — количество, число
- Номенклатура — объект Номенклатура
- НомСредИдентТов — массив маркировки
- НомУпак
- КИЗ
- Параметры
- Значение
- Название
- Тип
- Показатель — объект ПоказательУчета
- СведПрослеж — массив прослеживаемости
- КолВЕдПрослеж
- НомТовПрослеж
- Себест
- СебестБезНДС
- СебестСуммаНДС
- Состав — массив
- ЕдИзм — объект ЕдиницаИзмерения
- Количество
- Номенклатура — объект Номенклатура
- СтавкаНДС — объект СтавкаНДС
- Сумма
- СуммаБезНДС
- СуммаНДС
- СуммаСебест
- СуммаСебестБезНДС
- Цена — цена, число
- ЦенаБезНДС
- ГТД - словарь
- Услуги
- ЕдИзм — объект ЕдиницаИзмерения
- Количество, число
- Комментарий
- Номенклатура — объект Номенклатура
- Параметры
- Значение
- Название
- Тип
- Показатель — объект ПоказательУчета
- СтавкаНДС — объект СтавкаНДС
- Сумма, число
- СуммаБезНДС
- СуммаНДС, число
- Цена, число
- ЦенаБезНДС
- Товары
Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону
Пример:
{
'Дата': '01.08.2023',
'Номер': '20230801-full-upd',
'Название': 'Реализация копия №20230801-full-upd от 01.08.2023',
'НашаОрганизация': {'ИдСБИС': '234'},
'Контрагент': {'ИдСБИС': '244'},
'Склад': {'ИдСБИС': '245'},
'Грузоотправитель': {'ИдСБИС': '258'},
'Грузополучатель': {'ИдСБИС': '248'},
'Ответственный': {'ИдСБИС': '249'},
'Валюта': {'ИдСБИС': 'RUB'},
'СчетУчетаКонтрагент': {'Счет': '41-01'},
'СчетУчетаАванс': {'Счет': '62-02'},
'Регламент': 'Реализация копия',
'Сумма': '2500.00',
'Комментарий': 'комментарий документа',
'СуммаВключаетНДС': True,
'Параметры': [{'Название': 'ПараметрШапки', 'Значение': 'значение1'}],
'ТаблДок': {
'Товары': [
{
'Количество': '5.0',
'Цена': '500.00',
'Сумма': '2500.00',
'СуммаНДС': '500.00',
'Номенклатура': {'ИдСБИС': '1'},
'ЕдИзм': {'ИдСБИС': '796'},
'СтавкаНДС': {'ИдСБИС': '3'},
'ГТД': {'Номер': '10216100/050318/0001564',
'Страна': {'ИдСБИС': '112'}},
'Параметры': [{'Название': 'ПараметрТабЧасти', 'Значение': 'значение1'}],
'НомСредИдентТов': [{'НомУпак': '', 'КИЗ': ''}],
'СведПрослеж': [{'НомТовПрослеж': '', 'КолВЕдПрослеж': ''}],
}
],
'Услуги': [
{
'Количество': '5.0',
'Цена': '500.00',
'Сумма': '2500.00',
'СуммаНДС': '500.00',
'Номенклатура': {'ИдСБИС': '1'},
'ЕдИзм': {'ИдСБИС': '796'},
'СтавкаНДС': {'ИдСБИС': '3'},
'Параметры': [{'Название': 'ПараметрТабЧасти', 'Значение': 'значение1'}],
'Показатель': {'Счет': '41-01'},
'Комментарий': 'текст комментарий',
}
]
}
}
Естественные ключи
- Ключ1 - номер документа + дата документа + организация + контрагент (вес = 3)
- Ключ1_1 - номер документа
- Ключ1_2 - дата документа
- Ключ1_3 - идентификатор организации в ИС
- Ключ1_4 - идентификатор контрагента в ИС
- Ключ2 - не используется
- Ключ3 - не используется
Зависит от объектов
- Валюта
- Договор
- ЕдиницаИзмерения
- Контрагент
- НашаОрганизация
- Номенклатура
- ПоказательУчета
- Склад
- Страна
- СтавкаНДС
- ЧастноеЛицо
Используемые методы БЛ
- РеалИсх.Создать
- РеалИсх.Прочитать
- РеалИсх.DocNomList
- РеалИсх.DocNomDeleteAll
- РеалИсх.NomCreateWithSaveBatch
- РеалИсх.Записать
- Документ.ОтменитьПроведение
- Документ.Провести
- НашаОрганизация.Существует
- Contractor.ReadOutLite
- Документ.ПолучитьСвязанныеДокументыИТипы
- СменаККМ.ПрочитатьДляУчастника
- Warehouse.ReadCard
- Классификаторы.ReadByFullCode