Get

[POST] .../v1/widgetdata/get

Returns data for one widget. Load a widget selected through Widget/Get using dashboard period and filters; requires a positive widget id and returns a widget-specific result. Stock widgets apply company/warehouse filters and the user's warehouse access. Task widgets require project task select permission; CRM widgets require lead/deal/ticket select permission and record access. InventoryValuation hides blocks lacking permissions. Use widgets assigned to the user. RetailSalesActivity (18) counts closed, non-deleted receipts by creation date and hour, even without an end timestamp. Business errors return HTTP 200 ErrorResult.

Request Parameters

Name	Type	Required	Description
filters	Array of Filter	Optional	Optional filters by fields available for this API method.

Filterable Fields

Field	Type	Description
id	int	Record ID.

Request Example

{
  "filters": [
    {
      "Field": "id",
      "Operator": "Equal",
      "Value": "15"
    }
  ]
}

Response Parameters

Name	Type	Description
ok	Boolean	Indicates whether the request completed successfully.
result	Array of WidgetDataType1 / Array of WidgetDataType3 / WidgetDataType4 / Array of WidgetDataType5 / WidgetDataType6 / Array of WidgetDataType7 / Array of WidgetDataType8 / Array of WidgetDataType9 / Array of WidgetDataType10 / Array of WidgetDataType11 / Array of WidgetDataType12 / Array of WidgetDataType13 / Array of WidgetDataType14 / Array of WidgetDataType15 / WidgetDataType16 / Array of WidgetDataType17 / Array of WidgetDataType18 / WidgetDataType20 / WidgetDataType21 / Array of WidgetDataType22 / Array of WidgetDataType23 / Array of WidgetDataType24 / WidgetDataType25 / Array of WidgetDataType26 / Array of WidgetDataType27 / WidgetDataType28 / Array of WidgetDataType29 / Array of WidgetDataType30 / WidgetDataType31 / Array of WidgetDataType32 / Array of WidgetDataType33 / WidgetDataType34 / Array of WidgetDataType35 / Object	Widget data payload. The concrete shape depends on widget_type; Integration returns integration-defined chart JSON.

Response Example

{
  "ok": true,
  "result": {
    "item_count": 125,
    "quantity": {
      "common": 8432.5,
      "booked": 120.0,
      "allowed": 8312.5
    },
    "cost": {
      "amount": 120000000.0
    },
    "prices": [
      {
        "price_type_id": 1,
        "price_type_name": "Retail",
        "currency_id": 1,
        "currency_code": "UZS",
        "currency_name": "Uzbek sum",
        "exchange_rate": 1.0,
        "amount": 180000000.0
      }
    ]
  }
}

Response Payload Schemas

WidgetDataType1

Data for widget types 1 and 2: personal and global targets.

Name	Type	Description
id	Int64	Target ID.
name	String	Target name.
percent	Int64	Target progress percentage.
progress	Decimal	Target progress.
value	Decimal	Target value.

WidgetDataType3

Data for widget type 3: accounts.

Name	Type	Description
currency_name	String	Account currency name.
name	String	Account name.
value	Decimal	Account balance.

WidgetDataType4

Data for widget type 4: retail orders.

Name	Type	Description
new	Int64	New retail order count.
total	Int64	Total quantity.

WidgetDataType5

Data for widget type 5: cash registers.

Name	Type	Description
id	Int64	Cash register ID.
name	String	Cash register name.

WidgetDataType6

Data for widget type 6: sales statistics for the current day.

Name	Type	Description
average_receipt_amount	Decimal	Average cheque amount.
gross_profit	Decimal	Gross profit (total_amount - last_purchase_cost_amount).
markup_avg_in_percent	Decimal	Average markup percentage: (total_amount - last_purchase_cost_amount) / last_purchase_cost_amount * 100.
operating_cash_avg_down_time	Decimal	Average cash register operating time in seconds (SUM(sls_date - sls_start_date)).
operating_cash_avg_work_time	Decimal	Average cash register operating time in seconds (SUM(sls_end_date - sls_start_date)).
receipt_count	Int64	Cheques count.
refund_amount	Decimal	Return amount.
refund_count	Int64	Number of return cheques.
refund_pos_count	Int64	Number of line items in return cheques.
refund_unit_count	Int64	Number of returned units.
sales_amount	Decimal	Sales amount.
sales_amount_per_square_meter	Decimal	Sales amount per square meter (total_amount / SUM(area)).
sales_count	Int64	Sales cheque count.
sales_pos_count	Int64	Number of line items in sale cheques.
sales_unit_count	Int64	Number of sold units.
total_amount	Decimal	Total amount.

