Get a Setting's value.

Parameters

name

The setting you want to retrieve.

Default valid values:

  • 'app-header',
  • 'app-icon',
  • 'appointment-amber-days',
  • 'appointment-priorities',
  • 'appointment-statuses',
  • 'block-task-email-notifications',
  • 'company-address',
  • 'contracts-template',
  • 'customer-landline-unique',
  • 'customer-portal-asset-set',
  • 'customers-require-landlines',
  • 'customers-results-long',
  • 'customers-results-short',
  • 'date-format',
  • 'default-vat',
  • 'disable-appointment-time-in-progress-update',
  • 'invoice-template',
  • 'ip-restriction',
  • 'job-ref-method',
  • 'mainFormat',
  • 'replyto-email',
  • 'restrict-appointment-selection',
  • 'time-format',
  • 'vat-registration-number',
  • 'wizard'.

If Mantis integration is enabled:

  • 'issuetracker-mantis_wsdl',
  • 'issuetracker-mantis_username'.

If Xero integration is enabled:

  • 'xero_consumer_key',
  • 'xero_api_endpoint_url'.

If SMS integration is enabled:

  • 'sms_appointment_create',
  • 'sms_appointment_create_text',
  • 'sms_appointment_hours_before',
  • 'sms_appointment_hours_before_num',
  • 'sms_appointment_hours_before_text',
  • 'sms_appointment_on_route',
  • 'sms_appointment_on_route_text'.

Example

FM_api('Setting_get', ['name' => 'date-format']);

Results

"dd\/mm\/yy"