Экспорт чеков из SetRetail10 в ERP (веб-сервис на стороне SetRetail10)

Публичный ресурс

Экспорт чеков из SetRetail10 в ERP (веб-сервис на стороне SetRetail10)

Версия веб-сервиса 1.13

К оглавлению

Методы веб-сервиса для экспорта чеков

За заданный операционный день

Метод

getPurchasesByOperDay

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

dateOperDay

date

Операционный день в формате YYYY-MM-DD

Да

Возвращаемые параметры

return

base64Binary

Чеки за операционный день

Возвращаемый результат не содержит полные данные по бонусам и скидкам.

Для полного просмотра бонусов и скидок используйте метод getFullPurchasesByParams.

Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getPurchasesByOperDay> <!--Optional:--> <dateOperDay>2019-05-08</dateOperDay> </plug:getPurchasesByOperDay> </soapenv:Body> </soapenv:Envelope>

Описание формата выгрузки чеков 

 

За заданный операционный день c вводом параметров

Метод

getPurchasesByOperDayData

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

Year

integer

Год в формате YYYY

Нет

Mobth 

 Параметр mobth для вызова установки значений месяца должен использоваться именно в таком написании. Его наименование не совпадает со словом месяц (month) на английском языке!

string

Месяц в текстовом формате:

  • JANUARY

  • FEBRUARY

  • MARCH

  • APRIL

  • MAY

  • JUNE

  • JULY

  • AUGUST

  • SEPTEMBER

  • OCTOBER

  • NOVEMBER

  • DECEMBER

Да

Day

integer

День

Нет

Возвращаемые параметры

return

base64Binary

Чеки за операционный день

Возвращаемый результат не содержит полные данные по бонусам и скидкам.

Для полного просмотра бонусов и скидок используйте метод getFullPurchasesByParams.

Описание формата выгрузки чеков 

Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getPurchasesByOperDayData> <Year>2019</Year> <!--Optional:--> <Mobth>MAY</Mobth> <Day>27</Day> </plug:getPurchasesByOperDayData> </soapenv:Body> </soapenv:Envelope>

Методы getPurchasesByOperDay и getPurchasesByOperDayData отличаются только способом передачи параметров.

-

За заданный период

Метод

getPurchasesByPeriod

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

fromDate

date

Начало диапазона в формате YYYY-MM-DD

Нет

toDate

date

Конец диапазона в формате YYYY-MM-DD

Нет

Возвращаемые параметры

return

base64Binary

Чеки за операционный день

Возвращаемый результат не содержит полные данные по бонусам и скидкам.

Для полного просмотра бонусов и скидок используйте метод getFullPurchasesByParams.

Описание формата выгрузки чеков 

Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getPurchasesByPeriod> <!--Optional:--> <fromDate>2019-05-01</fromDate> <!--Optional:--> <toDate>2019-05-31</toDate> </plug:getPurchasesByPeriod> </soapenv:Body> </soapenv:Envelope>

-

За заданный период по товару

Метод

getPurchasesByPeriodAndProduct

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

fromDate

date

Начало диапазона

Нет

toDate

date

Конец диапазона

Нет

goodsCode

string

Код товара

Нет

Возвращаемые параметры 

return

base64Binary

Чеки за операционный день

Возвращаемый результат не содержит полные данные по бонусам и скидкам.

Для полного просмотра бонусов и скидок используйте метод getFullPurchasesByParams.

Описание формата выгрузки чеков 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getPurchasesByPeriodAndProduct> <!--Optional:--> <fromDate>2019-05-01</fromDate> <!--Optional:--> <toDate>2019-05-31</toDate> <!--Optional:--> <goodsCode>45033</goodsCode> </plug:getPurchasesByPeriodAndProduct> </soapenv:Body> </soapenv:Envelope>

-

Экспорт информации по отложенным чекам (включение)

Для включения выполняются скрипты по базе данных

set сервера SetRetail10/SetCentrum.

После выполнения скриптов включения, перезапустите службу сервера.

https://crystals.atlassian.net/browse/CR-5382

https://crystals.atlassian.net/browse/SRTE-3562

10.2.99.0

Выгрузка для веб сервиса на стороне ERP и SetRetail10

UPDATE public.sales_management_properties SET property_value='1.18' WHERE property_key = 'export.set10wsclient.purchases.version';
UPDATE public.sales_management_properties SET property_value='true' WHERE property_key = 'export.set10wsclient.purchases.deferred.enabled';

Файловый экспорт

UPDATE public.sales_management_properties SET property_value='1.9' WHERE property_key = 'export.file.purchases.version';
UPDATE public.sales_management_properties SET property_value='true' WHERE property_key = 'export.file.purchases.deferred.enabled';

