API Reference
This reference documents all available API endpoints. All endpoints require authentication via Bearer token.
Generated: 2026-02-09T12:43:30+02:00 Total Endpoints: 316
Base URL
Section titled “Base URL”https://www.mando.fi/apiQuick Navigation
Section titled “Quick Navigation”Endpoints by Resource
Section titled “Endpoints by Resource”AI
2 endpoint(s)
/api/secure/ai/company/infoCheck if company is configured in AI service
- 200Company info from AI service→ ai_company_info_response
- 404Company not found in AI service→ ai_error_response
- 503AI service unavailable→ ai_error_response
/api/secure/ai/querySend natural language query to AI service
- 200AI query result→ ai_query_response
- 400Invalid request→ ai_error_response
- 504AI service timeout→ ai_error_response
- 503AI service unavailable→ ai_error_response
attachment
4 endpoint(s)
/secure/attachment/{id}Get Attachment by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/attachment/{id}Update Attachment
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
businessday
4 endpoint(s)
/secure/businessday/{id}Get Business Day by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/businessday/{id}Update Business Day
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
BusinessDays
1 endpoint(s)
/api/secure/businessday_rename/{id}/{date}Change businessday date
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | guid | Yes | Business day GUID identifier |
date | path | date | Yes | New date for the business day (YYYY-MM-DD format) |
- 200Business day renamed successfully→ string
- 404Business day not found
- 500Internal server error
campaign
4 endpoint(s)
/secure/campaign/{id}Get Campaign by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
cashier
4 endpoint(s)
/secure/cashier/{id}Get Cashier by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
company
4 endpoint(s)
/secure/company/{id}Get Company by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
contract
4 endpoint(s)
/secure/contract/{id}Get Contract by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
customer
4 endpoint(s)
/secure/customer/{id}Get Customer by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
discount
4 endpoint(s)
/secure/discount/{id}Get Discount by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
dpt
4 endpoint(s)
/secure/dpt/{id}Get Department by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
external
4 endpoint(s)
/secure/external/{id}Get External Transfer by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
grp
4 endpoint(s)
/secure/grp/{id}Get Group by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
infocode
4 endpoint(s)
/secure/infocode/{id}Get Info Code by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
invoice
4 endpoint(s)
/secure/invoice/{id}Get Invoice by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
Invoices
1 endpoint(s)
/api/secure/invoice_statusGet invoice status summary and statistics
- 200Invoice status data→ invoice_status_response
layout
4 endpoint(s)
/secure/layout/{id}Get Pos Layout by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
location
4 endpoint(s)
/secure/location/{id}Get Location by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
other
135 endpoint(s)
/api/secure/company/{id}Get company information
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/companyGet list of companies
/api/secure/attachment/{id}Download attachment
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/attachmentsList all attachments
/api/secure/attachments/{type}List attachments by type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
type | path | string | Yes | — |
/api/secure/doc/{type}Download documentation PDF
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
type | path | string | Yes | — |
/api/secure/pos/screenshot/{pos}Get Castles POS screenshot
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
pos | path | string | Yes | — |
/api/secure/pos/androidscreenshot/{pos}Get Android POS screenshot
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
pos | path | string | Yes | — |
/api/secure/jwt/vnc/{id}Get VNC access token for POS
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/location/{id}/alert/{type}Send alert to location POS devices
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
type | path | string | Yes | — |
/api/secure/timesheet_xlsx/{year}/{month}get timesheets as xlsx
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
year | path | string | Yes | — |
month | path | string | Yes | — |
/api/secure/timesheet_csv/{year}/{month}get timesheets as csv
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
year | path | string | Yes | — |
month | path | string | Yes | — |
/api/secure/timesheet_flexim/{year}/{month}get timesheets in flexim file
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
year | path | string | Yes | — |
month | path | string | Yes | — |
/api/secure/export/productsExports products as excel file
/api/secure/export/inventory_templateExport inventory template excel
/api/secure/stockevent_by_plu/{location}/{from}/{to}/{plu_id}Get stock events for specific product
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
location | path | string | Yes | — |
from | path | string | Yes | — |
to | path | string | Yes | — |
plu_id | path | string | Yes | — |
/api/secure/inventory/transfersGet inventory transfer history
/api/inv_app/stockevent/{id}Get stock event for inventory app
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/procountor/accessGet Procountor OAuth access URL
/api/procountor/oauthHandle Procountor OAuth callback
/api/secure/procountor_attachmentDownload Procountor attachment
/api/secure/mobilepay/data/{pos}Get MobilePay store information for POS
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
pos | path | string | Yes | — |
/api/secure/external_search/{site}/{query}Search external product databases
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
site | path | string | Yes | — |
query | path | string | Yes | — |
/api/secure/monthly_externals/{date}Get monthly external system exports
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date | path | string | Yes | — |
/api/secure/plu/image/{plu}Get product image
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
plu | path | string | Yes | — |
/api/secure/task/yearreport/{year}Generate yearly report Excel file
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
year | path | string | Yes | — |
/api/secure/task/cashbook/{year}/{month}Generate monthly cash book Excel
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
year | path | string | Yes | — |
month | path | string | Yes | — |
/api/secure/task/purchase_fetch_list/{type}Fetch purchase invoice list from Procountor
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
type | path | string | Yes | — |
/api/secure/task/purchase_fetch/{id}Fetch specific purchase invoice
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/purchase_reconciliation/{id}Reconcile purchase invoice
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/stock_state/{id}Recalculate stock state for location
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/stock_recalc/{location_id}/{date}Recalculate stock for location and date
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
location_id | path | string | Yes | — |
date | path | string | Yes | — |
/api/secure/task/weekcheck/{id}Check weekly report for errors
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/invoice/{id}/pdfGenerate invoice PDF
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/invoice/{id}/attachmentGet invoice attachment
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/weeklyrecalc/{id}Recalculate weekly report
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/pos/filebackups/{pos}List POS file backups
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
pos | path | string | Yes | — |
/api/secure/pos/filebackup/{pos}/{id}Get POS file backup
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
pos | path | string | Yes | — |
id | path | string | Yes | — |
/api/secure/poslog/{uuid}Get POS log by uuid
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
uuid | path | string | Yes | — |
/api/secure/posevents/{uuid}Get POS events by uuid
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
uuid | path | string | Yes | — |
/api/secure/androidevents/{uuid}Get Android events by uuid
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
uuid | path | string | Yes | — |
/api/secure/company/{guid}Get company by guid
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
guid | path | string | Yes | — |
/api/secure/tax/{guid}Get tax by guid
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
guid | path | string | Yes | — |
/api/secure/taxList taxes
/api/secure/export/stockmann/{type}/{id}Export Stockmann data
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
type | path | string | Yes | — |
id | path | string | Yes | — |
/api/secure/stock/export/{type}/{id}Export stock data
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
type | path | string | Yes | — |
id | path | string | Yes | — |
/api/secure/export/finvoice/{id}Export finvoice by id
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/receipt/as_image/{type}/{id}Get receipt as PNG image
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
type | path | string | Yes | — |
id | path | string | Yes | — |
/api/secure/tender_change_listGet list of payment method changes
/api/secure/report2/generatorGenerate reports with various query types
/api/secure/attachments/{type}/{guid}List attachments for specific entity
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
type | path | string | Yes | — |
guid | path | string | Yes | — |
/api/secure/metasearchSearch across products, sales, and invoices
/api/secure/wolt/oauth/access/{location_id}Get Wolt OAuth access URL for location
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
location_id | path | string | Yes | — |
/api/wolt/oauth/callbackHandle Wolt OAuth callback and store tokens
/api/secure/invoicelist/{type}Get invoice list by type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
type | path | string | Yes | — |
/api/secure/kpi/plusales/{location}Get plu sales KPI for location
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
location | path | string | Yes | — |
/api/secure/stockevent_by_date/{date}Get stock events for specific date
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date | path | string | Yes | — |
/api/secure/task/stock_calc_date/{location_id}/{date}Calculate stock for location and date
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
location_id | path | string | Yes | — |
date | path | string | Yes | — |
/api/secure/invoice/{id}/overdue/{type}Generate overdue invoice notice
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
type | path | string | Yes | — |
/api/secure/task/stockrecalc/{guid}Recalculate stock event inventory value
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
guid | path | string | Yes | — |
/api/secure/sales_target_data/{target}Get sales target data for date range
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
target | path | string | Yes | — |
/api/secure/discount_usage/{id}Get POS devices using specific discount
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/discount_usageGet all discount usage by POS
/api/secure/report/hourlysalesGet Hourly sales report
/api/secure/sales/void/{id}Void a sales transaction
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/sales/change_date/{id}/{date}Change transaction date
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
date | path | string | Yes | — |
/api/secure/discount_subscribe/{id}Subscribe all POS devices to discount
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/discount_unsubscribe/{id}Unsubscribe all POS devices from discount
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/push_pos_paramsPush new parameters to all active POS devices
/api/secure/pricelist/revoke/{id}Toggle pricelist active status
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/cashier/password/{id}Change cashier password
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/attachment/uploadUpload general attachment
/api/secure/plu/attachment/upload/{plu}Upload product image
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
plu | path | string | Yes | — |
/api/secure/external_image/attachAttach external image to product
/api/secure/plu/upload/{plu}Upload product image (legacy)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
plu | path | string | Yes | — |
/api/secure/import/productxlsxImport products from excel file
/api/secure/mobilepay/register/{pos}Register POS for MobilePay
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
pos | path | string | Yes | — |
/api/secure/mobilepay/unregister/{pos}Unregister POS from MobilePay
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
pos | path | string | Yes | — |
/api/secure/task/weeksalesinvoice/{id}Generate and transfer weekly sales invoice
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/weekapprove/{id}Approve weekly report
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/generate_invoice/{id}Generate invoice
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/send_invoice/{id}Send invoice
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/sales_to_invoice/{id}Convert sales to invoice
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/rescan_invoice_receipts/{id}Rescan invoice receipts
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/order_to_delivery/{id}Convert purchase order to delivery
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/send_order/{id}Send purchase order
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/inventoryexcelUpload and process inventory Excel
/api/secure/task/inventoryaccounting/{id}Process inventory for accounting export
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/businessday_opExecute business day operation
/api/secure/task/accountingdayTransfer business day to accounting system
/api/secure/task/purchaseinvoice/{id}Process purchase invoice for Netvisor
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/export/stockmann/{type}/{id}Export Stockmann data (POST)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
type | path | string | Yes | — |
id | path | string | Yes | — |
/api/secure/arnolds/ingredients_testTest upload Arnold's ingredients from Excel
/api/secure/arnolds/ingredients_uploadUpload Arnold's ingredients from Excel
/api/secure/pricegroup_update/{p_guid}Update price group and apply to products
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
p_guid | path | string | Yes | — |
/api/secure/attachment/add/{type}/{guid}Add attachment to specific entity
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
type | path | string | Yes | — |
guid | path | string | Yes | — |
/api/secure/password/changeChange user password
/api/secure/password/reset/{user}Reset user password and send by email
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
user | path | string | Yes | — |
/api/secure/password/createCreate new user account
/api/secure/customer/importImport customers
/api/secure/import/ktlImport KTL data
/api/secure/task/sync/{op}Run synchronization task
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
op | path | string | Yes | — |
/api/secure/task/stock_use_date/{id}Calculate stock use for specific date
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/externals/test/{loc}/{day}Test external system transfer
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
loc | path | string | Yes | — |
day | path | string | Yes | — |
/api/secure/task/weeklyrecalc2/{id}Recalculate weekly report (version 2)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/stockdiff/{guid}Calculate stock differences
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
guid | path | string | Yes | — |
/api/secure/task/inventoryrefresh/{guid}Refresh inventory current stock
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
guid | path | string | Yes | — |
/api/secure/businessday_rename/{id}/{date}Rename business day
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
date | path | string | Yes | — |
/api/secure/dashboard/widgetsBatch fetch data for multiple dashboard widgets. Request is array of widget configs, response is object mapping widget ID to result.
/api/secure/task/stock_use/{id}Calculate stock use for business day
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/task/stock/complete/{id}Mark stock event as complete
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/company/{guid}Update company by guid
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
guid | path | string | Yes | — |
/api/secure/inventory/{id}Update inventory
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/attachment/{id}Update attachment metadata
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/inv_app/stockevent/{id}Update stock event from inventory app
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/attachment/{id}Delete attachment
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/api/secure/discount_usage/{id}Get POS systems that have subscribed to a specific discount
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | guid | Yes | Discount GUID identifier |
- 200List of POS system GUIDs that use the specified discount→ guid[]
- 404No POS systems found using this discount
/api/secure/discount_usageGet all POS systems and their discount subscriptions
- 200Map of POS GUID to discount subscription data→ pos_discount_usage_response
/api/secure/sales_target_data/{target}Get sales target data for a specific target and date range
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
target | path | guid | Yes | Sales target GUID identifier |
from | query | date | Yes | Start date for the target data range |
to | query | date | Yes | End date for the target data range |
- 200List of sales target data entries→ sales_target_data[]
- 404No sales target data found for the specified criteria
/api/secure/sales_target_dataUpdate sales target data
- 200Sales target data updated successfully
- 400Invalid request data
- 404Sales target not found
plu
4 endpoint(s)
/secure/plu/{id}Get Product by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
pos
4 endpoint(s)
/secure/pos/{id}Get Pos by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
postype
4 endpoint(s)
/secure/postype/{id}Get Pos Type by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
pricing
4 endpoint(s)
/secure/pricing/{id}Get Price Group by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
Products
1 endpoint(s)
/api/secure/plu/{id}/statisticsGet product statistics for ProductEditor
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | guid | Yes | Product GUID |
from | query | date | No | Start date (default: 30 days ago) |
to | query | date | No | End date (default: today) |
- 200Product statistics→ product_statistics
- 404Product not found
Reports
8 endpoint(s)
/api/secure/report_generator/product-salesGet product sales report with tax breakdown
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | int | No | Maximum number of rows to return (max 10000) |
date_from | query | date | No | Start date for report (YYYY-MM-DD) |
date_to | query | date | No | End date for report (YYYY-MM-DD) |
start_time | query | string | No | Start time (HH:MM:SS, default 00:00:00) |
end_time | query | string | No | End time (HH:MM:SS, default 23:59:59) |
location | query | guid | No | Filter by location GUID(s) |
locations | query | guid | No | Filter by location GUID(s) - alias for location |
pos | query | guid | No | Filter by POS system GUID(s) |
cashier | query | guid | No | Filter by cashier GUID(s) |
grp | query | guid | No | Filter by product group GUID(s) |
dpt | query | guid | No | Filter by department GUID(s) |
plu | query | guid | No | Filter by product GUID(s) |
customer | query | string | No | Filter by customer number(s) |
tags | query | string | No | Filter by product tags (partial match) |
- 200Product sales report data→ report_generator_product_sales_response
/api/secure/report_generator/tendersalesGet tender sales report
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date_from | query | date | No | Start date for report (YYYY-MM-DD) |
date_to | query | date | No | End date for report (YYYY-MM-DD) |
start_time | query | string | No | Start time (HH:MM:SS, default 00:00:00) |
end_time | query | string | No | End time (HH:MM:SS, default 23:59:59) |
location | query | guid | No | Filter by location GUID(s) |
locations | query | guid | No | Filter by location GUID(s) - alias for location |
pos | query | guid | No | Filter by POS system GUID(s) |
cashier | query | guid | No | Filter by cashier GUID(s) |
- 200Tender sales report data→ report_generator_tender_sales_response
/api/secure/report_generator/tenderfixesGet tender fixes report (manual tender corrections from sales JSON data)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date_from | query | date | No | Start date for report (YYYY-MM-DD) |
date_to | query | date | No | End date for report (YYYY-MM-DD) |
start_time | query | string | No | Start time (HH:MM:SS, default 00:00:00) |
end_time | query | string | No | End time (HH:MM:SS, default 23:59:59) |
location | query | guid | No | Filter by location GUID(s) |
locations | query | guid | No | Filter by location GUID(s) - alias for location |
pos | query | guid | No | Filter by POS system GUID(s) |
cashier | query | guid | No | Filter by cashier GUID(s) |
- 200Tender fixes report data→ report_generator_tender_fixes_response
/api/secure/report_generator/actionsGet operational actions report (PAID_OUT, RECEIVED_ON_ACCOUNT, voided sales, NO_SALE, etc.)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date_from | query | date | No | Start date for report (YYYY-MM-DD) |
date_to | query | date | No | End date for report (YYYY-MM-DD) |
start_time | query | string | No | Start time (HH:MM:SS, default 00:00:00) |
end_time | query | string | No | End time (HH:MM:SS, default 23:59:59) |
location | query | guid | No | Filter by location GUID(s) |
locations | query | guid | No | Filter by location GUID(s) - alias for location |
pos | query | guid | No | Filter by POS system GUID(s) |
cashier | query | guid | No | Filter by cashier GUID(s) |
- 200Actions report data→ report_generator_actions_response
/api/secure/report_generator/group-salesGet group sales report aggregated by department and tax rate
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | int | No | Maximum number of rows to return (max 5000) |
date_from | query | date | No | Start date for report (YYYY-MM-DD) |
date_to | query | date | No | End date for report (YYYY-MM-DD) |
start_time | query | string | No | Start time (HH:MM:SS, default 00:00:00) |
end_time | query | string | No | End time (HH:MM:SS, default 23:59:59) |
location | query | guid | No | Filter by location GUID(s) |
locations | query | guid | No | Filter by location GUID(s) - alias for location |
pos | query | guid | No | Filter by POS system GUID(s) |
cashier | query | guid | No | Filter by cashier GUID(s) |
grp | query | guid | No | Filter by product group GUID(s) |
dpt | query | guid | No | Filter by department GUID(s) |
plu | query | guid | No | Filter by product GUID(s) |
customer | query | string | No | Filter by customer number(s) |
- 200Group sales report data→ report_generator_group_sales_response
/api/secure/report_generator/tax-summaryGet tax summary report aggregated by tax rate
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date_from | query | date | No | Start date for report (YYYY-MM-DD) |
date_to | query | date | No | End date for report (YYYY-MM-DD) |
start_time | query | string | No | Start time (HH:MM:SS, default 00:00:00) |
end_time | query | string | No | End time (HH:MM:SS, default 23:59:59) |
location | query | guid | No | Filter by location GUID(s) |
locations | query | guid | No | Filter by location GUID(s) - alias for location |
pos | query | guid | No | Filter by POS system GUID(s) |
cashier | query | guid | No | Filter by cashier GUID(s) |
grp | query | guid | No | Filter by product group GUID(s) |
dpt | query | guid | No | Filter by department GUID(s) |
plu | query | guid | No | Filter by product GUID(s) |
customer | query | string | No | Filter by customer number(s) |
- 200Tax summary report data→ report_generator_tax_summary_response
/api/secure/report_generator/daily-salesGet daily sales report aggregated by day
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date_from | query | date | No | Start date (YYYY-MM-DD) |
date_to | query | date | No | End date (YYYY-MM-DD) |
start_time | query | string | No | Start time (HH:MM:SS) |
end_time | query | string | No | End time (HH:MM:SS) |
location | query | guid | No | Filter by location GUID(s) |
pos | query | guid | No | Filter by POS GUID(s) |
cashier | query | guid | No | Filter by cashier GUID(s) |
grp | query | guid | No | Filter by group GUID(s) |
dpt | query | guid | No | Filter by department GUID(s) |
plu | query | guid | No | Filter by product GUID(s) |
- 200Daily sales report data→ report_generator_daily_sales_response
/api/secure/report_generator/hourly-salesGet hourly sales report aggregated by hour
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
date_from | query | date | No | Start date (YYYY-MM-DD) |
date_to | query | date | No | End date (YYYY-MM-DD) |
start_time | query | string | No | Start time (HH:MM:SS) |
end_time | query | string | No | End time (HH:MM:SS) |
location | query | guid | No | Filter by location GUID(s) |
pos | query | guid | No | Filter by POS GUID(s) |
cashier | query | guid | No | Filter by cashier GUID(s) |
grp | query | guid | No | Filter by group GUID(s) |
dpt | query | guid | No | Filter by department GUID(s) |
plu | query | guid | No | Filter by product GUID(s) |
- 200Hourly sales report data→ report_generator_hourly_sales_response
sales
4 endpoint(s)
/secure/sales/{id}Get Sales by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
salesorder
4 endpoint(s)
/secure/salesorder/{id}Get Sales Order by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/salesorder/{id}Update Sales Order
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
salestarget
4 endpoint(s)
/secure/salestarget/{id}Get Sales Target by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/salestarget/{id}Update Sales Target
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
stock_cost_layer
4 endpoint(s)
/secure/stock_cost_layer/{id}Get Stock Cost Layer by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/stock_cost_layerCreate a new Stock Cost Layer
/secure/stock_cost_layer/{id}Update Stock Cost Layer
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
stock_count_item
4 endpoint(s)
/secure/stock_count_item/{id}Get Stock Count Item by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/stock_count_itemCreate a new Stock Count Item
/secure/stock_count_item/{id}Update Stock Count Item
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
stock_count_session
4 endpoint(s)
/secure/stock_count_session/{id}Get Stock Count Session by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/stock_count_sessionCreate a new Stock Count Session
/secure/stock_count_session/{id}Update Stock Count Session
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
stock_notification
4 endpoint(s)
/secure/stock_notification/{id}Get Stock Notification by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/stock_notificationCreate a new Stock Notification
/secure/stock_notification/{id}Update Stock Notification
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
stock_reservation
4 endpoint(s)
/secure/stock_reservation/{id}Get Stock Reservation by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/stock_reservationCreate a new Stock Reservation
/secure/stock_reservation/{id}Update Stock Reservation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
stock_state_v2
4 endpoint(s)
/secure/stock_state_v2/{id}Get Stock State by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/stock_state_v2Create a new Stock State
/secure/stock_state_v2/{id}Update Stock State
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
stock_transaction
4 endpoint(s)
/secure/stock_transaction/{id}Get Stock Transaction by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/stock_transactionCreate a new Stock Transaction
/secure/stock_transaction/{id}Update Stock Transaction
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
stock_transaction_item
4 endpoint(s)
/secure/stock_transaction_itemList all Stock Transaction Item entities
/secure/stock_transaction_item/{id}Get Stock Transaction Item by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/stock_transaction_itemCreate a new Stock Transaction Item
/secure/stock_transaction_item/{id}Update Stock Transaction Item
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
stock_transfer_batch
4 endpoint(s)
/secure/stock_transfer_batchList all Stock Transfer Batch entities
/secure/stock_transfer_batch/{id}Get Stock Transfer Batch by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/stock_transfer_batchCreate a new Stock Transfer Batch
/secure/stock_transfer_batch/{id}Update Stock Transfer Batch
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
stock_transfer_request
4 endpoint(s)
/secure/stock_transfer_requestList all Transfer Request entities
/secure/stock_transfer_request/{id}Get Transfer Request by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/stock_transfer_requestCreate a new Transfer Request
/secure/stock_transfer_request/{id}Update Transfer Request
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
stock_transfer_request_item
4 endpoint(s)
/secure/stock_transfer_request_itemList all Transfer Request Item entities
/secure/stock_transfer_request_item/{id}Get Transfer Request Item by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/stock_transfer_request_itemCreate a new Transfer Request Item
/secure/stock_transfer_request_item/{id}Update Transfer Request Item
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
stockevent
4 endpoint(s)
/secure/stockevent/{id}Get Stock Event by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/stockevent/{id}Update Stock Event
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
stockeventitem
4 endpoint(s)
/secure/stockeventitem/{id}Get Stock Event Item by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/stockeventitemCreate a new Stock Event Item
/secure/stockeventitem/{id}Update Stock Event Item
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
supplier
4 endpoint(s)
/secure/supplier/{id}Get Supplier by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
tax
4 endpoint(s)
/secure/tax/{id}Get Tax by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
tender
4 endpoint(s)
/secure/tender/{id}Get Tender by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
timesheet
4 endpoint(s)
/secure/timesheet/{id}Get Timesheet by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
user
4 endpoint(s)
/secure/user/{id}Get User by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
weeklyreport
4 endpoint(s)
/secure/weeklyreport/{id}Get Weekly Report by ID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |
/secure/weeklyreport/{id}Update Weekly Report
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | — |