Skip to content

Search is only available in production builds. Try building and previewing the site to test it out locally.

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

https://www.mando.fi/api

AI

2 endpoint(s)

GET/api/secure/ai/company/info

Check if company is configured in AI service

Responses:
POST/api/secure/ai/query

Send natural language query to AI service

Request Body: ai_query_request
Responses:

attachment

4 endpoint(s)

GET/secure/attachment

List all Attachment entities

Response: attachment[]
GET/secure/attachment/{id}

Get Attachment by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: attachment
POST/secure/attachment

Create a new Attachment

Request Body: attachment
Response: attachment
PUT/secure/attachment/{id}

Update Attachment

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: attachment
Response: attachment

businessday

4 endpoint(s)

GET/secure/businessday

List all Business Day entities

Response: businessday[]
GET/secure/businessday/{id}

Get Business Day by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: businessday
POST/secure/businessday

Create a new Business Day

Request Body: businessday
Response: businessday
PUT/secure/businessday/{id}

Update Business Day

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: businessday
Response: businessday

BusinessDays

1 endpoint(s)

POST/api/secure/businessday_rename/{id}/{date}

Change businessday date

Parameters
NameInTypeRequiredDescription
idpathguidYesBusiness day GUID identifier
datepathdateYesNew date for the business day (YYYY-MM-DD format)
Responses:
  • 200Business day renamed successfullystring
  • 404Business day not found
  • 500Internal server error

campaign

4 endpoint(s)

GET/secure/campaign

List all Campaign entities

Response: campaign[]
GET/secure/campaign/{id}

Get Campaign by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: campaign
POST/secure/campaign

Create a new Campaign

Request Body: campaign
Response: campaign
PUT/secure/campaign/{id}

Update Campaign

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: campaign
Response: campaign

cashier

4 endpoint(s)

GET/secure/cashier

List all Cashier entities

Response: cashier[]
GET/secure/cashier/{id}

Get Cashier by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: cashier
POST/secure/cashier

Create a new Cashier

Request Body: cashier
Response: cashier
PUT/secure/cashier/{id}

Update Cashier

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: cashier
Response: cashier

company

4 endpoint(s)

GET/secure/company

List all Company entities

Response: company[]
GET/secure/company/{id}

Get Company by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: company
POST/secure/company

Create a new Company

Request Body: company
Response: company
PUT/secure/company/{id}

Update Company

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: company
Response: company

contract

4 endpoint(s)

GET/secure/contract

List all Contract entities

Response: contract[]
GET/secure/contract/{id}

Get Contract by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: contract
POST/secure/contract

Create a new Contract

Request Body: contract
Response: contract
PUT/secure/contract/{id}

Update Contract

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: contract
Response: contract

customer

4 endpoint(s)

GET/secure/customer

List all Customer entities

Response: customer[]
GET/secure/customer/{id}

Get Customer by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: customer
POST/secure/customer

Create a new Customer

Request Body: customer
Response: customer
PUT/secure/customer/{id}

Update Customer

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: customer
Response: customer

discount

4 endpoint(s)

GET/secure/discount

List all Discount entities

Response: discount[]
GET/secure/discount/{id}

Get Discount by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: discount
POST/secure/discount

Create a new Discount

Request Body: discount
Response: discount
PUT/secure/discount/{id}

Update Discount

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: discount
Response: discount

dpt

4 endpoint(s)

GET/secure/dpt

List all Department entities

Response: dpt[]
GET/secure/dpt/{id}

Get Department by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: dpt
POST/secure/dpt

Create a new Department

Request Body: dpt
Response: dpt
PUT/secure/dpt/{id}

Update Department

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: dpt
Response: dpt

external

4 endpoint(s)

GET/secure/external

List all External Transfer entities

Response: external[]
GET/secure/external/{id}

Get External Transfer by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: external
POST/secure/external

Create a new External Transfer

Request Body: external
Response: external
PUT/secure/external/{id}

Update External Transfer

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: external
Response: external

grp

4 endpoint(s)

GET/secure/grp

List all Group entities

Response: grp[]
GET/secure/grp/{id}

Get Group by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: grp
POST/secure/grp

Create a new Group

Request Body: grp
Response: grp
PUT/secure/grp/{id}

Update Group

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: grp
Response: grp

infocode

4 endpoint(s)

GET/secure/infocode

List all Info Code entities

Response: infocode[]
GET/secure/infocode/{id}

Get Info Code by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: infocode
POST/secure/infocode

Create a new Info Code

Request Body: infocode
Response: infocode
PUT/secure/infocode/{id}

Update Info Code

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: infocode
Response: infocode

invoice

4 endpoint(s)

GET/secure/invoice

List all Invoice entities

Response: invoice[]
GET/secure/invoice/{id}

