[POST] ...v1/WidgetData/Get
Метод для получения данных виджета.
Входные параметры
Название | Тип данных | Обязательность | Описание |
---|---|---|---|
id | Int64 | Обязательный | ID виджета |
Пример запроса
{
"id": 3
}
Выходные параметры зависят от типа виджета:
Выходные параметры
Массив целей
Название | Тип данных | Описание |
---|---|---|
id | Int64 | ID цели |
name | String | Наименование цели |
value | Decimal | Значение цели |
progress | Decimal | Прогресс цели |
percent | Int64 | Прогресс цели в процентах |
Пример ответа
{
"ok": true,
"result": [
{
"id": 24,
"name": "1 Day",
"value": 10,
"progress": 0,
"percent": 0
}
]
}
Выходные параметры
Массив целей
Название | Тип данных | Описание |
---|---|---|
id | Int64 | ID цели |
name | String | Наименование цели |
value | Decimal | Значение цели |
progress | Decimal | Прогресс цели |
percent | Int64 | Прогресс цели в процентах |
Пример ответа
{
"ok": true,
"result": [
{
"id": 2,
"name": "Средний чек 2",
"value": 150000,
"progress": 767,
"percent": 1
},
{
"id": 1,
"name": "Сумма продаж 1",
"value": 50000000,
"progress": 0,
"percent": 0
}
]
}
Выходные параметры
Массив счетов
Название | Тип данных | Описание |
---|---|---|
name | String | Наименование счёта |
currency_name | String | Наименование валюты счёта |
value | Decimal | Баланс счёта |
Пример ответа
{
"ok": true,
"result": [
{
"name": "Основной счет",
"currency_name": "Узбекский сум",
"value": 3358685
},
{
"name": "Наличная касса",
"currency_name": "Узбекский сум",
"value": 1423496
},
{
"name": "Баллы и бонусы",
"currency_name": "Узбекский сум",
"value": 26400
}
]
}
Выходные параметры
Название | Тип данных | Описание |
---|---|---|
total | Int64 | Общее количество |
new | Int64 | Количествоновых заказов (в статусе New ) |
Пример ответа
{
"ok": true,
"result": {
"total": 254,
"new": 3
}
}
Выходные параметры
Массив касс
Название | Тип данных | Описание |
---|---|---|
id | Int64 | ID кассы |
name | String | Наименование кассы |
Пример ответа
{
"ok": true,
"result": [
{
"id": 1,
"name": "00001"
},
{
"id": 4,
"name": "00004"
},
{
"id": 5,
"name": "00005"
}
]
}
Выходные параметры
Название | Тип данных | Описание |
---|---|---|
total_amount | Decimal | Общая сумма |
average_receipt_amount | Decimal | Средняя сумма чека |
receipt_count | Int64 | Количество чеков |
sales_amount | Decimal | Сумма продаж |
sales_count | Int64 | Количство чеков продаж |
sales_pos_count | Int64 | Количство позиций в чеках продаж |
sales_unit_count | Int64 | Количство единиц продаж |
refund_amount | Decimal | Сумма возвратов |
refund_count | Int64 | Количство чеков возвратов |
refund_pos_count | Int64 | Количство позиций в чеках возвратов |
refund_unit_count | Int64 | Количство единиц возвратов |
Пример ответа
{
"ok": true,
"result": {
"total_amount": 63734453.54,
"average_receipt_amount": 24245.23,
"receipt_count": 122,
"sales_amount": 2342343.23,
"sales_count": 342,
"sales_pos_count": 213,
"sales_unit_count": 4524,
"refund_amount": 34235.34,
"refund_count": 12,
"refund_pos_count": 12,
"refund_unit_count": 19
}
}
Выходные параметры
Название | Тип данных | Описание |
---|---|---|
id | Int64 | ID типа оплаты |
name | String | Тип оплаты |
amount | Decimal | Сумма |
Пример ответа
{
"ok": true,
"result": [
{
"id": 2,
"name": "Пласт. карта",
"amount": 11000
}
]
}
Выходные параметры
Массив значений динамики продаж
Название | Тип данных | Описание |
---|---|---|
date | String | Дата и время в формате: ГГГГ-ММ-ДДTЧЧ:ММ:СС |
amount | Decimal | Сумма |
Пример ответа
{
"ok": true,
"result": [
{
"date": "2023-07-12T10:45:23",
"amount": 45452.43
},
{
"date": "2023-07-13T11:23:34",
"amount": 234434.44
}
]
}
Выходные параметры
Массив номенклатуры
Название | Тип данных | Описание |
---|---|---|
id | Int64 | ID номенклатуры |
code | Int64 | Код номенклатуры |
name | String | Наименование номенклатуры |
quantity | Decimal | Количество |
Пример ответа
{
"ok": true,
"result": [
{
"id": 5,
"code": 5,
"name": "item 4",
"quantity": 2
},
{
"id": 6,
"code": 6,
"name": "item 5",
"quantity": 1
}
]
}
Выходные параметры
Массив номенклатуры
Название | Тип данных | Описание |
---|---|---|
id | Int64 | ID номенклатуры |
code | Int64 | Код номенклатуры |
name | String | Наименование номенклатуры |
amount | Decimal | Сумма |
Пример ответа
{
"ok": true,
"result": [
{
"id": 5,
"code": 5,
"name": "test 4",
"amount": 2100
},
{
"id": 6,
"code": 6,
"name": "test 5",
"amount": 200
}
]
}
Выходные параметры
Массив покупателей
Название | Тип данных | Описание |
---|---|---|
id | Int64 | ID покупателя |
name | String | Имя покупателя |
phone | String | Контактный номер покупателя |
date | String | День рождения покупателя в формате: ГГГГ-ММ-ДДTЧЧ:ММ:СС |
Пример ответа
{
"ok": true,
"result": [
{
"id": "23",
"name": "John",
"phone": "998917866476",
"date": "2023-07-13"
}
]
}
Выходные параметры
Массив предпочитаемых покупок по картам покупателей
Название | Тип данных | Описание |
---|---|---|
item_id | Int64 | ID номенклатуры |
item_code | Int64 | Код номенклатуры |
item_name | String | Наименование номенклатуры |
value | Decimal | Значение |
customer_id | Int64 | ID покупателя |
customer_name | String | Имя покупателя |
customer_phone | String | Телефон покупателя |
Пример ответа
{
"ok": true,
"result": [
{
"item_id": "68",
"item_code": "3376232735",
"item_name": "coca-aola",
"value": "11000",
"customer_id": "12",
"customer_name": "John",
"customer_phone": "998917866476",
}
]
}
Выходные параметры
Массив долгов контрагентов
Название | Тип данных | Описание |
---|---|---|
id | Int64 | ID контрагента |
name | String | Имя контрагента |
debt_amount | Decimal | Сумма долга |
last_payment | String | Дата последней оплаты в формате: ГГГГ-ММ-ДДTЧЧ:ММ:СС |
Пример ответа
{
"ok": true,
"result": [
{
"id": 1,
"name": "test",
"debt_amount": 200,
"last_payment": null
}
]
}
Выходные параметры
Массив значений распределения возрастов покупателей
Название | Тип данных | Описание |
---|---|---|
age | String | Возраст покупателя |
count | Int64 | Количество чеков продаж |
Пример ответа
{
"ok": true,
"result": [
{
"age": "0-10",
"count": 21
},
{
"age": "11-15",
"count": 34
},
{
"age": "16-20",
"count": 45
},
{
"age": "21-25",
"count": 47
},
{
"age": "26-35",
"count": 86
},
{
"age": "36-45",
"count": 56
},
{
"age": "46-55",
"count": 43
},
{
"age": "56-70",
"count": 21
},
{
"age": "70+",
"count": 2
}
]
}
Выходные параметры
Массив распределения покупателей по полу
Название | Тип данных | Описание |
---|---|---|
sex | Enum | Пол покупателя: <none | 1> (не указан), <male | 2> (мужской), <female | 3> (женский) |
count | Int64 | Количество чеков продаж |
Пример ответа
{
"ok": true,
"result": [
{
"sex": 1,
"count": 3
},
{
"sex": 2,
"count": 122
},
{
"sex": 3,
"count": 146
}
]
}