API Docs

# Settings

The settings endpoint returns information about the configured business settings.

# The Settings Object

# Sample

{
  "business_currency": "SAR",
  "business_logo": "https://website/piubya20w.png",
  "business_name": "Demo's Business",
  "business_tax_number": "12461",
  "business_timezone": "+03:00",
  "call_center_agents": [
    "95a52612-36dd-4268-9640-e5ef0a995e44"
  ],
  "call_center_allow_discounts": false,
  "call_center_inactive_branches": [
    "9598b48e-1646-446b-92b6-08dd59bc245e"
  ],
  "call_center_inactive_order_types": [
    2
  ],
  "call_center_menu_group_id": "95ad3660-9f5a-4218-99fa-2b62bb221617",
  "cashier_always_ask_for_void_reason": false,
  "cashier_auto_print_products_mix_on_end_of_day": false,
  "cashier_auto_print_tills_report_on_end_of_day": false,
  "cashier_auto_send_to_kitchen_after_payment": false,
  "cashier_auto_sync_at_beginning_of_day": true,
  "cashier_discount_requires_customer_info": false,
  "cashier_enable_tips": true,
  "cashier_force_order_tags": [
    1,
    2,
    3,
    4
  ],
  "cashier_force_selections_for_dine_in_orders": false,
  "cashier_force_stocktaking_before_end_of_day": false,
  "cashier_logout_inactive_users_in_minutes": 30,
  "cashier_maximum_return_period_in_minutes": 60,
  "cashier_predefined_tips_percentages": "5",
  "cashier_preset_tendered_amounts": "50,100",
  "cashier_prevent_interaction_if_drawer_is_open": false,
  "cashier_reset_order_number_at": null,
  "cashier_start_order_number_at": 1,
  "cashier_tendered_amount_currencies": "USD,3.6,EGP,4",
  "cashier_upload_closed_orders_in_minutes": 0,
  "cashier_void_requires_customer_info": false,
  "display_app_background": "https://website/piubya20w.png",
  "final_price_rounding_level": 0.1,
  "final_price_rounding_method": "average",
  "kitchen_sorting_method": "menu_categories_sorting",
  "localization_enabled": true,
  "loyalty_earn_delay_in_minutes": 60,
  "loyalty_enabled": true,
  "loyalty_method": "points",
  "loyalty_minimum_order_price": 10,
  "loyalty_reward_maximum_amount": 30,
  "loyalty_reward_required_points": 10,
  "loyalty_reward_type": 1,
  "loyalty_reward_validity_in_days": 365,
  "loyalty_reward_value": 10,
  "loyalty_send_notifications_by_sms": true,
  "modifiers_splitting_enabled": false,
  "modifiers_splitting_pricing_mode": "average",
  "receipt_footer": "Thank you",
  "receipt_header": "Welcome to Ristecho",
  "receipt_hide_free_modifier_options": false,
  "receipt_invoice_title": "Simplified Tax Invoice",
  "receipt_localized_language": "ar",
  "receipt_main_language": "en",
  "receipt_print_language": 3,
  "receipt_show_calories": false,
  "receipt_show_check_number": true,
  "receipt_show_closer_username": false,
  "receipt_show_creator_username": true,
  "receipt_show_order_number": true,
  "receipt_show_rounding": true,
  "receipt_show_subtotal": false,
  "restrict_purchased_items_to_supplier": false,
  "sms_localized_language": null,
  "tax_inclusive_pricing": false,
  "tax_registration_name": "tax-reg-name",
  "web_cashier_auto_tags": [],
  "web_cashier_menu_group_id": null,
  "web_cashier_printer_ip_address": null,
  "web_cashier_printer_model": null,
  "web_cashier_reset_order_number_at": null,
  "web_cashier_start_order_number_at": 1
}

# Attributes