Отложенные чеки за операционный день

https://crystals.atlassian.net/browse/CR-5382

https://crystals.atlassian.net/browse/SRTE-3562

10.2.99.0

Метод

getReportDeferredByOperDay

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

dateOperDay

dateTime

Операционный день в формате YYYY-MM-DD

Нет

Возвращаемые параметры 

return

base64Binary

Чеки за операционный день

Возвращаемый результат не содержит полные данные по бонусам и скидкам.

Для полного просмотра бонусов и скидок используйте метод getFullPurchasesByParams.

Описание формата выгрузки чеков 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getReportDeferredByOperDay> <!--Optional:--> <dateOperDay>2021-07-07</dateOperDay> </plug:getReportDeferredByOperDay> </soapenv:Body> </soapenv:Envelope>

-

Отложенные чеки по заданным параметрам

https://crystals.atlassian.net/browse/CR-5382

https://crystals.atlassian.net/browse/SRTE-3562

10.2.99.0

Метод

getReportDeferredByParams

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

dateOperDay

dateTime

Операционный день в формате YYYY-MM-DD

Нет

shopNumber

Long

Номер магазина

Нет

cashNumber

Long

Номер кассы

Нет

shiftNumber

Long

Номер смены

Нет

cashierTabNo

String

Табельный номер кассира

Нет

Возвращаемые параметры 

return

base64Binary

Чеки за операционный день

Возвращаемый результат не содержит полные данные по бонусам и скидкам.

Для полного просмотра бонусов и скидок используйте метод getFullPurchasesByParams.

Описание формата выгрузки чеков 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getReportDeferredByParams> <dateOperDay>?</dateOperDay> <!--Optional:--> <shopNumber>234</shopNumber> <!--Optional:--> <cashNumber>3</cashNumber> <!--Optional:--> <shiftNumber>9</shiftNumber> <!--Optional:--> <cashierTabNo>231</cashierTabNo> </plug:getReportDeferredByParams> </soapenv:Body> </soapenv:Envelope>

asdasdas

По заданным параметрам

Метод

getPurchasesByParams

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

dateOperDay

date

Операционный день в формате YYYY-MM-DD

Да

shopNumber

integer

Номер магазина 

Нет

cashNumber

integer

Номер кассы

Нет

shiftNumber

integer

Номер смены

Нет

purchaseNumber

integer

Номер чека

Нет

Возвращаемые параметры

return

base64Binary

Чеки по заданным параметрам

Возвращаемый результат не содержит полные данные по бонусам и скидкам.

Для полного просмотра бонусов и скидок используйте метод getFullPurchasesByParams.

Описание формата выгрузки чеков  

Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getPurchasesByParams> <dateOperDay>2019-05-13</dateOperDay> <!--Optional:--> <shopNumber>3382</shopNumber> <!--Optional:--> <cashNumber>1</cashNumber> <!--Optional:--> <shiftNumber>1</shiftNumber> <!--Optional:--> <purchaseNumber>7</purchaseNumber> </plug:getPurchasesByParams> </soapenv:Body> </soapenv:Envelope>

Параметры shopNumber, cashNumber, shiftNumber, purchaseNumber – являются необязательными.

В зависимости от полноты указания параметров, в ответе будет возвращаться соответствующее количество чеков.

Кейсы

  1. dateOperDay - в отчёт попадают все чеки всех магазинов за операционный день dateOperDay.

  2. dateOperDayshopNumber - в отчёт попадают все чеки за операционный день dateOperDay с магазина shopNumber.

  3. dateOperDayshopNumbercashNumber - в отчёт попадают все чеки за операционный день dateOperDay с магазина shopNumber с кассы cashNumber.

  4. dateOperDayshopNumbercashNumbershiftNumber - в отчёт попадают все чеки смены shiftNumber за операционный день dateOperDay с магазина shopNumber с кассы cashNumber.

  5. dateOperDayshopNumbercashNumbershiftNumberpurchaseNumber - в отчёт попадает только один конкретный чек под номером purchaseNumber из сменыshiftNumber за операционный день dateOperDay с магазина shopNumber с кассы cashNumber.

Обработка не заданных параметров для метода getPurchasesByParams

https://crystals.atlassian.net/browse/SRTE-2613

10.2.80.0

При использовании метода getPurchasesByParams, параметры могут обрабатываться, как не заполненные, если в их настройках указано значение xsi:nil

При использовании метода getPurchasesByParams, значение xsi:nil в параметрах, обрабатывается как не заполненный параметр.

