Реализация - API3 Объект — различия между версиями

Материал из razgovorov.ru
Перейти к: навигация, поиск
(не показаны 34 промежуточные версии 5 участников)
Строка 1: Строка 1:
−
===Объект===
+
{{ДокументПродаж_-_API3_Объект}}
−
* ИдИС * - идентификатор документа в ИС (строка)
 
−
* Номер - номер документа (строка)
 
−
* Дата - дата документа (строка в формате "ДД.ММ.ГГГГ")
 
−
* Поставщик * - объект [[НашаОрганизация_-_API3_Объект|НашаОрганизация]]
 
−
* Покупатель * - объект [[Контрагент_-_API3_Объект|Контрагент]]
 
−
* Склад - объект [[Склад_-_API3_Объект|Склад]]
 
−
* мТаблДок - данные о номенклатуре документа
 
−
** Товары
 
−
*** Номенклатура - [[Номенклатура_-_API3_Объект|Номенклатура]]
 
−
*** Количество - количество услуг
 
−
*** Цена - цена за 1 товар
 
−
** Услуги
 
−
*** Номенклатура - [[Номенклатура_-_API3_Объект|Номенклатура]]
 
−
*** Количество - количество услуг
 
−
*** Цена - цена за 1 услугу
 
  
 +
* Грузоотправитель — объект [[НашаОрганизация_-_API3_Объект|НашаОрганизация]]
 +
* Грузополучатель — объект [[Контрагент_-_API3_Объект|Контрагент]]
 +
* <span style="color:#E70000">СкладСписания</span> — объект [[Склад_-_API3_Объект|Склад]], склад списания материалов (для реализации розницы, при наличии выпуска продукции)
 +
* <span style="color:#E70000">СуммаВозвратовОплатыQR</span> — число строкой, сумма возвратов оплаты QR-кодом (для реализаций розницы)
 +
* <span style="color:#E70000">СуммаВозвратовОплатыКартой</span> — число строкой, сумма возвратов оплаты картой (для реализаций розницы)
 +
* <span style="color:#E70000">СуммаОплатыQR</span> — число строкой, сумма оплаты QR-кодом (для реализаций розницы)
 +
* <span style="color:#E70000">СуммаОплатыКартой</span> — число строкой, сумма оплаты картой (для реализаций розницы)
 +
* <span style="color:#E70000">ТочкаПродаж</span> — объект [[НашаОрганизация_-_API3_Объект|НашаОрганизация]],точка продажи товара (для реализаций розницы)
 +
* ТаблДок — словарь, табличные части
 +
<div class="mw-collapsible mw-collapsed">
 +
:* Товары
 +
<div class="mw-collapsible-content">
 +
<div class="mw-collapsible mw-collapsed">
 +
::* ГТД - словарь, номера ГТД
 +
<div class="mw-collapsible-content">
 +
:::* Номер - строка, номер ГТД
 +
:::* Страна — объект [[Страна_-_API3_Объект|Страна]], страна происхождения товара
 +
</div></div>
 +
::* ЕдИзм — объект [[ЕдиницаИзмерения_-_API3_Объект|ЕдиницаИзмерения]], единица измерения товара
 +
::* <span style="color:#E70000">ЕстьСостав</span> - булево, признак наличия состава у товара
 +
::* Количество — число строкой, количество товара
 +
::* Номенклатура — объект [[Номенклатура_-_API3_Объект|Номенклатура]], продаваемый товар
 +
<div class="mw-collapsible mw-collapsed">
 +
::* НомСредИдентТов — массив, номера маркировок
 +
<div class="mw-collapsible-content">
 +
:::* НомУпак - строка, номер упаковки
 +
:::* КИЗ - строка, контрольный идентификационный знак (маркировка)
 +
</div></div>
 +
<div class="mw-collapsible mw-collapsed">
 +
::* Параметры - массив, дополнительные параметры
 +
<div class="mw-collapsible-content">
 +
:::* Значение - строка, значение доп. параметра
 +
:::* Название - строка, название доп. параметра
 +
:::* Тип - строка, тип доп. параметра [Текст, Многострочный текст, Число, Флаг, Логическое, Дата, Период, Время, Список, Группа флагов, Объект]
 +
</div></div>
 +
::* <span style="color:#E70000">Показатель</span> — объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]], счет учета товара
 +
<div class="mw-collapsible mw-collapsed">
 +
::* СведПрослеж — массив, данные о прослеживаемости
 +
<div class="mw-collapsible-content">
 +
:::* КолВЕдПрослеж - число строкой
 +
:::* НомТовПрослеж - строка
 +
</div></div>
 +
::* <span style="color:#E70000">Себест</span> — число строкой, себестоимость товара
 +