Field Type Rule Description
business_currency string updateable The main currency of the business
business_logo string updateable The logo of the business
business_name string updateable The business name
business_tax_number string updateable The Business Tax number
business_timezone string updateable The business timezone
final_price_rounding_level integer updateable The order final price Rounding Level
final_price_rounding_method integer updateable The order final price Rounding Method
kitchen_sorting_method string updateable The Kitchen sorting method.
localization_enabled boolean updateable True if the business is using localization
restrict_purchased_items_to_supplier boolean updateable True if business wants to restrict items purchasing to specific supplier
sms_localized_language string updateable The SMS localized language
tax_inclusive_pricing boolean updateable Defines whether business prices are tax exclusive or tax inclusive
tax_registration_name * string updateable The tax registration name
call_center_agents string updateable List of Call Center Agents
call_center_allow_discounts boolean updateable True if call center can add discount to orders
call_center_inactive_branches integer updateable List of Branches where call center is inactive
call_center_inactive_order_types integer updateable List of Order Types that are inactive in the call center
call_center_menu_group_id string updateable The id of the Menu Group that is used by the call center
cashier_always_ask_for_void_reason boolean updateable If true, cashier must enter a void reason when voiding an order
cashier_auto_print_products_mix_on_end_of_day boolean updateable If true, cashier will auto print product mix report at end of day
cashier_auto_print_tills_report_on_end_of_day boolean updateable If true, cashier will auto print tills report at end of day
cashier_auto_send_to_kitchen_after_payment boolean updateable If true, cashier will auto send order to kitchen after payment
cashier_auto_sync_at_beginning_of_day boolean updateable If true, cashier will auto sync at beginning of day
cashier_discount_requires_customer_info boolean updateable If true, cashier will be required to add customer in order to use discount
cashier_force_selections_for_dine_in_orders boolean updateable If true, when new dine order is created, cashier asks for table and guests
cashier_force_stocktaking_before_end_of_day boolean updateable If true, cashier will force stocktaking at end of day
cashier_logout_inactive_users_in_minutes integer updateable The time in minutes for cashier to auto logout when no user is active
cashier_maximum_return_period_in_minutes integer updateable The maximum allowed time in minutes for the cashier to return an order
cashier_preset_tindered_amounts string updateable The preset tendered amounts that will appear in the cashier at the payment section
cashier_prevent_interaction_if_drawer_is_open boolean updateable If true, cashier will not allow interaction when drawer is open
cashier_reset_order_number_at integer updateable The order number that the cashier will rest order numbers when reached, e.g. when orders number reaches 50, next order will start from 1
cashier_start_order_number_at integer updateable The number that the cashier will start numbering orders at
cashier_tendered_amount_currencies string updateable The currencies to be shown in the cashier when selecting tendered amount
cashier_upload_closed_orders_in_minutes string updateable Time in minutes which cashier should upload closed orders after
cashier_void_requires_customer_info boolean updateable Cashier will ask for customer info when voiding an order if true
display_app_background string updateable Display app backgroup
cashier_enable_tips string updateable If true, cashier will be able to add tips
cashier_force_order_tags integer updateable Require Order Tags for Orders.
cashier_predefined_tips_percentages boolean updateable A predefined percentage for tips that will appear to the cashier
loyalty_earn_delay_in_minutes integer updateable Number of minutes in delaying loyalty earning
loyalty_enabled boolean updateable True if loyalty system is enabled
loyalty_method* string updateable Points or Punches
loyalty_minimum_order_price* integer updateable The minimum order price required for the order to count towards loyalty
loyalty_reward_maximum_amount boolean updateable Receipt will show calories if true
loyalty_reward_required_points boolean updateable Receipt will show order number if true
loyalty_reward_type integer updateable 1 for Discount Percentage, 2 for Discount Amount
loyalty_reward_validity_in_days integer updateable Number of days where loyalty reward is valid
loyalty_reward_value integer updateable The loyalty reward value
loyalty_send_notifications_by_sms boolean updateable True if loyalty system will send notifications by SMS
receipt_header string updateable Message presented in the receipt header
receipt_hide_free_modifier_options boolean updateable True if the receipt hide free modifier options
receipt_invoice_title string updateable The receipt invoice title
receipt_localized_language string updateable The receipt localized language
receipt_main_language string updateable The receipt main language
receipt_footer string updateable Message presented in the receipt footer
receipt_print_language integer updateable The receipt print language
receipt_show_calories boolean updateable Receipt will show calories if true
receipt_show_check_number boolean updateable True if the receipt show check number
receipt_show_closer_username boolean updateable True if the receipt show closer username
receipt_show_creator_username boolean updateable True if the receipt show creator username
receipt_show_order_number boolean updateable Receipt will show order number if true
receipt_show_rounding boolean updateable True if the receipt show rounding
receipt_show_subtotal boolean updateable Receipt will show subtotal if true
web_cashier_menu_group_id boolean updateable The id of the Menu Group that is used by the web cashier
web_cashier_reset_order_number_at boolean updateable The order number that the cashier will rest order numbers when reached, e.g. when orders number reaches 50, next order will start from 1
web_cashier_start_order_number_at string updateable The number that the cashier will start numbering orders at
"web_cashier_auto_tags integer updateable The web cashier auto tags
"web_cashier_printer_ip_address string updateable The web cashier printer ip address
"web_cashier_printer_model string updateable The web cashier printer model

