Module

Name

Comment

Default Value

fm

amount_finance_tolerance

If in use, the Amount Finance is validated to see if it is within tolerance range

fm

approvals_allow_tyres_over_allowance

Set the flag to "yes" if approvals for tyres can exceed the value entered in Contracts/Contract "Tyre Allowance" field. Set to "no" to prevent the approval row from being saved if the tyre allowance has been exceeded. The alert message is also set here and can be modified to suit. The alert message will appear regardless of the flag setting. Flag: yes, Message: Tyres not allowed or Tyre Allowance exceeded for this contract!

yes

fm

approvals_code_fields_required

Set the required flags to "yes" if you want the code(s) to be a required entry on your approval rows. Visit Approvals Setup for full details. Vmrs: no, Work: no, Cause: no, Type: no

no

fm

approvals_contract_dates_message_flag

When set to "yes", users are provided with alerts about contract dates. Visit Approvals Setup for full details

yes

fm

approvals_odometer_required_by_class

This control can be set to make the Approvals / Approval "Odometer" field mandatory for each "Class" that is stored. The user is alerted and the approval cannot be saved if the "Odometer" field is blank and any of the stored classes has been used. For example: if the approval is for a service and the class 'S' is stored here, an odometer reading will be required. Visit the Approvals Setup page for full configuration details

fm

approvals_reference_date_tolerance

This record sets a validation range for the date that is entered in the Approvals / Approval "Reference Date" field. Past: 365, Future: 20

fm

autoguru_sftp_connection

Store the SFTP connection details for AutoGuru here. These credentials are used when running the importApprovals job to collect AutoGuru's Daily Booking file. Contact your Catch-e Account Manager to set this up initially. Host: sftp.autoguru.io, Port: 22, Username: as provided by AutoGuru, Key: Private key

fm

billing_credit_note_flag

Set this to 'yes' if you want negative value items to invoice separately on a credit note. This will occur for transactions created in the Contracts / Lease tab, the Approvals / Approval tab and the Sale Management / Sale tab. The default is 'no' and in this case, no separate credit notes are created

no

fm

billing_credit_note_prompt_flag

Set this to 'yes' if you want users to choose if negative value transactions are to be saved as a credit note. This will prompt you with "Save as a Credit Note?". If you have billing_credit_note_flag set to 'yes' and this flag set to 'no', credit notes will be created when the conditions are met

no

fm

billing_combined_consolidate_tolls_flag

On the combined invoice, Toll charges can be set up to consolidate into one transaction. Refer to Billing Setup for full details

no

fm

billing_combined_show_zero_lease_charges_flag

Flag to remove zero value lease charges for periodics, fees and initials from the combined invoice template

yes

fm

billing_invoice_date_override_flag

Controls which date fields are displayed on Billing/Periodic and Billing/Combined screens. Refer to Billing Setup for full details

no

fm

billing_invoice_from_date_flag

Set this to 'yes' if you want to display the "Invoice From" date on the Billing/Periodic and Billing/Combined screens. The default setting is 'no' which keeps the field hidden. Refer to Billing Setup for more details

no

fm

billing_period_ended_date_format

This setting allows you to change the presentation of the date shown in the invoice header of Periodic, Recharge and Recharge - Fuel type invoices. It has no effect on Combined, Booking, Sale or client-specific invoices. Visit MySQL date-format for a list of the available formats you can use. Also visit Billing Templates for complete details of invoice configuration

%D %M %Y (for example: 27th January 2017)

fm

billing_twice_in_first_month

If this flag is set to 'yes', then the first two billing cycles will be completed in the first month, on the dates set in the 'Start Periodic' field

no

fm

boq_ef_interface_enabled_flag

As part of the enabling of the BOQ Interface, set this flag to 'yes'

no

fm

boq_ef_interface_broker_code

As part of the enabling of the BOQ Interface, enter your organisation's BOQ unique broker code

??????

fm

calns_interface_exclude_fees_flag

Set this flag to 'yes' if you would like to exclude any CALNS fuel import transactions with the product code 'CARD FEES'

no

fm

card_services_posting_group_by

Used to summarise the Card Transactions by any fm_contracts field. Default is contract_id. This affects the level of detail output to Accounting systems such as General Ledger Export To MYOB or General Ledger Export To Xero. Table: fm_maintenance, Field: contract_id

fm

claim_suppress_gst_change_confirmation_flag

An alert is provided to users if the gst value of a Claim row does not align with the gst flag that has been populated from Contract Types/Approval-Expenses for the selected class (for example: the flag is 'Y' and the GST value is changed to 0). The gst flags are used in the GST Checks process

no

fm

client_billing_type_default

Set a default entry for the field "Billing Type" in Clients / Contract Defaults. This default value is used when creating a new Client (including when copying)

fm

client_billing_type_exclusions

Exclude options from the drop down list the field "Billing Type" in Clients / Contract Defaults

fm

client_roadside_assistance_plan_code_default