WidgetDataType7

Data for widget type 7: payment statistics for the current day.

Name	Type	Description
amount	Decimal	Amount.
id	Int64	Payment type ID.
name	String	Payment type.

WidgetDataType8

Data for widget type 8: retail sales amount turnover dynamics for the week.

Name	Type	Description
amount	Decimal	Amount.
date	String	Date.

WidgetDataType9

Data for widget type 9: top 10 selling retail items by quantity for 7 days including the current day.

Name	Type	Description
code	Int64	Item code.
id	Int64	Item ID.
image_url	String	Image URL.
name	String	Item name.
quantity	Decimal	Quantity.

WidgetDataType10

Data for widget type 10: top 10 selling retail items by amount for 7 days including the current day.

Name	Type	Description
amount	Decimal	Quantity.
code	Int64	Item code.
id	Int64	Item ID.
image_url	String	Image URL.
name	String	Item name.

WidgetDataType11

Data for widget type 11: retail customers with upcoming birthdays, 5 days in advance.

Name	Type	Description
date	String	Customer birthday.
id	Int64	Customer ID.
name	String	Customer first name.
phone	String	Customer contact number.

WidgetDataType12

Data for widget type 12: top 10 preferred purchases by customer cards, by quantity and amount according to system settings.

Name	Type	Description
customer_id	Int64	Customer ID.
customer_name	String	Customer first name.
customer_phone	String	Customer phone number.
image_url	String	Image URL.
item_code	Int64	Item code.
item_id	Int64	Item ID.
item_name	String	Item name.
value	Decimal	Value.

WidgetDataType13

Data for widget type 13: top 10 partner debts in base currency.

Name	Type	Description
debt_amount	Decimal	Debt amount.
id	Int64	Partner ID.
last_payment	String	Last payment date.
name	String	Partner name.

WidgetDataType14

Data for widget type 14: customer age distribution for 7 days including the current day.

Name	Type	Description
age	String	Customer age.
count	Int64	Sales cheque count.

WidgetDataType15

Data for widget type 15: customer distribution by gender for 7 days including the current day.

Name	Type	Description
count	Int64	Sales cheque count.
sex	String	Customer gender. Allowed values: `none`, `male`, `female`.

WidgetDataType16

Data for widget type 16: tariff information.

Name	Type	Description
data_display_period	Int32	Data display period.
name	String	Tariff name.
name_var	String	Tariff name variable.
paid_until	String	Paid until.
pay_discount_percent	Int32	Payment discount percentage.
pay_period	Int32	Payment frequency in months.
price	Decimal	Tariff cost for one month without discount.
service_data	Array of WidgetDataType16Data	Service data.
services_price	Decimal	Cost of all tariff services for one month without discount.
tariff_id	Int32	Tariff ID.

WidgetDataType16Data

Additional widget data.

Name	Type	Description
in_use	Int64	Used.
name_var	String	Name, stored as a translation variable.
quantity	Int64	Quantity.

WidgetDataType17

Data for widget type 17: top 10 retail customer debts in base currency.

Name	Type	Description
debt_amount	Decimal	Debt amount.
id	Int64	Partner ID.
last_payment	String	Last payment date.
name	String	Partner name.

WidgetDataType18

Data for widget type 18: sales activity.