Get Invoice by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: invoice
POST/secure/invoice

Create a new Invoice

Request Body: invoice
Response: invoice
PUT/secure/invoice/{id}

Update Invoice

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: invoice
Response: invoice

Invoices

1 endpoint(s)

GET/api/secure/invoice_status

Get invoice status summary and statistics

Responses:

layout

4 endpoint(s)

GET/secure/layout

List all Pos Layout entities

Response: layout[]
GET/secure/layout/{id}

Get Pos Layout by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: layout
POST/secure/layout

Create a new Pos Layout

Request Body: layout
Response: layout
PUT/secure/layout/{id}

Update Pos Layout

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: layout
Response: layout

location

4 endpoint(s)

GET/secure/location

List all Location entities

Response: location[]
GET/secure/location/{id}

Get Location by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: location
POST/secure/location

Create a new Location

Request Body: location
Response: location
PUT/secure/location/{id}

Update Location

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: location
Response: location

other

135 endpoint(s)

GET/api/secure/company/{id}

Get company information

Parameters
NameInTypeRequiredDescription
idpathstringYes
GET/api/secure/company

Get list of companies

GET/api/secure/pricelists

Get active pricelists

GET/api/secure/chainstatus

Get weekly reports for chain status

GET/api/secure/attachment/{id}

Download attachment

Parameters
NameInTypeRequiredDescription
idpathstringYes
GET/api/secure/attachments

List all attachments

GET/api/secure/attachments/{type}

List attachments by type

Parameters
NameInTypeRequiredDescription
typepathstringYes
GET/api/secure/doc/{type}

Download documentation PDF

Parameters
NameInTypeRequiredDescription
typepathstringYes
GET/api/secure/pos/screenshot/{pos}

Get Castles POS screenshot

Parameters
NameInTypeRequiredDescription
pospathstringYes
GET/api/secure/pos/androidscreenshot/{pos}

Get Android POS screenshot

Parameters
NameInTypeRequiredDescription
pospathstringYes
GET/api/secure/jwt/vnc/{id}

Get VNC access token for POS

Parameters
NameInTypeRequiredDescription
idpathstringYes
GET/api/secure/location/{id}/alert/{type}

Send alert to location POS devices

Parameters
NameInTypeRequiredDescription
idpathstringYes
typepathstringYes
GET/api/secure/timesheet_xlsx/{year}/{month}

get timesheets as xlsx

Parameters
NameInTypeRequiredDescription
yearpathstringYes
monthpathstringYes
GET/api/secure/timesheet_csv/{year}/{month}

get timesheets as csv

Parameters
NameInTypeRequiredDescription
yearpathstringYes
monthpathstringYes
GET/api/secure/timesheet_flexim/{year}/{month}

get timesheets in flexim file

Parameters
NameInTypeRequiredDescription
yearpathstringYes
monthpathstringYes
GET/api/secure/export/products

Exports products as excel file

GET/api/secure/export/inventory_template

Export inventory template excel

GET/api/secure/stockevent_by_plu/{location}/{from}/{to}/{plu_id}

Get stock events for specific product

Parameters
NameInTypeRequiredDescription
locationpathstringYes
frompathstringYes
topathstringYes
plu_idpathstringYes
GET/api/secure/inventory/transfers

Get inventory transfer history

GET/api/inv_app/stockevent/{id}

Get stock event for inventory app

Parameters
NameInTypeRequiredDescription
idpathstringYes
GET/api/procountor/access

Get Procountor OAuth access URL

GET/api/procountor/oauth

Handle Procountor OAuth callback

GET/api/secure/procountor_attachment

Download Procountor attachment

GET/api/secure/mobilepay/data/{pos}

Get MobilePay store information for POS

Parameters
NameInTypeRequiredDescription
pospathstringYes
GET/api/secure/external_search/{site}/{query}

Search external product databases

Parameters
NameInTypeRequiredDescription
sitepathstringYes
querypathstringYes
GET/api/secure/monthly_externals/{date}

Get monthly external system exports

Parameters
NameInTypeRequiredDescription
datepathstringYes
GET/api/secure/emailtest

Test email configuration

Response: password_result
GET/api/secure/plu/image/{plu}

Get product image

Parameters
NameInTypeRequiredDescription
plupathstringYes
GET/api/secure/number/salesorder

Get next sales order number

Response: number_response
GET/api/secure/task/yearreport/{year}

Generate yearly report Excel file

Parameters
NameInTypeRequiredDescription
yearpathstringYes
GET/api/secure/task/cashbook/{year}/{month}

Generate monthly cash book Excel

Parameters
NameInTypeRequiredDescription
yearpathstringYes
monthpathstringYes
GET/api/secure/task/purchase_fetch_list/{type}

Fetch purchase invoice list from Procountor

