GetBackOfficeDocuments: відмінності між версіями
Перейти до навігації
Перейти до пошуку
| Рядок 1: | Рядок 1: | ||
=='''Функція повертає список | =='''Функція повертає список документів Реалізації '''== | ||
Розділ містить методи, необхідні для отримання списку проведених документів з бек-офісу | Розділ містить методи, необхідні для отримання списку проведених документів Реалізації з бек-офісу | ||
<br> | <br> | ||
| Рядок 97: | Рядок 97: | ||
"Error": "", | "Error": "", | ||
"Success": true, | "Success": true, | ||
" | "RetailSalesReport": [ | ||
{ | { | ||
"DocumentType": { | "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 | |||
} | |||
] | |||
} | |||
] | |||
}, | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> | ||
| Рядок 140: | Рядок 181: | ||
| Bool | | Bool | ||
| Успіх виконання запиту | | Успіх виконання запиту | ||
|- | |||
| SessionID | |||
| Int | |||
| ІД зміни, по якій сформовано документ реалізації | |||
|- | |||
| <span style="color:#ff3451">DocumentsGroup</span> | |||
| <span style="color:#ff3451">DocumentsGroup[]</span> | |||
| Масив документів, згрупованих по підприємству, складу та типу оплат | |||
|- | |||
|| <span style="color:#ff0000">'''|'''</span> EnterpriseID | |||
| Int | |||
| ID Підприємства | |||
|- | |||
|| <span style="color:#ff0000">'''|'''</span> ProviderID | |||
| Int | |||
| ID складу | |||
|- | |||
|| <span style="color:#ff0000">'''|'''</span> IsCash | |||
| Boolean | |||
| Тип оплати | |||
|- | |||
|| <span style="color:#ff0000">'''|'''</span> Total | |||
| Decimal | |||
| Сума усіх документів | |||
|- | |||
|| <span style="color:#ff0000">'''|'''</span> NDS | |||
| Dеcimal | |||
| Сума усіх НДС по документам | |||
|- | |- | ||
| <span style="color:#ff0000">Documents</span> | | <span style="color:#ff0000">Documents</span> | ||
Версія за 13:06, 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 | ЕДРПОУ підприємства, на яке було оформлено документ |
| Додатковий опис вхідних параметрів |
|---|