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

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


Розділ містить методи, необхідні для отримання списку проведених документів з бек-офісу
Розділ містить методи, необхідні для отримання списку проведених документів Реалізації з бек-офісу
<br>
<br>


Рядок 40: Рядок 40:
     "DateFrom": "2022-01-01",
     "DateFrom": "2022-01-01",
     "DateTo": "2022-03-01",
     "DateTo": "2022-03-01",
     "EDRPOU": "3202032",
     //"ProviderEDRPOU": "32049199",
    //"RecipientEDRPOU": "43949061",
     "SystemUploadCodeExclude": ""
     "SystemUploadCodeExclude": ""
}
}
Рядок 69: Рядок 70:
| EDRPOU
| EDRPOU
| String
| String
| ЕДРПОУ підприємства, по якому було оформлено документи
| ЕДРПОУ підприємства. Фільтрує як по Provider так й Recipient
|-
|
| ProviderEDRPOU
| String
| ЕДРПОУ підприємства, яке надає товари/послуги.
|-
|
| RecipientEDRPOU
| String
| ЕДРПОУ підприємства, яке отримує товари/послуги.
|-
|-
|
|
Рядок 94: Рядок 105:
<div class="mw-collapsible"; overflow: hidden;">
<div class="mw-collapsible"; overflow: hidden;">
<syntaxhighlight lang="json">
<syntaxhighlight lang="json">
{
{
    "Error": "",
            "Comment": "Продажі по зміні №13",
    "Success": true,
            "DocumentDate": "2025-06-02 21:00:57",
    "Documents": [
            "DocumentID": 2028,
        {
            "DocumentNumber": "Реалізація 830",
             "DocumentType": {
             "DocumentType": {
                 "Name": "Прибуткова накладна",
                 "Name": "Реалізація",
                 "Number": 1
                 "Number": 6
             },
             },
            "DocumentDate": "2023-12-01 14:45:50",
            "DocumentNumber": "25322",
            "DocumentID": 914,
            "ProviderID": 126877,
            "ProviderName": "ФОП Servio ES",
            "ProviderEDRPOU": "",
            "RecipientID": 4,
            "RecipientName": "Склад КУХНЯ",
            "RecipientEDRPOU": "202712115621380",
            "Total": 1165.44,
            "Tax": 194.24,
             "InEx": "",
             "InEx": "",
             "SessionID": null,
             "SessionID": null,
             "EnterpriseID": 9107,
             "SessionNumber": null,
             "EnterpriseEDRPOU": "2104005931"
            "Tax": 830.4800000000000000,
        }
            "Total": 5179.0000000000000000,
    ]
            "RelatedDocument": {
}
                "Comment": "Виробництво для документу Реалізація 830",
                "DocumentDate": "2025-06-02 21:00:57",
                "DocumentID": 2029,
                "DocumentNumber": "Виробництво 830/1",
                "DocumentType": {
                    "Name": "Виробництво для реалізації",
                    "Number": 7
                },
                "InEx": "",
                "SessionID": null,
                "SessionNumber": null,
                "Tax": 0.0000000000000000,
                "Total": 0,
                "RelatedDocument": null,
                "RelatedDocumentID": null,
                "CostSum": 0,
                "ExciseSum": 0.000000,
                "IsCash": null,
                "PaymentCode": null,
                "PaymentID": null,
                "PaymentName": null,
                "ProviderCompany": {
                    "EDRPOU": "45235833",
                    "EnterpriseID": 205,
                    "ID": 190,
                    "Name": "ТОВ Сервіо",
                    "WarehouseID": 1,
                    "WarehouseName": "Склад №1"
                },
                "RecipientCompany": {
                    "EDRPOU": "45235833",
                    "EnterpriseID": 205,
                    "ID": 190,
                    "Name": "ТОВ Сервіо",
                    "WarehouseID": 5,
                    "WarehouseName": "Службовий склад списання"
                }
            },
            "RelatedDocumentID": 2029,
            "CostSum": 0.00,
             "ExciseSum": 1035.800000,
            "IsCash": true,
            "PaymentCode": "PAYMENT070314151418783  ",
            "PaymentID": 2441,
            "PaymentName": "Готівка",
            "ProviderCompany": {
                "EDRPOU": "45235833",
                "EnterpriseID": 205,
                "ID": 190,
                "Name": "ТОВ Сервіо",
                "WarehouseID": 1,
                "WarehouseName": "Склад №1"
            },
            "RecipientCompany": {
                "EDRPOU": "45235833",
                "EnterpriseID": 205,
                "ID": 190,
                "Name": "ТОВ Сервіо",
                "WarehouseID": 4,
                "WarehouseName": "Службовий склад реалізації"
            }
}
</syntaxhighlight>
</syntaxhighlight>
</div>  
</div>  
Рядок 141: Рядок 202:
| Успіх виконання запиту
| Успіх виконання запиту
|-
|-
| <span style="color:#ff0000">Documents</span>
| SessionID
| <span style="color:#ff0000">Documents[]</span>
| Int
| Масив проведених документів
| ІД зміни, по якій сформовано документ реалізації
|-
|DocumentDate
| Datetime
| Дата документу
|-
| <span style="color:#ff0000">DocumentID</span>
| <span style="color:#ff0000">DocumentID []</span>
| Масив типу документів
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Comment
| String
| Коментар до документу
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> DocumentID
| Int
| ID документу
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> DocumentNumber
| String
| Номер документу
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> DocumentType
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> DocumentType
Рядок 149: Рядок 230:
| Тип документу
| Тип документу
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> DocumentDate
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Name
| Datetime
| String
| Дата документу
| Назва типу документу
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> Number
| Int
| Номер (ID) типу документу
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> DocumentNumber
| InEx
| String
| String
| Номер документу
| Стаття розходу/приходу
|-
| SessionID
| Int
| ID касової зміни
|-
| SessionNumber
| Int
| Номер касової зміни
|-
| Tax
| Decimal
| Сума податку (ПДВ)
|-
| Total
| Decimal
| Сума з ПДВ
|-
|<span style="color:#FF7E00">RelatedDocuments</span>
|<span style="color:#FF7E00">RelatedDocuments []</span>
|Масив документів, пов'язаних із цим документом реалізації
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> DocumentID
| RelatedDocumentID
| Int
| Int
| ID документу
| ID повязаного документу
|-
| CostSum
| Decimal
| Сума собівартості
|-
| ExciseSum
| Decimal
| Сума акцизу
|-
| IsCash
| Bool
| Оплата готівка / безготівка <br> true - Готівка;<br> false - Карта;<br>
|-
| PaymentCode
| String
| Код типу оплати
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ProviderID
| PaymentID
| Int
| Int
| ID Постачальника
| ID Виду оплати
|-
| PaymentName
| String
| Назва виду оплати
|-
| <span style="color:#9966CC">ProviderCompany</span>
| <span style="color:#9966CC">ProviderCompany []</span>
| Масив даних про компанію, що надає послугу
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ProviderName
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#9966CC">'''|'''</span> EDRPOU
| String
| String
| Назва постачальника
| Код ЕДРПОУ
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#9966CC">'''|'''</span> EnterpriseID
| Int
| ID Підприємство постачальник
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#9966CC">'''|'''</span> ID
| Int
| ID компанії постачальника
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> ProviderEDRPOU
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#9966CC">'''|'''</span> Name
| String
| String
| ЕДРПОУ постачальника
| Назва підприємства (компанії)
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> RecipientID
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#9966CC">'''|'''</span> WarehouseID
| Int
| Int
| ID отримувача
| ID Склад постачальник
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> RecipientName
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#9966CC">'''|'''</span> WarehouseName
| String
| String
| Назва отримувача
| Імя складу постачальника
|-
| <span style="color:#007FFF">RecipientCompany</span>
| <span style="color:#007FFF">RecipientCompany[]</span>
| Масив даних про компанію, що надає послугу
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> RecipientEDRPOU
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#007FFF">'''|'''</span> EDRPOU
| String
| String
| ЕДРПОУ отримувача
| Код ЕДРПОУ
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> TotalNoTax
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#007FFF">'''|'''</span> EnterpriseID
| Decimal
| Int
| Сума документу без ПДВ
| ID Підприємство отримувач
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> TotalTax
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#007FFF">'''|'''</span> ID
| Decimal
| Int
| Сума ПДВ
| ID компанії отримувача
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> InEx
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#007FFF">'''|'''</span> Name
| String
| String
| Стаття розходу/приходу
| Назва підприємства (компанії)
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> EnterpriseID
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#007FFF">'''|'''</span> WarehouseID
| Int
| Int
| ID підприємства, на яке було оформлено документ
| ID Склад отримувача
|-
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> EnterpriseEDRPOU
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#007FFF">'''|'''</span> WarehouseName
| String
| String
| ЕДРПОУ  підприємства, на яке було оформлено документ
| Імя складу отримувача
|-
|}
|}