Parameters
NameInTypeRequiredDescription
typepathstringYes
GET/api/secure/task/purchase_fetch/{id}

Fetch specific purchase invoice

Parameters
NameInTypeRequiredDescription
idpathstringYes
GET/api/secure/task/purchase_reconciliation/{id}

Reconcile purchase invoice

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: sync_result
GET/api/secure/task/stock_state/{id}

Recalculate stock state for location

Parameters
NameInTypeRequiredDescription
idpathstringYes
GET/api/secure/task/stock_recalc/{location_id}/{date}

Recalculate stock for location and date

Parameters
NameInTypeRequiredDescription
location_idpathstringYes
datepathstringYes
GET/api/secure/task/pricetag_pdf

Generate price tag PDF

Request Body: pricetag_request
GET/api/secure/task/weekcheck/{id}

Check weekly report for errors

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: sync_result
GET/api/secure/invoice/{id}/pdf

Generate invoice PDF

Parameters
NameInTypeRequiredDescription
idpathstringYes
GET/api/secure/invoice/{id}/attachment

Get invoice attachment

Parameters
NameInTypeRequiredDescription
idpathstringYes
GET/api/secure/task/weeklyrecalc/{id}

Recalculate weekly report

Parameters
NameInTypeRequiredDescription
idpathstringYes
GET/api/secure/pos/filebackups/{pos}

List POS file backups

Parameters
NameInTypeRequiredDescription
pospathstringYes
GET/api/secure/pos/filebackup/{pos}/{id}

Get POS file backup

Parameters
NameInTypeRequiredDescription
pospathstringYes
idpathstringYes
GET/api/secure/poslog/{uuid}

Get POS log by uuid

Parameters
NameInTypeRequiredDescription
uuidpathstringYes
GET/api/secure/posevents/{uuid}

Get POS events by uuid

Parameters
NameInTypeRequiredDescription
uuidpathstringYes
GET/api/secure/androidevents/{uuid}

Get Android events by uuid

Parameters
NameInTypeRequiredDescription
uuidpathstringYes
GET/api/secure/company/{guid}

Get company by guid

Parameters
NameInTypeRequiredDescription
guidpathstringYes
GET/api/secure/tax/{guid}

Get tax by guid

Parameters
NameInTypeRequiredDescription
guidpathstringYes
GET/api/secure/tax

List taxes

GET/api/secure/export/stockmann/{type}/{id}

Export Stockmann data

Parameters
NameInTypeRequiredDescription
typepathstringYes
idpathstringYes
GET/api/secure/stock/export/{type}/{id}

Export stock data

Parameters
NameInTypeRequiredDescription
typepathstringYes
idpathstringYes
GET/api/secure/export/finvoice/{id}

Export finvoice by id

Parameters
NameInTypeRequiredDescription
idpathstringYes
GET/api/secure/receipt/as_image/{type}/{id}

Get receipt as PNG image

Parameters
NameInTypeRequiredDescription
typepathstringYes
idpathstringYes
GET/api/secure/paid_out_list

Get list of paid out transactions

GET/api/secure/tender_change_list

Get list of payment method changes

GET/api/secure/report2/generator

Generate reports with various query types

GET/api/secure/vipps/list

Get Vipps payment data

GET/api/secure/attachments/{type}/{guid}

List attachments for specific entity

Parameters
NameInTypeRequiredDescription
typepathstringYes
guidpathstringYes
GET/api/secure/metasearch

Search across products, sales, and invoices

Request Body: metasearch_request
GET/api/secure/wolt/oauth/access/{location_id}

Get Wolt OAuth access URL for location

Parameters
NameInTypeRequiredDescription
location_idpathstringYes
GET/api/wolt/oauth/callback

Handle Wolt OAuth callback and store tokens

GET/api/secure/invoicelist/{type}

Get invoice list by type

Parameters
NameInTypeRequiredDescription
typepathstringYes
GET/api/secure/kpi/plusales/{location}

Get plu sales KPI for location

Parameters
NameInTypeRequiredDescription
locationpathstringYes
GET/api/secure/stockevent_by_date/{date}

Get stock events for specific date

Parameters
NameInTypeRequiredDescription
datepathstringYes
GET/api/secure/task/stock_calc_date/{location_id}/{date}

Calculate stock for location and date

Parameters
NameInTypeRequiredDescription
location_idpathstringYes
datepathstringYes
GET/api/secure/invoice/{id}/overdue/{type}

Generate overdue invoice notice

Parameters
NameInTypeRequiredDescription
idpathstringYes
typepathstringYes
GET/api/secure/task/stockrecalc/{guid}

Recalculate stock event inventory value

Parameters
NameInTypeRequiredDescription
guidpathstringYes
GET/api/secure/sales_target_data/{target}

Get sales target data for date range

