Реализация - API3 Объект

Материал из razgovorov.ru
(перенаправлено с «!Реализация - API3 Объект»)
Перейти к: навигация, поиск

Объект

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

Легенда:

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


Структура:

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

Объем данных возвращаемых методом 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
Источник — «http://wiki.razgovorov.ru/index.php?title=Реализация_-_API3_Объект&oldid=7126»