Get

[POST] ...v1/WidgetData/Get

Метод для получения данных виджета.

Входные параметры

Название Тип данных Обязательность Описание параметра
id Int64 Обязательный ID виджета

Пример запроса

{
    "id": 3
}

Выходные параметры зависят от типа виджета:

Содержание

1. Личные задачи (Только текущие) Мои цели

Выходные параметры
Массив целей

Название Тип данных Описание
id int64 id цели
name string наименование цели
value float128 значение цели
progress float128 прогресс цели
percent int64 прогресс цели в процентах

Пример ответа

{
  "ok": true,
  "result": [
    {
      "id": 24,
      "name": "1 Day",
      "value": 10,
      "progress": 0,
      "percent": 0
    }
  ]
}

2. Глобальные задачи (Только текущие) Глобальные цели

Выходные параметры
Массив целей

Название Тип данных Описание
id int64 id цели
name string наименование цели
value float128 значение цели
progress float128 прогресс цели
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
    }
  ]
}

3. Состояние счетов, на дату формирования Счета

Выходные параметры
Массив счетов

Название Тип данных Описание
name string наименование счёта
currency_name string наименование валюты счёта
value float128 баланс счёта

Пример ответа

{
  "ok": true,
  "result": [
    {
      "name": "Основной счет",
      "currency_name": "Узбекский сум",
      "value": 3358685
    },
    {
      "name": "Наличная касса",
      "currency_name": "Узбекский сум",
      "value": 1423496
    },
    {
      "name": "Баллы и бонусы",
      "currency_name": "Узбекский сум",
      "value": 26400
    }
  ]
}

4. Заказы (Розн. заказы), на дату формирования Розничные заказы

Выходные параметры

Название Тип данных Описание
total int64 общее количество
new int64

Пример ответа

{
  "ok": true,
  "result": {
    "total": 254,
    "new": 3
  }
}

5. Касса (массив касс, доступных пользователю) Кассы

Выходные параметры
Массив касс

Название Тип данных Описание
id int64 id кассы
name string наименование кассы

Пример ответа

{
  "ok": true,
  "result": [
    {
      "id": 1,
      "name": "00001"
    },
    {
      "id": 4,
      "name": "00004"
    },
    {
      "id": 5,
      "name": "00005"
    }
  ]
}

6. Статистика продаж, розница (за текущий день) Статистика продаж

Выходные параметры

Название Тип данных Описание
total_amount float128 Общая сумма
average_receipt_amount float128 Средняя сумма чека
receipt_count int64 Количество чеков
sales_amount float128 Сумма продаж
sales_count int64 Количство чеков продаж
sales_pos_count int64 Количство позиций в чеках продаж
sales_unit_count int64 Количство единиц продаж
refund_amount float128 Сумма возвратов
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
  }
}

7. Стат. продаж по типам оплат, розница (за текущий день) Статистика оплат

Выходные параметры

Название Тип данных Описание
id int64 ID типа оплаты
name string Тип оплаты
amount float128 Сумма

Пример ответа

{
  "ok": true,
  "result": [
    {
      "id": 2,
      "name": "Пласт. карта",
      "amount": 11000
    }
  ]
}

8. Динамика продаж (оборот по сумме) за неделю, розница (за 7 дней, включая текущий) Продажи за неделю

Выходные параметры
Массив значений динамики продаж

Название Тип данных Описание
date string Дата
amount float128 Сумма

Пример ответа

{
  "ok": true,
  "result": [
    {
      "date": "2023-07-12T10:45:23",
      "amount": 45452.43
    },
    {
      "date": "2023-07-13T11:23:34",
      "amount": 234434.44
    }
  ]
}

9. Топ-10 продаваемые товары (по количеству), розница  (за 7 дней, включая текущий), Топ - 10, по количеству продаж

Выходные параметры
Массив номенклатуры

Название Тип данных Описание
id int64 ID номенклатуры
code int64 Код номенклатуры
name string Наименование номенклатуры
quantity float128 Количество

Пример ответа

{
  "ok": true,
  "result": [
    {
      "id": 5,
      "code": 5,
      "name": "item 4",
      "quantity": 2
    },
    {
      "id": 6,
      "code": 6,
      "name": "item 5",
      "quantity": 1
    }
  ]
}

10. Топ-10 продаваемые товары (по сумме), розница (за 7 дней, включая текущий) Топ - 10, по сумме продаж

Выходные параметры
Массив номенклатуры

Название Тип данных Описание
id int64 ID номенклатуры
code int64 Код номенклатуры
name string Наименование номенклатуры
amount float128 Сумма

Пример ответа

{
  "ok": true,
  "result": [
    {
      "id": 5,
      "code": 5,
      "name": "test 4",
      "amount": 2100
    },
    {
      "id": 6,
      "code": 6,
      "name": "test 5",
      "amount": 200
    }
  ]
}

11. Розн. покупатели, предстоящиее дни рождения (за 5 дней заранее) Ближайшие дни рождения

Выходные параметры
Массив покупателей

Название Тип данных Описание
id int64 ID покупателя
name string Имя покупателя
phone string Контактный номер покупателя
date string День рождения покупателя

Пример ответа

{
  "ok": true,
  "result": [
        {
            "id": "23",
            "name": "John",
            "phone": "998917866476",
            "date": "2023-07-13"
        }
    ]
}

12. Топ-10, Предпочитаемые покупки по картам покупателя (количество и сумма по настройкам системы) Предпочитаемые покупки покупателей

Выходные параметры
Массив предпочитаемых покупок по картам покупателей

Название Тип данных Описание
item_id int64 ID номенклатуры
item_code int64 Код номенклатуры
item_name string Наименование номенклатуры
value float128 Значение
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",
        }
    ]
}

13. Топ-10 Долги по котнрагентам (в базовой валюте) (Сортировка по сумме), на текущий день Контрагенты, задолженности

Выходные параметры
Массив долгов контрагентов

Название Тип данных Описание
id int64 ID контрагента
name string Имя контрагента
debt_amount float128 Сумма долга
last_payment string Дата последней оплаты

Пример ответа

{
  "ok": true,
  "result": [
    {
      "id": 1,
      "name": "test",
      "debt_amount": 200,
      "last_payment": null
    }
  ]
}

14. График распределения возрастов покупателей (за 7 дней, включая текущий) Покупатели по возрастам

Выходные параметры
Массив значений распределения возрастов покупателей

Название Тип данных Описание
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
    }
  ]
}

15. График распределения покупателей по полу (за 7 дней, включая текущий) Покупатели по полу

Выходные параметры
Массив распределения покупателей по полу

Название Тип данных Описание
sex enum Пол покупателя: 1 - не указан; 2 - мужской; 3 - женский
int64 count Количество чеков продаж

Пример ответа

{
  "ok": true,
  "result": [
    {
      "sex": 1,
      "count": 3
    },
    {
      "sex": 2,
      "count": 122
    },
    {
      "sex": 3,
      "count": 146
    }
  ]
}