Parameters
NameInTypeRequiredDescription
targetpathstringYes
GET/api/secure/discount_usage/{id}

Get POS devices using specific discount

Parameters
NameInTypeRequiredDescription
idpathstringYes
GET/api/secure/discount_usage

Get all discount usage by POS

POST/api/secure/report/hourlysales

Get Hourly sales report

POST/api/secure/sales/void/{id}

Void a sales transaction

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/api/secure/sales/change_date/{id}/{date}

Change transaction date

Parameters
NameInTypeRequiredDescription
idpathstringYes
datepathstringYes
POST/api/secure/discount_subscribe/{id}

Subscribe all POS devices to discount

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/api/secure/discount_unsubscribe/{id}

Unsubscribe all POS devices from discount

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/api/secure/push_pos_params

Push new parameters to all active POS devices

POST/api/secure/pricelist/revoke/{id}

Toggle pricelist active status

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/api/secure/cashier/password/{id}

Change cashier password

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/api/secure/attachment/upload

Upload general attachment

POST/api/secure/plu/attachment/upload/{plu}

Upload product image

Parameters
NameInTypeRequiredDescription
plupathstringYes
POST/api/secure/external_image/attach

Attach external image to product

POST/api/secure/plu/upload/{plu}

Upload product image (legacy)

Parameters
NameInTypeRequiredDescription
plupathstringYes
POST/api/secure/alert

Create system alert

Request Body: alert_request
POST/api/secure/ack_alert

Acknowledge alert

Request Body: ack_alert_request
POST/api/secure/import/productxlsx

Import products from excel file

POST/api/secure/mobilepay/register/{pos}

Register POS for MobilePay

Parameters
NameInTypeRequiredDescription
pospathstringYes
POST/api/secure/mobilepay/unregister/{pos}

Unregister POS from MobilePay

Parameters
NameInTypeRequiredDescription
pospathstringYes
POST/api/secure/task/weeksalesinvoice/{id}

Generate and transfer weekly sales invoice

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/api/secure/task/procountor_op

Execute Procountor operation

Request Body: procountor_op_request
POST/api/secure/task/weekapprove/{id}

Approve weekly report

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/api/secure/task/generate_invoice/{id}

Generate invoice

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: sync_result
POST/api/secure/task/send_invoice/{id}

Send invoice

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: sync_result
POST/api/secure/task/sales_to_invoice/{id}

Convert sales to invoice

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: sync_result
POST/api/secure/task/rescan_invoice_receipts/{id}

Rescan invoice receipts

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: sync_result
POST/api/secure/task/order_to_delivery/{id}

Convert purchase order to delivery

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/api/secure/task/send_order/{id}

Send purchase order

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: sync_result
POST/api/secure/task/inventoryexcel

Upload and process inventory Excel

POST/api/secure/task/inventoryaccounting/{id}

Process inventory for accounting export

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/api/secure/task/businessday_op

Execute business day operation

POST/api/secure/task/accountingday

Transfer business day to accounting system

Response: sync_result
POST/api/secure/task/purchaseinvoice/{id}

Process purchase invoice for Netvisor

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/api/secure/task/pricelist

Generate new price list

Request Body: pricelist_request
POST/api/secure/export/stockmann/{type}/{id}

Export Stockmann data (POST)

Parameters
NameInTypeRequiredDescription
typepathstringYes
idpathstringYes
POST/api/secure/arnolds/ingredients_test

Test upload Arnold's ingredients from Excel

POST/api/secure/arnolds/ingredients_upload

Upload Arnold's ingredients from Excel

POST/api/secure/pricegroup_update/{p_guid}

Update price group and apply to products

Parameters
NameInTypeRequiredDescription
p_guidpathstringYes
POST/api/secure/attachment/add/{type}/{guid}

Add attachment to specific entity

Parameters
NameInTypeRequiredDescription
typepathstringYes
guidpathstringYes
POST/api/secure/password/change

Change user password

POST/api/secure/password/reset/{user}

Reset user password and send by email

Parameters
NameInTypeRequiredDescription
userpathstringYes
Response: password_result
POST/api/secure/password/create

Create new user account

Request Body: user_create_request
Response: password_result
POST/api/secure/customer/import

Import customers

POST/api/secure/import/ktl

Import KTL data

POST/api/secure/task/sync/{op}

Run synchronization task

Parameters
NameInTypeRequiredDescription
oppathstringYes
Response: sync_result
POST/api/secure/task/stock_use_date/{id}

Calculate stock use for specific date

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/api/secure/externals/test/{loc}/{day}

Test external system transfer

Parameters
NameInTypeRequiredDescription
locpathstringYes
daypathstringYes
Response: sync_result
POST/api/secure/task/weeklyrecalc2/{id}

Recalculate weekly report (version 2)

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/api/secure/task/stockdiff/{guid}