Name	Type	Description
data	Array of WidgetDataType18HourData	Hourly sales activity values for the day.
day	String	Day of week. Allowed values: `Default`, `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, `Saturday`, `Sunday`.

WidgetDataType18HourData

Hourly sales activity value.

Name	Type	Description
hour	Int32	Hour (0 - 23).
value	Int32	Value (number of cheques).

WidgetDataType20

Data for widget type 20: current inventory quantity and valuation.

Name	Type	Description
cost	WidgetDataType20Cost	Inventory valuation by last purchase cost. null means that the caller has no last purchase cost permission or no item quantity permission.
item_count	Int64	Number of item records with non-zero current common quantity. null means that the caller has no item quantity permission.
prices	Array of WidgetDataType20Price	Inventory valuation by price type with current exchange rates. null means that the caller has no item price permission or no item quantity permission.
quantity	WidgetDataType20Quantity	Current inventory quantity totals. null means that the caller has no item quantity permission.

WidgetDataType20Quantity

Current inventory quantity totals for widget type 20.

Name	Type	Description
allowed	Decimal	Total available quantity calculated as common minus booked.
booked	Decimal	Total booked quantity.
common	Decimal	Total current common quantity.

WidgetDataType20Cost

Inventory valuation by last purchase cost for widget type 20.

Name	Type	Description
amount	Decimal	Total current common quantity multiplied by the last purchase cost in the base currency.

WidgetDataType20Price

Inventory valuation by one price type for widget type 20.

Name	Type	Description
amount	Decimal	Total current common quantity multiplied by item prices and the current exchange rate.
currency_code	String	Price type currency alphabetic code.
currency_id	Int64	Price type currency ID.
currency_name	String	Price type currency name.
exchange_rate	Decimal	Exchange rate used to convert the price type amount to the base currency.
price_type_id	Int64	Price type ID.
price_type_name	String	Price type name.

WidgetDataType21

Data for widget type 21: wholesale sales and return statistics for the selected period.

Name	Type	Description
average_document_amount	Decimal	Average wholesale document amount in the base currency.
document_count	Int64	Total wholesale document count.
gross_profit	Decimal	Gross profit in the base currency: net wholesale amount minus last purchase cost amount.
markup_avg_in_percent	Decimal	Average markup percentage: gross profit divided by last purchase cost amount.
refund_amount	Decimal	Wholesale return amount in the base currency.
refund_count	Int64	Wholesale return document count.
refund_pos_count	Int64	Number of line items in wholesale return documents.
refund_unit_count	Decimal	Number of returned units in wholesale return documents.
sales_amount	Decimal	Wholesale shipment amount in the base currency.
sales_count	Int64	Wholesale shipment document count.
sales_pos_count	Int64	Number of line items in wholesale shipment documents.
sales_unit_count	Decimal	Number of shipped units in wholesale shipment documents.
total_amount	Decimal	Net wholesale amount in the base currency: sales minus returns.

WidgetDataType22

Data for widget type 22: wholesale sales amount turnover dynamics by day.

Name	Type	Description
amount	Decimal	Net wholesale amount in the base currency for the date.
date	String	Date.

WidgetDataType23

Data for widget type 23: top 10 wholesale items by net quantity.

Name	Type	Description
code	Int64	Item code.
id	Int64	Item ID.
image_url	String	Image URL.
name	String	Item name.
quantity	Decimal	Net quantity: shipments minus returns.

WidgetDataType24

Data for widget type 24: top 10 wholesale items by net amount.

Name	Type	Description
amount	Decimal	Net amount in the base currency: shipments minus returns.
code	Int64	Item code.
id	Int64	Item ID.
image_url	String	Image URL.
name	String	Item name.

WidgetDataType25

Data for widget type 25: project task status and due-date statistics for the current request user.

Name	Type	Description
assigned_to_me	Int64	Open task count assigned to the current request user.
canceled_in_period	Int64	Task count canceled during the selected dashboard period.
created_by_me	Int64	Open task count created by the current request user.
created_in_period	Int64	Task count created during the selected dashboard period.
done_in_period	Int64	Task count completed during the selected dashboard period.
due_today	Int64	Open task count due today.
due_tomorrow	Int64	Open task count due tomorrow.
in_progress	Int64	In-progress open task count.
new	Int64	New open task count.
observing	Int64	Open task count where the current request user is an observer.
open	Int64	Open task count: New plus InProgress.
overdue	Int64	Open task count with due date earlier than today.
without_due_date	Int64	Open task count without due date.

WidgetDataType26

Data row for widget type 26: top projects by open task count.

Name	Type	Description
open	Int64	Open task count in the project.
overdue	Int64	Overdue open task count in the project.
project_id	Int64	Project ID.
project_name	String	Project name.

WidgetDataType27

Data row for widget type 27: nearest open project tasks ordered by due date.

Name	Type	Description
due_date	Int64	Due date as Unix time in seconds.
id	Int64	Task ID.
name	String	Task name.
project_id	Int64	Project ID.
project_name	String	Project name.
responsible_user_id	Int64	Responsible user ID.
status	String	Task status. Allowed values: `Default`, `New`, `InProgress`, `Done`, `Canceled`.

WidgetDataType28

Data for widget type 28: CRM lead status and SLA statistics for records visible to the current request user.

Name	Type	Description
assigned_to_me	Int64	Active lead count assigned to the current request user.
closed_in_period	Int64	Lead count closed without conversion during the selected dashboard period.
converted_in_period	Int64	Lead count converted to deals during the selected dashboard period.
created_in_period	Int64	Lead count created during the selected dashboard period.
in_progress	Int64	In-progress active lead count.
new	Int64	New active lead count.
open	Int64	Active lead count: New plus InProgress plus WaitingClient.
participating	Int64	Active lead count where the current request user is a participant.
sla_breached	Int64	Active lead count with breached SLA.
waiting_client	Int64	Lead count waiting for the client.

WidgetDataType29

Data row for widget type 29: top CRM lead stages by active lead count.

Name	Type	Description
open	Int64	Active lead count in the stage.
pipeline_id	Int64	Pipeline ID.
pipeline_name	String	Pipeline name.
stage_id	Int64	Stage ID.
stage_name	String	Stage name.

WidgetDataType30

Data row for widget type 30: top CRM lead pipelines by active lead count.

Name	Type	Description
open	Int64	Active lead count in the pipeline.
pipeline_id	Int64	Pipeline ID.
pipeline_name	String	Pipeline name.
sla_breached	Int64	Active lead count with breached SLA in the pipeline.

WidgetDataType31

Data for widget type 31: CRM deal amount and conversion statistics for records visible to the current request user.

Name	Type	Description
assigned_to_me	Int64	Open deal count assigned to the current request user.
avg_won_amount	Decimal	Average won deal amount in the base currency for the selected dashboard period.
created_in_period_amount	Decimal	Deal amount in the base currency for deals opened during the selected dashboard period.
created_in_period_count	Int64	Deal count opened during the selected dashboard period.
lost_in_period_amount	Decimal	Lost deal amount in the base currency for deals closed during the selected dashboard period.
lost_in_period_count	Int64	Lost deal count closed during the selected dashboard period.
open_amount	Decimal	Open deal amount in the base currency.
open_count	Int64	Open deal count.
participating	Int64	Open deal count where the current request user is a participant.
win_rate	Decimal	Won share percentage among deals closed as Won or Lost during the selected dashboard period.
won_in_period_amount	Decimal	Won deal amount in the base currency for deals closed during the selected dashboard period.
won_in_period_count	Int64	Won deal count closed during the selected dashboard period.

WidgetDataType32

Data row for widget type 32: top CRM deal stages by open deal count.

Name	Type	Description
open_amount	Decimal	Open deal amount in the base currency for the stage.
open_count	Int64	Open deal count in the stage.
pipeline_id	Int64	Pipeline ID.
pipeline_name	String	Pipeline name.
stage_id	Int64	Stage ID.
stage_name	String	Stage name.

WidgetDataType33

Data row for widget type 33: top CRM deal types by open deal amount.

Name	Type	Description
deal_type_id	Int64	Deal type ID.
deal_type_name	String	Deal type name.
open_amount	Decimal	Open deal amount in the base currency for the deal type.
open_count	Int64	Open deal count for the deal type.

WidgetDataType34

Data for widget type 34: CRM ticket status and SLA statistics for records visible to the current request user.

Name	Type	Description
assigned_to_me	Int64	Open ticket count assigned to the current request user.
closed_in_period	Int64	Ticket count closed during the selected dashboard period.
created_in_period	Int64	Ticket count created during the selected dashboard period.
first_response_overdue	Int64	Open ticket count with an overdue first-response SLA and no first response.
inbound_open	Int64	Open inbound ticket count.
missed	Int64	Missed ticket count resolved during the selected dashboard period.
open	Int64	Open ticket count: Open plus WaitingClient plus WaitingStaff.
outbound_open	Int64	Open outbound ticket count.
participating	Int64	Open ticket count where the current request user is a participant.
resolve_overdue	Int64	Open ticket count with an overdue resolution SLA.
sla_breached	Int64	Open ticket count with breached SLA.
waiting_client	Int64	Ticket count waiting for the client.
waiting_staff	Int64	Ticket count waiting for staff.

WidgetDataType35

Data row for widget type 35: nearest open CRM tickets ordered by SLA due date.

Name	Type	Description
channel_id	Int64	Channel ID.
client_id	Int64	Client ID.
client_name	String	Client name, or null if the linked client is unavailable.
due_date	Int64	SLA due date as Unix time in seconds.
id	Int64	Ticket ID.
responsible_user_id	Int64	Responsible user ID.
sla_type	String	SLA kind selected for ordering. Values are FirstResponse or Resolve.
status	String	Ticket status. Allowed values: `Default`, `Open`, `Closed`, `WaitingClient`, `WaitingStaff`.
subject	String	Ticket subject.