# Rounding Method

Method Description
none No rounding
average Rounds to closest, half up
up Rounds price up e.g. 10.5 --> 11
down Rounds price down e.g. 10.5 --> 10

# Rounding Level

Level Description
0.01 Rounds price to the nearest hundredth e.g. 10.568 --> 10.57
0.1 Rounds price to the nearest tenth e.g. 10.56 --> 10.6
0.25 Rounds price to the nearest quartar e.g. 10.20 --> 10.25
0.5 Rounds price to the nearest half e.g. 10.3 --> 10.5
1 Rounds price to the nearest integer e.g. 10.6 --> 11

# List Settings

GET /settings

# Scope

general.read

# Response

{
  "data": {
    "business_currency": "SAR",
    "business_logo": "https://website/piubya20w.png",
    "business_name": "Demo's Business",
    "business_tax_number": "12461",
    "business_timezone": "+03:00",
    "call_center_agents": [
      "95a52612-36dd-4268-9640-e5ef0a995e44"
    ],
    "call_center_allow_discounts": false,
    "call_center_inactive_branches": [
      "9598b48e-1646-446b-92b6-08dd59bc245e"
    ],
    "call_center_inactive_order_types": [
      2
    ],
    "call_center_menu_group_id": "95ad3660-9f5a-4218-99fa-2b62bb221617",
    "cashier_always_ask_for_void_reason": false,
    "cashier_auto_print_products_mix_on_end_of_day": false,
    "cashier_auto_print_tills_report_on_end_of_day": false,
    "cashier_auto_send_to_kitchen_after_payment": false,
    "cashier_auto_sync_at_beginning_of_day": true,
    "cashier_discount_requires_customer_info": false,
    "cashier_enable_tips": true,
    "cashier_force_order_tags": [
      1,
      2,
      3,
      4
    ],
    "cashier_force_selections_for_dine_in_orders": false,
    "cashier_force_stocktaking_before_end_of_day": false,
    "cashier_logout_inactive_users_in_minutes": 30,
    "cashier_maximum_return_period_in_minutes": 60,
    "cashier_predefined_tips_percentages": "5",
    "cashier_preset_tendered_amounts": "50,100",
    "cashier_prevent_interaction_if_drawer_is_open": false,
    "cashier_reset_order_number_at": null,
    "cashier_start_order_number_at": 1,
    "cashier_tendered_amount_currencies": "USD,3.6,EGP,4",
    "cashier_upload_closed_orders_in_minutes": 0,
    "cashier_void_requires_customer_info": false,
    "display_app_background": "https://website/piubya20w.png",
    "final_price_rounding_level": 0.1,
    "final_price_rounding_method": "average",
    "kitchen_sorting_method": "menu_categories_sorting",
    "localization_enabled": true,
    "loyalty_earn_delay_in_minutes": 60,
    "loyalty_enabled": true,
    "loyalty_method": "points",
    "loyalty_minimum_order_price": 10,
    "loyalty_reward_maximum_amount": 30,
    "loyalty_reward_required_points": 10,
    "loyalty_reward_type": 1,
    "loyalty_reward_validity_in_days": 365,
    "loyalty_reward_value": 10,
    "loyalty_send_notifications_by_sms": true,
    "modifiers_splitting_enabled": false,
    "modifiers_splitting_pricing_mode": "average",
    "receipt_footer": "Thank you",
    "receipt_header": "Welcome to Ristecho",
    "receipt_hide_free_modifier_options": false,
    "receipt_invoice_title": "Simplified Tax Invoice",
    "receipt_localized_language": "ar",
    "receipt_main_language": "en",
    "receipt_print_language": 3,
    "receipt_show_calories": false,
    "receipt_show_check_number": true,
    "receipt_show_closer_username": false,
    "receipt_show_creator_username": true,
    "receipt_show_order_number": true,
    "receipt_show_rounding": true,
    "receipt_show_subtotal": false,
    "restrict_purchased_items_to_supplier": false,
    "sms_localized_language": null,
    "tax_inclusive_pricing": false,
    "tax_registration_name": "tax-reg-name",
    "web_cashier_auto_tags": [],
    "web_cashier_menu_group_id": null,
    "web_cashier_printer_ip_address": null,
    "web_cashier_printer_model": null,
    "web_cashier_reset_order_number_at": null,
    "web_cashier_start_order_number_at": 1
  }
}