Calculate stock differences

Parameters
NameInTypeRequiredDescription
guidpathstringYes
Response: sync_result
POST/api/secure/task/inventoryrefresh/{guid}

Refresh inventory current stock

Parameters
NameInTypeRequiredDescription
guidpathstringYes
Response: sync_result
POST/api/secure/token/create

Create API token

Response: token_response
POST/api/secure/businessday_rename/{id}/{date}

Rename business day

Parameters
NameInTypeRequiredDescription
idpathstringYes
datepathstringYes
POST/api/secure/dashboard/widgets

Batch fetch data for multiple dashboard widgets. Request is array of widget configs, response is object mapping widget ID to result.

POST/api/secure/task/stock_use/{id}

Calculate stock use for business day

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/api/secure/task/stock/complete/{id}

Mark stock event as complete

Parameters
NameInTypeRequiredDescription
idpathstringYes
PUT/api/secure/company/{guid}

Update company by guid

Parameters
NameInTypeRequiredDescription
guidpathstringYes
PUT/api/secure/user_companies

Update user company associations

PUT/api/secure/inventory/{id}

Update inventory

Parameters
NameInTypeRequiredDescription
idpathstringYes
PUT/api/secure/sales_target_data

Update sales target data

PUT/api/secure/attachment/{id}

Update attachment metadata

Parameters
NameInTypeRequiredDescription
idpathstringYes
PUT/api/inv_app/stockevent/{id}

Update stock event from inventory app

Parameters
NameInTypeRequiredDescription
idpathstringYes
DELETE/api/secure/attachment/{id}

Delete attachment

Parameters
NameInTypeRequiredDescription
idpathstringYes
GET/api/secure/discount_usage/{id}

Get POS systems that have subscribed to a specific discount

Parameters
NameInTypeRequiredDescription
idpathguidYesDiscount GUID identifier
Responses:
  • 200List of POS system GUIDs that use the specified discountguid[]
  • 404No POS systems found using this discount
GET/api/secure/discount_usage

Get all POS systems and their discount subscriptions

Responses:
GET/api/secure/sales_target_data/{target}

Get sales target data for a specific target and date range

Parameters
NameInTypeRequiredDescription
targetpathguidYesSales target GUID identifier
fromquerydateYesStart date for the target data range
toquerydateYesEnd date for the target data range
Responses:
  • 200List of sales target data entriessales_target_data[]
  • 404No sales target data found for the specified criteria
PUT/api/secure/sales_target_data

Update sales target data

Responses:
  • 200Sales target data updated successfully
  • 400Invalid request data
  • 404Sales target not found

plu

4 endpoint(s)

GET/secure/plu

List all Product entities

Response: plu[]
GET/secure/plu/{id}

Get Product by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: plu
POST/secure/plu

Create a new Product

Request Body: plu
Response: plu
PUT/secure/plu/{id}

Update Product

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: plu
Response: plu

pos

4 endpoint(s)

GET/secure/pos

List all Pos entities

Response: pos[]
GET/secure/pos/{id}

Get Pos by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: pos
POST/secure/pos

Create a new Pos

Request Body: pos
Response: pos
PUT/secure/pos/{id}

Update Pos

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: pos
Response: pos

postype

4 endpoint(s)

GET/secure/postype

List all Pos Type entities

Response: postype[]
GET/secure/postype/{id}

Get Pos Type by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: postype
POST/secure/postype

Create a new Pos Type

Request Body: postype
Response: postype
PUT/secure/postype/{id}

Update Pos Type

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: postype
Response: postype

pricing

4 endpoint(s)

GET/secure/pricing

List all Price Group entities

Response: pricing[]
GET/secure/pricing/{id}

Get Price Group by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: pricing
POST/secure/pricing

Create a new Price Group

Request Body: pricing
Response: pricing
PUT/secure/pricing/{id}

Update Price Group

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: pricing
Response: pricing

Products

1 endpoint(s)

GET/api/secure/plu/{id}/statistics

Get product statistics for ProductEditor

Parameters
NameInTypeRequiredDescription
idpathguidYesProduct GUID
fromquerydateNoStart date (default: 30 days ago)
toquerydateNoEnd date (default: today)
Responses:

Reports

8 endpoint(s)

GET/api/secure/report_generator/product-sales

Get product sales report with tax breakdown