Такой кейс упрощает интеграцию SetRetail10 и 1С. 

Пример: для загрузки чеков c отбором по дате, магазину, для кассе в 1С используется метод getPurchasesByParams, в котором возможно заполнить параметры dateOperDay, shopNumber, cashNumber, но параметры shiftNumber, purchaseNumber заполнять не требуется.

Пример SOAP-запроса:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header/> <soap:Body> <m:getPurchasesByParams xmlns:m="http://plugins.operday.ERPIntegration.crystals.ru/"> <dateOperDay xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2019-10-29T00:00:00</dateOperDay> <shopNumber xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2</shopNumber> <cashNumber xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1</cashNumber> <shiftNumber xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/> <purchaseNumber xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/> </m:getPurchasesByParams></soap:Body> </soap:Envelope>

-

Экспорт новых, не отправленных чеков за операционный день с вводом параметров

Метод

getNewPurchasesByParams

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

Комментарий

Выгружаются все новые чеки за указанный операционный день, либо удовлетворяющие заданным параметрам, если они указаны.

10.2.66.0

https://crystals.atlassian.net/browse/SRTE-2030

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

dateOperDay

date

Операционный день в формате YYYY-MM-DD

Да

shopNumber

integer

Номер магазина

Нет

cashNumber

integer

Номер кассы

Нет

shiftNumber

integer

Номер смены

Нет

purchaseNumber

integer

Номер чека

Нет

Возвращаемые параметры

return

base64Binary

Чеки по заданным параметрам

Возвращаемый результат не содержит полные данные по бонусам и скидкам.

Для полного просмотра бонусов и скидок используйте метод getFullPurchasesByParams.

Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getNewPurchasesByParams> <dateOperDay>2019-05-03</dateOperDay> <!--Optional:--> <shopNumber>3328</shopNumber> <!--Optional:--> <cashNumber>3</cashNumber> <!--Optional:--> <shiftNumber>16</shiftNumber> <!--Optional:--> <purchaseNumber>?</purchaseNumber> </plug:getNewPurchasesByParams> </soapenv:Body> </soapenv:Envelope>

--

Экспорт новых, не отправленных чеков

Метод

getNewPurchasesByOperDay

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

В отчёте выгружаются только новые чеки (те которые ещё не забирали).

Выгружаются все новые чеки за указанный операционный день, либо удовлетворяющие заданным параметрам, если они указаны.

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

arrayOfParams

array

Массив параметров по следующему формату:

[OperDay (DateTime, REQUIRED), shop(Long), cash(Long), shift(Long), number(Long)]

Да

Возвращаемые параметры

return

base64Binary

Чеки за операционный день

Возвращаемый результат не содержит полные данные по бонусам и скидкам.

Для полного просмотра бонусов и скидок используйте метод getFullPurchasesByParams.

Описание формата выгрузки чеков 

Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Header/> <soapenv:Body> <plug:getNewPurchasesByOperDay> <!---OperDay --> <arrayOfParams xsi:type="xs:dateTime">2014-11-24T12:00:00.000</arrayOfParams> <!---Shop number (optional) --> <arrayOfParams xsi:type="xs:long">12345</arrayOfParams> <!---Cash number (optional)--> <arrayOfParams xsi:type="xs:long">1</arrayOfParams> <!---Shift number (optional)--> <arrayOfParams xsi:type="xs:long">3</arrayOfParams> <!---Document number (optional)--> <arrayOfParams xsi:type="xs:long">2</arrayOfParams> </plug:getNewPurchasesByOperDay> </soapenv:Body> </soapenv:Envelope>

Экземпляры чеков со скидками и бонусными операциями

https://crystals.atlassian.net/browse/CORE-352

10.2.54.0

Чеки и скидки с кассы в загружаются в операционный день не одновременно. В случае, если для чека были скидки, но в операционный день они ещё не пришли, такой чек не будет возвращаться веб-сервисами, пока для чека не придут скидки.

По умолчанию у скидок установлен срок хранения 29 дней, и по истечении указанного срока чеки, в которых были применены какие-либо рекламные акции, также не будут возвращаться веб-сервисом.

Для увеличения или уменьшения периода хранения скидок в днях можно скорректировать в конфигурационном файле сервера параметр erpi.loy.transaction.clean.days.interval:

  • Linux: /var/lib/jboss/standalone/configuration/modules/erp-integration/ERPIntegration.properties

  • Windows: {Папка SetRetail10}\standalone\configuration\modules\erp-integration\ERPIntegration.properties

фшщвшфш-ыывуывывфыв

Получение информации о чеках и расчетов скидок по ним

Метод