# Update Settings

PUT /settings

# Scope

admin.write

# Request

{
  "business_currency": "SAR",
  "business_logo": "https://website/piubya20w.png",
  "business_name": "Demo's Business",
  "business_tax_number": "12461",
  "business_timezone": "+03:00",
  "call_center_agents": [
    "95a52612-36dd-4268-9640-e5ef0a995e44"
  ],
  "call_center_allow_discounts": false,
  "call_center_inactive_branches": [
    "9598b48e-1646-446b-92b6-08dd59bc245e"
  ],
  "call_center_inactive_order_types": [
    2
  ],
  "call_center_menu_group_id": "95ad3660-9f5a-4218-99fa-2b62bb221617",
  "cashier_always_ask_for_void_reason": false,
  "cashier_auto_print_products_mix_on_end_of_day": false,
  "cashier_auto_print_tills_report_on_end_of_day": false,
  "cashier_auto_send_to_kitchen_after_payment": false,
  "cashier_auto_sync_at_beginning_of_day": true,
  "cashier_discount_requires_customer_info": false,
  "cashier_enable_tips": true,
  "cashier_force_order_tags": [
    1,
    2,
    3,
    4
  ],
  "cashier_force_selections_for_dine_in_orders": false,
  "cashier_force_stocktaking_before_end_of_day": false,
  "cashier_logout_inactive_users_in_minutes": 30,
  "cashier_maximum_return_period_in_minutes": 60,
  "cashier_predefined_tips_percentages": "5",
  "cashier_preset_tendered_amounts": "50,100",
  "cashier_prevent_interaction_if_drawer_is_open": false,
  "cashier_reset_order_number_at": null,
  "cashier_start_order_number_at": 1,
  "cashier_tendered_amount_currencies": "USD,3.6,EGP,4",
  "cashier_upload_closed_orders_in_minutes": 0,
  "cashier_void_requires_customer_info": false,
  "display_app_background": "https://website/piubya20w.png",
  "final_price_rounding_level": 0.1,
  "final_price_rounding_method": "average",
  "kitchen_sorting_method": "menu_categories_sorting",
  "localization_enabled": true,
  "loyalty_earn_delay_in_minutes": 60,
  "loyalty_enabled": true,
  "loyalty_method": "points",
  "loyalty_minimum_order_price": 10,
  "loyalty_reward_maximum_amount": 30,
  "loyalty_reward_required_points": 10,
  "loyalty_reward_type": 1,
  "loyalty_reward_validity_in_days": 365,
  "loyalty_reward_value": 10,
  "loyalty_send_notifications_by_sms": true,
  "modifiers_splitting_enabled": false,
  "modifiers_splitting_pricing_mode": "average",
  "receipt_footer": "Thank you",
  "receipt_header": "Welcome to Ristecho",
  "receipt_hide_free_modifier_options": false,
  "receipt_invoice_title": "Simplified Tax Invoice",
  "receipt_localized_language": "ar",
  "receipt_main_language": "en",
  "receipt_print_language": 3,
  "receipt_show_calories": false,
  "receipt_show_check_number": true,
  "receipt_show_closer_username": false,
  "receipt_show_creator_username": true,
  "receipt_show_order_number": true,
  "receipt_show_rounding": true,
  "receipt_show_subtotal": false,
  "restrict_purchased_items_to_supplier": false,
  "sms_localized_language": null,
  "tax_inclusive_pricing": false,
  "tax_registration_name": "tax-reg-name",
  "web_cashier_auto_tags": [],
  "web_cashier_menu_group_id": null,
  "web_cashier_printer_ip_address": null,
  "web_cashier_printer_model": null,
  "web_cashier_reset_order_number_at": null,
  "web_cashier_start_order_number_at": 1
}