Add a preferred roadside supplier code here if you want the Clients / Quote Defaults "Roadside Assistance" field to populate automatically for new clients

fm

contract_auto_search_flag

When 'yes', a search will run automatically when a user navigates to the Contracts / Search screen. When set to 'no', the screen columns remain blank until a search is run by the user

yes

fm

fmcontracts_supplier_id_roadside_default

This control only appears to be used in the IFCS Card Import process within the upsertFmContract function. If the roadside_managed_flag is set to 'yes' the fmcontracts_supplier_id_roadside_default control value is applied to the fm_contract supplier_id_roadside field

fm

contract_order_reports_suffix

The value of this field from the current contract, is added as a suffix to the filename when printing any of the documents on the Contract / Orders screen (for example: 'dealerorder4' where this control is set to 'quoteid' and the value of the quoteid field for the current contract is '4')

contract_id

fm

contracts_bespoke_fields_screen_flag

If set to yes the new Contracts / Other tab is shown in the Fleet / Administration / Contracts screen

no

fm

contracts_fbt_year_ending_default_offset

Used as a relative month offset when setting the default value in the FBT Year Ending field on the Contract / FBT tab (for example: if set to -1, a date will be derived from the current date plus -1 months). The FBT Year end will be calculated relative to that date and the Year component of that date is used as the default value

0

fm

contract_maintenance_exclude_checkbox_classes

This control enables you to define which maintenance class transactions to exclude from the Contracts / Maintenance screen when the check box is checked ON. This is done by listing in sequence the posting_class_code and name of the posting classes

F = Fuel, TOL = Tolls, Ins = Insurance

fm

contract_internal_user_default_landing_page

This identifies which tab the user should land on when navigating to the Contracts module from the top menu. The default setting is 'search', which takes you to the Contracts / Search screen. It can be set to 'contract' instead, this takes you to Contracts / Contract. This control only applies to users with internal roles

search

fm

depreciation_basis

The value stored will be used as the basis for calculating the Contracts / Finance tab fields "Depreciation LTD" and "Book Value". The Depreciation Model may be used to check the calculations

amount_financed

fm

driver_access_check_posting_class

If you want to use a contract event to send an access email to a driver or employee, add the Posting Classes / Details "Class code" of the selected event into this control. If populated, the contract event email can be created, but cannot be sent unless the "Access" check box of the linked driver or employee is checked on. You will be alerted: "Can not send email. Driver login access must be enabled before you can send this email."

fm

driver_home_email_validate_flag

Does an email address validation when it is set to 'yes'. No validation is performed if it is set to 'no'

yes

fm

driver_reports_insurance_actual_excludes_budget_flag

Overrides all Driver Report rules based on the Contracts/Insurance "Billing Type" field and sets the insurance row 'Actual' value to only show transactions from the Contract/Maintenance and Contract/Payment screens. Visit the Billing Type page for further details about insurance or Driver Report Setup for details about configuring your Driver Reports

no

fm

driver_reports_use_receipting_tables_flag

If this is set to 'yes', the receipting values will be used to calculate the "Funds Received" amount on Driver Reports; this will match your accounting values. If it is 'no', the value allocated to any invoices within the report period will be shown, regardless of when the payment was made. Visit the Driver Report Setup for more details about configuring your Driver Reports

yes

fm

driver_temporary_password_flag

If set to 'yes', activates temporary passwords for clients to Access the Portal. If the Driver lacks an Active Contract, they can login to driver portal for updating their Details

no

fm

driver_user_login_alias_enabled_flag

If set to 'yes', the driver's "Email" will be used as the login instead of the "Driver ID". When using this control also refer to Driver Contract Access for full set up information. Note: This control must be set to 'yes', not 'Yes'

no

fm

excess_km_limit

Used to identify vehicles for review on the Leased Vehicle Report. Vehicles are highlighted if the difference between the "Contract Kms" and the "Estimated EOL Odo" is greater than the limit set here. Update the value to suit your business as required

5000

fm

fbt_declaration_access_denied_message

Body text of a message given to Drivers who try to use the Declaration screen when it has expired

The hyperlink provided to you was a single use link. An Odometer reading has already been recorded using this link OR the link has expired. To obtain another link, please contact your fleet manager

fm

fbt_declaration_action_period

The time frame that the FBT Declaration can be sent in. This can be Yearly, Quarterly or Monthly

yearly

fm

fbt_declaration_entry_accepted

Body text shown on the Declaration screen when a Driver has successfully entered their reading

Thank you for visiting the odometer declaration page. Should you wish to make another declaration, please contact your fleet manager for a new login

fm

fbt_declaration_instructional_text

Body text shown on the Declaration screen when a Driver is to enter a reading

By entering and saving data on this screen, you are declaring that the date and odometer reading is accurate, true and correct for the vehicle detailed above. Your user details are recorded with this reading as part of the system audit records, noting the date and time the declaration has been made and by whom

