Download OpenAPI specification:Download
{domain} - URL client exampe: xxx.fusionpos.ru or where xxx - client prefix
| search | any |
| modifierIs | any |
| pointId | any Required - true, if select has: menuCategory, goodsCategory, clientsGroups, tables, discounts |
| select | Array of strings Items Enum: "users" "clients" "networks" "points" "menuCategory" "goodsCategory" "clientsGroups" "paymentTypes" "statuses" "maxTotalMoney" "tables" "discounts" Possible to select multiple fields |
| id_holding required | number |
| name required | string Max 100 |
| printlogo | string Max 255 |
| printlogo_base64 | string TEXT format |
| admin_password | string Max 16 |
| pos_type | string Default: "cafe" Enum: "cafe" "shop" "catering" |
| seller_name required | string Default: "Официант" Max 20 |
| preorder_tags | string Max 1024 |
| id_point_main | number Id point |
| uds_game_enabled | string Default: "no" Enum: "yes" "no" "discount" "bonus" |
| uds_game_key | string Max 128 |
| pos_auth_type | string Default: "pin4" Enum: "pin4" "pin6" "pin8" "card" |
| firebase_auth_key_legacy | string Max 255 |
| apns_app_topic | string Max 255 |
| shop_status | string Default: "not-created" Enum: "not-created" "active" "inactive" "deleted" "disabled" |
| shop_domain | string Max 255 |
| shop_token | string Max 255 |
| shared_email_for_checks | string Max 100 |
| currency | string Default: "RUB" Max 255 |
{- "id_holding": 0,
- "name": "string",
- "printlogo": "string",
- "printlogo_base64": "string",
- "admin_password": "string",
- "pos_type": "cafe",
- "seller_name": "Официант",
- "preorder_tags": "string",
- "id_point_main": 0,
- "uds_game_enabled": "yes",
- "uds_game_key": "string",
- "pos_auth_type": "pin4",
- "firebase_auth_key_legacy": "string",
- "apns_app_topic": "string",
- "shop_status": "not-created",
- "shop_domain": "string",
- "shop_token": "string",
- "shared_email_for_checks": "string",
- "currency": "RUB"
}| changeIds | string |
| tableIds | string |
| discountIds | string |
| minTotalSum | string |
| maxTotalSum | string |
| clientIds | string |
| userIds | string |
| pointIds | string |
| clientName | string |
| clientLastname | string |
| clientPhone | string |
| clientCardNumber | string |
| waiterFirstname | string |
| foodName | string |
| orderCommentText | string |
| search | string |
| openDateStart | string |
| openDateEnd | string |
| closeDateStart | string |
| closeDateEnd | string |
| paymentTypes | string |
| orderByPosition | string Enum: "ASC" "DESC" |
| tpl | string Default: "default" Enum: "client" "default" "user" "discount" |
| orderBy | Array of strings Items Enum: "id" "order_number" "id_point" "change_id" "hall_id" "table_id" "open_date" "close_date" "guest" "user_id" "status" "discount" "id_discount" "type_payment" "cash_sum" "card_sum" "total_money" "extra_money" "cost_price" "paid_by_points" "client_get_points" "prepayment" "is_fiskal" "waiterName" "tableName" Possible to select multiple fields |
| changeIds | string |
| tableIds | string |
| discountIds | string |
| minTotalSum | string |
| maxTotalSum | string |
| clientIds | string |
| userIds | string |
| pointIds | string |
| clientName | string |
| clientLastname | string |
| clientPhone | string |
| clientCardNumber | string |
| waiterFirstname | string |
| foodName | string |
| orderCommentText | string |
| search | string |
| openDateStart | string |
| openDateEnd | string |
| closeDateStart | string |
| closeDateEnd | string |
| paymentTypes | string |
| orderByPosition | string Enum: "ASC" "DESC" |
| tpl | string Default: "default" Enum: "client" "default" "user" "discount" |
| orderBy | Array of strings Items Enum: "id" "order_number" "id_point" "change_id" "hall_id" "table_id" "open_date" "close_date" "guest" "user_id" "status" "discount" "id_discount" "type_payment" "cash_sum" "card_sum" "total_money" "extra_money" "cost_price" "paid_by_points" "client_get_points" "prepayment" "is_fiskal" "waiterName" "tableName" Possible to select multiple fields |
| id_network required | number |
| id_warehouse required | number |
| name required | string Max 100 |
| time_zone required | string Max 50 |
| address | string Max 100 |
{- "id_network": 0,
- "id_warehouse": 0,
- "name": "string",
- "time_zone": "string",
- "address": "string"
}| id_network required | number |
| id_warehouse required | number |
| address | string |
| name required | string |
| status | string Default: "active" Enum: "active" "inactive" "deleted" |
| is_quick_service | string Default: "no" Enum: "yes" "no" |
| is_fiskal | string Default: "no" Enum: "yes" "no" |
| do_kitchen_check | string Default: "yes" Enum: "yes" "no" |
| discount_type | string Default: "none" Enum: "none" "simple" "clients" "combine" "uds_game" "clientsapp" "clientsapp_pre" |
| max_points_percent | number Default: 50 Max 255 |
| allow_add_client | string Default: "no" Enum: "yes" "no" |
| predcheck | string Default: "yes" Enum: "yes" "no" |
| map_x | string Default: "47.2429" Max 20 |
| map_y | string Default: "39.7016" Max 20 |
| print_paid_check | string Default: "no" Enum: "yes" "no" |
| send_coords | string Default: "no" Enum: "yes" "no" |
| admin_pin | string Default: "" Max 20 |
| notify_crit_qty_goods | string Default: "none" Enum: "none" "onordersell" "onclosechange" |
| id_user_notify | number Default: 0 |
| print_address | string Default: "no" Enum: "yes" "no" |
| print_wifi | string Default: "no" Enum: "yes" "no" |
| wifi_name | string Max 32 |
| wifi_password | string Max 20 |
| group_check_items | string Default: "no" Enum: "yes" "no" |
| do_inventory | string Default: "no" Enum: "yes" "no" |
| order_number_view | string Default: "normal" Enum: "normal" "big" "separate" "normal-3" "big-3" "separate-3" "normal-4" "big-4" "separate-4" |
| print_transactions | string Default: "no" Enum: "yes" "no" |
| orders_screen | string Default: "tables" Enum: "tables" "calendar" "delivery" |
| do_invoice | string Default: "no" Enum: "yes" "no" |
| do_delivery | string Default: "no" Enum: "yes" "no" |
| do_booking | string Default: "no" Enum: "yes" "no" |
| time_zone | string Max 50 |
| round_order_sum | string Default: "no" Enum: "no" "to_min" "to_max" "round" |
| currency | string Max 100 |
| default_city | string Max 50 |
| do_egais | string Default: "no" Enum: "yes" "no" |
| goods_production | string Default: "no" Enum: "yes" "no" |
| remote_orders_check_time | number |
| fiskal_default | string Default: "yes" Enum: "yes" "no" |
| logout_time | number |
| order_owner | string Default: "closer" Enum: "opener" "closer" |
| delivery_minutes_to_ready | number |
| delivery_main_screen | string Default: "list" Enum: "list" "calendar" |
| client_search_type | string Default: "all" Enum: "all" "card" |
| bill_free_text | string Max 1024 |
| quick_open_order_button | string Default: "show" Enum: "show" "hide" |
| default_category_id | number |
| fiskal_button_style | string Default: "active" Enum: "active" "inactive" "hidden" |
| id_finance_account_inkass | number |
| id_finance_category_invoice_transaction | number |
| id_finance_account_invoice_transaction | number |
| ask_client_email | string Default: "no" Enum: "yes" "no" |
| use_shared_email_for_checks | string Default: "no" Enum: "yes" "no" |
| print_zeroprice_items | string Default: "yes" Enum: "yes" "no" |
| use_print_service | string Default: "no" Enum: "yes" "no" |
| transaction_category | string Default: "no" Enum: "yes" "no" |
| barcode_template | string Default: "plain_text" Max 50 |
{- "id_network": 0,
- "id_warehouse": 0,
- "address": "string",
- "name": "string",
- "status": "active",
- "is_quick_service": "yes",
- "is_fiskal": "yes",
- "do_kitchen_check": "yes",
- "discount_type": "none",
- "max_points_percent": 50,
- "allow_add_client": "yes",
- "predcheck": "yes",
- "map_x": "47.2429",
- "map_y": "39.7016",
- "print_paid_check": "yes",
- "send_coords": "yes",
- "admin_pin": "",
- "notify_crit_qty_goods": "none",
- "id_user_notify": 0,
- "print_address": "yes",
- "print_wifi": "yes",
- "wifi_name": "string",
- "wifi_password": "string",
- "group_check_items": "yes",
- "do_inventory": "yes",
- "order_number_view": "normal",
- "print_transactions": "yes",
- "orders_screen": "tables",
- "do_invoice": "yes",
- "do_delivery": "yes",
- "do_booking": "yes",
- "time_zone": "string",
- "round_order_sum": "no",
- "currency": "string",
- "default_city": "string",
- "do_egais": "yes",
- "goods_production": "yes",
- "remote_orders_check_time": 0,
- "fiskal_default": "yes",
- "logout_time": 0,
- "order_owner": "opener",
- "delivery_minutes_to_ready": 0,
- "delivery_main_screen": "list",
- "client_search_type": "all",
- "bill_free_text": "string",
- "quick_open_order_button": "show",
- "default_category_id": 0,
- "fiskal_button_style": "active",
- "id_finance_account_inkass": 0,
- "id_finance_category_invoice_transaction": 0,
- "id_finance_account_invoice_transaction": 0,
- "ask_client_email": "yes",
- "use_shared_email_for_checks": "yes",
- "print_zeroprice_items": "yes",
- "use_print_service": "yes",
- "transaction_category": "yes",
- "barcode_template": "plain_text"
}| id_network required | number |
| discount_name required | string Max 100 |
| value required | string Max 255 |
| discount_type | string TEXT format |
| description | string TEXT format |
| is_active | string Default: "yes" Enum: "yes" "no" |
| is_deleted | string Default: "no" Enum: "yes" "no" |
| discount_for | string Default: "order" Enum: "order" "client" "menu" "bonus" |
| is_client_default | string Default: "no" Enum: "yes" "no" |
| id_manufactory | number Id manufactory |
| include_type | string Default: "exclude" Enum: "exclude" "include" |
| items | Array of strings Only if discount_type = custom/menuitem; Example: [1,2,3] |
{- "id_network": 0,
- "discount_name": "string",
- "value": "string",
- "discount_type": "string",
- "description": "string",
- "is_active": "yes",
- "is_deleted": "yes",
- "discount_for": "order",
- "is_client_default": "yes",
- "id_manufactory": 0,
- "include_type": "exclude",
- "items": [
- "string"
]
}| id_network required | number |
| discount_name required | string Max 100 |
| value required | string Max 255 |
| discount_type | string TEXT format |
| description | string TEXT format |
| is_active | string Default: "yes" Enum: "yes" "no" |
| is_deleted | string Default: "no" Enum: "yes" "no" |
| discount_for | string Default: "order" Enum: "order" "client" "menu" "bonus" |
| is_client_default | string Default: "no" Enum: "yes" "no" |
| id_manufactory | number Id manufactory |
| include_type | string Default: "exclude" Enum: "exclude" "include" |
| items | Array of strings Only if discount_type = custom/menuitem; Example: [1,2,3] |
{- "id_network": 0,
- "discount_name": "string",
- "value": "string",
- "discount_type": "string",
- "description": "string",
- "is_active": "yes",
- "is_deleted": "yes",
- "discount_for": "order",
- "is_client_default": "yes",
- "id_manufactory": 0,
- "include_type": "exclude",
- "items": [
- "string"
]
}| name required | string Max 50 |
| lastname | string Max 50 |
| father | string Max 30 |
| phone required | string Max 20 |
string | |
| points | number |
| id_network | number |
| id_group required | number |
| gender | string Enum: "male" "female" |
| birthday | string Date format 'Y-m-d' |
| allow_sms | string Default: "no" Enum: "yes" "no" |
| card_number | string Max 20 |
{- "name": "string",
- "lastname": "string",
- "father": "string",
- "phone": "string",
- "email": "string",
- "points": 0,
- "id_network": 0,
- "id_group": 0,
- "gender": "male",
- "birthday": "string",
- "allow_sms": "yes",
- "card_number": "string"
}| name required | string Max 50 |
| lastname | string Max 50 |
| father | string Max 30 |
| phone required | string Max 20 |
string | |
| points | number |
| id_network | number |
| id_group required | number |
| gender | string Enum: "male" "female" |
| birthday | string Date format 'Y-m-d' |
| allow_sms | string Default: "no" Enum: "yes" "no" |
| card_number | string Max 20 |
{- "name": "string",
- "lastname": "string",
- "father": "string",
- "phone": "string",
- "email": "string",
- "points": 0,
- "id_network": 0,
- "id_group": 0,
- "gender": "male",
- "birthday": "string",
- "allow_sms": "yes",
- "card_number": "string"
}| id_network required | number |
| parent_id | number |
| step | number |
| group_name required | string |
| discount_type required | string Default: "discount" Enum: "discount" "bonus" |
| id_discount | number |
| is_default | string Default: "no" Enum: "yes" "no" |
| is_active | string Default: "yes" Enum: "yes" "no" |
| is_deleted | string Default: "no" Enum: "yes" "no" |
| allow_autochange | string Default: "no" Enum: "yes" "no" |
| autochange_limit | number Default: 0 decimal(15, 2) |
| greeting_points | number Default: 0 |
Array of objects (StepsClass) Шаги |
{- "id_network": 0,
- "parent_id": 0,
- "step": 0,
- "group_name": "string",
- "discount_type": "discount",
- "id_discount": 0,
- "is_default": "yes",
- "is_active": "yes",
- "is_deleted": "yes",
- "allow_autochange": "yes",
- "autochange_limit": 0,
- "greeting_points": 0,
- "steps": [
- {
- "value": 0,
- "autochange_limit": 0,
- "discount_type": "all",
- "id_manufactory": 0,
- "id_discount": 0,
- "id": 0,
- "include_type": "exclude",
- "positions": [
- "string"
]
}
]
}| id_network required | number |
| parent_id | number |
| step | number |
| group_name required | string |
| discount_type required | string Default: "discount" Enum: "discount" "bonus" |
| id_discount | number |
| is_default | string Default: "no" Enum: "yes" "no" |
| is_active | string Default: "yes" Enum: "yes" "no" |
| is_deleted | string Default: "no" Enum: "yes" "no" |
| allow_autochange | string Default: "no" Enum: "yes" "no" |
| autochange_limit | number Default: 0 decimal(15, 2) |
| greeting_points | number Default: 0 |
Array of objects (StepsClass) Шаги |
{- "id_network": 0,
- "parent_id": 0,
- "step": 0,
- "group_name": "string",
- "discount_type": "discount",
- "id_discount": 0,
- "is_default": "yes",
- "is_active": "yes",
- "is_deleted": "yes",
- "allow_autochange": "yes",
- "autochange_limit": 0,
- "greeting_points": 0,
- "steps": [
- {
- "value": 0,
- "autochange_limit": 0,
- "discount_type": "all",
- "id_manufactory": 0,
- "id_discount": 0,
- "id": 0,
- "include_type": "exclude",
- "positions": [
- "string"
]
}
]
}| orderBy | string |
| orderByPosition | string |
| size | number |
| isSubGoods | string Default: "no" Enum: "yes" "no" |
| isDeleted | string Default: "no" Enum: "yes" "no" |
| search | string Search on name |
| pointId | number Specify to receive price_in_this_point in goods |
| name required | string |
| unit required | string Отправлять значение 'name' из списка /api/v2/weight |
| id_category required | number |
| is_alco | string Enum: "yes" "no" |
| norm_qty | number |
| crit_qty | number |
| is_send_report | string Enum: "yes" "no" |
| is_sub_goods | string Default: "no" Enum: "yes" "no" Если 'yes' - это полуфабрикат и ожидается recipe, 'no' - это простой ингредиент |
| weight | number |
| process_desc | string |
| id_network | number |
| loss_clean_percent | number 0 - 100 float(5,2) |
| loss_boil_percent | number 0 - 100 float(5,2) |
| loss_fry_percent | number 0 - 100 float(5,2) |
| loss_stew_percent | number 0 - 100 float(5,2) |
| loss_bake_percent | number 0 - 100 float(5,2) |
Array of objects (RecipeClass) | |
Array of objects (GoodsPointsCritQtyClass) | |
Array of objects (GoodsPackingClass) |
{- "name": "string",
- "unit": "string",
- "id_category": 0,
- "is_alco": "yes",
- "norm_qty": 0,
- "crit_qty": 0,
- "is_send_report": "yes",
- "is_sub_goods": "yes",
- "weight": 0,
- "process_desc": "string",
- "id_network": 0,
- "loss_clean_percent": 0,
- "loss_boil_percent": 0,
- "loss_fry_percent": 0,
- "loss_stew_percent": 0,
- "loss_bake_percent": 0,
- "recipe": [
- {
- "id_goods": 0,
- "id_goods_parent": 0,
- "weight": "string",
- "quantity": 0,
- "quantity_netto": 0,
- "output": 0,
- "quantity_orig": 0,
- "quantity_netto_orig": 0,
- "output_orig": 0,
- "loss_clean": "yes",
- "loss_boil": "yes",
- "loss_fry": "yes",
- "loss_stew": "yes",
- "loss_bake": "yes"
}
], - "points_critical_quantity": [
- {
- "id_goods": 0,
- "id_point": 0,
- "norm_qty": 0,
- "crit_qty": 0,
- "is_send_report": "yes"
}
], - "packing": [
- {
- "good_id": 0,
- "qty": 0,
- "name": "string"
}
]
}| id required | number |
| name required | string |
| unit required | string Отправлять значение 'name' из списка /api/v2/weight |
| id_category required | number |
| is_alco | string Enum: "yes" "no" |
| norm_qty | number |
| crit_qty | number |
| is_send_report | string Enum: "yes" "no" |
| is_sub_goods | string Default: "no" Enum: "yes" "no" Если 'yes' - это полуфабрикат и ожидается recipe, 'no' - это простой ингредиент |
| weight | number |
| process_desc | string |
| id_network | number |
| loss_clean_percent | number 0 - 100 float(5,2) |
| loss_boil_percent | number 0 - 100 float(5,2) |
| loss_fry_percent | number 0 - 100 float(5,2) |
| loss_stew_percent | number 0 - 100 float(5,2) |
| loss_bake_percent | number 0 - 100 float(5,2) |
Array of objects (RecipeClass) | |
Array of objects (GoodsPointsCritQtyClass) | |
Array of objects (GoodsPackingClass) |
{- "name": "string",
- "unit": "string",
- "id_category": 0,
- "is_alco": "yes",
- "norm_qty": 0,
- "crit_qty": 0,
- "is_send_report": "yes",
- "is_sub_goods": "yes",
- "weight": 0,
- "process_desc": "string",
- "id_network": 0,
- "loss_clean_percent": 0,
- "loss_boil_percent": 0,
- "loss_fry_percent": 0,
- "loss_stew_percent": 0,
- "loss_bake_percent": 0,
- "recipe": [
- {
- "id_goods": 0,
- "id_goods_parent": 0,
- "weight": "string",
- "quantity": 0,
- "quantity_netto": 0,
- "output": 0,
- "quantity_orig": 0,
- "quantity_netto_orig": 0,
- "output_orig": 0,
- "loss_clean": "yes",
- "loss_boil": "yes",
- "loss_fry": "yes",
- "loss_stew": "yes",
- "loss_bake": "yes"
}
], - "points_critical_quantity": [
- {
- "id_goods": 0,
- "id_point": 0,
- "norm_qty": 0,
- "crit_qty": 0,
- "is_send_report": "yes"
}
], - "packing": [
- {
- "good_id": 0,
- "qty": 0,
- "name": "string"
}
]
}| id required | number |
| name required | string |
| id_network required | number |
| id_menu_category | number |
{- "name": "string",
- "id_network": 0,
- "id_menu_category": 0
}| id_network required | number |
| title required | string |
| sysname required | string |
| is_deleted required | string Default: "no" Enum: "yes" "no" |
{- "id_network": 0,
- "title": "string",
- "sysname": "string",
- "is_deleted": "yes"
}| id_network required | number |
| title required | string |
| sysname required | string |
| is_deleted required | string Default: "no" Enum: "yes" "no" |
{- "id_network": 0,
- "title": "string",
- "sysname": "string",
- "is_deleted": "yes"
}| ids required | Array of strings |
| delete required | string Default: "yes" Enum: "yes" "no" |
| id_manufactory | number If delete = "no", then required |
{- "ids": [
- "string"
], - "delete": "yes",
- "id_manufactory": 0
}| name required | string |
| address required | string |
| inn | string |
| post_index | string |
| rs | string |
| kpp | string |
| phones | string |
| bank_name | string |
| bik | string |
| ks | string |
| id_fsrar | string |
| country_code | string |
| is_deleted required | string Default: "no" Enum: "yes" "no" |
Array of objects (LicensesClass) Лицензии |
{- "name": "string",
- "address": "string",
- "inn": "string",
- "post_index": "string",
- "rs": "string",
- "kpp": "string",
- "phones": "string",
- "bank_name": "string",
- "bik": "string",
- "ks": "string",
- "id_fsrar": "string",
- "country_code": "string",
- "is_deleted": "yes",
- "licenses": [
- {
- "supplier_id": 0,
- "serial": "string",
- "number": "string",
- "date_issue": "string",
- "date_expiry": "string",
- "issuing": "string"
}
]
}| name required | string |
| address required | string |
| inn | string |
| post_index | string |
| rs | string |
| kpp | string |
| phones | string |
| bank_name | string |
| bik | string |
| ks | string |
| id_fsrar | string |
| country_code | string |
| is_deleted required | string Default: "no" Enum: "yes" "no" |
Array of objects (LicensesClass) Лицензии |
{- "name": "string",
- "address": "string",
- "inn": "string",
- "post_index": "string",
- "rs": "string",
- "kpp": "string",
- "phones": "string",
- "bank_name": "string",
- "bik": "string",
- "ks": "string",
- "id_fsrar": "string",
- "country_code": "string",
- "is_deleted": "yes",
- "licenses": [
- {
- "supplier_id": 0,
- "serial": "string",
- "number": "string",
- "date_issue": "string",
- "date_expiry": "string",
- "issuing": "string"
}
]
}| name required | string max 256 |
| address required | string max 2000 |
| inn | string max 20 |
| kpp | string max 50 |
| id_fsrar | string max 50 |
| country_code | number |
| region_code | string max 2 |
| type required | string Enum: "FL" "UL" |
Array of objects (TaxationsClass) Налогообложение |
{- "name": "string",
- "address": "string",
- "inn": "string",
- "kpp": "string",
- "id_fsrar": "string",
- "country_code": 0,
- "region_code": "string",
- "type": "FL",
- "taxations": [
- {
- "id_legal_face": 0,
- "id_taxation": 0
}
]
}| name required | string max 256 |
| address required | string max 2000 |
| inn | string max 20 |
| kpp | string max 50 |
| id_fsrar | string max 50 |
| country_code | number |
| region_code | string max 2 |
| type required | string Enum: "FL" "UL" |
Array of objects (TaxationsClass) Налогообложение |
{- "name": "string",
- "address": "string",
- "inn": "string",
- "kpp": "string",
- "id_fsrar": "string",
- "country_code": 0,
- "region_code": "string",
- "type": "FL",
- "taxations": [
- {
- "id_legal_face": 0,
- "id_taxation": 0
}
]
}| id_point required | string |
| name required | string |
| type required | string Default: "local" Enum: "cook" "bar" "local" "fiskal" "cookscreen" |
| path | string |
| comments | string |
| id_manufactory | number |
| id_legal_face | number |
| tasks_delay_ms | number |
| chunks_delay_ms | number |
| chunk_size | number |
| tape_width | number |
| fiskal_model | string Default: "atol25f" Enum: "atol11f" "atol15f" "atol20f" "atol22f" "atol22ptk" "atol25f" "atol30f" "atol50f" "atol55f" "atol77f" "atol150f" "kassatka" |
| fiskal_protocol | string Default: "atol_v3" Enum: "atol_v2" "atol_v3" "atol_v3_5" |
| send_beep | string Default: "local" Enum: "none" "local" "manufactory" |
| com_port | string Default: "ttyMT1" |
| com_port_speed | string Default: "115200" Enum: "1200" "2400" "4800" "9600" "38400" "57600" "115200" |
| connection_type | string Default: "TCP/IP" Enum: "COM" "USB" "TCP/IP" |
| persist_connection | string Default: "yes" Enum: "yes" "no" |
| print_images | string Default: "all" Enum: "no" "not_from_memory" "not_from_pixels" "all" |
{- "id_point": "string",
- "name": "string",
- "type": "cook",
- "path": "string",
- "comments": "string",
- "id_manufactory": 0,
- "id_legal_face": 0,
- "tasks_delay_ms": 0,
- "chunks_delay_ms": 0,
- "chunk_size": 0,
- "tape_width": 0,
- "fiskal_model": "atol11f",
- "fiskal_protocol": "atol_v2",
- "send_beep": "none",
- "com_port": "ttyMT1",
- "com_port_speed": "1200",
- "connection_type": "COM",
- "persist_connection": "yes",
- "print_images": "no"
}| id_point required | string |
| name required | string |
| type required | string Default: "local" Enum: "cook" "bar" "local" "fiskal" "cookscreen" |
| path | string |
| comments | string |
| id_manufactory | number |
| id_legal_face | number |
| tasks_delay_ms | number |
| chunks_delay_ms | number |
| chunk_size | number |
| tape_width | number |
| fiskal_model | string Default: "atol25f" Enum: "atol11f" "atol15f" "atol20f" "atol22f" "atol22ptk" "atol25f" "atol30f" "atol50f" "atol55f" "atol77f" "atol150f" "kassatka" |
| fiskal_protocol | string Default: "atol_v3" Enum: "atol_v2" "atol_v3" "atol_v3_5" |
| send_beep | string Default: "local" Enum: "none" "local" "manufactory" |
| com_port | string Default: "ttyMT1" |
| com_port_speed | string Default: "115200" Enum: "1200" "2400" "4800" "9600" "38400" "57600" "115200" |
| connection_type | string Default: "TCP/IP" Enum: "COM" "USB" "TCP/IP" |
| persist_connection | string Default: "yes" Enum: "yes" "no" |
| print_images | string Default: "all" Enum: "no" "not_from_memory" "not_from_pixels" "all" |
{- "id_point": "string",
- "name": "string",
- "type": "cook",
- "path": "string",
- "comments": "string",
- "id_manufactory": 0,
- "id_legal_face": 0,
- "tasks_delay_ms": 0,
- "chunks_delay_ms": 0,
- "chunk_size": 0,
- "tape_width": 0,
- "fiskal_model": "atol11f",
- "fiskal_protocol": "atol_v2",
- "send_beep": "none",
- "com_port": "ttyMT1",
- "com_port_speed": "1200",
- "connection_type": "COM",
- "persist_connection": "yes",
- "print_images": "no"
}| id_point required | string |
| id_legal_face | string |
| name required | string |
| type required | string Default: "scales" Enum: "scales" "scanner" "clientscreen" "acquiring" "cookscreen" |
| model_device | string Default: "" |
| ip_address | number Default: "" |
| ip_protocol | string Default: "tcp" Enum: "tcp" "udp" |
| port | number Default: 5001 |
| sysname | string Default: "" |
| params | string |
| status | string Default: "active" Enum: "active" "inactive" |
| is_deleted | string Default: "no" Enum: "yes" "no" |
{- "id_point": "string",
- "id_legal_face": "string",
- "name": "string",
- "type": "scales",
- "model_device": "",
- "ip_address": "",
- "ip_protocol": "tcp",
- "port": 5001,
- "sysname": "",
- "params": "string",
- "status": "active",
- "is_deleted": "yes"
}| id_point required | string |
| id_legal_face | string |
| name required | string |
| type required | string Default: "scales" Enum: "scales" "scanner" "clientscreen" "acquiring" "cookscreen" |
| model_device | string Default: "" |
| ip_address | number Default: "" |
| ip_protocol | string Default: "tcp" Enum: "tcp" "udp" |
| port | number Default: 5001 |
| sysname | string Default: "" |
| params | string |
| status | string Default: "active" Enum: "active" "inactive" |
| is_deleted | string Default: "no" Enum: "yes" "no" |
{- "id_point": "string",
- "id_legal_face": "string",
- "name": "string",
- "type": "scales",
- "model_device": "",
- "ip_address": "",
- "ip_protocol": "tcp",
- "port": 5001,
- "sysname": "",
- "params": "string",
- "status": "active",
- "is_deleted": "yes"
}| orderBy | string |
| orderByPosition | string |
| size | number |
| page | number |
| search | string Search on username, firstname, lastname |
| networkId | number |
| holdingId | number |
| type | string Enum: "pos" "panel" "terminals" Пользователи панели управления - panel, Пользователи терминалов продаж - pos, Терминалы POS - terminals |
| id_holding | number |
| id_network | number |
| id_warehouse | number |
| id_point | number |
| id_user_kkt | number |
| username | string Max 20 |
| password | string Max 128, Min 4 |
string Max 128 | |
| firstname | string Max 50 |
| lastname | string Max 50 |
| fathername | string Max 20 |
| activkey | string Max 128 |
| superuser | number 1/0 |
| status required | number 1/0 |
| pin | string Max 20 |
| cashier_inn | string Max 100 |
| card_code | string Max 255 |
| terminal_role | string Default: "master" Enum: "master" "slave" |
| type required | string Enum: "pos" "panel" "terminals" Пользователи панели управления - panel, Пользователи терминалов продаж - pos, Терминалы POS - terminals |
| itemname required | string |
Array of objects (UPAClass) Тут массивы id (items - points, cats - categories), цифрами. Прим: [1,2,3] |
{- "id_holding": 0,
- "id_network": 0,
- "id_warehouse": 0,
- "id_point": 0,
- "id_user_kkt": 0,
- "username": "string",
- "password": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "fathername": "string",
- "activkey": "string",
- "superuser": 0,
- "status": 0,
- "pin": "string",
- "cashier_inn": "string",
- "card_code": "string",
- "terminal_role": "master",
- "type": "pos",
- "itemname": "string",
- "user_point_access": [
- {
- "items": [
- 0
], - "cats": [
- 0
]
}
]
}| id_holding | number |
| id_network | number |
| id_warehouse | number |
| id_point | number |
| id_user_kkt | number |
| username | string Max 20 |
| password | string Max 128, Min 4 |
string Max 128 | |
| firstname | string Max 50 |
| lastname | string Max 50 |
| fathername | string Max 20 |
| activkey | string Max 128 |
| superuser | number 1/0 |
| status required | number 1/0 |
| pin | string Max 20 |
| cashier_inn | string Max 100 |
| card_code | string Max 255 |
| terminal_role | string Default: "master" Enum: "master" "slave" |
| type required | string Enum: "pos" "panel" "terminals" Пользователи панели управления - panel, Пользователи терминалов продаж - pos, Терминалы POS - terminals |
| itemname required | string |
Array of objects (UPAClass) Тут массивы id (items - points, cats - categories), цифрами. Прим: [1,2,3] |
{- "id_holding": 0,
- "id_network": 0,
- "id_warehouse": 0,
- "id_point": 0,
- "id_user_kkt": 0,
- "username": "string",
- "password": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "fathername": "string",
- "activkey": "string",
- "superuser": 0,
- "status": 0,
- "pin": "string",
- "cashier_inn": "string",
- "card_code": "string",
- "terminal_role": "master",
- "type": "pos",
- "itemname": "string",
- "user_point_access": [
- {
- "items": [
- 0
], - "cats": [
- 0
]
}
]
}| id required | number |
| type required | string Enum: "pos" "panel" "terminals" Пользователи панели управления - panel, Пользователи терминалов продаж - pos, Терминалы POS - terminals |
{- "id": 0,
- "type": "pos"
}| name required | string |
| permissions required | Array of strings |
| isEditable | boolean |
| isHidden | boolean |
{- "name": "string",
- "permissions": [
- "string"
], - "isEditable": true,
- "isHidden": true
}| permissions required | Array of strings |
| category required | string Enum: "delivery" "1c" "shop" "boardapp" "discounts" "android_token" "ios_token" "webapp" |
| servicename | string Enum: "1c" "statix-pro" |
| expired_at | string Default: "2023-04-30 20:41:03" Format - 'Y-m-d H:i:s', if say infinity - 'null' |
{- "permissions": [
- "string"
], - "category": "delivery",
- "servicename": "1c",
- "expired_at": "2023-04-30 20:41:03"
}| orderBy | string |
| orderByPosition | string |
| size | number |
| page | number |
| pointId | number |
| discountId | number |
| startTime | string Format H:i:s |
| endTime | string Format H:i:s |
| dayOfWeek | Array of strings Array number. Пн - 1, Вт - 2, Ср - 3, Чт - 4, Пт - 5, Сб - 6, Вс - 7 |
| id_point required | number |
| id_discount required | number |
| discount | number |
| day_of_month | string |
| day_of_week | Array of strings Array number. Пн - 1, Вт - 2, Ср - 3, Чт - 4, Пт - 5, Сб - 6, Вс - 7 |
| start_time | string Format H:i:s |
| end_time | string Format H:i:s |
{- "id_point": 0,
- "id_discount": 0,
- "discount": 0,
- "day_of_month": "string",
- "day_of_week": [
- "string"
], - "start_time": "string",
- "end_time": "string"
}| id_point required | number |
| id_discount required | number |
| discount | number |
| day_of_month | string |
| day_of_week | Array of strings Array number. Пн - 1, Вт - 2, Ср - 3, Чт - 4, Пт - 5, Сб - 6, Вс - 7 |
| start_time | string Format H:i:s |
| end_time | string Format H:i:s |
{- "id_point": 0,
- "id_discount": 0,
- "discount": 0,
- "day_of_month": "string",
- "day_of_week": [
- "string"
], - "start_time": "string",
- "end_time": "string"
}| id_point required | number |
| id_hall required | number |
| number | string Max 255 |
| shape | string Text format, Квадрат - square, Круг - circle |
| x required | number decimal(11, 2) |
| y required | number decimal(11, 2) |
{- "id_point": 0,
- "id_hall": 0,
- "number": "string",
- "shape": "string",
- "x": 0,
- "y": 0
}| id_point required | number |
| id_hall required | number |
| number | string Max 255 |
| shape | string Text format, Квадрат - square, Круг - circle |
| x required | number decimal(11, 2) |
| y required | number decimal(11, 2) |
{- "id_point": 0,
- "id_hall": 0,
- "number": "string",
- "shape": "string",
- "x": 0,
- "y": 0
}| orderBy | string |
| orderByPosition | string |
| size | number |
| page | number |
| search | string Search on cash_sum and cash_sum_diff |
| networkId | number |
| isDeleted | string Default: "no" Enum: "yes" "no" |
| type | string Enum: "income" "expense" "transfer" "kass" |
| opType | string Enum: "open_change" "income" "outcome" "inkass" "close_change" |
| startDate | string Format: Y-m-d |
| endDate | string Format: Y-m-d |
| id_network required | number |
| id_change | number |
| id_point | number |
| id_terminal | number |
| id_user | number |
| op_type | string Enum: "open_change" "income" "outcome" "inkass" "close_change" |
| type required | string Enum: "income" "expense" "transfer" "kass" |
| id_category | number |
| id_account_to | number |
| id_account_from | number |
| comment | string Max 500 |
| cash_sum required | number Default: 0 decimal(15, 2) |
| op_client_date | string Format: Y-m-d H:i:s |
| client_hash | string Max 64 |
| id_parent | number |
| id_invoice | number |
| is_fiskal | string Default: "no" Enum: "yes" "no" |
{- "id_network": 0,
- "id_change": 0,
- "id_point": 0,
- "id_terminal": 0,
- "id_user": 0,
- "op_type": "open_change",
- "type": "income",
- "id_category": 0,
- "id_account_to": 0,
- "id_account_from": 0,
- "comment": "string",
- "cash_sum": 0,
- "op_client_date": "string",
- "client_hash": "string",
- "id_parent": 0,
- "id_invoice": 0,
- "is_fiskal": "yes"
}| id_network required | number |
| id_change | number |
| id_point | number |
| id_terminal | number |
| id_user | number |
| op_type | string Enum: "open_change" "income" "outcome" "inkass" "close_change" |
| type required | string Enum: "income" "expense" "transfer" "kass" |
| id_category | number |
| id_account_to | number |
| id_account_from | number |
| comment | string Max 500 |
| cash_sum required | number Default: 0 decimal(15, 2) |
| op_client_date | string Format: Y-m-d H:i:s |
| client_hash | string Max 64 |
| id_parent | number |
| id_invoice | number |
| is_fiskal | string Default: "no" Enum: "yes" "no" |
{- "id_network": 0,
- "id_change": 0,
- "id_point": 0,
- "id_terminal": 0,
- "id_user": 0,
- "op_type": "open_change",
- "type": "income",
- "id_category": 0,
- "id_account_to": 0,
- "id_account_from": 0,
- "comment": "string",
- "cash_sum": 0,
- "op_client_date": "string",
- "client_hash": "string",
- "id_parent": 0,
- "id_invoice": 0,
- "is_fiskal": "yes"
}| id_network required | number |
| name required | string Max 50 |
| type required | string Enum: "cash" "cashless" "card" |
| acquiring | number Default: 0 decimal(5, 2) |
| balance | number Default: 0 decimal(10, 2) |
{- "id_network": 0,
- "name": "string",
- "type": "cash",
- "acquiring": 0,
- "balance": 0
}| id_network required | number |
| name required | string Max 50 |
| type required | string Enum: "cash" "cashless" "card" |
| acquiring | number Default: 0 decimal(5, 2) |
| balance | number Default: 0 decimal(10, 2) |
{- "id_network": 0,
- "name": "string",
- "type": "cash",
- "acquiring": 0,
- "balance": 0
}| id_network required | number |
| id_parent required | number id FinanceCategories |
| name required | string Max 50 |
| allow_income | string Default: "yes" Enum: "yes" "no" |
| allow_expense | string Default: "yes" Enum: "yes" "no" |
{- "id_network": 0,
- "id_parent": 0,
- "name": "string",
- "allow_income": "yes",
- "allow_expense": "yes"
}| id_network required | number |
| id_parent required | number id FinanceCategories |
| name required | string Max 50 |
| allow_income | string Default: "yes" Enum: "yes" "no" |
| allow_expense | string Default: "yes" Enum: "yes" "no" |
{- "id_network": 0,
- "id_parent": 0,
- "name": "string",
- "allow_income": "yes",
- "allow_expense": "yes"
}| network_id required | number |
| start_date required | string Format: Y-m-d |
| end_date required | string Format: Y-m-d |
required | Array of objects (WaitersClass) Официанты |
{- "network_id": 0,
- "start_date": "string",
- "end_date": "string",
- "waiters": [
- {
- "id": 0,
- "active": 0,
- "network_id": 0,
- "waiter_id": 0,
- "start_date": "string",
- "end_date": "string",
- "count_changes": 0,
- "pay_by_change": 0,
- "sales_sum": 0,
- "percent_sales": 0,
- "sales_plan": 0,
- "bonus_plan": 0,
- "bonus_above_plan": 0,
- "sales_plan_total": 0,
- "bonus_plan_total": 0,
- "bonus_above_plan_total": 0,
- "bonus": 0,
- "fine": 0,
- "total": 0,
- "comment": ""
}
]
}| network_id | number |
| start_date | string Format: Y-m-d, default -1 month |
| end_date | string Format: Y-m-d, default today |
Array of objects (WaitersClass) Официанты |
{- "network_id": 0,
- "start_date": "string",
- "end_date": "string",
- "waiters": [
- {
- "id": 0,
- "active": 0,
- "network_id": 0,
- "waiter_id": 0,
- "start_date": "string",
- "end_date": "string",
- "count_changes": 0,
- "pay_by_change": 0,
- "sales_sum": 0,
- "percent_sales": 0,
- "sales_plan": 0,
- "bonus_plan": 0,
- "bonus_above_plan": 0,
- "sales_plan_total": 0,
- "bonus_plan_total": 0,
- "bonus_above_plan_total": 0,
- "bonus": 0,
- "fine": 0,
- "total": 0,
- "comment": ""
}
]
}