GetZReportByDate: відмінності між версіями
Перейти до навігації
Перейти до пошуку
(Створена сторінка: =='''Функція повертає дані Z-звіту по терміналу'''== Розділ містить методи, необхідні для отримання даних Z-звіту по терміналу <br> {| cellspacing="3" cellpadding="0" style="width:100%; clear:both; margin:0.5em auto; background-color:#eaecf0; border:1px solid #c8ccd1;" |- ! style="background:#cdf; padding:0.5em; text-align:left; width:15%" id="fileinfotpl_des...) |
|||
| (Не показано 36 проміжних версій цього користувача) | |||
| Рядок 1: | Рядок 1: | ||
=='''Функція повертає дані Z-звіту по | =='''Функція повертає дані Z-звіту по ПРРО'''== | ||
Розділ містить методи, необхідні для отримання даних Z-звіту по | Розділ містить методи, необхідні для отримання даних Z-звіту по '''ПРРО''' | ||
<br> | <br> | ||
| Рядок 7: | Рядок 7: | ||
|- | |- | ||
! style="background:#cdf; padding:0.5em; text-align:left; width:15%" id="fileinfotpl_desc" | Опис | ! style="background:#cdf; padding:0.5em; text-align:left; width:15%" id="fileinfotpl_desc" | Опис | ||
| style="background:#fff; padding:0.5em;" | Отримання даних | | style="background:#fff; padding:0.5em;" | Отримання даних Z-звіту. | ||
|- | |- | ||
! style="background:#cdf; padding:0.5em; text-align:left;" id="fileinfotpl_src" | Метод | ! style="background:#cdf; padding:0.5em; text-align:left;" id="fileinfotpl_src" | Метод | ||
| Рядок 13: | Рядок 13: | ||
|- | |- | ||
! style="background:#cdf; padding:0.5em; text-align:left;" id="fileinfotpl_date" | URL | ! style="background:#cdf; padding:0.5em; text-align:left;" id="fileinfotpl_date" | URL | ||
| style="background:#fff; padding:0.5em;" | /POSExternal/ | | style="background:#fff; padding:0.5em;" | /POSExternal/GetZReportByDate | ||
|} | |||
<br> | |||
<br> | |||
{| class="wikitable mw-collapsible" | |||
! style="width:40%; background:#accae4;" scope="row" colspan="2"| '''Request Headers''' | |||
|- | |||
! scope="col"| KEY | |||
! scope="col"| VALUE | |||
|- | |||
| Content-Type | |||
| application/json | |||
|- | |||
| AccessToken | |||
| | |||
|- | |||
|} | |||
<br> | |||
<br> | |||
{| class="wikitable" | |||
! style="width:40%; background:#accae4;" scope="row" colspan="2"| '''Body''' raw (json) | |||
|} | |||
<div class="mw-collapsible"; overflow: hidden;"> | |||
<syntaxhighlight lang="json"> | |||
{ | |||
"StartDate": "2024-08-01 08:00:00", | |||
"EndDate": "2024-08-01 23:00:00", | |||
"CashRegisterNumber": null | |||
} | |||
</syntaxhighlight> | |||
</div> | |||
<br> | |||
<br> | |||
{| class="wikitable sortable mw-collapsible" | |||
! style="width:90%; background:#accae4;" scope="row" colspan="4"| '''Типи даних Body''' | |||
|- | |||
! scope="col"; class="wikitable"; style="width:5px; | * | |||
! scope="col"| Параметр | |||
! scope="col"| Тип | |||
! scope="col"| Опис | |||
|- | |||
|<span style="color:#ff0000"><center>*</center></span> | |||
| BeginDate | |||
| DateTime | |||
| Початкова дата та час | |||
|- | |||
|<span style="color:#ff0000"><center>*</center></span> | |||
| EndDate | |||
| DateTime | |||
| Дата та час закінчення | |||
|- | |||
|<span style="color:#ff0000"><center>*</center></span> | |||
| CashRegisterNumber | |||
| Int64 | |||
| Фіскальний номер ПРРО<br>Якщо передано значення - повертаються Z-звіти тільки по вказаній ПРРО;<br>Null - повертаються Z-звіти по всіх ПРРО;<br> | |||
|- | |||
!style="width:50%; background:#accae4;" scope="row" colspan="4"| * Позначення обов’язкового параметру | |||
|- | |||
|} | |||
<br> | |||
<br> | |||
{| class="wikitable" | |||
! style="width:40%; background:#accae4;" scope="row" colspan="2"| '''Response''' (json) | |||
|} | |||
<div class="mw-collapsible"; overflow: hidden;"> | |||
<syntaxhighlight lang="json"> | |||
{ | |||
"Error": "", | |||
"Success": true, | |||
"ClientTime": "2026-07-03 11:24:41", | |||
"ErrorCode": 0, | |||
"ZReports": [ | |||
{ | |||
"CashDeskNum": 7770000000, | |||
"CashRegisterNum": 7770000000, | |||
"Cashier": "Тестовий касир", | |||
"DocClass": 1, | |||
"Ipn": "12345678", | |||
"Mac": "ac6bd5b030c84ca22c6a01b287b36517", | |||
"OrderDate": "03.07.2026 11:24:17", | |||
"OrderNum": 1785, | |||
"OrgName": "Тестова організація", | |||
"PointAddr": "м.Київ, Подільський район, Тестова, 39г", | |||
"PointName": "Тестова", | |||
"PrevDocHash": null, | |||
"PrintSettings": null, | |||
"PrinterSettings": null, | |||
"Tin": "12345678", | |||
"Uid": "d7d8892a-8d5f-4cc2-b069-563b34954053", | |||
"XML": null, | |||
"CloseBalance": 15743027.99, | |||
"FooterText": null, | |||
"LastCheckOrderTaxNum": "eb4a47c0", | |||
"Offline": false, | |||
"OpenBalance": 15742327.99, | |||
"OrderTaxNum": "7ce6dbc3", | |||
"Realiz": { | |||
"OrdersCount": 11, | |||
"Pays": [ | |||
{ | |||
"PayFormCode": 0, | |||
"PayFormName": "ГОТІВКА_3", | |||
"PaymentSystem": null, | |||
"Provided": 0.0, | |||
"RRN": null, | |||
"Remains": 0.0, | |||
"Sum": 700.00 | |||
}, | |||
{ | |||
"PayFormCode": 1, | |||
"PayFormName": "ПЛАТІЖНА КАРТКА", | |||
"PaymentSystem": null, | |||
"Provided": 0.0, | |||
"RRN": null, | |||
"Remains": 0.0, | |||
"Sum": 290.00 | |||
} | |||
], | |||
"RoundDownSum": 0.00, | |||
"RoundUpSum": 0.00, | |||
"Taxes": [], | |||
"Total": 990.00 | |||
}, | |||
"Return": { | |||
"OrdersCount": 0, | |||
"Pays": [], | |||
"RoundDownSum": 0.00, | |||
"RoundUpSum": 0.00, | |||
"Taxes": [], | |||
"Total": 0.0 | |||
}, | |||
"ServiceInput": 0.00, | |||
"ServiceOutput": 0.00, | |||
"ShiftCloseDate": "03.07.2026 11:24:17", | |||
"ShiftEnd": "03.07.2026 11:24:17", | |||
"ShiftLocalNum": 0, | |||
"ShiftOpenDate": "01.07.2026 14:10:36", | |||
"ShiftOpened": false, | |||
"ShiftStart": "01.07.2026 14:10:36" | |||
} | |||
] | |||
} | |||
</syntaxhighlight> | |||
</div> | |||
<br> | |||
<br> | |||
{| class="wikitable sortable mw-collapsible" | |||
! style="width:90%; background:#accae4;" scope="row" colspan="4"| '''Типи даних Response''' | |||
|- | |||
! scope="col"; class="wikitable"; style="width:5px; | * | |||
! scope="col"| Параметр | |||
! scope="col"| Тип | |||
! scope="col"| Опис | |||
|- | |||
| | |||
| Error | |||
| String [] | |||
| Опис помилки, що виникла | |||
|- | |||
| <!-- <center style="color:#ff0000">*</center> --> <!-- ЗАКОМЕНТОВАНИЙ ПРИЗНАК ОБОВЯЗКОВОГО ПОЛЯ --> | |||
| Success | |||
| Bool | |||
| Успіх виконання запиту | |||
|- | |||
| | |||
| ClientTime | |||
| String / DateTime | |||
| Дата та час виконання запиту на стороні клієнта | |||
|- | |||
| | |||
| <span style="color:#ff0000">ZReports</span> | |||
| <span style="color:#ff0000">ZReport[ ] </span> | |||
| Список Z-звітів: | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> CashDeskNum | |||
| Int | |||
| Номер каси | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> CashRegisterNum | |||
| Int | |||
| Фіскальний номер ПРРО | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> Cashier | |||
| String | |||
| Ім’я касира | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> DocClass | |||
| Int | |||
| Клас документа | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> Ipn | |||
| String | |||
| ІПН організації | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> Mac | |||
| String | |||
| MAC / ідентифікатор пристрою або каси | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> OrderDate | |||
| String / DateTime | |||
| Дата та час формування документа | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> OrderNum | |||
| Int | |||
| Номер документа | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> OrgName | |||
| String | |||
| Назва організації | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> PointAddr | |||
| String | |||
| ID Адреса торгової точки | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> PointName | |||
| String | |||
| Назва торгової точки | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> PrevDocHash | |||
| String / Null | |||
| Хеш попереднього документа | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> PrintSettings | |||
| Object / Null | |||
| Налаштування друку | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> PrinterSettings | |||
| Object / Null | |||
| Налаштування принтера | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> Tin | |||
| String | |||
| Податковий номер організації | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> Uid | |||
| String / GUID | |||
| Унікальний ідентифікатор документа | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> XML | |||
| String / Null | |||
| XML-представлення документа | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> CloseBalance | |||
| Decimal | |||
| Баланс на момент закриття зміни | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> FooterText | |||
| String / Null | |||
| Текст футера документа | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> LastCheckOrderTaxNum | |||
| String | |||
| Фіскальний номер останнього чека | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> Offline | |||
| Bool | |||
| Ознака офлайн-режиму | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> OpenBalance | |||
| Decimal | |||
| Баланс на момент відкриття зміни | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> OrderTaxNum | |||
| String | |||
| Фіскальний номер Z-звіту | |||
|- | |||
| | |||
| <span style="color:#ff0000">Realiz</span> | |||
| <span style="color:#ff0000">ZReportOperation[ ] </span> | |||
| Дані по реалізації: | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> OrdersCount | |||
| Int | |||
| Кількість чеків / операцій | |||
|- | |||
| | |||
| <span style="color:#ff0000">Pays</span> | |||
| <span style="color:#ff0000">Pay [ ] </span> | |||
| Список оплат: | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> <span style="color:#9966CC">'''|'''</span> PayFormCode | |||
| Int | |||
| Код форми оплати | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> <span style="color:#9966CC">'''|'''</span> PayFormName | |||
| String | |||
| Назва форми оплати | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> <span style="color:#9966CC">'''|'''</span> PaymentSystem | |||
| String / Null | |||
| Назва платіжної системи | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> <span style="color:#9966CC">'''|'''</span> Provided | |||
| Decimal | |||
| Сума, надана клієнтом | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> <span style="color:#9966CC">'''|'''</span> RRN | |||
| String / Null | |||
| RRN банківської операції | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> <span style="color:#9966CC">'''|'''</span> Remains | |||
| Decimal | |||
| Решта | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> <span style="color:#9966CC">'''|'''</span> Sum | |||
| Decimal | |||
| Сума оплати | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> RoundDownSum | |||
| Decimal | |||
| Сума округлення в меншу сторону | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> RoundUpSum | |||
| Decimal | |||
| Сума округлення в більшу сторону | |||
|- | |||
| | |||
| <span style="color:#ff0000">Taxes</span> | |||
| <span style="color:#ff0000">Tax [ ] </span> | |||
| Список податків. Якщо податки відсутні, повертається порожній масив | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> Total | |||
| Decimal | |||
| Загальна сума | |||
|- | |||
| | |||
| <span style="color:#ff0000">Return</span> | |||
| <span style="color:#ff0000">Return [ ] </span> | |||
| Дані по поверненнях | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> ServiceInput | |||
| Decimal | |||
| Службове внесення | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> ServiceOutput | |||
| Decimal | |||
| Службова видача | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> ShiftCloseDate | |||
| String / DateTime | |||
| Дата та час закриття зміни | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> ShiftEnd | |||
| String / DateTime | |||
| Дата та час завершення зміни | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> ShiftLocalNum | |||
| Int | |||
| Локальний номер зміни | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> ShiftOpenDate | |||
| String / DateTime | |||
| Дата та час відкриття зміни | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> ShiftOpened | |||
| Bool | |||
| Ознака відкритої зміни | |||
|- | |||
| | |||
| | <span style="color:#ff0000">'''|'''</span> ShiftStart | |||
| String / DateTime | |||
| Дата та час початку зміни | |||
|- | |||
| | |||
Поточна версія на 11:20, 3 липня 2026
Функція повертає дані Z-звіту по ПРРО
Розділ містить методи, необхідні для отримання даних Z-звіту по ПРРО
| Опис | Отримання даних Z-звіту. |
|---|---|
| Метод | POST |
| URL | /POSExternal/GetZReportByDate |
| Request Headers | |
|---|---|
| KEY | VALUE |
| Content-Type | application/json |
| AccessToken | |
| Body raw (json) |
|---|
{
"StartDate": "2024-08-01 08:00:00",
"EndDate": "2024-08-01 23:00:00",
"CashRegisterNumber": null
}
| Типи даних Body | |||
|---|---|---|---|
| * | Параметр | Тип | Опис |
| BeginDate | DateTime | Початкова дата та час | |
| EndDate | DateTime | Дата та час закінчення | |
| CashRegisterNumber | Int64 | Фіскальний номер ПРРО Якщо передано значення - повертаються Z-звіти тільки по вказаній ПРРО; Null - повертаються Z-звіти по всіх ПРРО; | |
| * Позначення обов’язкового параметру | |||
| Response (json) |
|---|
{
"Error": "",
"Success": true,
"ClientTime": "2026-07-03 11:24:41",
"ErrorCode": 0,
"ZReports": [
{
"CashDeskNum": 7770000000,
"CashRegisterNum": 7770000000,
"Cashier": "Тестовий касир",
"DocClass": 1,
"Ipn": "12345678",
"Mac": "ac6bd5b030c84ca22c6a01b287b36517",
"OrderDate": "03.07.2026 11:24:17",
"OrderNum": 1785,
"OrgName": "Тестова організація",
"PointAddr": "м.Київ, Подільський район, Тестова, 39г",
"PointName": "Тестова",
"PrevDocHash": null,
"PrintSettings": null,
"PrinterSettings": null,
"Tin": "12345678",
"Uid": "d7d8892a-8d5f-4cc2-b069-563b34954053",
"XML": null,
"CloseBalance": 15743027.99,
"FooterText": null,
"LastCheckOrderTaxNum": "eb4a47c0",
"Offline": false,
"OpenBalance": 15742327.99,
"OrderTaxNum": "7ce6dbc3",
"Realiz": {
"OrdersCount": 11,
"Pays": [
{
"PayFormCode": 0,
"PayFormName": "ГОТІВКА_3",
"PaymentSystem": null,
"Provided": 0.0,
"RRN": null,
"Remains": 0.0,
"Sum": 700.00
},
{
"PayFormCode": 1,
"PayFormName": "ПЛАТІЖНА КАРТКА",
"PaymentSystem": null,
"Provided": 0.0,
"RRN": null,
"Remains": 0.0,
"Sum": 290.00
}
],
"RoundDownSum": 0.00,
"RoundUpSum": 0.00,
"Taxes": [],
"Total": 990.00
},
"Return": {
"OrdersCount": 0,
"Pays": [],
"RoundDownSum": 0.00,
"RoundUpSum": 0.00,
"Taxes": [],
"Total": 0.0
},
"ServiceInput": 0.00,
"ServiceOutput": 0.00,
"ShiftCloseDate": "03.07.2026 11:24:17",
"ShiftEnd": "03.07.2026 11:24:17",
"ShiftLocalNum": 0,
"ShiftOpenDate": "01.07.2026 14:10:36",
"ShiftOpened": false,
"ShiftStart": "01.07.2026 14:10:36"
}
]
}
| Типи даних Response | |||
|---|---|---|---|
| * | Параметр | Тип | Опис |
| Error | String [] | Опис помилки, що виникла | |
| Success | Bool | Успіх виконання запиту | |
| ClientTime | String / DateTime | Дата та час виконання запиту на стороні клієнта | |
| ZReports | ZReport[ ] | Список Z-звітів: | |
| | CashDeskNum | Int | Номер каси | |
| | CashRegisterNum | Int | Фіскальний номер ПРРО | |
| | Cashier | String | Ім’я касира | |
| | DocClass | Int | Клас документа | |
| | Ipn | String | ІПН організації | |
| | Mac | String | MAC / ідентифікатор пристрою або каси | |
| | OrderDate | String / DateTime | Дата та час формування документа | |
| | OrderNum | Int | Номер документа | |
| | OrgName | String | Назва організації | |
| | PointAddr | String | ID Адреса торгової точки | |
| | PointName | String | Назва торгової точки | |
| | PrevDocHash | String / Null | Хеш попереднього документа | |
| | PrintSettings | Object / Null | Налаштування друку | |
| | PrinterSettings | Object / Null | Налаштування принтера | |
| | Tin | String | Податковий номер організації | |
| | Uid | String / GUID | Унікальний ідентифікатор документа | |
| | XML | String / Null | XML-представлення документа | |
| | CloseBalance | Decimal | Баланс на момент закриття зміни | |
| | FooterText | String / Null | Текст футера документа | |
| | LastCheckOrderTaxNum | String | Фіскальний номер останнього чека | |
| | Offline | Bool | Ознака офлайн-режиму | |
| | OpenBalance | Decimal | Баланс на момент відкриття зміни | |
| | OrderTaxNum | String | Фіскальний номер Z-звіту | |
| Realiz | ZReportOperation[ ] | Дані по реалізації: | |
| | OrdersCount | Int | Кількість чеків / операцій | |
| Pays | Pay [ ] | Список оплат: | |
| | | PayFormCode | Int | Код форми оплати | |
| | | PayFormName | String | Назва форми оплати | |
| | | PaymentSystem | String / Null | Назва платіжної системи | |
| | | Provided | Decimal | Сума, надана клієнтом | |
| | | RRN | String / Null | RRN банківської операції | |
| | | Remains | Decimal | Решта | |
| | | Sum | Decimal | Сума оплати | |
| | RoundDownSum | Decimal | Сума округлення в меншу сторону | |
| | RoundUpSum | Decimal | Сума округлення в більшу сторону | |
| Taxes | Tax [ ] | Список податків. Якщо податки відсутні, повертається порожній масив | |
| | Total | Decimal | Загальна сума | |
| Return | Return [ ] | Дані по поверненнях | |
| | ServiceInput | Decimal | Службове внесення | |
| | ServiceOutput | Decimal | Службова видача | |
| | ShiftCloseDate | String / DateTime | Дата та час закриття зміни | |
| | ShiftEnd | String / DateTime | Дата та час завершення зміни | |
| | ShiftLocalNum | Int | Локальний номер зміни | |
| | ShiftOpenDate | String / DateTime | Дата та час відкриття зміни | |
| | ShiftOpened | Bool | Ознака відкритої зміни | |
| | ShiftStart | String / DateTime | Дата та час початку зміни | |