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

Материал из razgovorov.ru
Перейти к: навигация, поиск
Строка 1: Строка 1:
===Объект===
+
{{ДокументПродаж_-_API3_Объект}}
Тип: Документ
+
* Грузоотправитель - объект [[Контрагент_-_API3_Объект|Контрагент]]
 
+
* Грузополучатель - объект [[Контрагент_-_API3_Объект|Контрагент]]
'''Структура:'''
+
* <span style="color:#E70000">СуммаОплатыКартой</span> - сумма оплаты картой (для реализаций розницы по безналу)
* Дата* - дата документа
 
* Номер* - номер документа
 
* НашаОрганизация* - объект [[НашаОрганизация_-_API3_Объект|НашаОрганизация]])
 
* Контрагент - объект [[Контрагент_-_API3_Объект|Контрагент]])
 
* Грузоотправитель- объект [[Контрагент_-_API3_Объект|Контрагент]])
 
* Грузополучатель - объект [[Контрагент_-_API3_Объект|Контрагент]])
 
* СуммаВключаетНДС  - признак ндс в сумме
 
* Регламент - имя регламента
 
* Сумма - сумма документа
 
* Комментарий - комментарий
 
* Склад - объект [[Склад_-_API3_Объект|Склад]]
 
* ТаблДок - данные о номенклатуре документа
 
** Товары
 
*** Номенклатура
 
*** СтавкаНДС
 
*** Количество
 
*** Сумма
 
*** Сумма НДС
 
*** СведПрослеж- Данные о прослеживаемости по позиции номенклатруры (Массив)
 
**** НомТовПрослеж - Регистрационный номер партии товара
 
**** КолВЕдПрослеж - Количество единиц товара по указанному РНПТ
 
*** ГТД
 
**** Номер
 
**** Страна - [[Страна - API3 Объект|Страна]]
 
*** ЕдИзм - [[ЕдиницаИзмерения_-_API3_Объект|ЕдиницаИзмерения]]
 
** Услуги
 
*** Номенклатура
 
*** СтавкаНДС
 
*** Количество
 
*** Сумма
 
*** Сумма НДС
 
 
 
  
 
'''Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону'''
 
'''Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону'''
Строка 42: Строка 10:
 
<source lang="json">
 
<source lang="json">
 
{
 
{
  "ИдИС": "ИдИС",
+
'Дата': '01.08.2023',
  "Номер": "FOR_UPDATE1FOR_UPDATE1",
+
'Номер': '20230801-full-upd',
  "Дата": "15.11.2020",
+
'Название': 'Реализация копия №20230801-full-upd от 01.08.2023',
  "СуммаВключаетНДС": "Да",
+
'НашаОрганизация': {'ИдСБИС': '234'},
  "НашаОрганизация": {
+
'Контрагент': {'ИдСБИС': '244'},
    "ИдСБИС": "167"
+
'Склад': {'ИдСБИС': '245'},
  },
+
'Грузоотправитель': {'ИдСБИС': '258'},
  "Контрагент": {
+
'Грузополучатель': {'ИдСБИС': '248'},
    "ИдСБИС": "488"
+
'Ответственный': {'ИдСБИС': '249'},
  },
+
'Валюта': {'ИдСБИС': 'RUB'},
  "Грузоотправитель": {
+
'СчетУчетаКонтрагент': {'Счет': '41-01'},
    "ИдСБИС": "252"
+
'СчетУчетаАванс': {'Счет': '62-02'},
  },
+
'Регламент': 'Реализация копия',
  "Грузополучатель": {
+
'Сумма': '2500.00',
    "ИдСБИС": "227"
+
'Комментарий': 'комментарий документа',
  },
+
'СуммаВключаетНДС': True,
  "Склад": {
+
'Параметры': [{'Название': 'ПараметрШапки', 'Значение': 'значение1'}],
    "ИдСБИС": "3240"
+
'ТаблДок': {
  },
+
'Товары': [
  "Сумма": "500.00",
+
{
  "Регламент": "Реализация",
+
'Количество': '5.0',
  "Комментарий": "ДЛЯ ТЕСТОВ НЕ УДАЛЯТЬ",
+
'Цена': '500.00',
  "ТаблДок": {
+
'Сумма': '2500.00',
    "Товары": [
+
'СуммаНДС': '500.00',
      {
+
'Номенклатура': {'ИдСБИС': '1'},
        "Номенклатура": {
+
'ЕдИзм': {'ИдСБИС': '796'},
          "ИдСБИС": "61"
+
'СтавкаНДС': {'ИдСБИС': '3'},
        },
+
'ГТД': {'Номер': '10216100/050318/0001564',
        "СтавкаНДС": {
+
'Страна': {'ИдСБИС': '112'}},
          "ИдСБИС": "1"
+
'Параметры': [{'Название': 'ПараметрТабЧасти', 'Значение': 'значение1'}],
        },
+
'НомСредИдентТов': [{'НомУпак': '', 'КИЗ': ''}],
        "Количество": "2.0",
+
'СведПрослеж': [{'НомТовПрослеж': '', 'КолВЕдПрослеж': ''}],
        "Сумма": "200.00",
+
        "СуммаНДС": "18.18",
+
}
        "ГТД": {
+
],
          "Номер": "10702030/260917/0080321",
+
'Услуги': [
          "Страна": {
+
{
            "ИдСБИС": "591"
+
'Количество': '5.0',
        }
+
'Цена': '500.00',
      }
+
'Сумма': '2500.00',
    ],
+
'СуммаНДС': '500.00',
    "Услуги": [
+
'Номенклатура': {'ИдСБИС': '1'},
      {
+
'ЕдИзм': {'ИдСБИС': '796'},
        "Номенклатура": {
+
'СтавкаНДС': {'ИдСБИС': '3'},
          "ИдСБИС": "321"
+
'Параметры': [{'Название': 'ПараметрТабЧасти', 'Значение': 'значение1'}],
        },
+
'Показатель': {'Счет': '41-01'},
        "Количество": "3.0",
+
'Комментарий': 'текст комментарий',
        "Сумма": "300.00",
+
}
        "СуммаНДС": "50.00"
+
]
      }
+
}
    ]
 
  }
 
 
}
 
}
 
</source>
 
</source>
Строка 112: Строка 78:
 
* Склад
 
* Склад
 
* ЕдиницаИзмерения
 
* ЕдиницаИзмерения
 +
* СчетНаОплату
 +
* Договор
 +
* Валюта
 +
* ПоказательУчета
 +
* Страна
 +
* СтавкаНДС
 +
* ЗаказПокупателя
 +
* ЗаказПоставщику
  
 
===Используемые методы БЛ===
 
===Используемые методы БЛ===
Строка 122: Строка 96:
 
* Документ.ОтменитьПроведение
 
* Документ.ОтменитьПроведение
 
* Документ.Провести
 
* Документ.Провести
 +
* НашаОрганизация.Существует
 +
* Contractor.ReadOutLite
 +
* Документ.ПолучитьСвязанныеДокументыИТипы
 +
* СменаККМ.ПрочитатьДляУчастника
 +
* Warehouse.ReadCard
 +
* Классификаторы.ReadByFullCode
  
 
[[Категория:SBIS API3 Объект]]
 
[[Категория:SBIS API3 Объект]]

Версия 22:50, 1 августа 2023

Объект

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

Легенда:

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


Структура:

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

Объем данных возвращаемых методом 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