Parameters
NameInTypeRequiredDescription
limitqueryintNoMaximum number of rows to return (max 10000)
date_fromquerydateNoStart date for report (YYYY-MM-DD)
date_toquerydateNoEnd date for report (YYYY-MM-DD)
start_timequerystringNoStart time (HH:MM:SS, default 00:00:00)
end_timequerystringNoEnd time (HH:MM:SS, default 23:59:59)
locationqueryguidNoFilter by location GUID(s)
locationsqueryguidNoFilter by location GUID(s) - alias for location
posqueryguidNoFilter by POS system GUID(s)
cashierqueryguidNoFilter by cashier GUID(s)
grpqueryguidNoFilter by product group GUID(s)
dptqueryguidNoFilter by department GUID(s)
pluqueryguidNoFilter by product GUID(s)
customerquerystringNoFilter by customer number(s)
tagsquerystringNoFilter by product tags (partial match)
Responses:
GET/api/secure/report_generator/tendersales

Get tender sales report

Parameters
NameInTypeRequiredDescription
date_fromquerydateNoStart date for report (YYYY-MM-DD)
date_toquerydateNoEnd date for report (YYYY-MM-DD)
start_timequerystringNoStart time (HH:MM:SS, default 00:00:00)
end_timequerystringNoEnd time (HH:MM:SS, default 23:59:59)
locationqueryguidNoFilter by location GUID(s)
locationsqueryguidNoFilter by location GUID(s) - alias for location
posqueryguidNoFilter by POS system GUID(s)
cashierqueryguidNoFilter by cashier GUID(s)
Responses:
GET/api/secure/report_generator/tenderfixes

Get tender fixes report (manual tender corrections from sales JSON data)

Parameters
NameInTypeRequiredDescription
date_fromquerydateNoStart date for report (YYYY-MM-DD)
date_toquerydateNoEnd date for report (YYYY-MM-DD)
start_timequerystringNoStart time (HH:MM:SS, default 00:00:00)
end_timequerystringNoEnd time (HH:MM:SS, default 23:59:59)
locationqueryguidNoFilter by location GUID(s)
locationsqueryguidNoFilter by location GUID(s) - alias for location
posqueryguidNoFilter by POS system GUID(s)
cashierqueryguidNoFilter by cashier GUID(s)
Responses:
GET/api/secure/report_generator/actions

Get operational actions report (PAID_OUT, RECEIVED_ON_ACCOUNT, voided sales, NO_SALE, etc.)

Parameters
NameInTypeRequiredDescription
date_fromquerydateNoStart date for report (YYYY-MM-DD)
date_toquerydateNoEnd date for report (YYYY-MM-DD)
start_timequerystringNoStart time (HH:MM:SS, default 00:00:00)
end_timequerystringNoEnd time (HH:MM:SS, default 23:59:59)
locationqueryguidNoFilter by location GUID(s)
locationsqueryguidNoFilter by location GUID(s) - alias for location
posqueryguidNoFilter by POS system GUID(s)
cashierqueryguidNoFilter by cashier GUID(s)
Responses:
GET/api/secure/report_generator/group-sales

Get group sales report aggregated by department and tax rate

Parameters
NameInTypeRequiredDescription
limitqueryintNoMaximum number of rows to return (max 5000)
date_fromquerydateNoStart date for report (YYYY-MM-DD)
date_toquerydateNoEnd date for report (YYYY-MM-DD)
start_timequerystringNoStart time (HH:MM:SS, default 00:00:00)
end_timequerystringNoEnd time (HH:MM:SS, default 23:59:59)
locationqueryguidNoFilter by location GUID(s)
locationsqueryguidNoFilter by location GUID(s) - alias for location
posqueryguidNoFilter by POS system GUID(s)
cashierqueryguidNoFilter by cashier GUID(s)
grpqueryguidNoFilter by product group GUID(s)
dptqueryguidNoFilter by department GUID(s)
pluqueryguidNoFilter by product GUID(s)
customerquerystringNoFilter by customer number(s)
Responses:
GET/api/secure/report_generator/tax-summary

Get tax summary report aggregated by tax rate

Parameters
NameInTypeRequiredDescription
date_fromquerydateNoStart date for report (YYYY-MM-DD)
date_toquerydateNoEnd date for report (YYYY-MM-DD)
start_timequerystringNoStart time (HH:MM:SS, default 00:00:00)
end_timequerystringNoEnd time (HH:MM:SS, default 23:59:59)
locationqueryguidNoFilter by location GUID(s)
locationsqueryguidNoFilter by location GUID(s) - alias for location
posqueryguidNoFilter by POS system GUID(s)
cashierqueryguidNoFilter by cashier GUID(s)
grpqueryguidNoFilter by product group GUID(s)
dptqueryguidNoFilter by department GUID(s)
pluqueryguidNoFilter by product GUID(s)
customerquerystringNoFilter by customer number(s)
Responses:
GET/api/secure/report_generator/daily-sales

Get daily sales report aggregated by day