Поточна версія на 09:18, 7 жовтня 2025

Функція повертає список документів Реалізації

Розділ містить методи, необхідні для отримання списку проведених документів Реалізації з бек-офісу

Опис Отримати список проведених документів з бек-офісу.
Метод POST
URL /POSExternal/GetBackOfficeDocuments



Request Headers
KEY VALUE
Content-Type application/json
AccessToken



Body raw (json)
{
    "DateFrom": "2022-01-01",
    "DateTo": "2022-03-01",
    //"ProviderEDRPOU": "32049199",
    //"RecipientEDRPOU": "43949061",
    "SystemUploadCodeExclude": ""
}



Типи даних Body
* Параметр Тип Опис
DateFrom Datetime Початок періоду відбору документів — якщо не передати параметри дати, тоді повертаємо всі документи, які ще не були вивантажені
DateTo Datetime Кінець періоду відбору документів
EDRPOU String ЕДРПОУ підприємства. Фільтрує як по Provider так й Recipient
ProviderEDRPOU String ЕДРПОУ підприємства, яке надає товари/послуги.
RecipientEDRPOU String ЕДРПОУ підприємства, яке отримує товари/послуги.
SystemUploadCodeExclude String Код системи, у яку робимо вивантаження — по ньому робимо відбір не вивантажених документів у цю систему (коли дата вказана, то ігноруємо цей параметр) (1 — 1С по замовчуванню)
* Позначення обов’язкового параметру
Додатковий опис вихідних параметрів



