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

Матеріал з SERVIO
Перейти до навігації Перейти до пошуку
(Створена сторінка: =='''Функція повертає список проведених документів з бек-офісу'''== Розділ містить методи, необхідні для отримання списку проведених документів з бек-офісу <br> {| cellspacing="3" cellpadding="0" style="width:100%; clear:both; margin:0.5em auto; background-color:#eaecf0; border:1px solid #c8ccd1;" |- ! style="background:#cdf; paddi...)
 
 
(Не показано 5 проміжних версій цього користувача)
Рядок 1: Рядок 1:
=='''Функція повертає список проведених документів з бек-офісу'''==
=='''Функція повертає список документів Реалізації '''==


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


Рядок 69: Рядок 69:
| EDRPOU
| EDRPOU
| String
| String
| ЕДРПОУ підприємства — не обов’язкове поле, коли його не передано, тоді повертаємо документи по всім підприємствам
| ЕДРПОУ підприємства, по якому було оформлено документи
|-
|-
|
|
Рядок 97: Рядок 97:
     "Error": "",
     "Error": "",
     "Success": true,
     "Success": true,
     "Documents": [
     "RetailSalesReport": [
         {
         {
             "DocumentType": "Прибуткова накладна",
             "SessionID": 28668,
            "DocumentDate": "2022-02-17 16:17:56",
            "DocumentsGroup": [
            "DocumentNumber": " ПН 322",
                {
            "DocumentID": 5230,
                    "EnterpriseID": 3308,
            "ProviderID": 3918,
                    "ProviderID": 2,
            "ProviderName": "Предприятие 1",
                    "IsCash": null,
            "ProviderEDRPOU": "777777",
                    "Total": 110.00,
            "RecipientID": 0,
                    "NDS": 0,
            "RecipientName": "",
                    "Documents": [
            "RecipientEDRPOU": "",
                        {
            "TotalNoTax": 2640.00,
                            "__type": "ProdSaleDocument:#PosExternal.CommandsResult",
            "TotalTax": 3080.00,
                            "DocumentType": {
            "InEx": ""
                                "Name": "Реалізація",
        }
                                "Number": 6
    ]
                            },
}
                            "DocumentDate": "2023-06-16 16:00:53",
                            "DocumentNumber": "1460",
                            "DocumentID": 13946,
                            "ProviderID": 2,
                            "ProviderName": "Склад Бар",
                            "ProviderEDRPOU": "",
                            "ProviderWarehouseEDRPOU": "22222222222",
                            "RecipientID": 1,
                            "RecipientName": "*Реалізація",
                            "RecipientEDRPOU": "",
                            "RecipientWarehouseEDRPOU": "1",
                            "Total": 110.00,
                            "Tax": 0,
                            "InEx": "",
                            "SessionID": 28668,
                            "EnterpriseID": 3308,
                            "EnterpriseEDRPOU": "",
                            "RelatedDocument": {
                                "__type": "SaleProdSaleDocument:#PosExternal.CommandsResult",
                                "DocumentType": {
                                    "Name": "7",
                                    "Number": 7
                                },
                                "DocumentDate": "2023-06-16 16:00:53",
                                "DocumentNumber": "1460",
                                "DocumentID": 13947,
                                "ProviderID": 2,
                                "ProviderName": "Склад Бар",
                                "ProviderEDRPOU": "",
                                "ProviderWarehouseEDRPOU": "22222222222",
                                "RecipientID": 1,
                                "RecipientName": "*Реалізація",
                                "RecipientEDRPOU": "",
                                "RecipientWarehouseEDRPOU": "1",
                                "Total": 0,
                                "Tax": 0,
                                "InEx": "",
                                "SessionID": 28668,
                                "EnterpriseID": 3308,
                                "EnterpriseEDRPOU": ""
                            },
                            "ExciseSum": 0.00,
                            "IsCash": null
                        }
                    ]
                }
            ]
        },
</syntaxhighlight>
</syntaxhighlight>
</div>  
</div>  
Рядок 134: Рядок 181:
| Bool
| Bool
| Успіх виконання запиту
| Успіх виконання запиту
|-
| SessionID
| Int
| ІД зміни, по якій сформовано документ реалізації
|-
| <span style="color:#00ff00">DocumentsGroup</span>
| <span style="color:#00ff00">DocumentsGroup[]</span>
| Масив документів, згрупованих по підприємству,  складу та типу оплат
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#00ff00">'''|'''</span> EnterpriseID
| Int
| ID Підприємства
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#00ff00">'''|'''</span> ProviderID
| Int
| ID складу
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#00ff00">'''|'''</span> IsCash
| Boolean
| Тип оплати
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#00ff00">'''|'''</span> Total
| Decimal
| Сума усіх документів
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#00ff00">'''|'''</span> NDS
| Dеcimal
| Сума усіх НДС по документам
|-
|-
| <span style="color:#ff0000">Documents</span>
| <span style="color:#ff0000">Documents</span>
Рядок 190: Рядок 265:
| String
| String
| Стаття розходу/приходу
| Стаття розходу/приходу
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> EnterpriseID
| Int
| ID  підприємства, на яке було оформлено документ
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#ff0000">'''|'''</span> EnterpriseEDRPOU
| String
| ЕДРПОУ  підприємства, на яке було оформлено документ
|-
||&nbsp;&nbsp;&nbsp;&nbsp; <span style="color:#00ffff">'''|'''</span> RelatedDocuments
|  RelatedDocuments []
| Масив документів, пов'язаних із цим документом реалізації
|}
|}