getFullPurchasesByParams

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

dateOperDay

Date

Определяет дату, за которую из операционного дня следует выбрать чеки

 

Да

shopNumber

Long

Определяет номер магазина, чеки которого из операционного дня следует получить

Нет

cashNumber

Long

Определяет номер кассы, чеки которой из операционного дня следует получить

Нет

shiftNumber

Long

Определяет номер смены, чеки которой из операционного дня следует получить

Нет

purchaseNumber

Long

Определяет номер чека, который из опердня операционного дня получить

Нет

Возвращаемые параметры

return

base64Binary

Чеки по заданным параметрам

 

Описание формата выгрузки чеков  

Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getFullPurchasesByParams> <dateOperDay>2018-08-16</dateOperDay> <shopNumber>6502</shopNumber> <cashNumber>1</cashNumber> <shiftNumber>1</shiftNumber> <purchaseNumber>2</purchaseNumber> </plug:getFullPurchasesByParams> </soapenv:Body> </soapenv:Envelope>

 

Получение новых чеков, которые не отправлялись веб-сервисом

Метод

getNewFullPurchasesByOperDay

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

Индекс

Тип данных

Описание

Обязательное

Принимаемые параметры

0

Date

Дата, за которую из операционного дня требуется получить новые чеки

Да

1

Long

Номер магазина, от которого из операционного дня следует выбрать новые чеки

Нет

2

Long

Номер кассы, от которой из операционного дня следует выбрать новые чеки

Нет

3

Long

Номер смены, от которой из операционного дня следует выбрать новые чеки

Нет

4

Long

Номер чека, от которой из операционного дня следует выбрать новые чеки

Нет

Возвращаемые параметры

return

base64Binary

Чеки по заданным параметрам

Описание формата выгрузки чеков  

  • Минимальный размер массива аргументов метода - 1 (потому что параметр "дата опердня" обязательный).

  • Если требуется пропустить, параметр "номер смены", тогда установите значение null, потому что за номером смены следует номер чека.

  • Если требуется номер чека, массиву допустимо быть длиной 4, потому что за параметром "номер чека" ничего не следует.

Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Header/> <soapenv:Body> <plug:getNewFullPurchasesByOperDay> <arrayOfParams xsi:type="xs:dateTime">2018-08-16T12:00:00.000</arrayOfParams> <arrayOfParams xsi:type="xs:long">6502</arrayOfParams> <!-- Номер магазина --> <arrayOfParams xsi:type="xs:long">1</arrayOfParams> <!-- Номер кассы --> <arrayOfParams xsi:type="xs:long">1</arrayOfParams> <!-- Номер смены --> <arrayOfParams xsi:type="xs:long">2</arrayOfParams> <!-- Номер чека --> </plug:getNewFullPurchasesByOperDay> </soapenv:Body> </soapenv:Envelope>

Настройка ограничения размера пачки экспорта чеков для веб-сервиса на стороне SetRetail10

https://crystals.atlassian.net/browse/SRTE-3008

https://crystals.atlassian.net/browse/SRTE-2991

10.2.92.0

Только для методов:

  • getNewPurchses(...)

  • getNewFullPurchases(...)

0 - размер не ограничен

SELECT add_property('SET_ERP_INTEGRATION', 'export.websevice.new.purchases.batch.size', '0', 'Ограничение размера пачки "новых" чеков возвращаемой вебсервисом. 0 - размер не ограничен.');

Методы веб-сервиса для экспорта нефискальных документов

По заданным параметрам

По заданным параметрам

Метод

getNonFiscalDocsByParams

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

Поле

Тип данных

Описание

Обязательное

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

dateOperDay

date

Операционный день в формате YYYY-MM-DD

Да

shopNumber

integer

Номер магазина

Нет

cashNumber

integer

Номер кассы

Нет

shiftNumber

integer

Номер смены

Нет

purchaseNumber

integer

Номер нефискального документа

Нет

type

string

Тип нефискального документа. 

Поле может быть пустым, но обязательно должно присутствовать в структуре запроса

Да 

status

string

Статус документа. Возможные значения:

  • new – новые, не отправленные документы (помечает документ как отправленный)

  • all – все/любые (не меняет статус документа)

Да 

Возвращаемые параметры

return

base64Binary

Нефискальные документы по заданным параметрам

Описание формата выгрузки нефискальных документов

Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getNonFiscalDocsByParams> <dateOperDay>2022-05-30</dateOperDay> <!--Optional:--> <shopNumber>1</shopNumber> <!--Optional:--> <cashNumber>1</cashNumber> <!--Optional:--> <shiftNumber>2</shiftNumber> <!--Optional:--> <purchaseNumber>1</purchaseNumber> <type>?</type> <status>all</status> </plug:getNonFiscalDocsByParams> </soapenv:Body> </soapenv:Envelope>