fm

fbt_declaration_period_end_tolerance

The time frame from date of sending a Declaration email in which a Driver can submit a reading. See Standard Reports: FBT Declaration Email for full details of this feature

30

fm

fbt_declaration_show_target_reading_flag

If this flag is turned on, then display the Target Reading on the Declaration page, directly under the Odometer input box

yes / no

fm

fbt_declaration_valid_date_tolerance

The time frame in which a Driver can submit a reading in advance (for example: The driver declares on the 27th March a reading for 31st March)

7

fm

finance_budget_term_deferred_flag_default

When creating new Clients this flag determines the default value for the "Finance Budget Term Deferred" flag unless Client is linked to a Channel where the Channels > Quote defaults "Finance Budget Term Deferred" flag is used as the default value. Visit Quotes/Lease Finance for more details. See also the Quote Finance Calculation for full details of the factors and calculations. Changing this control between 'yes' and 'no' (and vice versa) could have an adverse effect on your quoting template results. Prior to making any changes you should discuss the ramifications with your Account Manager

yes / no

fm

fleetrak_login

Login credentials required to activate the IMEI button on the Contracts / Maintenance screen

fm

fm_clients_allow_quoting_flag_default

Create a default entry for the field "Allow Quoting" that is located in the Clients/Quote Defaults screen

no

fm

fm_clients_billing_term_id_default

Set a default entry for the field "Billing Terms" in Clients / Contract Defaults

100014

fm

fm_clients_client_type_default

Create a default entry for the field "Client Type" that is located in the Clients / Contact screen

lead

fm

fm_clients_contract_pay_cycle_from_quote_flag_default

This control sets the default value of Clients / Contract Defaults "Contract Pay Cycle From Quote" when new clients are created. If this is set to 'no', the field is unchecked. If this is set to 'yes', the field is checked. Visit Pay Cycle Billing for more details about this feature

no

fm

fm_clients_fbt_email_novated_default

Create a default entry for the flag "FBT Email Novated" that is located in the Clients/Contract Defaults screen

no or yes as applicable

fm

fm_clients_history_only_flag_default

If set to yes all new clients set up will have Contract Defaults history_only_flag set to yes (which can be overwritten at client level). Relates to Card Services setup

no

fm

fm_clients_pay_cycle_default

Create a default entry for the field "Pay Cycle" in the Clients / Quote Defaults that is set to monthly

monthly

fm

fm_clients_payment_method_default

Create a default entry for the field "Payment Method" that is located in the Clients/Contract Defaults screen

(blank)

fm

fm_clients_periods_deferred_default

When new channel or client records are created, this record is the default value for the following fields: Channels / Defaults "Periods Deferred", Clients / Contract Defaults "Periods Deferred"

0

fm

fm_clients_periodic_start_default

Define a default value for Clients / Contract Defaults "Start Period"

2

fm

fm_clients_quoting_denied_message

To show an alert message when "Allow Quoting" is turned off and Clients code in the Quotes / Contract is entered

Client not profiled for quoting. Refer to management

fm

fm_contract_finance_vehicle_purchase_gross_validate_flag

To validate Gross Vehicle Cost set this control to yes

no

fm

fm_suppliers_interface_type_exclude

To hide the value 'maclease' from the 'Interface Type' drop box in Suppliers / Account Tab. Must be lowercase as per entry in enum

fm

fuel_treat_inactive_cards_as_valid_flag

If set to 'yes', card transactions will be processed even when the card's "Status" is 'inactive'. This control is used in the following processes: 1. Fleet / Card Services / Transactions > Card Transaction Date Check 2. Scheduler / Job > "Method" 'importTransactions'

no

fm

glass_ftp_connection

Not used anywhere. Refer qt glass_ftp_connection

fm

new_approvals_screen

If set to yes the new Approvals Screen is shown in the Fleet / Administration menu and the Approval tab is removed from the Contracts tabs

no

fm

novated_driver_report_periods_deferred_flag

If set to yes exclude driver reports from being included if the contract start plus months deferred is greater than the report date. Applies to delivery by email only, you can still run a report from the Contracts/FBT screen. Visit Driver Report Setup for details about configuring your Driver Reports

no

fm

odometer_valid_tolerance

Percentage tolerance used to validate odometer readings in Contracts: Approvals and Card Transactions. See also Estimated Odometer Calculation

d:0.2

fm

onelink_sftp_connection

Store the SFTP connection details for Onelink here. Host: as advised by Onelink, Port: 22, Username: as advised by Onelink, Password: as advised by Onelink, Export Path: Upload

fm

payments_mfee_default_supplier_id

Enter a default supplier for your 'Management Fee' payments. Go to the Payments Setup for all the steps required to set up your payments

0

fm

payments_spv_company_id

Used to nominate a gb_companies.company_id to be used for bespoke journals created in the Contracts: Payments Principal and Interest calculations. Contact Catch-e if you require custom journal entries to be raised

0