Parameters
NameInTypeRequiredDescription
date_fromquerydateNoStart date (YYYY-MM-DD)
date_toquerydateNoEnd date (YYYY-MM-DD)
start_timequerystringNoStart time (HH:MM:SS)
end_timequerystringNoEnd time (HH:MM:SS)
locationqueryguidNoFilter by location GUID(s)
posqueryguidNoFilter by POS GUID(s)
cashierqueryguidNoFilter by cashier GUID(s)
grpqueryguidNoFilter by group GUID(s)
dptqueryguidNoFilter by department GUID(s)
pluqueryguidNoFilter by product GUID(s)
Responses:
GET/api/secure/report_generator/hourly-sales

Get hourly sales report aggregated by hour

Parameters
NameInTypeRequiredDescription
date_fromquerydateNoStart date (YYYY-MM-DD)
date_toquerydateNoEnd date (YYYY-MM-DD)
start_timequerystringNoStart time (HH:MM:SS)
end_timequerystringNoEnd time (HH:MM:SS)
locationqueryguidNoFilter by location GUID(s)
posqueryguidNoFilter by POS GUID(s)
cashierqueryguidNoFilter by cashier GUID(s)
grpqueryguidNoFilter by group GUID(s)
dptqueryguidNoFilter by department GUID(s)
pluqueryguidNoFilter by product GUID(s)
Responses:

sales

4 endpoint(s)

GET/secure/sales

List all Sales entities

Response: sales[]
GET/secure/sales/{id}

Get Sales by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: sales
POST/secure/sales

Create a new Sales

Request Body: sales
Response: sales
PUT/secure/sales/{id}

Update Sales

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: sales
Response: sales

salesorder

4 endpoint(s)

GET/secure/salesorder

List all Sales Order entities

Response: salesorder[]
GET/secure/salesorder/{id}

Get Sales Order by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: salesorder
POST/secure/salesorder

Create a new Sales Order

Request Body: salesorder
Response: salesorder
PUT/secure/salesorder/{id}

Update Sales Order

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: salesorder
Response: salesorder

salestarget

4 endpoint(s)

GET/secure/salestarget

List all Sales Target entities

Response: salestarget[]
GET/secure/salestarget/{id}

Get Sales Target by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: salestarget
POST/secure/salestarget

Create a new Sales Target

Request Body: salestarget
Response: salestarget
PUT/secure/salestarget/{id}

Update Sales Target

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: salestarget
Response: salestarget

stock_cost_layer

4 endpoint(s)

GET/secure/stock_cost_layer

List all Stock Cost Layer entities

GET/secure/stock_cost_layer/{id}

Get Stock Cost Layer by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/secure/stock_cost_layer

Create a new Stock Cost Layer

Request Body: stock_cost_layer
PUT/secure/stock_cost_layer/{id}

Update Stock Cost Layer

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: stock_cost_layer

stock_count_item

4 endpoint(s)

GET/secure/stock_count_item

List all Stock Count Item entities

GET/secure/stock_count_item/{id}

Get Stock Count Item by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/secure/stock_count_item

Create a new Stock Count Item

Request Body: stock_count_item
PUT/secure/stock_count_item/{id}

Update Stock Count Item

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: stock_count_item

stock_count_session

4 endpoint(s)

GET/secure/stock_count_session

List all Stock Count Session entities

GET/secure/stock_count_session/{id}

Get Stock Count Session by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/secure/stock_count_session

Create a new Stock Count Session

PUT/secure/stock_count_session/{id}

Update Stock Count Session

Parameters
NameInTypeRequiredDescription
idpathstringYes

stock_notification

4 endpoint(s)

GET/secure/stock_notification

List all Stock Notification entities

GET/secure/stock_notification/{id}

Get Stock Notification by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/secure/stock_notification

Create a new Stock Notification

Request Body: stock_notification
PUT/secure/stock_notification/{id}

Update Stock Notification

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: stock_notification

stock_reservation

4 endpoint(s)

GET/secure/stock_reservation

List all Stock Reservation entities

GET/secure/stock_reservation/{id}

Get Stock Reservation by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/secure/stock_reservation

Create a new Stock Reservation

Request Body: stock_reservation
PUT/secure/stock_reservation/{id}

Update Stock Reservation

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: stock_reservation

stock_state_v2

4 endpoint(s)

GET/secure/stock_state_v2

List all Stock State entities

GET/secure/stock_state_v2/{id}

Get Stock State by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: stock_state_v2
POST/secure/stock_state_v2

Create a new Stock State

Request Body: stock_state_v2
Response: stock_state_v2
PUT/secure/stock_state_v2/{id}

Update Stock State

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: stock_state_v2
Response: stock_state_v2

stock_transaction

4 endpoint(s)

GET/secure/stock_transaction

List all Stock Transaction entities

GET/secure/stock_transaction/{id}

Get Stock Transaction by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/secure/stock_transaction

Create a new Stock Transaction

Request Body: stock_transaction
PUT/secure/stock_transaction/{id}