Методы веб-сервиса для экспорта аннулированных чеков

https://crystals.atlassian.net/browse/SRTS-970

https://crystals.atlassian.net/browse/CR-8315

10.3.15.0

За заданный операционный день

Метод

getCancelledPurchasesByOperDay

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

dateOperDay

date

Операционный день в формате YYYY-MM-DD

Да

Возвращаемые параметры

return

base64Binary

Аннулированные чеки за операционный день

Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getCancelledPurchasesByOperDay> <dateOperDay>2022-08-22</dateOperDay> </plug:getCancelledPurchasesByOperDay> </soapenv:Body> </soapenv:Envelope>

Описание формата выгрузки чеков 

 

По заданным параметрам

По заданным параметрам

Метод

getCancelledPurchasesByParams

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

Поле

Тип данных

Описание

Обязательное

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

dateOperDay

date

Операционный день в формате YYYY-MM-DD

Да

shopNumber

integer

Номер магазина

Нет

cashNumber

integer

Номер кассы

Нет

shiftNumber

integer

Номер смены

Нет

cashierTabNo

integer

Табельный номер кассира, аннулировавшего чек

Нет

Возвращаемые параметры

return

base64Binary

Аннулированные чеки по заданным параметрам

Описание формата выгрузки аннулированных чеков

Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getCancelledPurchasesByParams> <dateOperDay>2022-08-22</dateOperDay> <shopNumber>3245</shopNumber> <cashNumber>62</cashNumber> <shiftNumber>1</shiftNumber> <cashierTabNo>111</cashierTabNo> </plug:getCancelledPurchasesByParams> </soapenv:Body> </soapenv:Envelope>

 

Метод веб-сервиса для экспорта чеков по периоду и категориям карт лояльности

По периоду и категориям карт лояльности

По периоду и категориям карт лояльности

Метод

getPurchasesByPeriodAndCardTypes

URL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport

WSDL

http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl

https://crystals.atlassian.net/browse/CR-12834

https://crystals.atlassian.net/browse/SRTS-3459

10.4.13.0

Для осуществления фильтрации чеков по параметру cardTypeGuids и для получения в выходном объекте чека информации о примененной в чеке лояльности необходимо изменение версии схемы xsd в настройке таблице sales_management_properties: export.file.purchases.version = “2.0”.

UPDATE public.sales_management_properties SET property_value='2.0' WHERE property_key = 'export.file.purchases.version';

Пример запроса в файле

Поле

Тип данных

Описание

Обязательное

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

fromDate

date

Начало диапазона в формате YYYY-MM-DD

Нет

toDate

date

Конец диапазона в формате YYYY-MM-DD

Нет

cardTypeGuids

array

Список кодов категорий карт.

Фильтрация чеков происходит по значению атрибута card_type_guid в XML экспорта чеков)

Да

Возвращаемые параметры

return

base64Binary

Чеки за период, в которых была применена карта лояльности с указанным в фильтре типом

Описание формата выгрузки чеков 

 

 

 

Начиная с версии 10.2.97.0 типы данных Double изменены на Decimal.

https://crystals.atlassian.net/browse/SRTS-6

https://crystals.atlassian.net/browse/CR-3319

Чеки <purchases>

purchases

Наименование элемента

Тип данных

Описание

Обязательное

purchase

Комплексный

Данные чека

Да

Наименование атрибута

Тип данных

Описание

Обязательное

count

Long

Количество передаваемых чеков, т.е. общее количество тегов purchase вложенных в общий тег purchases

Нет

Состав чека <purchase>

purchases/purchase

Наименование атрибута

Тип данных

Описание

Обязательное

tabNumber

String

Табельный номер кассира

Нет

returndayinday

Boolean

Признак для чека возврата "День в день"

Нет

username

String

Имя кассира

Нет

operationType

Boolean

Кассовая операция

  • True - продажа

  • False - возврат

Нет

cashOperation

Комплексный

Кассовые операции для лотерей Столото

Начиная с версии веб-сервиса 1.15

https://crystals.atlassian.net/browse/SRTE-2953

10.2.89.0

  • EXPENSE - Операция "Расход"

  • INCOME - Операция "Приход"

Пример выгрузки чека расхода

Нет

operDay

Date

Операционный день

Да

shop

Long

Номер магазина

Да

cash

Long

Номер кассы

Да

shift

Long

Номер смены

Да

number

Long

Номер чека

Да