::* <span style="color:#E70000">СебестБезНДС</span> — число строкой, себестоимость без учет НДС
 +
::* <span style="color:#E70000">СебестСуммаНДС</span> — число строкой, сумма НДС в себестоимости товара
 +
<div class="mw-collapsible mw-collapsed">
 +
::* <span style="color:#E70000">Состав</span> — массив, состав одной единицы товара
 +
<div class="mw-collapsible-content">
 +
:::* <span style="color:#E70000">ЕдИзм</span>— объект [[ЕдиницаИзмерения_-_API3_Объект|ЕдиницаИзмерения]], единица измерения материала
 +
:::* <span style="color:#E70000">Количество</span> — число строкой, количество материала на единицу товара
 +
:::* <span style="color:#E70000">Номенклатура</span> — объект [[Номенклатура_-_API3_Объект|Номенклатура]], материал
 +
:::* <span style="color:#E70000">Показатель</span> — объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]], счет учета материала
 +
</div></div>
 +
::* СтавкаНДС — объект [[СтавкаНДС_-_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> — число строкой, цена товара с учетом НДС
 +
</div></div>
 +
<div class="mw-collapsible mw-collapsed">
 +
:* Услуги
 +
<div class="mw-collapsible-content">
 +
::* ЕдИзм — объект [[ЕдиницаИзмерения_-_API3_Объект|ЕдиницаИзмерения]], единица измерения услуги
 +
::* Количество — число строкой, количество товара
 +
::* <span style="color:#E70000">Комментарий</span> - строка, содержание услуги
 +
::* Номенклатура — объект [[Номенклатура_-_API3_Объект|Номенклатура]], продаваемая услуга
 +
<div class="mw-collapsible mw-collapsed">
 +
::* Параметры - массив, дополнительные параметры
 +
<div class="mw-collapsible-content">
 +
:::* Значение - строка, значение доп. параметра
 +
:::* Название - строка, название доп. параметра
 +
:::* Тип - строка, тип доп. параметра [Текст, Многострочный текст, Число, Флаг, Логическое, Дата, Период, Время, Список, Группа флагов, Объект]
 +
</div></div>
 +
::* <span style="color:#E70000">Показатель</span> — объект [[ПоказательУчета_-_API3_Объект|ПоказательУчета]], счет учета услуги
 +
::* <span style="color:#E70000">Себест</span> — число строкой, себестоимость услуги
 +
::* <span style="color:#E70000">СебестБезНДС</span> — число строкой, себестоимость без учет НДС
 +
::* <span style="color:#E70000">СебестСуммаНДС</span> — число строкой, сумма НДС в себестоимости услуги
 +
::* СтавкаНДС — объект [[СтавкаНДС_-_API3_Объект|СтавкаНДС]], ставка НДС услуги
 +
::* <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> — число строкой, сумма услуги с учетом НДС
 +
::* Цена — число строкой, цена услуги с учетом флага СуммаВключаетНДС
 +
::* <span style="color:#E70000">ЦенаБезНДС</span> — число строкой, цена услуги без учета НДС
 +
::* <span style="color:#E70000">ЦенаСНДС</span> — число строкой, цена услуги с учетом НДС
 +
</div></div>
 +
 +
'''Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону'''
  
  
Строка 21: Строка 102:
 
<source lang="json">
 
<source lang="json">
 
{
 
{
−
  "ИдИС": "7cf838b6-f9e6-11e7-ad08-3497f6377b7e",
+
'Дата': '01.08.2023',
−
  "Номер": "00000000001",
+
'Номер': '20230801-full-upd',
−
  "Дата": "15.01.2018",
+
'Название': 'Реализация копия №20230801-full-upd от 01.08.2023',
−
  "Поставщик": {
+
'НашаОрганизация': {'ИдСБИС': '234'},
−
    "ИдИС": "56c61dec-e570-11e3-893a-005056c00008",
+
'Контрагент': {'ИдСБИС': '244'},
−
    "ИмяСБИС": "НашаОрганизация"
+
'Склад': {'ИдСБИС': '245'},
−
  },
+
'Грузоотправитель': {'ИдСБИС': '258'},
−
  "Покупатель": {
+
'Грузополучатель': {'ИдСБИС': '248'},
−
    "ИдИС": "b9321b89-2648-11e6-ab23-080027358f3f",
+
'Ответственный': {'ИдСБИС': '249'},
−
    "ИмяСБИС": "Контрагент"
+
'Валюта': {'ИдСБИС': 'RUB'},
−
  },
+
'СчетУчетаКонтрагент': {'Счет': '41-01'},
−
  "Склад": {
+
'СчетУчетаАванс': {'Счет': '62-02'},
−
    "ИдИС": "56c61dee-e570-11e3-893a-005056c00008",
+
'Регламент': 'Реализация копия',
−
    "ИмяСБИС": "Склад"
+
'Сумма': '2500.00',
−
  },
+
'Комментарий': 'комментарий документа',
−
  "мТаблДок": {
+
'СуммаВключаетНДС': True,
−
    "Товары": [
+
'Параметры': [{'Название': 'ПараметрШапки', 'Значение': 'значение1'}],
−
      {
+
'ТаблДок': {
−
        "Номенклатура": {
+
'Товары': [
−
          "ИдИС": "db3311b2-0a23-11e7-adce-080027358f3f",
+
{
−
          "ИмяСБИС": "Номенклатура"
+
'Количество': '5.0',
−
        },
+
'Цена': '500.00',
−
        "Количество": "3.000",
+
'Сумма': '2500.00',
−
        "Цена": 500
+
'СуммаНДС': '500.00',
−
      }
+
'Номенклатура': {'ИдСБИС': '1'},
−
    ],
+
'ЕдИзм': {'ИдСБИС': '796'},
−
    "Услуги": [
+
'СтавкаНДС': {'ИдСБИС': '3'},
−
      {
+
'ГТД': {'Номер': '10216100/050318/0001564',
−
        "Номенклатура": {
+
'Страна': {'ИдСБИС': '112'}},
−
          "ИдИС": "db3311b2-0a23-11e7-adce-080027358f3f",
+
'Параметры': [{'Название': 'ПараметрТабЧасти', 'Значение': 'значение1'}],
−
          "ИмяСБИС": "Номенклатура"
+
'НомСредИдентТов': [{'НомУпак': '', 'КИЗ': ''}],
−
        },
+
'СведПрослеж': [{'НомТовПрослеж': '', 'КолВЕдПрослеж': ''}],
−
        "Количество": "3.000",
+
−
        "Цена": 500
+
}
−
      }
+
],
−
    ]
+
'Услуги': [
−
  }
+
{
 +
'Количество': '5.0',
 +
'Цена': '500.00',
 +
'Сумма': '2500.00',
 +
'СуммаНДС': '500.00',
 +
'Номенклатура': {'ИдСБИС': '1'},
 +
'ЕдИзм': {'ИдСБИС': '796'},
 +
'СтавкаНДС': {'ИдСБИС': '3'},
 +
'Параметры': [{'Название': 'ПараметрТабЧасти', 'Значение': 'значение1'}],
 +
'Показатель': {'Счет': '41-01'},
 +
'Комментарий': 'текст комментарий',
 +
}
 +
]
 +
}
 
}
 
}
 
</source>
 
</source>
  
 
===Естественные ключи===
 
===Естественные ключи===
−
* Ключ1 - номер документа + дата документа + организация + контрагент(вес = 3)
+
* Ключ1 - номер документа + дата документа + организация + контрагент (вес = 3)
 
** Ключ1_1 - номер документа
 
** Ключ1_1 - номер документа
 
** Ключ1_2 - дата документа
 
** Ключ1_2 - дата документа
Строка 71: Строка 165:
  
 
===Зависит от объектов===
 
===Зависит от объектов===
 +
* Валюта
 +
* Договор
 +
* ЕдиницаИзмерения
 +
* Контрагент
 
* НашаОрганизация
 
* НашаОрганизация
 
* Номенклатура
 
* Номенклатура
−
* Контрагент
+
* ПоказательУчета
 
* Склад
 
* Склад
−
* ЕдиницаИзмерения
+
* Страна
 +
* СтавкаНДС
 +
* ЧастноеЛицо
  
 
===Используемые методы БЛ===
 
===Используемые методы БЛ===
 
* РеалИсх.Создать
 
* РеалИсх.Создать
 
* РеалИсх.Прочитать
 
* РеалИсх.Прочитать
 +
* РеалИсх.DocNomList
 
* РеалИсх.DocNomDeleteAll
 
* РеалИсх.DocNomDeleteAll
 
* РеалИсх.NomCreateWithSaveBatch
 
* РеалИсх.NomCreateWithSaveBatch
Строка 85: Строка 186:
 
* Документ.ОтменитьПроведение
 
* Документ.ОтменитьПроведение
 
* Документ.Провести
 
* Документ.Провести
 +
* НашаОрганизация.Существует
 +
* Contractor.ReadOutLite
 +
* Документ.ПолучитьСвязанныеДокументыИТипы
 +
* СменаККМ.ПрочитатьДляУчастника
 +
* Warehouse.ReadCard
 +
* Классификаторы.ReadByFullCode
  
 
[[Категория:SBIS API3 Объект]]
 
[[Категория:SBIS API3 Объект]]

Версия 14:24, 17 апреля 2025

Объект

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

Легенда:

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


Структура:

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