GetZReportByDate: відмінності між версіями

Матеріал з expertsolution
Перейти до навігації Перейти до пошуку
 
(Не показані 33 проміжні версії цього користувача)
Рядок 1: Рядок 1:
=='''Функція повертає дані Z-звіту по терміналу'''==
=='''Функція повертає дані Z-звіту по ПРРО'''==


  Розділ містить методи, необхідні для отримання даних Z-звіту по терміналу
  Розділ містить методи, необхідні для отримання даних Z-звіту по '''ПРРО'''
<br>
<br>


Рядок 38: Рядок 38:
<syntaxhighlight lang="json">
<syntaxhighlight lang="json">
{
{
"StartDate":  
  "StartDate": "2024-08-01 08:00:00",
"EndDate":
  "EndDate": "2024-08-01 23:00:00",
"CashRegisterNumber": null
  "CashRegisterNumber": null
}
}
</syntaxhighlight>
</syntaxhighlight>
</div>  
</div>  
Рядок 54: Рядок 54:
! scope="col"| Опис
! scope="col"| Опис
|-
|-
|
|<span style="color:#ff0000"><center>*</center></span>
| TermID
| BeginDate
| Int
| DateTime
| ID терміналу (не обов'язковий параметр. Якщо не вказаний, то звіт по поточному терміналу)
| Початкова дата та час
|}
|-
 
|<span style="color:#ff0000"><center>*</center></span>
{| cellspacing="3" cellpadding="0" style="width:100%; clear:both; margin:0.5em auto; background-color:#eaecf0; border:1px solid #c8ccd1;"
| 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"| * Позначення обов’язкового параметру
|-
|-
! style="background:#cdf; padding:0.5em; text-align:left; width:15%" id="fileinfotpl_desc" | Додатковий опис вихідних параметрів
| style="background:#fff; padding:0.5em;" |
|}
|}


