API Documentation

Endpoints

GET Get list

Authentication

Every API request requires sending the X-API-KEY header.

X-API-KEY: {your_api_key}

Still have questions?

Open a ticket with us, or browse our help center.

Base URL

https://{tenant}.logzi.com/api/base-stat/

Every request returns a JSON response. On success result.code == 1, on error result.code == 0. The base statistics API returns one summary row for every month of the requested period. This endpoint is read-only.

GET /api/base-stat/list

Retrieve the base statistics broken down by month. Each row represents one calendar month of the period, with turnover, profit, order and previous-year comparison indicators. The endpoint is not paginated: it returns all months of the requested period at once.

Query parameters

Parameter	Type	Description
`list_condition[date_create_from]`	date	Start of the period - document creation date from (format: YYYY-MM-DD). Default: January 1st of the current year
`list_condition[date_create_to]`	date	End of the period - document creation date to (format: YYYY-MM-DD). Default: last day of the current month. If earlier than the start date, the two dates are swapped
`list_condition[company_id]`	int	Own company identifier (default: 1)
`list_condition[store_id]`	int	Filter by warehouse
`list_condition[partner_id]`	int	Filter by partner (customer)
`list_condition[partner_company_name]`	string	Partner company name filter (partial match)
`list_condition[product_id]`	int	Filter by product
`list_condition[product_name]`	string	Product name filter (partial match)
`list_condition[product_partnumber]`	string	Part number filter (partial match)
`list_condition[product_category_id]`	int	Filter by product category
`list_condition[company_user_id]`	int	Filter by responsible colleague

Example request

GET /api/base-stat/list?list_condition[date_create_from]=2026-08-01&list_condition[date_create_to]=2026-08-31
X-API-KEY: {az_api_kulcsod}

Example response

{
  "language": "HU",
  "api_key": null,
  "result": { "code": 1, "message": null },
  "data": [
    {
      "date_ym": "2026.08",
      "month_name": "Augusztus",
      "cogs_netto": "87774.0775",
      "turnover_netto": "157583.0000000",
      "turnover_brutto": "197949.9400000",
      "profit_netto": "69808.9225",
      "profit_brutto": "110175.8625",
      "profit_margin_percent": "44.2998",
      "order_in_count": "17",
      "order_in_price_netto": "45837.0000000",
      "order_in_price_netto_avg": "2696.2941",
      "cash_register_turnover_netto": "15253.0000000",
      "order_in_turnover_percent": "29.0875",
      "turnover_yoy_diff": "128591.0000000",
      "turnover_yoy_percent": "443.5396",
      "profit_yoy_diff": "253067.9225",
      "profit_yoy_percent": "-138.0930",
      "currency_sign": "Ft"
    }
  ],
  "params": null
}

Notes

Sales indicators (turnover, cost of goods sold, profit) are built from the items of Cash register sales, Invoice and Prepayment invoice documents; customer order indicators come from Customer Order documents. Only non-deleted documents in Closed or Completed status are counted.
Amounts are given in the default currency of the system; items in other currencies are converted using their exchange rate. The currency sign is available in the currency_sign field.
Decimal values (amounts, percentages) may appear as strings in the JSON response.
Year-over-year indicators (*_yoy_*) compare against the same month of the previous year; if there is no data for the previous year, the percentage value is 0.

Response field descriptions

Field	Group	Description
`date_ym`	Period	Month (YYYY.MM format)
`month_name`	Period	Hungarian month name without accents (e.g. `Augusztus`), not localized
`cogs_netto`	Turnover and cost	Cost of goods sold, net: quantity × cost price (the purchase price if no cost price is set)
`turnover_netto`	Turnover and cost	Net turnover (cash register sales, invoices, prepayment invoices)
`turnover_brutto`	Turnover and cost	Gross turnover
`profit_netto`	Profit	Net profit: `turnover_netto - cogs_netto`
`profit_brutto`	Profit	Gross profit: `turnover_brutto - cogs_netto`
`profit_margin_percent`	Profit	Average profit (%): `profit_netto / turnover_netto × 100`, 0 without turnover
`order_in_count`	Customer orders	Number of customer orders in the month
`order_in_price_netto`	Customer orders	Net value of customer orders
`order_in_price_netto_avg`	Customer orders	Average cart value: `order_in_price_netto / order_in_count`
`cash_register_turnover_netto`	Channels	Net turnover of cash register (in-store) sales
`order_in_turnover_percent`	Channels	Customer order value as a share of net turnover (%): `order_in_price_netto / turnover_netto × 100`
`turnover_yoy_diff`	Year-over-year	Change in net turnover compared to the same month of the previous year
`turnover_yoy_percent`	Year-over-year	Change in net turnover compared to the same month of the previous year (%)
`profit_yoy_diff`	Year-over-year	Change in net profit compared to the same month of the previous year
`profit_yoy_percent`	Year-over-year	Change in net profit compared to the same month of the previous year (%)
`currency_sign`	Currency	Sign of the default currency (e.g. `Ft`)

Base Statistics API