Поточна версія на 13:16, 7 грудня 2023

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

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

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



Request Headers
KEY VALUE
Content-Type application/json
AccessToken



Body raw (json) 
{
    "DateFrom": "2022-01-01",
    "DateTo": "2022-03-01",
    "EDRPOU": "3202032",
    "SystemUploadCodeExclude": ""
}



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



Response (json) 
{
    "Error": "",
    "Success": true,
    "RetailSalesReport": [
        {
            "SessionID": 28668,
            "DocumentsGroup": [
                {
                    "EnterpriseID": 3308,
                    "ProviderID": 2,
                    "IsCash": null,
                    "Total": 110.00,
                    "NDS": 0,
                    "Documents": [
                        {
                            "__type": "ProdSaleDocument:#PosExternal.CommandsResult",
                            "DocumentType": {
                                "Name": "Реалізація",
                                "Number": 6
                            },
                            "DocumentDate": "2023-06-16 16:00:53",
                            "DocumentNumber": "1460",
                            "DocumentID": 13946,
                            "ProviderID": 2,
                            "ProviderName": "Склад Бар",
                            "ProviderEDRPOU": "",
                            "ProviderWarehouseEDRPOU": "22222222222",
                            "RecipientID": 1,
                            "RecipientName": "*Реалізація",
                            "RecipientEDRPOU": "",
                            "RecipientWarehouseEDRPOU": "1",
                            "Total": 110.00,
                            "Tax": 0,
                            "InEx": "",
                            "SessionID": 28668,
                            "EnterpriseID": 3308,
                            "EnterpriseEDRPOU": "",
                            "RelatedDocument": {
                                "__type": "SaleProdSaleDocument:#PosExternal.CommandsResult",
                                "DocumentType": {
                                    "Name": "7",
                                    "Number": 7
                                },
                                "DocumentDate": "2023-06-16 16:00:53",
                                "DocumentNumber": "1460",
                                "DocumentID": 13947,
                                "ProviderID": 2,
                                "ProviderName": "Склад Бар",
                                "ProviderEDRPOU": "",
                                "ProviderWarehouseEDRPOU": "22222222222",
                                "RecipientID": 1,
                                "RecipientName": "*Реалізація",
                                "RecipientEDRPOU": "",
                                "RecipientWarehouseEDRPOU": "1",
                                "Total": 0,
                                "Tax": 0,
                                "InEx": "",
                                "SessionID": 28668,
                                "EnterpriseID": 3308,
                                "EnterpriseEDRPOU": ""
                            },
                            "ExciseSum": 0.00,
                            "IsCash": null
                        }
                    ]
                }
            ]
        },



Типи даних Response
Параметр Тип Опис
Error String Опис помилки, що виникла
Success Bool Успіх виконання запиту
SessionID Int ІД зміни, по якій сформовано документ реалізації
DocumentsGroup DocumentsGroup[] Масив документів, згрупованих по підприємству, складу та типу оплат
     | EnterpriseID Int ID Підприємства
     | ProviderID Int ID складу
     | IsCash Boolean Тип оплати
     | Total Decimal Сума усіх документів
     | NDS Dеcimal Сума усіх НДС по документам
Documents Documents[] Масив проведених документів
     | DocumentType String Тип документу
     | DocumentDate Datetime Дата документу
     | DocumentNumber String Номер документу
     | DocumentID Int ID документу
     | ProviderID Int ID Постачальника
     | ProviderName String Назва постачальника
     | ProviderEDRPOU String ЕДРПОУ постачальника
     | RecipientID Int ID отримувача
     | RecipientName String Назва отримувача
     | RecipientEDRPOU String ЕДРПОУ отримувача
     | TotalNoTax Decimal Сума документу без ПДВ
     | TotalTax Decimal Сума ПДВ
     | InEx String Стаття розходу/приходу
     | EnterpriseID Int ID підприємства, на яке було оформлено документ
     | EnterpriseEDRPOU String ЕДРПОУ підприємства, на яке було оформлено документ
     | RelatedDocuments RelatedDocuments [] Масив документів, пов'язаних із цим документом реалізації
Додатковий опис вхідних параметрів
Отримано з http://wiki.servio.support/index.php?title=GetBackOfficeDocuments&oldid=5420