saletime

DateTime

Дата/Время продажи

Нет

begintime

DateTime

Дата создания чека (добавления первого товара)

Нет

amount

Decimal

Сумма чека

Нет

discountAmount

Decimal

Сумма скидки на чек

Нет

inn

String

ИНН юридического лица в смене

Нет

qrcode

String

Состав QR-кода чека отправленного в ОФД

Начиная с версии веб-сервиса 1.7

https://crystals.atlassian.net/browse/SRTE-2915

10.2.89.0

Пример XML выгрузки чека с QR-кодом

Нет

fiscalDocNum

String

Номер фискального документа

https://crystals.atlassian.net/browse/SRTE-3135

https://crystals.atlassian.net/browse/CR-4879

10.2.93.0

Пример чека с номером фискального документа

Нет

storno

 

Boolean

Признак чека, если он был хоть раз отложен (через функцию отложить чек) и восстановлен на кассе.

Начиная с версии веб-сервиса 1.9

https://crystals.atlassian.net/browse/SRTE-3562

https://crystals.atlassian.net/browse/CR-5382

10.2.99.0

 

Данный тип экспорта должен быть активирован. По умолчанию выключен.

  • true - чек сторнирован

Если чек не сторнировался, то данный атрибут не отображается.

Пример сторнированного чека

Нет

status

 

Комплексный

Статус чека

Начиная с версии веб-сервиса 1.9

https://crystals.atlassian.net/browse/SRTE-3562

https://crystals.atlassian.net/browse/CR-5382

10.2.99.0

 

Данный тип экспорта должен быть активирован. По умолчанию выключен.

  • CANCELLED - Чек аннулирован

  • DEFERRED - Чек отложен

  • NONFISCAL - Нефискальный документ

  • REGISTERED - Чек зарегистрирован

Пример чека со статусом

Нет

cashType

String

Тип кассы

Тип кассы не выгружается, если экспорт чека с кассы был напрямую в SetESB, без участия SetCentrum или SetRetail.

10.3.16.0

Версия веб-сервиса 1.11

  • POS - клавиатурная;

  • TOUCH_2 - SetTouch;

  • SCO - касса самообслуживания, CSI-K.

example.xml

https://crystals.atlassian.net/browse/SRTS-1003

https://crystals.atlassian.net/browse/CR-8367

Нет

fiscalnum

String

Регистрационный номер фискального регистратора

Версия веб-сервиса 1.12

https://crystals.atlassian.net/browse/SRTS-1103

https://crystals.atlassian.net/browse/SRTS-1104

https://crystals.atlassian.net/browse/CR-8476

10.3.17.0

Пример экспорта чека

Нет

Наименование элемента

Тип данных

Описание

Обязательное

positions

Комплексный

Товарные позиции

Да

payments

Комплексный

Оплаты

Да

discountCards

Комплексный

Список дисконтных карт, примененных при оплате этого чека

Нет

card

Комплексный

Список карт, использованных при оплате этой покупки. Фактически более
детализированная версия содержимого элемента "discountCards"

Нет

original-purchase

Комплексный

Оригинальный чек продажи для возвратного чека (purchaseType)

Нет

exciseBottles

Комплексный

Бутылки с акцизными марками

Нет

presents

Комплексный

Выданные подарки

Нет

coupons

Комплексный

Выданные купоны

https://crystals.atlassian.net/browse/SLS-1290

https://crystals.atlassian.net/browse/SLS-1295

https://crystals.atlassian.net/browse/CR-5582

10.3.4.0

Нет

discount

Комплексный

Список скидок, сработавших в этом чеке

Нет

discountCard

Комплексный

Список дисконтных карт, примененных при оплате этого чека

Нет

bonuses

Комплексный

Список бонусных транзакций, проведенных в этом чеке

Нет

plugin-property

Комплексный

Список "плагинных" (расширенных, не базовых) свойств этого чека.
Может отсутствовать.

Нет

Плагинные свойства чека <plugin-property>

purchases/purchase/plugin-property

Наименование атрибута

Тип данных

Описание

Обязательное

key

String

Наименование плагинного свойства

Да

value

String

Значение плагинного свойства

Нет

Дополнительная информация по мягкому чеку SetKit

https://crystals.atlassian.net/browse/SR-2709

10.2.63.0

SetKit ◾️ Дополнительная информация о заказе в чеке

Наименование плагинного свойства

Описание

sc.num.[ИДЕНТИФИКАТОР_МЯГКОГО_ЧЕКА]

Идентификатор мягкого чека

value

Дополнительная информация по мягкому чеку

Также может выводиться Номер позиции заказаvalue="positionOrder=2"