Рядок 77: Рядок 84:
     "Error": "",
     "Error": "",
     "Success": true,
     "Success": true,
     "Payments": [],
     "ClientTime": "2026-07-03 11:24:41",
    "PaymentsTotal": 0,
    "ErrorCode": 0,
    "Sections": [],
    "ZReports": [
    "SectionsTotal": 0
        {
            "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>
</syntaxhighlight>
Рядок 88: Рядок 163:


{| class="wikitable sortable mw-collapsible"
{| class="wikitable sortable mw-collapsible"
!  style="width:90%; background:#accae3;" scope="row" colspan="3"| '''Типи даних Response'''
!  style="width:90%; background:#accae4;" scope="row" colspan="4"| '''Типи даних Response'''
|-
|-
! scope="col"; class="wikitable"; style="width:5px; | *
! scope="col"| Параметр
! scope="col"| Параметр
! scope="col"| Тип
! scope="col"| Тип
! scope="col"| Опис
! scope="col"| Опис
|-
|-
|
| Error
| Error
| String  
| String []
| Опис помилки, що виникла
| Опис помилки, що виникла
|-
|-
|  <!-- <center style="color:#ff0000">*</center>  -->                                    <!-- ЗАКОМЕНТОВАНИЙ ПРИЗНАК ОБОВЯЗКОВОГО ПОЛЯ -->
| Success
| Success
| Bool
| Bool
| Успіх виконання запиту
| Успіх виконання запиту
|-
|-
| <span style="color:#ff0000">'''|'''</span> <span style="color:#ff0000">Payments</span>
|  
| <span style="color:#ff0000">Payments []</span>
| ClientTime
| Cписок сум по оплатам виду
| String / DateTime
| Дата та час виконання запиту на стороні клієнта
|-
|
| <span style="color:#ff0000">ZReports</span>
|  <span style="color:#ff0000">ZReport[  ] </span>
| Список Z-звітів:
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> CashDeskNum
| Int
| Номер каси
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> CashRegisterNum
| Int
| Фіскальний номер ПРРО
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Cashier
| String
| Ім’я касира
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> DocClass
| Int
| Клас документа
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Ipn
| String
| ІПН організації
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Mac
| String
| MAC / ідентифікатор пристрою або каси
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> OrderDate
| String / DateTime
| Дата та час формування документа
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> OrderNum
| Int
| Номер документа
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> OrgName
| String
| Назва організації
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> PointAddr
| String
| ID  Адреса торгової точки
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> PointName
| String
| Назва торгової точки
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> PrevDocHash
| String / Null
| Хеш попереднього документа
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> PrintSettings
| Object / Null
| Налаштування друку
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> PrinterSettings
| Object / Null
| Налаштування принтера
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Tin
| String
| Податковий номер організації
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Uid
| String / GUID
| Унікальний ідентифікатор документа
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> XML
| String / Null
| XML-представлення документа
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> CloseBalance
| Decimal
| Баланс на момент закриття зміни
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> FooterText
| String / Null
| Текст футера документа
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> LastCheckOrderTaxNum
| String
| Фіскальний номер останнього чека
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Offline
| Bool
| Ознака офлайн-режиму
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> OpenBalance
| Decimal
| Баланс на момент відкриття зміни
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> OrderTaxNum
| String
| Фіскальний номер Z-звіту
|-
|
| <span style="color:#ff0000">Realiz</span>
|  <span style="color:#ff0000">ZReportOperation[ ] </span>
| Дані по реалізації:
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> OrdersCount
| Int
| Кількість чеків / операцій
|-
|
| <span style="color:#ff0000">Pays</span>
|  <span style="color:#ff0000">Pay [  ] </span>
| Список оплат:
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>&nbsp; <span style="color:#9966CC">'''|'''</span> PayFormCode
| Int
| Код форми оплати
|-
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>&nbsp; <span style="color:#9966CC">'''|'''</span> PayFormName
| String
| Назва форми оплати
|-
|-
|| &nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Name
|
| String [150]
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>&nbsp; <span style="color:#9966CC">'''|'''</span> PaymentSystem
| Назва оплати
| String / Null
| Назва платіжної системи
|-
|-
|| &nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Total
|  
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>&nbsp; <span style="color:#9966CC">'''|'''</span> Provided
| Decimal
| Decimal
| Сума оплат
| Сума, надана клієнтом
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>&nbsp; <span style="color:#9966CC">'''|'''</span> RRN
| String / Null
| RRN банківської операції
|-
|-
| PaymentsTotal
|  
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>&nbsp; <span style="color:#9966CC">'''|'''</span> Remains
| Decimal
| Decimal
| Всього по оплатам
| Решта
|-
|-
| <span style="color:#008F39">'''|'''</span> <span style="color:#008F39">Sections</span>
|  
| <span style="color:#008F39">Sections []</span>
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span>&nbsp; <span style="color:#9966CC">'''|'''</span> Sum
| Список сум по відділам виду
| Decimal
| Сума оплати
|-
|-
| | &nbsp;&nbsp; <span style="color:#008F39">'''|'''</span> Name
|
| String [150]
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> RoundDownSum
| Назва відділу
| Decimal
| Сума округлення в меншу сторону
|-
|-
| | &nbsp;&nbsp; <span style="color:#008F39">'''|'''</span> Total
|  
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> RoundUpSum
| Decimal
| Decimal
| Сума оплат
| Сума округлення в більшу сторону
|-
|-
| SectionsTotal
|  
| <span style="color:#ff0000">Taxes</span>
|  <span style="color:#ff0000">Tax [  ] </span>
| Список податків. Якщо податки відсутні, повертається порожній масив
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Total 
| Decimal
| Загальна сума
|-
|
| <span style="color:#ff0000">Return</span>
|  <span style="color:#ff0000">Return [  ] </span>
| Дані по поверненнях
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ServiceInput
| Decimal
| Decimal
| Всього по відділам
| Службове внесення
|}
|-
 
|
{| cellspacing="3" cellpadding="0" style="width:100%; clear:both; margin:0.5em auto; background-color:#eaecf0; border:1px solid #c8ccd1;"
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ServiceOutput
| Decimal
| Службова видача
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ShiftCloseDate
| String / DateTime
| Дата та час закриття зміни
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ShiftEnd
| String / DateTime
| Дата та час завершення зміни
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ShiftLocalNum
| Int
| Локальний номер зміни
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ShiftOpenDate
| String / DateTime
| Дата та час відкриття зміни
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ShiftOpened
| Bool
| Ознака відкритої зміни
|-
|
| |&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ShiftStart
| String / DateTime
| Дата та час початку зміни
|-
|-
! style="background:#cdf; padding:0.5em; text-align:left; width:15%" id="fileinfotpl_desc" | Додатковий опис вхідних параметрів
|
| style="background:#fff; padding:0.5em;" |
|}

Поточна версія на 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 Дата та час початку зміни