Update Stock Transaction

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: stock_transaction

stock_transaction_item

4 endpoint(s)

GET/secure/stock_transaction_item

List all Stock Transaction Item entities

GET/secure/stock_transaction_item/{id}

Get Stock Transaction Item by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/secure/stock_transaction_item

Create a new Stock Transaction Item

PUT/secure/stock_transaction_item/{id}

Update Stock Transaction Item

Parameters
NameInTypeRequiredDescription
idpathstringYes

stock_transfer_batch

4 endpoint(s)

GET/secure/stock_transfer_batch

List all Stock Transfer Batch entities

GET/secure/stock_transfer_batch/{id}

Get Stock Transfer Batch by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/secure/stock_transfer_batch

Create a new Stock Transfer Batch

PUT/secure/stock_transfer_batch/{id}

Update Stock Transfer Batch

Parameters
NameInTypeRequiredDescription
idpathstringYes

stock_transfer_request

4 endpoint(s)

GET/secure/stock_transfer_request

List all Transfer Request entities

GET/secure/stock_transfer_request/{id}

Get Transfer Request by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/secure/stock_transfer_request

Create a new Transfer Request

PUT/secure/stock_transfer_request/{id}

Update Transfer Request

Parameters
NameInTypeRequiredDescription
idpathstringYes

stock_transfer_request_item

4 endpoint(s)

GET/secure/stock_transfer_request_item

List all Transfer Request Item entities

GET/secure/stock_transfer_request_item/{id}

Get Transfer Request Item by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
POST/secure/stock_transfer_request_item

Create a new Transfer Request Item

PUT/secure/stock_transfer_request_item/{id}

Update Transfer Request Item

Parameters
NameInTypeRequiredDescription
idpathstringYes

stockevent

4 endpoint(s)

GET/secure/stockevent

List all Stock Event entities

Response: stockevent[]
GET/secure/stockevent/{id}

Get Stock Event by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: stockevent
POST/secure/stockevent

Create a new Stock Event

Request Body: stockevent
Response: stockevent
PUT/secure/stockevent/{id}

Update Stock Event

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: stockevent
Response: stockevent

stockeventitem

4 endpoint(s)

GET/secure/stockeventitem

List all Stock Event Item entities

GET/secure/stockeventitem/{id}

Get Stock Event Item by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: stockeventitem
POST/secure/stockeventitem

Create a new Stock Event Item

Request Body: stockeventitem
Response: stockeventitem
PUT/secure/stockeventitem/{id}

Update Stock Event Item

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: stockeventitem
Response: stockeventitem

supplier

4 endpoint(s)

GET/secure/supplier

List all Supplier entities

Response: supplier[]
GET/secure/supplier/{id}

Get Supplier by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: supplier
POST/secure/supplier

Create a new Supplier

Request Body: supplier
Response: supplier
PUT/secure/supplier/{id}

Update Supplier

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: supplier
Response: supplier

tax

4 endpoint(s)

GET/secure/tax

List all Tax entities

Response: tax[]
GET/secure/tax/{id}

Get Tax by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: tax
POST/secure/tax

Create a new Tax

Request Body: tax
Response: tax
PUT/secure/tax/{id}

Update Tax

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: tax
Response: tax

tender

4 endpoint(s)

GET/secure/tender

List all Tender entities

Response: tender[]
GET/secure/tender/{id}

Get Tender by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: tender
POST/secure/tender

Create a new Tender

Request Body: tender
Response: tender
PUT/secure/tender/{id}

Update Tender

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: tender
Response: tender

timesheet

4 endpoint(s)

GET/secure/timesheet

List all Timesheet entities

Response: timesheet[]
GET/secure/timesheet/{id}

Get Timesheet by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: timesheet
POST/secure/timesheet

Create a new Timesheet

Request Body: timesheet
Response: timesheet
PUT/secure/timesheet/{id}

Update Timesheet

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: timesheet
Response: timesheet

user

4 endpoint(s)

GET/secure/user

List all User entities

Response: user[]
GET/secure/user/{id}

Get User by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: user
POST/secure/user

Create a new User

Request Body: user
Response: user
PUT/secure/user/{id}

Update User

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: user
Response: user

weeklyreport

4 endpoint(s)

GET/secure/weeklyreport

List all Weekly Report entities

Response: weeklyreport[]
GET/secure/weeklyreport/{id}

Get Weekly Report by ID

Parameters
NameInTypeRequiredDescription
idpathstringYes
Response: weeklyreport
POST/secure/weeklyreport

Create a new Weekly Report

Request Body: weeklyreport
Response: weeklyreport
PUT/secure/weeklyreport/{id}

Update Weekly Report

Parameters
NameInTypeRequiredDescription
idpathstringYes
Request Body: weeklyreport
Response: weeklyreport