MIDAS API: Appendix B - Setting Names

The following settings may be used in conjunction with the "get_setting" and "set_setting" calls. The "Settable" column denotes which settings can be changed via the "set_setting" call.

Setting	Description	Example Value	Settable
api_version	Current version of the MIDAS API	2.45
availability_alt_buffer	This setting (in Minutes) enforces a "gap" (spacing) when offering earlier/later alternative times in a venue	15
availability_alt_earlier	If "1" MIDAS will attempt to offer an earlier time in the event of an Unavailable venue	1
availability_alt_ignorervs	If "1" MIDAS will not enforce venue resource restrictions when offering alternative venues	1
availability_alt_later	If "1" MIDAS will attempt to offer a later time in the event of an Unavailable venue	1
availability_alt_venue	If "1" MIDAS will attempt to offer an alternative venue in the event that desired times are unavailable	1
availability_display_prepost	If "1", times shown on the Booking Availability screen will include any setup/breakdown times	1
availability_estimate_costs	If "1", estimated charges for bookings/resource will be indicated on the Booking Availability screen	0
availability_include_pending	If "1" MIDAS takes into account any pending booking requests when checking booking availability. If "0" confirmed bookings can be made over provisional booking slots	0
availability_post_buffer	Maintains a fixed spacing (in minutes) after each booking before the next booking may commence	15
availability_pre_buffer	Maintains a fixed spacing (in minutes) before each booking to that of the end of the previous booking	15
backup_email	The email address that automated database backups are sent to	[email protected]
backup_last	The time of the last backup (epoch seconds)	1365609454
backup_persist	The number of days to keep backups on server	7
bookings_overbook_post	If "1" a booking following on from another booking may start during the breakdown time of the previous	0
bookings_overbook_pre	If "1" a booking will be allowed to end during the setup time of a booking following on from it	0
bookings_prompt_add_client	If "1" MIDAS will prompt for additional client details when adding bookings for a new client	0
bookings_use_map	If "1" users can visually book from a floorplan or map. If "0" users select bookable spaces from a list of venues.	0
build_date	Current MIDAS build date	1365608000
callto_enabled	If "1" client phone/cell numbers become clickable "callto" links within MIDAS	1
checkintime	Sets the check in time (in 24hour HHMM format) for when the time selector is set to "Nights"	1500
checkouttime	Sets the check out time (in 24 hour HHMM format) for when the time selector is set to "Nights"	1100
cron_enable_invoice_overdue	If "1" automated invoice overdue notifications are enabled	1
cron_enable_invoice_remind	If "1" automated upcoming invoice reminders are enabled	1
cron_enable_invoice_send	If "1" automated sending of unsent invoices is enabled	1
cron_enable_post_feedback	If "1" automated post-booking follow up emails are enabled	1
cron_enable_start_remind	If "1" automated upcoming booking reminders are enabled	1
cron_hour	The hour (0-24) during which daily scheduled tasks should run	11
cron_invoice_overdue	The number of days after an unpaid invoice was due to automatically send an overdue notification to the client	7
cron_invice_remind	The number of days before an unpaid invoice is due to automatically send a payment reminder to the client	3
cron_last	The time that scheduled tasks were last run (epoch seconds)	1407123529
cron_post_feedback	The number of hours after bookings have completed to send automated post-booking follow up emails	24
cron_start_remind	If "1" automated upcoming booking reminders are enabled	1
datetime_amsymbol	The symbol denoting the first 12 hours of the day (when running in 12 hour clock mode)	AM
datetime_datefirst	If "1" dates are shown before times, otherwise times are shown before dates	1
datetime_dateformat	The date format	DD/MM/YYYY
datetime_dtlink	The link symbol between date and time	@
datetime_gmtoffset	The timezone's GMT offset	0
datetime_minterval	The granularity of minutes	5
datetime_pmsymbol	The symbol denoting the first 12 hours of the day (when running in 12 hour clock mode)	PM
datetime_startofweek	The day that should be considered the start of the week (0 = Sunday, 1 = Monday, etc)	1
datetime_timeformat	The time format	HH:mm
datetime_timenow	The current time (in epoch seconds)	1365696187
datetime_timezone	The timezone	Europe/London
datetime_ttlink	The link symbol between two times	-
datetime_vcaltzfix	If "1" times in VCALS are adjusted to UTC times for compatibility with some 3rd party calendar apps don't support "local" times	0
default_booktype	The numeric ID of a booking type set as the default booking type	3
email_allsendfrom	If "1" all outgoing email from MIDAS will be sent from the "email_sendfrom" address. If "0", only system-generated emails (such as password reset requests, etc) will be sent from the "email_sendfrom" address. User-initiated email (i.e. sending an email or invoice to a client, etc) will instead send mail appearing to be sent from the email address associated with the user's account	0
email_bcc	An email address that outgoing email should be bcc'd to	[email protected]
email_bcc_what	A string of 4-character codes denoting which type of emails should be bcc'd. Possible codes are: "mail" (Generic email), "bcan" (Booking cancellations), "bcon" (Booking confirmations), "brem" (Booking reminders), "rapp" (Booking request approved), "rapm" (booking request approved with changes), "rrej" (Booking request rejected), "rsub" (Booking request submitted), "invo" (Invoice), "iovr" (Invoice Overdue), "irmd" (Invoice Reminder), "rcpt" (Receipt)	mailbcanbconrsubiovr
email_compat	If "1" outgoing emails will be sent in compatibility mode for the benefit of older email clients	0
email_merge	If "1" MIDAS will attempt to reduce outgoing email volume by automatically combining similar emails, otherwise if "0" MIDAS will send emails individually	1
email_reply_to	Optionally specify a "reply to" email address for all outgoing mail	[email protected]
evac_include_prepost	If "1", times shown on Emergency Evacuation printouts will include any setup/breakdown times	1
invoicing_amounts_ex_tax	If "1", invoice amounts are show excluding tax	1
invoicing_apply_disc	If "1", booking type discounts apply to venues only. If "2", discounts apply to resources only. If "12", discounts apply to both venues + resources. If "0", no discounts will be applied	1
invoicing_cancel_amount	The amount (fixed or percentage) to charge in late cancellation fees	20%
invoicing_cancel_enabled	If "1" and a booking is cancelled (deleted) within invoicing_cancel_leadtime hours of when the booking was due to commence, a cancellation invoice will be created	1
invoicing_cancel_leadtime	Specifies (in hours) the cut-off point before a booking commences after which a cancellation invoice can be generated if the booking is cancelled (deleted)	168
invoicing_cancel_tax	Specifies a percentage tax rate to apply to cancellation invoices	20
invoicing_counter	The next regular invoice number to be generated	4
invoicing_counter_cancel	The next cancellation invoice number to be generated	4
invoicing_counter_credit	The next credit note number to be generated	4
invoicing_counter_deposit	The next deposit invoice number to be generated	4
invoicing_createbydefault	If "1" the "Create Invoice" option is checked when adding bookings	0
invoicing_createifzero	If "1" invoices will be created even if the calculated invoice total is zero. If "0" invoices will only be created if their values are non-zero	1
invoicing_currencycode	The currency code	USD
invoicing_currencysymbol	The currency symbol	$
invoicing_decimalsep	The decimal separator	.
invoicing_deposit_amount	The amount to charge on deposit invoices. Can be an absolute value, or a percentage of total booking cost	20%
invoicing_deposit_deduct	If "1" the value of a deposit invoice is deducted from the total value of the corresponding regular invoice	0
invoicing_deposit_enabled	If "1" deposit invoices are enabled	1
invoicing_deposit_tax	Specifies a percentage tax rate to apply to deposit invoices	20
invoicing_generate_notes	The internal name of a booking field to optionally include in the "notes" section on generated invoices	notes
invoicing_include_prepost	If "1" booking length takes into account setup/breakdown times for the purposes of invoicing. If "0" setup/breakdown periods are not invoiced for	0
invoicing_includezero	If "1" items will be included on invoices even if their total value is zero. If "0" invoices will only include items that have an associated cost	1
invoicing_itemize_notes	If "1" notes on invoices will be itemized per booking. If "0" invoice notes will be combined	1
invoicing_no_booking_mod	If "1" bookings from which invoices have been generated can then no longer be modified	0
invoicing_no_invoice_delete	If "1" invoices cannot be deleted/removed from the system until they have been paid in full	0
invoicing_paid_if_zero	If "1" when generating an invoice totaling zero, the invoice will be marked as "Paid In Full". If "0" a generated invoice totaling zero will not automatically be marked as paid	0
invoicing_partial_payments	If "1" partial invoice payments are allowed. If "0" invoices can only be paid in full	1
invoicing_pay_require_email	If "1" clients are required to enter their email address in order to view their invoice online	1
invoicing_paypal_account	Your PayPal email address (Required to accept payments via PayPal)	[email protected]
invoicing_paypal_enabled	If "1" online invoice payments are allowed via PayPal	1
invoicing_prefix	The prefix that is prepended to all regular invoice numbers	MIDAS
invoicing_prefix_cancel	The prefix that is prepended to all cancellation invoice numbers	CANCEL
invoicing_prefix_credit	The prefix that is prepended to all credit note numbers	CREDIT
invoicing_prefix_deposit	The prefix that is prepended to all deposit invoice numbers	DEPOSIT
invoicing_resource_additional	How resource items appear on invoices. "0" = Name "1" = Name (Venue) "2" = Name (Date/Times) "3" = Name (Venue, Date/Times)	0
invoicing_rounding	If "1" invoice values are rounded up to the nearest whole number 0	1
invoicing_send_as_pdf	If "1" invoices are sent via email to clients as PDF attachments. If "0" invoices are sent to clients enclosed within the body of the email	0
invoicing_silentdisc	If "1" booking type discounts are applied to invoices without any indication. If "0" invoices will denote that a discount has been applied	0
invoicing_stripe_enabled	If "1" online invoice payments are allowed via Stripe	1
invoicing_stripe_pk	Your Stripe Publishable Key (Required to accept payments via Stripe)	pk_live_xxxxxxxxxxxxxxxxxxxxxxxx
invoicing_stripe_sk	Your Stripe Secret Key (Required to accept payments via Stripe)	sk_live_xxxxxxxxxxxxxxxxxxxxxxxx
invoicing_tax	The default tax percentage to be added to invoices	0
invoicing_terms	The default payment terms (days) for invoices	30
invoicing_thousandsep	The thousand separator	,
maxnights	The maximum number of nights stay to permit when the time selector is set to "Nights"	14
occupancy_max	The maximum number of people allowed on your site at any one time	510
occupancy_show	Show the occupancy level when adding/modifying bookings	1
occupancy_warn	Warn if the number of people on site exceeds this value	300
pdf_margins	A pipe separated list of PDF page margins to apply (in the order top|bottom|left|right). The final value is the unit of measurement of the margins (i.e. "mm" for millimeters)	10|10|10|10|mm
pdf_orientation	The page orientation (Portrait or Landscape) of generated PDFs	Portrait
pdf_size	The page size of generated PDFs	A4
print_evactolerance	When printing Emergency Evacuation Data, this number reflects how many minutes either side of the current time the calculation of the number of people on site should account for	15
print_sortby	The booking field to sort booking print outs by	start
print_sortdir	The sort order of print outs (0 = ascending, 1 = descending)	0
print_split_resources	If "1" resources will be split into their categories on printouts	0
public_update_clients	If "1" existing client records will be updated based on data entered on public booking/request screens	0
resources_overbook_post	If "1" a booking following on from another booking may use the same resources during the breakdown time of the first booking and setup time of the second	0
resources_overbook_pre	If "1" a booking following on from another booking may use the same resources during the setup time of that booking during the breakdown time of the previous	0
search_maxresults	The maximum number of search results to return per page	50
security_hibp	If "1" new user passwords are checked against the "Have I been Pwned?" service	1
security_new_device_alert	If "1" users are alerted upon logins from unfamiliar devices	1
send_booking_confirms	Controls the state of the "Send Booking Confirmation" box on Booking Availability screens. "0" is off by default, "1" is on by default, "2" is always on	1
tentative_enabled	If "1" tentative booking expiration is enabled, if "0" tentative bookings won't expire	1
upload_max_size	The maximum permitted size of file uploads (in MB)	5
version	Current MIDAS version	4.28
view_autoclose_alerts	The number of seconds the "My Messages" pop-up should display for, if enabled by users	10
view_autoclose_notes	The number of seconds after which any "day notes" pop-ups should automatically close	15
view_changemonthcell	Allow users to choose what's displayed in the monthly overview	1
view_cutoffdays	The number of days to keep temporary logs for	30
view_default	The default view in the Booking Grid	All
view_gridrowheight	The height (in pixels) of each row in the booking grid	30
view_gridvenuewidth	The width (in pixels) of the first column in the booking grid	100
view_showonblocks	The booking field(s) to show on booking "blocks" in the booking grid	organisation
view_showonmonthcell	The booking field to show on dates in the monthly overview	client
view_showontools	The booking field(s) to show on tooltips when hovering over booking "blocks" in the booking grid	organisation
view_updatefrequency	The number of seconds between successive background data refreshes	30
view_viewsize	The number of days to show in the booking grid by default	1
webbook_enabled	If "1" public web booking is enabled, if "0" public web booking is disabled	1
webbook_expire	The length of time (in minutes) a public web booking is held before being automatically removed if not paid for by the client within this time frame	15
webbook_invoice	If "1" invoices are automatically created when web bookings are made	1
webrequest_alloweddomains	A comma separated list of email domains from which public bookings/requests are permitted	@example.com,@hotmail.com
webrequest_autoapprove	If "1" booking requests are auto-approved. If "0" booking requests must be approved by an administrator	0
webrequest_autoapprove_from	A comma separated list of email address/domains from which booking requests are automatically approved	@example.com,@hotmail.com
webrequest_autoapprove_type	A comma separated list of internal booking type IDs for which booking requests are automatically approved	1,3,4
webrequest_blockcolor	The color of existing booking blocks on the public booking/request screen	red
webrequest_bulkapprove_order	Controls the order in which booking requests are bulk approved (0 = Earliest requested approved first, 1 = Latest requested first, 2 = Earliest commencing first, 3 = Latest commencing first)	0
webrequest_disablepast	The date (YYYYMMDD) past which public bookings/requests are not permitted	20251231
webrequest_enabled	If "1" public booking requests are enabled, if "0" public booking requests are disabled	1
webrequest_leadintime	The number of days in advance public bookings/requests must be made	7
webrequest_leadouttime	The number of days in advance public bookings/requests are allowed to be made for	14
webrequest_showcapacities	If "1" selected venue's capacities are shown during public booking/requesting. If "0" venue capacities are not revealed to requestors	1
webrequest_showclosed	If "1" selected venue's operating hours are shown during public booking/requesting. If "0" operating hours are not revealed to requestors	0
webrequest_showonblocks	What information should be shown on booking blocks in the public bookings/requests screen	times
webrequest_use_map	If "1" enables visually booking/requesting from a floorplan or map on the public bookings/request screen. If "0" users select spaces to book/request from a list of venues on public booking/requesting screens.	0
webrequest_venue_auto_select	If "1" venue auto selection is enabled for public booking/requests	0