ВЕРСИЯ WEB-СЕРВИСА 1.8

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

Метод

processZReports - без обратной связи

processZReportsWithTI - с обратной связью

URL

http://Любой_IP-адрес_на стороне_ERP_сервера/Set10ZReportsService

WSDL

http://Любой_IP-адрес_на стороне_ERP_сервера/Set10ZReportsService.wsdl

Поле	Тип данных	Описание	Обязательное
Принимаемые параметры
zreports	base64Binary	Список Z-отчетов в формате XML, закодированный в base64	Да
version	string	Версия xsd схемы выдаваемых данных	Нет
Возвращаемые параметры
return	boolean	`True` в случае успешной обработки пакета	Да

Описание формата выгружаемых Z-отчётов

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	Да
sumCashBegin	Decimal	Сумма в денежном ящике на начало смены SRTS-1776 - Получение подробных данных проблемы… СТАТУС CR-8824 - Получение подробных данных проблемы… СТАТУС 10.3.28.0 Версия веб-сервиса 1.8	Да
sumCashEnd	Decimal	Сумма в денежном ящике на конец смены SRTS-1776 - Получение подробных данных проблемы… СТАТУС CR-8824 - Получение подробных данных проблемы… СТАТУС 10.3.28.0 Версия веб-сервиса 1.8	Да
plugin-property	Комплексный	Список "плагинных" (расширенных, не базовых) свойств этого отчета. Может отсутствовать. SRTS-1138 - Получение подробных данных проблемы… СТАТУС CR-7962 - Получение подробных данных проблемы… СТАТУС 10.3.18.0 Версия веб-сервиса 1.7	Нет