https://crystals.atlassian.net/browse/KIT-122

https://crystals.atlassian.net/browse/CR-4908

10.2.94.0

Пример мягкого чека с дополнительной информацией
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <purchases count="1"> <purchase tabNumber="5" userName="Admin Admin " operationType="true" operDay="2019-03-05+03:00" shop="3174" cash="1" shift="14" number="6" saletime="2019-03-06T10:56:44.933+03:00" begintime="2019-03-06T10:56:38.862+03:00" amount="46.31" discountAmount="0.0" inn="7802781104"> <plugin-property key="sc.num.88384132" value="Дополнительное сообщение"/> <positions> <position order="1" departNumber="1" goodsCode="1" barCode="5050582541748" count="4.5" cost="10.29" nds="20.0" ndsSum="7.72" discountValue="0.0" costWithDiscount="10.29" amount="46.31" softCheckNumber="88384132" dateCommit="2019-03-06T10:56:38.887+03:00"/> </positions> <payments> <payment typeClass="CashChangePaymentEntity" amount="3.69" description=""/> <payment typeClass="CashPaymentEntity" amount="50.0" description="Оплата наличными"/> </payments> </purchase> </purchases>
Пример мягкого чека с дополнительной информации о номере позиции в заказе
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <purchases count="1"> <purchase tabNumber="1" userName="Администраторов Администратор Администраторович" operationType="true" cashOperation="INCOME" operDay="2021-01-12+03:00" shop="1361" cash="61" shift="1" number="13" saletime="2021-01-13T14:30:04.017+03:00" begintime="2021-01-13T14:29:58.445+03:00" amount="300.0" discountAmount="0.0" inn="7802781104" fiscalDocNum="9;13"> <plugin-property key="externalSystemId" value="13610611610537400465"/> <plugin-property key="sc.num.SK43401740245235" value="order information"/> <plugin-property key="UID_PURCHASE" value="290c1f79-9d4a-4f6b-8f87-c9c575397d87"/> <positions> <position order="1" departNumber="1" goodsCode="00045" barCode="4600045000001" count="1.0" cost="100.0" nds="20.0" ndsSum="16.67" discountValue="0.0" costWithDiscount="100.0" amount="100.0" softCheckNumber="SK43401740245235" dateCommit="2021-01-13T14:29:58.463+03:00" insertType="10"> <plugin-property key="sc.num.SK43401740245235" value="positionOrder=1"/> <plugin-property key="countryName" value="Бельгия"/> </position> <position order="2" departNumber="1" goodsCode="00046" barCode="4600046000000" count="1.0" cost="200.0" nds="20.0" ndsSum="33.33" discountValue="0.0" costWithDiscount="200.0" amount="200.0" softCheckNumber="SK43401740245235" dateCommit="2021-01-13T14:29:58.494+03:00" insertType="10"> <plugin-property key="sc.num.SK43401740245235" value="positionOrder=2"/> <plugin-property key="countryName" value="Бельгия"/> </position> </positions> <payments> <payment typeClass="CashPaymentEntity" amount="300.0" description="Оплата наличными"/> </payments> </purchase> </purchases>

Передача информации о печати, электронной отправке и принудительной печати в составе чека

https://crystals.atlassian.net/browse/SR-4874

10.2.99.0

https://crystals.atlassian.net/browse/SR-5018

10.3.3.0

Наименование плагинного свойства

Описание

Наименование плагинного свойства

Описание

PRINT_DISABLED

Признак фискализации чека без печати (отправка чека электронным способом).

Значение по умолчанию: false (не заполняется).

PROMO_PRINT_DISABLED

Признак того, что рекламные материалы не были распечатаны.

Значение по умолчанию: false (не заполняется).

FORCED_PRINT

Признак того, что чек был распечатан принудительно.

Значение по умолчанию: false (не заполняется).

CLIENT_REQUISITES_TYPE

Тип реквизитов клиента, на которые был отправлен чек (EMAIL, MOBILE_PHONE).

Не заполняется если реквизитов нет.

CUSTOMER_RECEIPT_REFUSE

Признак отказа от печати чека, полученный из карточки клиента в модуле CDP: Покупатели

Выгружается только при подключенном модуле CDP: Покупатели

Пример экспорта

https://crystals.atlassian.net/browse/SR-6664

https://crystals.atlassian.net/browse/CR-10277

10.3.30.0

CUSTOMER_PROMO_REFUSE

Признак отказа от печати купонов и промоматериалов, полученный из карточки клиента в модуле CDP: Покупатели

Выгружается только при подключенном модуле CDP: Покупатели