Response (json)
 {
            "Comment": "Продажі по зміні №13",
            "DocumentDate": "2025-06-02 21:00:57",
            "DocumentID": 2028,
            "DocumentNumber": "Реалізація 830",
            "DocumentType": {
                "Name": "Реалізація",
                "Number": 6
            },
            "InEx": "",
            "SessionID": null,
            "SessionNumber": null,
            "Tax": 830.4800000000000000,
            "Total": 5179.0000000000000000,
            "RelatedDocument": {
                "Comment": "Виробництво для документу Реалізація 830",
                "DocumentDate": "2025-06-02 21:00:57",
                "DocumentID": 2029,
                "DocumentNumber": "Виробництво 830/1",
                "DocumentType": {
                    "Name": "Виробництво для реалізації",
                    "Number": 7
                },
                "InEx": "",
                "SessionID": null,
                "SessionNumber": null,
                "Tax": 0.0000000000000000,
                "Total": 0,
                "RelatedDocument": null,
                "RelatedDocumentID": null,
                "CostSum": 0,
                "ExciseSum": 0.000000,
                "IsCash": null,
                "PaymentCode": null,
                "PaymentID": null,
                "PaymentName": null,
                "ProviderCompany": {
                    "EDRPOU": "45235833",
                    "EnterpriseID": 205,
                    "ID": 190,
                    "Name": "ТОВ Сервіо",
                    "WarehouseID": 1,
                    "WarehouseName": "Склад №1"
                },
                "RecipientCompany": {
                    "EDRPOU": "45235833",
                    "EnterpriseID": 205,
                    "ID": 190,
                    "Name": "ТОВ Сервіо",
                    "WarehouseID": 5,
                    "WarehouseName": "Службовий склад списання"
                }
            },
            "RelatedDocumentID": 2029,
            "CostSum": 0.00,
            "ExciseSum": 1035.800000,
            "IsCash": true,
            "PaymentCode": "PAYMENT070314151418783  ",
            "PaymentID": 2441,
            "PaymentName": "Готівка",
            "ProviderCompany": {
                "EDRPOU": "45235833",
                "EnterpriseID": 205,
                "ID": 190,
                "Name": "ТОВ Сервіо",
                "WarehouseID": 1,
                "WarehouseName": "Склад №1"
            },
            "RecipientCompany": {
                "EDRPOU": "45235833",
                "EnterpriseID": 205,
                "ID": 190,
                "Name": "ТОВ Сервіо",
                "WarehouseID": 4,
                "WarehouseName": "Службовий склад реалізації"
            }
 }



Типи даних Response
Параметр Тип Опис
Error String Опис помилки, що виникла
Success Bool Успіх виконання запиту
SessionID Int ІД зміни, по якій сформовано документ реалізації
DocumentDate Datetime Дата документу
DocumentID DocumentID [] Масив типу документів
     | Comment String Коментар до документу
     | DocumentID Int ID документу
     | DocumentNumber String Номер документу
     | DocumentType String Тип документу
     | Name String Назва типу документу
     | Number Int Номер (ID) типу документу
InEx String Стаття розходу/приходу
SessionID Int ID касової зміни
SessionNumber Int Номер касової зміни
Tax Decimal Сума податку (ПДВ)
Total Decimal Сума з ПДВ
RelatedDocuments RelatedDocuments [] Масив документів, пов'язаних із цим документом реалізації
RelatedDocumentID Int ID повязаного документу
CostSum Decimal Сума собівартості
ExciseSum Decimal Сума акцизу
IsCash Bool Оплата готівка / безготівка
true - Готівка;
false - Карта;
PaymentCode String Код типу оплати
PaymentID Int ID Виду оплати
PaymentName String Назва виду оплати
ProviderCompany ProviderCompany [] Масив даних про компанію, що надає послугу
     | EDRPOU String Код ЕДРПОУ
     | EnterpriseID Int ID Підприємство постачальник
     | ID Int ID компанії постачальника
     | Name String Назва підприємства (компанії)
     | WarehouseID Int ID Склад постачальник
     | WarehouseName String Імя складу постачальника
RecipientCompany RecipientCompany[] Масив даних про компанію, що надає послугу
     | EDRPOU String Код ЕДРПОУ
     | EnterpriseID Int ID Підприємство отримувач
     | ID Int ID компанії отримувача
     | Name String Назва підприємства (компанії)
     | WarehouseID Int ID Склад отримувача
     | WarehouseName String Імя складу отримувача
Додатковий опис вхідних параметрів