ВЕРСИЯ WEB-СЕРВИСА 1.4
Методы веб-сервиса для экспорта Z-отчетов
За заданный операционный день | |
Метод | getZReportsByOperDay |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
dateOperDay | date | Операционный день в формате YYYY-MM-DD | Нет |
Возвращаемые параметры | |||
return | base64Binary | Z-отчеты за операционный день |
Описание формата выгрузки Z-отчётов
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getZReportsByOperDay> <!--Optional:--> <dateOperDay>2019-05-28</dateOperDay> </plug:getZReportsByOperDay> </soapenv:Body> </soapenv:Envelope>
-
За заданный операционный день c вводом параметров | |
Метод | getZReportsByOperDayData |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
Year | integer | Год | Нет |
Mobth Параметр | string | Месяц в текстовом формате:
| Да |
Day | integer | День месяца | Нет |
Возвращаемые параметры | |||
return | base64Binary | Z-отчеты за операционный день |
Описание формата выгрузки Z-отчётов
Методы getZReportsByOperDay и getZReportsByOperDayData отличаются только способом передачи параметров.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getZReportsByOperDayData> <Year>2019</Year> <!--Optional:--> <Mobth>MAY</Mobth> <Day>28</Day> </plug:getZReportsByOperDayData> </soapenv:Body> </soapenv:Envelope>
-
За заданный период | |
Метод | getZReportsByPeriod |
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 | Z-отчеты за операционный день |
Описание формата выгрузки Z-отчётов
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getZReportsByPeriod> <!--Optional:--> <fromDate>2018-12-01</fromDate> <!--Optional:--> <toDate>2019-05-13</toDate> </plug:getZReportsByPeriod> </soapenv:Body> </soapenv:Envelope>
-
По заданным параметрам | |
Метод | getZReportsByParams |
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 | Номер смены | Нет |
Возвращаемые параметры | |||
return | base64Binary | Z-отчеты по заданным параметрам |
Описание формата выгрузки Z-отчётов
Параметры shopNumber, cashNumber, shiftNumber – являются необязательными.
В зависимости от полноты указания параметров, в ответе будет возвращаться соответствующее количество смен.
Кейсы
dateOperDay
- в отчёт попадают все смены всех магазинов за операционный деньdateOperDay
.dateOperDay
,shopNumber
- в отчёт попадают все смены за операционный деньdateOperDay
с магазинаshopNumber
.dateOperDay
,shopNumber
,cashNumber
- в отчёт попадают все смены за операционный деньdateOperDay
с магазинаshopNumber
с кассыcashNumber
.dateOperDay
,shopNumber
,cashNumber
,shiftNumber
- в отчёт попадает сменаshiftNumber
за операционный деньdateOperDay
с магазинаshopNumber
с кассыcashNumber
.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:plug="http://plugins.operday.ERPIntegration.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <plug:getZReportsByParams> <dateOperDay>2019-05-13</dateOperDay> <!--Optional:--> <shopNumber>3455</shopNumber> <!--Optional:--> <cashNumber>1</cashNumber> <!--Optional:--> <shiftNumber>16</shiftNumber> </plug:getZReportsByParams> </soapenv:Body> </soapenv:Envelope>
-
Новые, не отправленные Z-отчеты | |
Метод | getNewZReportsByOperDay |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl |
- Выгружаются только новые Z-отчеты (те которые ещё не забирали).
- Выгружаются все новые Z-отчеты за указанный операционный день, либо удовлетворяющие заданным параметрам, если они указаны.
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
arrayOfParams | array | Массив параметров по следующему формату:
| Да |
Возвращаемые параметры | |||
return | base64Binary | Z-отчеты за операционный день или по заданным параметрам |
Описание формата выгрузки Z-отчётов
<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: getNewZReportsByOperDay > <!---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> </plug: getNewZReportsByOperDay > </soapenv:Body> </soapenv:Envelope>
-
Выгрузка новых, не отправленных Z-отчётов за операционный день с вводом параметров | |
Метод | getNewZReportsByParams |
URL | http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport |
WSDL | http://IP-адрес_сервера:8090/SET-ERPIntegration/FiscalInfoExport?wsdl |
Комментарий | Выгружаются все новые Z-отчеты за указанный операционный день, либо удовлетворяющие заданным параметрам, если они указаны. |
10.2.66.0 |
Поле | Тип данных | Описание | Обязательное |
Принимаемые параметры | |||
dateOperDay | date | Операционный день | Да |
shopNumber | integer | Номер магазина | Да |
cashNumber | integer | Номер кассы | Да |
shiftNumber | integer | Номер смены | Да |
purchaseNumber | 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:getNewZReportsByParams> <dateOperDay>2019-05013</dateOperDay> <!--Optional:--> <shopNumber>3328</shopNumber> <!--Optional:--> <cashNumber>3</cashNumber> <!--Optional:--> <shiftNumber>14</shiftNumber> </plug:getNewZReportsByParams> </soapenv:Body> </soapenv:Envelope>
Z-отчёты <reports>
reports | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
count | Long | Количество Z-отчётов | Да |
Наименование элемента | Тип данных | Описание | Обязательное |
zreport | Комплексный | Данные Z-отчётов | Да |
Состав Z-отчёта <zreport>
reports/zreport | |||
Наименование элемента | Тип данных | Описание | Обязательное |
reportType | String | Тип отчёта (Zreport, Xreport) | Да |
shiftNumber | Long | Номер смены | Да |
shopNumber | Long | Номер магазина | Да |
docNumber | Long | Номер документа | Да |
cashNumber | Long | Номер кассы | Да |
serialCashNumber | String | Серийный номер ФР | Да |
userTabNumber | Long | Табельный номер кассира | Да |
userName | String | ФИО кассира | Да |
dateOperDay | dateTime | Дата и время операционного дня | Да |
dateShiftClose | dateTime | Дата и время закрытия смены | Да |
dateShiftOpen | dateTime | Дата и время открытия смены | Да |
countCashPurchase | Long | Количество чеков продаж за наличные | Да |
countCashlessPurchase | Long | Количество чеков продаж за б/наличные | Да |
countPurchase | Long | Количество чеков продаж | Да |
countCashReturn | Long | Количество чеков возврата за наличные | Да |
countCashlessReturn | Long | Количество чеков возврата за б/наличные | Да |
countReturn | Long | Количество чеков возврата | Да |
counterIncoming | Long | Количество внесений в кассу | Да |
counterWithdrawal | Long | Количество изъятий из кассы | Да |
amountByCashPurchase | Decimal | Сумма продаж за наличные | Да |
amountByCashlessPurchase | Decimal | Сумма продаж за б/наличные | Да |
amountByPurchaseFiscal | Decimal | Сумма продаж из ФП | Да |
amountByCashReturn | Decimal | Сумма возвратов наличных | Да |
amountByCashlessReturn | Decimal | Сумма возвратов б/наличных | Да |
amountByReturnFiscal | Decimal | Сумма возвратов из ФП | Да |
amountCashIn | Decimal | Сумма внесений | Да |
amountCashOut | Decimal | Сумма изъятий | Да |
amountCashDiscount | Decimal | Сумма скидок | Да |
returnDiscountCashPay | Decimal | Сумма скидок по возвратам | Да |
incresentTotalStart | Long | Накопительный счётчик продаж на начало смены (в копейках) | Да |
incresentTotalFinish | Long | Накопительный счётчик продаж на конец смены (в копейках) | Да |
incresentTotalReturnStart | Long | Накопительный счётчик возвратов на начало смены (в копейках) | Да |
incresentTotalReturnFinish | Long | Накопительный счётчик возвратов на начало смены (в копейках) | Да |
products | Комплексный | Информация по количеству чеков и продажам разных типов товаров | Нет |
factoryCashNumber | String | Заводской номер ФР | Да |
cashName | String | Наименование модели ФР | Да |
inn | String | ИНН юридического лица | Нет |
payments | Комплексный | Информация по количеству типов оплат на каждый чек | Нет |
taxes | Комплексный | Сумма налогов за смену - ESB-27Получение подробных данных проблемы… СТАТУС 10.2.59.0 Версия веб-сервиса 1.3 | Нет |
reversals | Комплексный | Список операций по чеку расхода. - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 Описание работы расходных операций в непубличной статье. | Нет |
countExpenseReceipt | Long | Количество чеков расхода - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
countCashExpenseReceipt | Long | Количество наличных чеков расхода - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
countCashlessExpenseReceipt | Long | Количество безналичных чеков расхода - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
amountByExpenseReceipt | Decimal | Сумма чеков расхода - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
amountByExpenseReceiptFiscal | Decimal | Сумма чеков расхода в ФР - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
amountByCashExpenseReceipt | Decimal | Сумма наличных чеков расхода - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
amountByCashlessExpenseReceipt | Decimal | Сумма безналичных чеков расхода - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
incresentTotalExpenseStart | Long | Нарастающий итог расхода на начало смены - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
incresentTotalExpenseFinish | Long | Нарастающий итог расхода на конец смены - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
countReturnExpenseReceipt | Long | Количество чеков возврата расхода - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
countCashReturnExpenseReceipt | Long | Количество наличных чеков возврата расхода - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
countCashlessReturnExpenseReceipt | Long | Количество безналичных чеков возврата расхода - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
amountByReturnExpenseReceipt | Decimal | Сумма чеков возврата расхода - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
amountByReturnExpenseReceiptFiscal | Long | Сумма чеков возврата расхода в ФР - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
amountByCashReturnExpenseReceipt | Decimal | Сумма наличных чеков возврата расхода - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
amountByCashlessReturnExpenseReceipt | Decimal | Сумма безналичных чеков возврата расхода - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
incresentTotalReturnExpenseStart | Long | Нарастающий итог возврата расхода на начало смены - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
incresentTotalReturnExpenseFinish | Long | Нарастающий итог возврата расхода на конец смены - CR-3746Получение подробных данных проблемы… СТАТУС - SRTS-26Получение подробных данных проблемы… СТАТУС 10.2.97.0 Версия веб-сервиса 1.4 | Да |
Группировка по типам товаров <product>
Для включения экспорта группировки по типам товаров выполните скрипт в базе данных set
UPDATE public.sales_management_properties SET property_value='true' WHERE property_key='export.set10wsclient.zreports.include.products';
reports/zreport/products/product | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
typeClass | String | Тип товара | Нет |
amountPurchase | Decimal | Сумма продажи | Нет |
amountReturn | Decimal | Сумма возвратов | Нет |
Группировка по типам оплат <payments>
- SRTE-1182Получение подробных данных проблемы… СТАТУС
10.2.36.0
reports/zreport/payments | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
typeClass | String | Тип оплаты | Нет |
amountPurchase | Decimal | Сумма продаж | Нет |
amountReturn | Decimal | Сумма возвратов | Нет |
amountExpense | Decimal | Сумма чека расхода | Нет |
amountReturnExpense | Decimal | Сумма чека расхода по возврату | Нет |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <reports count="1"> <zreport> <reportType>ZReport</reportType> <shiftNumber>9</shiftNumber> <shopNumber>6417</shopNumber> <docNumber>6</docNumber> <cashNumber>10</cashNumber> <serialCashNumber>NFM.6417.10.0.1505978075854</serialCashNumber> <userTabNumber>1</userTabNumber> <userName>CASHIE USER TEST</userName> <dateOperDay>2017-09-28T00:00:00.000+03:00</dateOperDay> <dateShiftClose>2017-09-28T12:15:36.608</dateShiftClose> <dateShiftOpen>2017-09-28T12:14:27.908</dateShiftOpen> <countCashPurchase>1</countCashPurchase> <countCashlessPurchase>1</countCashlessPurchase> <countPurchase>1</countPurchase> <countCashReturn>1</countCashReturn> <countCashlessReturn>1</countCashlessReturn> <countReturn>2</countReturn> <counterIncoming>1</counterIncoming> <counterWithdrawal>1</counterWithdrawal> <amountByCashPurchase>300.46</amountByCashPurchase> <amountByCashlessPurchase>1914.46</amountByCashlessPurchase> <amountByPurchaseFiscal>2214.92</amountByPurchaseFiscal> <amountByCashReturn>157.23</amountByCashReturn> <amountByCashlessReturn>300.23</amountByCashlessReturn> <amountByReturnFiscal>457.46</amountByReturnFiscal> <amountCashIn>100.0</amountCashIn> <amountCashOut>100.0</amountCashOut> <amountCashDiscount>0.0</amountCashDiscount> <returnDiscountCashPay>0.0</returnDiscountCashPay> <incresentTotalStart>837991</incresentTotalStart> <incresentTotalFinish>1059483</incresentTotalFinish> <incresentTotalReturnStart>30023</incresentTotalReturnStart> <incresentTotalReturnFinish>75769</incresentTotalReturnFinish> <factoryCashNumber>00000641710</factoryCashNumber> <cashName>Fiscal printer emulator 0</cashName> <inn>7802781104</inn> <payments> <payment typeClass="CashPaymentEntity" amountPurchase="300.46" amountReturn="157.23"/> <payment typeClass="ExternalBankTerminalPaymentEntity" amountPurchase="300.00"/> <payment typeClass="BankCardPaymentEntity" amountPurchase="314.46" amountReturn="300.23"/> <payment typeClass="ChildrenCardPaymentEntity" amountPurchase="1300.00"/> </payments> </zreport> </reports>
Сумма налогов за смену <taxes>
reports/zreport/taxes/tax | |||
Наименование элемента | Тип данных | Описание | Обязательное |
tax | Комплексный | Ставка налога | Да |
Наименование атрибута | Тип данных | Описание | Обязательное |
nds | Integer | Ставка НДС | Да |
ndsSumSale | Decimal | Сумма налога по всем проданным товарам за смену по ставке НДС | Да |
ndsSumReturn | Decimal | Сумма налога по всем возвращённым товарам за смену по ставке НДС | Да |
sumPosition | Decimal | Сумма всех товаров за смену по ставке НДС | Да |
Список операций по чеку расхода <reversals>
- CR-3746Получение подробных данных проблемы… СТАТУС
- SRTS-26Получение подробных данных проблемы… СТАТУС
10.2.97.0
Версия веб-сервиса 1.4
Описание работы расходных операций в SetRetail10 ◾️ Mastercard ◾️ Выдача наличных на кассе.
reports/zreport/reversals/reversal | |||
Наименование элемента | Тип данных | Описание | Обязательное |
reversal | Комплексный | Данные о типах расходных операций кроме выдачи/продажи | Нет |
Наименование атрибута | Тип данных | Описание | Обязательное |
operation | Комплексный | Операция:
| Нет |
amount | Decimal | Количество товаров по данной операции. | Нет |
sum | Decimal | Сумма стоимости товаров по данной операции. | Нет |