Пример экспорта

https://crystals.atlassian.net/browse/SR-6664

https://crystals.atlassian.net/browse/CR-10277

10.3.30.0

<purchases count="1"> <purchase tabNumber="1" userName="Администраторов Администратор Администраторович" operationType="true" operDay="2019-06-24+03:00" shop="1782" cash="61" shift="1" number="2" saletime="2019-06-24T14:44:00.924+03:00" begintime="2019-06-24T14:43:29.727+03:00" amount="845.34" discountAmount="1268.04" inn="7802781104"> <plugin-property key="PROMO_PRINT_DISABLED" value="true"/> <plugin-property key="PRINT_DISABLED" value="true"/> <plugin-property key="CLIENT_REQUISITES_TYPE" value="EMAIL"/> <positions> <position order="1" departNumber="351" goodsCode="45633" barCode="4607141313337" count="1.0" cost="28.8" nds="10.0" ndsSum="2.62" discountValue="0.0" costWithDiscount="28.8" amount="28.8" dateCommit="2020-07-27T15:11:02.463+03:00"> <plugin-property key="countryName" value="Россия"/> </position> </positions> <payments> <payment typeClass="CashPaymentEntity" amount="90.0" description="Оплата наличными"/> <payment typeClass="CashChangePaymentEntity" amount="61.2" description=""/> </payments> <card type="EXTERNAL_COUPON" number="12620003"/> </purchase> </purchases>

Данные отложенного чека

https://crystals.atlassian.net/browse/SRTB-5270

https://crystals.atlassian.net/browse/CR-5382

10.3.1.0

Наименование плагинного свойства

Описание

PURCHASE_DEFERRED

Признак отложенного чека

value

Содержание отложенного чека в формате JSON

Пример чека

Нефискальный документ

ТОЛЬКО ДЛЯ WEB-СЕРВИСА НА СТОРОНЕ SETRETAIL

https://crystals.atlassian.net/browse/SRTE-2318

10.2.78.0

https://crystals.atlassian.net/browse/SRTB-5584

10.3.7.0

Наименование плагинного свойства

Описание

NON_FISCAL_DOCUMENT_TYPE

Тип нефискального документа

value

Значение типа нефискального документа

  • LEGAL_ENTITY_ORDER - заказ юридического лица

  • OPEN_UP_TARE - вскрытие тары

NON_FISCAL_DOCUMENT_NUMBER

Номер документа-основания нефискального документа.

Выгрузка настраивается отдельно для каждого типа нефискального документа, подробнее в статье SetRetail10 ◾️ Ввод номера нефискального документа.

https://crystals.atlassian.net/browse/SRTB-9728

https://crystals.atlassian.net/browse/CR-13898

10.4.18.0

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <purchases count="1"> <purchase tabNumber="99999" userName="Иванов Пётр " operationType="true" cashOperation="INCOME" operDay="2022-06-02+03:00" shop="42" cash="1" shift="72" number="2" saletime="2022-06-02T14:35:10.578+03:00" begintime="2022-06-02T14:34:26.279+03:00" amount="255.00" discountAmount="0.00" inn="7802781104" status="NONFISCAL"> <plugin-property key="NON_FISCAL_DOCUMENT_TYPE" value="OPEN_UP_TARE"/> <plugin-property key="FISCAL_DOC_ID" value="0"/> <plugin-property key="KPP" value="780201001"/> <plugin-property key="NON_FISCAL_DOCUMENT_NUMBER" value="22354"/> <positions> <position order="1" departNumber="582" goodsCode="45036" barCode="4607145132030" count="1.000" cost="255.00" nds="20.0" ndsSum="0.00" discountValue="0.00" costWithDiscount="255.00" amount="255.00" dateCommit="2022-06-02T14:35:07.771+03:00" insertType="1"> <plugin-property key="countryName" value="Россия"/> </position> </positions> <payments/> <exciseBottles> <bottle barcode="4607145132030" exciseBarcode="507100000000010118001D5CCFC794963898C1B13E41231CKY42T7UDIJJY2AWLHS7HPGINLMY7PQPDNJALVS42WNCHYRCO257SPCSCF4ASM37BZNTLIASYRVGFUTCXDXDJPML5MMVLEEHZWPWJVI" volume="1.0" price="255.00"/> </exciseBottles> </purchase> </purchases>

Уникальный идентификатор экземпляра чека

https://crystals.atlassian.net/browse/SRTB-4485

https://crystals.atlassian.net/browse/CR-2350

10.2.91.0

Наименование плагинного свойства

Описание

UID_PURCHASE

Признак уникального идентификатора чека