# Response

{
  "data": {
    "business_currency": "SAR",
    "business_logo": "https://website/piubya20w.png",
    "business_name": "Demo's Business",
    "business_tax_number": "12461",
    "business_timezone": "+03:00",
    "call_center_agents": [
      "95a52612-36dd-4268-9640-e5ef0a995e44"
    ],
    "call_center_allow_discounts": false,
    "call_center_inactive_branches": [
      "9598b48e-1646-446b-92b6-08dd59bc245e"
    ],
    "call_center_inactive_order_types": [
      2
    ],
    "call_center_menu_group_id": "95ad3660-9f5a-4218-99fa-2b62bb221617",
    "cashier_always_ask_for_void_reason": false,
    "cashier_auto_print_products_mix_on_end_of_day": false,
    "cashier_auto_print_tills_report_on_end_of_day": false,
    "cashier_auto_send_to_kitchen_after_payment": false,
    "cashier_auto_sync_at_beginning_of_day": true,
    "cashier_discount_requires_customer_info": false,
    "cashier_enable_tips": true,
    "cashier_force_order_tags": [
      1,
      2,
      3,
      4
    ],
    "cashier_force_selections_for_dine_in_orders": false,
    "cashier_force_stocktaking_before_end_of_day": false,
    "cashier_logout_inactive_users_in_minutes": 30,
    "cashier_maximum_return_period_in_minutes": 60,
    "cashier_predefined_tips_percentages": "5",
    "cashier_preset_tendered_amounts": "50,100",
    "cashier_prevent_interaction_if_drawer_is_open": false,
    "cashier_reset_order_number_at": null,
    "cashier_start_order_number_at": 1,
    "cashier_tendered_amount_currencies": "USD,3.6,EGP,4",
    "cashier_upload_closed_orders_in_minutes": 0,
    "cashier_void_requires_customer_info": false,
    "display_app_background": "https://website/piubya20w.png",
    "final_price_rounding_level": 0.1,
    "final_price_rounding_method": "average",
    "kitchen_sorting_method": "menu_categories_sorting",
    "localization_enabled": true,
    "loyalty_earn_delay_in_minutes": 60,
    "loyalty_enabled": true,
    "loyalty_method": "points",
    "loyalty_minimum_order_price": 10,
    "loyalty_reward_maximum_amount": 30,
    "loyalty_reward_required_points": 10,
    "loyalty_reward_type": 1,
    "loyalty_reward_validity_in_days": 365,
    "loyalty_reward_value": 10,
    "loyalty_send_notifications_by_sms": true,
    "modifiers_splitting_enabled": false,
    "modifiers_splitting_pricing_mode": "average",
    "receipt_footer": "Thank you",
    "receipt_header": "Welcome to Ristecho",
    "receipt_hide_free_modifier_options": false,
    "receipt_invoice_title": "Simplified Tax Invoice",
    "receipt_localized_language": "ar",
    "receipt_main_language": "en",
    "receipt_print_language": 3,
    "receipt_show_calories": false,
    "receipt_show_check_number": true,
    "receipt_show_closer_username": false,
    "receipt_show_creator_username": true,
    "receipt_show_order_number": true,
    "receipt_show_rounding": true,
    "receipt_show_subtotal": false,
    "restrict_purchased_items_to_supplier": false,
    "sms_localized_language": null,
    "tax_inclusive_pricing": false,
    "tax_registration_name": "tax-reg-name",
    "web_cashier_auto_tags": [],
    "web_cashier_menu_group_id": null,
    "web_cashier_printer_ip_address": null,
    "web_cashier_printer_model": null,
    "web_cashier_reset_order_number_at": null,
    "web_cashier_start_order_number_at": 1
  }
}
Last Updated: 22/9/2023, 2:36:35 PM

← Shifts →