Реализация - API3 Объект — различия между версиями
(не показано 13 промежуточных версий 2 участников) | |||
Строка 1: | Строка 1: | ||
{{ДокументПродаж_-_API3_Объект}} | {{ДокументПродаж_-_API3_Объект}} | ||
− | * Грузоотправитель | + | * Грузоотправитель — объект [[Контрагент_-_API3_Объект|Контрагент]] |
− | * Грузополучатель | + | * Грузополучатель — объект [[Контрагент_-_API3_Объект|Контрагент]] |
− | * <span style="color:#E70000">СуммаОплатыКартой</span> | + | * СуммаВключаетНДС — сумма включает НДС, булево |
− | * | + | * <span style="color:#E70000">СуммаОплатыКартой</span> — сумма оплаты картой (для реализаций розницы по безналу) |
− | * | + | * <span style="color:#E70000">СуммаОплатыКартойВозврат</span> — возвращенная сумма оплаты картой (для реализаций розницы по безналу) |
− | * ТаблДок | + | * <span style="color:#E70000">СкладСписания</span> — склад списания (объект склад [[Склад_-_API3_Объект|Склад]]) |
+ | * ТаблДок — словарь таб.частей | ||
** Товары | ** Товары | ||
− | *** | + | *** ГТД - словарь |
− | *** | + | **** Номер |
− | * | + | **** Страна — объект [[Страна_-_API3_Объект|Страна]] |
− | *** | + | *** ЕдИзм — объект [[ЕдиницаИзмерения_-_API3_Объект|ЕдиницаИзмерения]] |
− | * | + | *** Количество — количество, число |
− | *** ЕдИзм | + | *** Номенклатура — объект [[Номенклатура_-_API3_Объект|Номенклатура]] |
− | *** | + | *** НомСредИдентТов — массив маркировки |
− | *** НомСредИдентТов | ||
**** НомУпак | **** НомУпак | ||
**** КИЗ | **** КИЗ | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
*** Параметры | *** Параметры | ||
+ | **** Значение | ||
**** Название | **** Название | ||
− | |||
**** Тип | **** Тип | ||
− | *** <span style="color:#E70000">Показатель</span> | + | *** <span style="color:#E70000">Показатель</span> — объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]] |
+ | *** СведПрослеж — массив прослеживаемости | ||
+ | **** КолВЕдПрослеж | ||
+ | **** НомТовПрослеж | ||
+ | *** <span style="color:#E70000">Себест</span> | ||
+ | *** <span style="color:#E70000">СебестБезНДС</span> | ||
+ | *** <span style="color:#E70000">СебестСуммаНДС</span> | ||
+ | *** <span style="color:#E70000">Состав</span> — массив | ||
+ | **** ЕдИзм — объект [[ЕдиницаИзмерения_-_API3_Объект|ЕдиницаИзмерения]] | ||
+ | **** Количество | ||
+ | **** Номенклатура — объект [[Номенклатура_-_API3_Объект|Номенклатура]] | ||
+ | *** СтавкаНДС — объект [[СтавкаНДС_-_API3_Объект|СтавкаНДС]] | ||
+ | *** Сумма | ||
*** <span style="color:#E70000">СуммаБезНДС</span> | *** <span style="color:#E70000">СуммаБезНДС</span> | ||
+ | *** СуммаНДС | ||
+ | *** <span style="color:#E70000">СуммаСебест</span> | ||
+ | *** <span style="color:#E70000">СуммаСебестБезНДС</span> | ||
+ | *** Цена — цена, число | ||
*** <span style="color:#E70000">ЦенаБезНДС</span> | *** <span style="color:#E70000">ЦенаБезНДС</span> | ||
** Услуги | ** Услуги | ||
− | + | *** ЕдИзм — объект [[ЕдиницаИзмерения_-_API3_Объект|ЕдиницаИзмерения]] | |
− | + | *** Количество, число | |
− | |||
− | |||
− | |||
− | *** ЕдИзм | ||
− | *** | ||
− | |||
*** Комментарий | *** Комментарий | ||
+ | *** Номенклатура — объект [[Номенклатура_-_API3_Объект|Номенклатура]] | ||
*** Параметры | *** Параметры | ||
+ | **** Значение | ||
**** Название | **** Название | ||
− | |||
**** Тип | **** Тип | ||
− | *** <span style="color:#E70000">Показатель</span> | + | *** <span style="color:#E70000">Показатель</span> — объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]] |
+ | *** СтавкаНДС — объект [[СтавкаНДС_-_API3_Объект|СтавкаНДС]] | ||
+ | *** Сумма, число | ||
*** <span style="color:#E70000">СуммаБезНДС</span> | *** <span style="color:#E70000">СуммаБезНДС</span> | ||
+ | *** СуммаНДС, число | ||
+ | *** Цена, число | ||
*** <span style="color:#E70000">ЦенаБезНДС</span> | *** <span style="color:#E70000">ЦенаБезНДС</span> | ||
+ | |||
'''Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону''' | '''Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону''' | ||
Строка 107: | Строка 117: | ||
===Естественные ключи=== | ===Естественные ключи=== | ||
− | * Ключ1 - номер документа + дата документа + организация + контрагент(вес = 3) | + | * Ключ1 - номер документа + дата документа + организация + контрагент (вес = 3) |
** Ключ1_1 - номер документа | ** Ключ1_1 - номер документа | ||
** Ключ1_2 - дата документа | ** Ключ1_2 - дата документа | ||
Строка 116: | Строка 126: | ||
===Зависит от объектов=== | ===Зависит от объектов=== | ||
+ | * Валюта | ||
+ | * Договор | ||
+ | * ЕдиницаИзмерения | ||
+ | * Контрагент | ||
* НашаОрганизация | * НашаОрганизация | ||
* Номенклатура | * Номенклатура | ||
− | * | + | * ПоказательУчета |
* Склад | * Склад | ||
− | |||
− | |||
− | |||
− | |||
− | |||
* Страна | * Страна | ||
* СтавкаНДС | * СтавкаНДС | ||
− | * | + | * ЧастноеЛицо |
− | |||
===Используемые методы БЛ=== | ===Используемые методы БЛ=== |
Текущая версия на 18:36, 19 июля 2024
Объект
Тип: Документ
Легенда:
- Реквизиты черного цвета поддерживаются синхронизацией в обоих направлениях
- Реквизиты зеленого цвета поддерживаются синхронизацией только в СБИС
- Реквизиты красного цвета поддерживаются синхронизацией только из СБИС
Структура:
- Автор — объект ЧастноеЛицо
- Вложение — массив с данными файлов, прилагаемых к документу
- Дата* — дата документа, строка в формате "ДД.ММ.ГГГГ"
- ЗапуститьЭДО — флаг необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается новый документ, действие на этапе не требует выбора ответственного или подписания, булево
- Идентификатор — идентификатор файла в хранилище СБИС Диск
- Файл
- Имя
- Идентификатор — ИдентификаторВИ
- ИдИС — идентификатор документа в ИС, строка
- ИдСБИС — идентификатор документа в СБИС, строка
- ИмяСБИС — имя 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