Группировка по типам товаров `<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:

<?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>

Группировка по типам оплат `<subPayment>`

SRTS-1776 - Получение подробных данных проблемы… СТАТУС

CR-8824 - Получение подробных данных проблемы… СТАТУС

10.3.28.0

reports/zreport/payments/subPayment

Наименование атрибута	Тип данных	Описание	Обязательное
typeSubClass	String	Тип подтипа оплаты	Нет
frcode	String	Код ФР	Нет
amountPurchase	Decimal	Сумма продаж	Нет
amountReturn	Decimal	Сумма возвратов	Нет

Сумма налогов за смену `<taxes>`

Начиная с верси 10.4.4.0 актуализирован экспорт налогов.

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

CR-11870 - Получение подробных данных проблемы… СТАТУС

SRTS-2833 - Получение подробных данных проблемы… СТАТУС

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	Комплексный	Операция: `ANNULMENT` - операция аннулирования чека целиком. `CANCEL` - операция отмены добавления позиции, то есть, отмены товара из подвала чека. `STORNO` - операция удаления товарной позиции из чека.	Нет
amount	Decimal	Количество товаров по данной операции.	Нет
sum	Decimal	Сумма стоимости товаров по данной операции.	Нет

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

SRTS-1138 - Получение подробных данных проблемы… СТАТУС

CR-7962 - Получение подробных данных проблемы… СТАТУС

10.3.18.0

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

reports/zreport/plugin-property

Наименование атрибута	Тип данных	Описание	Обязательное
key	String	Наименование плагинного свойства	Да
value	String	Значение плагинного свойства	Нет

Фискальные данные

SRTS-1138 - Получение подробных данных проблемы… СТАТУС

SRTZ-1973 - Получение подробных данных проблемы… СТАТУС

CR-7962 - Получение подробных данных проблемы… СТАТУС

10.3.18.0

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

Наименование плагинного свойства	Описание
FISCAL_DOC_ID	Порядковый номер фискального документа
FN_NUM	Номер фискального накопителя или его аналога
FPD	Фискальный признак документа

Пробег термоголовки Пирит 2Ф

SRTZ-2299 - Получение подробных данных проблемы… СТАТУС

CR-8572 - Получение подробных данных проблемы… СТАТУС

10.3.24.0

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

Только для ФР Пирит 2Ф

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

Описание

THERMO_HEAD_RESOURCE_TOTAL

Общий ресурс термоголовки. Представляет собой общий расход чековой ленты в миллиметрах, на основании которого может быть рассчитан суточный расход

Особенности работы:

при перевыгрузке Z-отчета данные по расходу чековой ленты буду обновленными, т.к. расчет идет накопительным итогом;
при смене принтера данные по расходу чековой ленты будут обнулены.

Пример XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reports count="1">
    <zreport>
        <reportType>ZReport</reportType>
        <shiftNumber>1</shiftNumber>
        <shopNumber>1162</shopNumber>
        <docNumber>8</docNumber>
        <cashNumber>61</cashNumber>
        <serialCashNumber>NFM.1162.61.0.1670846994294</serialCashNumber>
        <userTabNumber>1</userTabNumber>
        <userName>Администраторов Администратор Администраторович</userName>
        <dateOperDay>2022-12-12+03:00</dateOperDay>
        <dateShiftClose>2022-12-12T15:18:54.497</dateShiftClose>
        <dateShiftOpen>2022-12-12T15:18:04.119</dateShiftOpen>
        <countCashPurchase>6</countCashPurchase>
        <countCashlessPurchase>0</countCashlessPurchase>
        <countPurchase>6</countPurchase>
        <countCashReturn>0</countCashReturn>
        <countCashlessReturn>0</countCashlessReturn>
        <countReturn>0</countReturn>
        <counterIncoming>1</counterIncoming>
        <counterWithdrawal>0</counterWithdrawal>
        <amountByCashPurchase>4109.03</amountByCashPurchase>
        <amountByCashlessPurchase>0.00</amountByCashlessPurchase>
        <amountByPurchaseFiscal>4109.03</amountByPurchaseFiscal>
        <amountByCashReturn>0.00</amountByCashReturn>
        <amountByCashlessReturn>0.00</amountByCashlessReturn>
        <amountByReturnFiscal>0.00</amountByReturnFiscal>
        <amountCashIn>195487.00</amountCashIn>
        <amountCashOut>0.00</amountCashOut>
        <amountCashDiscount>0.00</amountCashDiscount>
        <returnDiscountCashPay>0.00</returnDiscountCashPay>
        <incresentTotalStart>0</incresentTotalStart>
        <incresentTotalFinish>410903</incresentTotalFinish>
        <incresentTotalReturnStart>0</incresentTotalReturnStart>
        <incresentTotalReturnFinish>0</incresentTotalReturnFinish>
        <factoryCashNumber>00000116261</factoryCashNumber>
        <cashName>Fiscal printer emulator 0</cashName>
        <inn>7802781104</inn>
        <payments>
            <payment typeClass="CashPaymentEntity" amountPurchase="4109.03"/>
        </payments>
        <reversals/>
        <countExpenseReceipt>0</countExpenseReceipt>
        <countCashExpenseReceipt>0</countCashExpenseReceipt>
        <countCashlessExpenseReceipt>0</countCashlessExpenseReceipt>
        <amountByExpenseReceipt>0.00</amountByExpenseReceipt>
        <amountByExpenseReceiptFiscal>0.00</amountByExpenseReceiptFiscal>
        <amountByCashExpenseReceipt>0.00</amountByCashExpenseReceipt>
        <amountByCashlessExpenseReceipt>0.00</amountByCashlessExpenseReceipt>
        <incresentTotalExpenseStart>0</incresentTotalExpenseStart>
        <incresentTotalExpenseFinish>0</incresentTotalExpenseFinish>
        <countReturnExpenseReceipt>0</countReturnExpenseReceipt>
        <countCashReturnExpenseReceipt>0</countCashReturnExpenseReceipt>
        <countCashlessReturnExpenseReceipt>0</countCashlessReturnExpenseReceipt>
        <amountByReturnExpenseReceipt>0.00</amountByReturnExpenseReceipt>
        <amountByReturnExpenseReceiptFiscal>0.00</amountByReturnExpenseReceiptFiscal>
        <amountByCashReturnExpenseReceipt>0.00</amountByCashReturnExpenseReceipt>
        <amountByCashlessReturnExpenseReceipt>0.00</amountByCashlessReturnExpenseReceipt>
        <incresentTotalReturnExpenseStart>0</incresentTotalReturnExpenseStart>
        <incresentTotalReturnExpenseFinish>0</incresentTotalReturnExpenseFinish>
        <plugin-property key="FISCAL_DOC_ID" value="9"/>
        <plugin-property key="FN_NUM" value="3701669721244726"/>
        <plugin-property key="FPD" value="1000009"/>
		<plugin-property key="THERMO_HEAD_RESOURCE_TOTAL" value="563018"/>
    </zreport>
</reports>

Интеграция

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

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

Z-отчёты `<reports>`

Состав Z-отчёта `<zreport>`

Группировка по типам товаров `<product>`

Группировка по типам оплат `<payments>`

Группировка по типам оплат `<subPayment>`

Сумма налогов за смену `<taxes>`

Список операций по чеку расхода `<reversals>`

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

Фискальные данные

Пробег термоголовки Пирит 2Ф

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

[data-colorid=mw77slbs5w]{color:#808080} html[data-color-mode=dark] [data-colorid=mw77slbs5w]{color:#7f7f7f}[data-colorid=zmsfdi88kz]{color:#808080} html[data-color-mode=dark] [data-colorid=zmsfdi88kz]{color:#7f7f7f}Методы веб-сервиса для экспорта Z-отчетов

Z-отчёты <reports>

Состав Z-отчёта <zreport>

Группировка по типам товаров <product>

Группировка по типам оплат <payments>

Группировка по типам оплат <subPayment>

Сумма налогов за смену <taxes>

Список операций по чеку расхода <reversals>

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

Фискальные данные

Пробег термоголовки Пирит 2Ф

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

Z-отчёты `<reports>`

Состав Z-отчёта `<zreport>`

Группировка по типам товаров `<product>`

Группировка по типам оплат `<payments>`

Группировка по типам оплат `<subPayment>`

Сумма налогов за смену `<taxes>`

Список операций по чеку расхода `<reversals>`

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