Skip to main content
Quote Lease & Inclusion Plans

Quotes / Lease

How the Quotes / Lease screen works: budgets, profiles, inclusions, business rules, validation alerts and troubleshooting.

Overview

The lease screen provides the summary of the various lease components. Budgets such as Finance (FIN) are calculated from the Finance screen and the results shown here.
For each Contract Type, add each budget shown here that you will use to the Contract Types / Accruals tab.
Thus if Fuel is not a defined budget within the contract type then it will not be an allowed budget in the quote.

Budgets which require calculations have their own "profile" visible on this screen.
Although profiles are set as default types at the Variant Profile level they may be adjusted by advanced users if required on this screen.
For example if non standard wheels and tyres are selected as an option then the user can adjust the tyre profile accordingly on this screen.

See below for a sample screen with sample profiles:

Budgets

The budgets section displays the various components of the lease derived from coded budgets, profiles and inclusions.
Some budget values and notes can be edited directly, others are read only and must be updated by changing the related profile or inclusion entries to update the calculated budget.

Field Descriptions

Field

Type

Description

[table]field

Budget

Display only

Shows the posting class name of each budget.

[qt_quote_budgets]posting_class_id
links to
[gl_posting_classes]name

Net

Number

Shows the monthly net amount of each budget.

[qt_quote_budgets]amount_net

GST

Number

Shows the monthly GST amount of each budget.

[qt_quote_budgets]amount_gst

Inclusive

Number

Shows the monthly amount of each budget including GST (Net plus GST).

[qt_quote_budgets]amount_net + [qt_quote_budgets]amount_gst

Quote Note

Text

Describes if the budget is included or not. ('Included','Excluded').
Some budgets have extra detail shown. This field can be edited.

[qt_quote_budgets]notes

Lock Lease Rate

Check Box

The "Lock Lease Rate" checkbox is used to allow adjustments to the lease budgets without changing the total lease cost, for example if minor adjustments are required but the agreed monthly lease rate must not change.
If checked, the Management Fee (MFEE) budget is adjusted automatically by the system to keep the lease total the same. If the Contract Type / Accrual tab does not contain a MFEE class, the "Lock Lease Rate" check box will be disabled.

The "Lock Lease Rate" check box is updated by the system in the following scenarios;

When a quote is created, "Lock Lease Rate" is un-checked as the default.
When a quote is copied, "Lock Lease Rate" becomes un-checked.
When a quote is accepted, "Lock Lease Rate" is checked automatically if [gb_controls]lock_lease_rate_flag is 'yes'.
The Quotes / Finance "Lock Residual Rate" field is affected by updates to "Lock Lease Rate";

If "Lock Lease Rate" is checked, "Lock Residual Rate" also becomes checked, but can be edited to become different.
When a quote is accepted, "Lock Residual Rate" is also checked automatically if [gb_controls]lock_lease_rate_flag is 'yes'.

[qt_quote]lock_lease_rate_flag

Summary

Budget

Accrual

Level

Comments

Finance

FIN

Various

Management Fee

MFEE

Various

Fuel Fee

FFEE

Client

Clients / Quote Defaults "Fuel Fee". This field can be renamed.

Insurance Uplift

INSUP

Contract Type

Contract Types / Details "Insurance Uplift Rate"

Insurance Fee

IFEE

Client

Clients / Quote Defaults "Document Fee". This field can be renamed.

Luxury Car Charge

LCC

Contract Type

Contract Types / Accruals "Class" 'LCC' is populated. Quotes / Lease "Luxury Car Charge" will be used to calculate a budget value.

Budgets Financed

BF

Contract Type

Contract Types / Details "Budgets Financed"

Residual Reserve

RRES

Contract Type

Contract Types / Details "Quote Residual Reserve"

Finance (FIN)

The Finance budget calculation is affected by a number of variables. Please open and view the Quote Finance Calculation for full details of these.

If you use "Months Deferred" in your finance calculation, the Clients / Contract Defaults "Finance Budget Term Deferred" check box determines if the Finance budget will either;

a. Use the same parameters as the required Finance Payments (Term less Months Deferred) - Client 'finance_budget_term_deferred_flag' = 'yes'
E.g. 36 month lease, two months deferred with 34 monthly lease payments and 34 monthly lease rentals.

b. Be spread over the lease term - Client 'finance_budget_term_deferred_flag' = 'no'
E.g. 36 month lease, two months deferred with 34 monthly lease payments and 36 monthly rentals.

Note 1:

If Setup / Reference Data 'qt_financier_posting_map_defaults' "Finance Budget Term Deferred" is set to 'Yes' or 'No', it is applied.
Otherwise, the Clients / Contract Defaults "Finance Budget Term Deferred" value is applied.

Note 2:

The entry in Clients / Contract Defaults "Finance Budget Term Deferred" updates the value of the Clients / Contract Defaults "Budget Term Deferred" check box
The Clients / Contract Defaults "Budget Term Deferred" check box is not editable. Having these fields set differently can impact billing values and is not recommended.
The Clients / Contract Defaults "Budget Term Deferred" check box is used to calculate all the other budgets by either "Term" or ("Term" less "Months Deferred")

Changing the "Finance Budget Term Deferred" check box between 'yes' and 'no' will change the values seen in your quote documents.
Contact your Account Manager for assistance if you want to make changes in this area.

This field may be updated via the Refresh Base Rate or RefreshQuoteBaseRate feature.

Management Fee (MFEE)

This is a monthly fee that is set on most contract types. It normally contains a default value when new quotes are created.

  • Go to Setup / Reference Data → gb_controls "management_fee" and enter the amount if you want to use as the default.

  • Go to Clients / Quote Defaults "Novated Management Fee" and enter an amount if you want to use as the default value for this client for quotes in the Novated group. If this is set, it will override the global control "management_fee" setting.

MFEE amount shown in "Budget" section will be different than Clients / Quote Defaults "Novated Management Fee" when Clients / Contract Defaults "Budget Term Deferred" flag = yes and Quotes:Finance "Months Deferred" is not zero.
For example, using the following scenario:

Clients / Contract Defaults:
"Budget Term Deferred" = yes
"Periods Deferred" = 2

Clients / Quote Defaults:
"Novated Management Fee" = 30.00

Create a Quote
Term = 48
Months Deferred = 2

Quote Budgets:
Management Fee = $31.30

Access to this field can be role restricted.

Employee Contribution (ECM)

Go to the Employee Contribution (ECM) page for all the details about using this profile.

Fuel Fee (FFEE)

This is an optional monthly fee. This can be renamed and will display in Budgets sections with posting class name. To use this budget class:

  • Go to Posting Classes / Details and check that "Class Code" 'FFEE' exists. Event check-boxes should be un-checked

  • Go to Contract Types / Accruals and add "Class" 'FFEE' to the records here.

  • Go to Clients / Quote Defaults "Fuel Fee" and enter an amount if you want a default value for this budget when new quotes are created.

Insurance Fee (IFEE)

This is an optional monthly fee that will populate if configured and the Comprehensive Insurance (INS) profile has been selected in the quote.
To use this budget:

  • Go to Posting Classes / Details and check that "Class Code" 'IFEE' exists.

  • Check that the Event check-boxes are un-checked.

  • Confirm or update the "Name" for this record. This will display as the name in the Quotes / Lease Budgets section.

  • Go to Contract Types / Accruals and add the "Class" 'IFEE' to the records.

  • Go to Clients / Quote Defaults "Document Fee" ([fm_clients]document_fee_budgeted) and enter an amount if you want a default value for this budget when new quotes are created for this client.

  • Go to Setup / Reference Data → gb_controls "ins_fee" and enter an amount if you want a default value for this budget when new quotes are created. This Global Control value will be used if Clients / Quote Defaults "Document Fee" ([fm_clients]document_fee_budgeted) is $0.00.

Insurance Uplift (INSUP)

The Insurance Uplift (INSUP) budget can be configured by Contract Type to automatically add a calculated uplift to quotes to cover Insurance cost increases.
It is calculated when Comprehensive Insurance (INS) has been selected. INSUP is not a stand alone budget.

INSUP is calculated and added to all new quotes for configured Contract Types, regardless of the chosen "Policy Owner". I.e. it is applied to Internal Insurer, Driver and Client policies.
Open the Insurance Uplift calculation model.xlsx to see the working calculation.

INSUP will be added to quotes when the following conditions are met:

  • Contract Types / Details "Insurance Uplift Rate" has a value. I.e. is not set to '0.0000'

  • Contract Types / Accruals "Class" has an 'INSUP' entry

  • Quotes / Lease Comprehensive Insurance has been selected

  • Quotes / Lease Comprehensive Insurance "Monthly Budget" is not '0.00'

You can edit this budget directly, although it is not recommended as any changes made will be overwritten if the Comprehensive Insurance "Monthly Budget" amount changes.
The Budget section fields "Net", "GST" and "Quote Note" fields may be display only if a role restriction is in place.

Luxury Car Charge (LCC)

You can use the LCC budget to incorporate the vehicle's Luxury Car Charge into the lease costs.
A budget amount will calculate and populate if set-up to do so.
This is 1/12th of the stored amount in the Quotes / Lease "Luxury Car Charge" field.
Open the LCC Budget calculation model.xlsx to see the working calculation.
The LCC Budget will not calculate if [gb_controls]luxury_charge_basis is set as 'fbt_amount'.
To use this budget:

  • Go to Posting Classes / Details and check that "Class Code" 'LCC' exists and create it if it is missing.

  • When creating 'LCC', make sure the event check-boxes are un-checked. The class "Name" displays as the Quotes / Lease Budgets also.

  • Go to Contract Types / Accruals and add the "Class" 'LCC'.

Budgets Financed (BF)

If the Contract Types/Details check box Budgets Financed is selected, a Budget row called Budgets Financed will contain a negative amount to reverse the amount of the other running cost budgets. Those amounts and profile calculations will remain visible, but the amount will be financed. You can see the financed amount in the Quotes/Lease screen in the Brokerage section.

Residual Reserve (RRES)

An additional amount can be budgeted to buffer any shortfalls on the Residual value of a vehicle. This would typically be applied to operating leases.
To use this budget class:

  • Go to Posting Classes / Details and check that "Class Code" 'RRES' exists. Event check-boxes should be un-checked

  • Go to Contract Types / Accruals and add "Class" 'RRES' to the records here.

  • Go to Contract Types / Details "Quote Residual Reserve" and enter an amount if you want a default value for this budget when new quotes are created.

Budgets GST

The Total GST of a lease can be forced to calculate as exactly 10% of the net value. Various budget roundings can lead to a GST Total that is slightly off.
Two global controls need to be set up for this;

  • [gb_controls]total_lease_gst_calc_flag turns the feature on.

  • [gb_controls]total_lease_gst_calc_class nominates the budget to apportion the rounding to.

Note: [gb_controls]total_lease_per_pay_cycle_gst_calc_flag used to change the GST on quote outputs, but has been superseded by the flags above.

Profiles Exc. GST

Profiles assist with the calculation of budgets and link particular maintenance and service cost tables to the vehicle variant. Default budgets are set per variant in the table qt_variant_profiles.
An example of how a profile might be structured is shown in the Quote Profiles page.
If you wish to change the name of the Profile, refer to Posting Classes for more information. Please note that if you change the name, your quote form will also require updating if you disclose this product.

New Quotes Default Profiles can be overwritten with different values during the quote process or deactivated. If the Quote term is changed, the new profiles will be retained and the values re-calculated accordingly. Deactivated profiles will remain so.

Editing Saved Quotes When term or contract kilometres (not profile Kilometres) are adjusted on existing quotes, active profiles will re-calculate values, where relevant. Deactivated profiles will remain so.

Editing Type Code (Contract Type) When the Type Code is changed (manually or changing Client Code if default contract type setup) this will:

  • Silently drop any Quote Profiles where a Profile is not mapped to the new Type Code.

  • Will not automatically include Quote Profiles where the Profile is mapped to the new Type Code and not previously already included in the Quote.

The table below illustrates the expected behaviour of each profile, based on where term and/or kilometres are changed and the effect on the profile recalculating the values or not.

Profile

Term

Kilometres

Comments

Quote Profile Table

Maintenance

Yes

Yes

Maintenance tables must be populated for this to be effective. If tables are not populated, any changes will result with stored data dropping out when any changes to term and kms are made. Visit the Maintenance page for more details.

qt_quote_maintenance_service

Tyres

Yes

Yes

Tyres tables must be populated for this to be effective. If tables are not populated, any changes will result with stored data dropping out when any changes to term and kms are made.

qt_quote_tyres

Registration

Yes

No

qt_quote_reg_ctp

Comprehensive Insurance (INS)

Yes

No

Go to the Comprehensive Insurance (INS) page for all the details about using this profile.

qt_quote_insurance

Fuel

Yes

Yes

qt_quote_fuel

Extended Warranty

No

No

Profile will always drop out when Term is changed. A change in Kilometres will have no effect on the recalculation of the amount, nor will it cause a saved profile to drop out.

qt_quote_extended_warranty

Small Damage Repair

Yes

No

Also referred to as 'Minor Damage Repairs'.

qt_quote_small_damage_repairs

Roadside Assistance

Yes

No

Based on Supplier data populated in table

qt_quote_roadside_assistance

Vehicle Maintenance Program

Yes

No

Calculation based on term, not kilometres

qt_quote_vehicle_maintenance_program

Carbon Emission Offset

No

Yes

Where Carbon Emission Offset amount is calculated by using gb_control.qt_carbon_emissions_offset

qt_quote_carbon_emissions_offset

Yes

No

Where Carbon Emission Offset amount is calculated by using gb_control.qt_carbon_emissions_offset_per_tonne

qt_quote_carbon_emissions_offset

Accident Management

Yes

No

qt_quote_accident_management_fee

Loan Termination Insurance

No

No

Calculation based on vehicle value

qt_quote_lti

Warrant of Fitness

Yes

No

Calculation based on Quote Budget

qt_quotes_warrant_of_fitness

Maintenance (MAINT)

Go to the Maintenance (MAINT) page for all the details about using this profile.

Tyres (T)

Go to the Tyres (T) page for all the details about using this profile.

Filter

Type

Description

[table]field

Include?

Check Box

Check to include this budget profile. Un-check to remove.

[qt_quote_tyres]included_flag

Specification

Lookup

Use the lookup icon to find and select a Tyre Code. If one is recorded in the maintenance profile of the selected variant, it will default into new quotes.
Access to this field can be role restricted.

[qt_variants]rear_tyre_size

Tyre Name

Calculation

Displays the stored tyre name

[qt_tyres]name

Tyres per Set

Calculation

Defaults in the stored Tyres/Set on the linked variant's profile. This can be edited.
Access to this field can be role restricted.

[qt_variant_profiles]tyres_per_set

Interval KMs

Calculation

Defaults in the stored Tyre Interval on the linked variant's profile. This can be edited.
Access to this field can be role restricted.

[qt_variant_profiles]tyre_km_interval

Unit Cost

Calculation

Defaults in the stored tyre cost linked to the chosen tyre. This can be edited.
Access to this field can be role restricted.

[qt_tyres]list_price

Estimated Tyres

Number

This is calculated based on "Contract KMs" / "Interval KMs". This can be edited.
Access to this field can be role restricted.

[qt_quote_tyres]tyres_estimated

Limit?

Checkbox

Report only field. This is not used in any system processes or calculations.
Access to this field can be role restricted.

[qt_quote_tyres]limit_flag

Monthly Budget

Number

The "Monthly Budget" is calculated by dividing the "Total Budget" by the number of billing periods there will be.
Open the Monthly Budget Calculation for an illustration of this.
Access to this field can be role restricted.

[qt_quote_budgets]amount_net

Total Budget

Number

Calculated as follows; "Estimated Tyres" x "Unit Cost"

[qt_quote_budgets]total_amount_net

Registration (REG)

Registration costs are normally calculated from stored table values and settings first.
If the Quote / Vehicle tab "Initial Registration" and "Initial CTP" fields are updated during creation or editing, the values will normally copy here into "Annual Registration" and "Annual CTP" leading to a re-calculation of the "Monthly Budget".
You can edit these values to be different to the Quote / Vehicle tab amounts, but do this last.

Quotes are calculated on the basis that the Quote / Vehicle tab "Initial Registration" and "Initial CTP" are included in the financed amount of the vehicle for 'New' vehicles and therefore the first years registration does not need to be budgeted for. I.e. the calculated "Number of Renewals" is a year less than the term. E.g. a 36 month lease will require 2 registration renewals. For expanded details on this please see Registration.

The behaviour of your screens may be different to what's described above depending on your system settings. You can change the behaviour of 'Used' and 'Demonstrator' vehicles, which can return a '0' amount for these calculations.

Visit the Registration page for more details about the available calculations. Calculations are normally set to calculate based on the quote's "Delivery State". You can also use the Client's "Reg CTP Type" and the "Variant ID" to create more specific calculations. You can also add an uplift percentage to increase the registration budget each year to allow for general cost increases.

The field name for "Annual Registration" can be renamed.

Comprehensive Insurance (INS)

Go to the Comprehensive Insurance (INS) page for more details about using this profile.

Field

Type

Description

[table]field

Include?

Check Box

Select if you want to add or calculate a Comprehensive Insurance budget. This was likely selected on the Quotes / Contact tab.

[qt_quote_insurance]included_flag

Policy Owner

List

Select who will be responsible for managing and paying for the Comprehensive Insurance of this contract.
A default entry may come from the Clients / Quote Defaults "Policy Owner" field if recorded, otherwise it will default to 'Driver Policy'.
This choice carries into the Contracts / Insurance "Policy Owner" field when a quote is accepted.

[qt_quotes]policy_owner_type

Insurer

List

Select an insurer for this vehicle. A default entry may come from the Clients / Quote Defaults "Insurer" field.
This choice carries into the Contracts / Insurance "Insurer" field when a quote is accepted.

[qt_quotes]supplier_id_insurer

Location

List

Select a Location or a Postcode to complete the insurance premium calculation.
The choice comes from your system's insurance set-up.

[qt_quotes]insurer_location_id or [qt_quotes]insurer_location_postcode

Billing Type

Drop List

This defaults to 'Monthly'. 'Annually', 'Reimbursement' and 'Excluded' can also be selected.
When a quote is accepted AND "Policy Owner" is 'Internal Policy' THEN Contracts / Insurance "Billing Frequency" will be set as
'Annually' if this field is set as 'Annually', or 'Monthly' for all other selections.

[qt_quote_insurance]billing_type

Ins Type

List

"Ins Type" is a necessary selection to calculate an insurance premium.
If the selected variant has a stored "Ins Type" that is active, it will default into this field. If the variant's stored "Ins Type" is inactive, it will not default into new quotes.
If the "Ins Type" does not default, you can select an active "Ins Type" from the drop list. Inactive records are not shown.
If you are not sure if the selected "Ins Type" is correct or is active, un-check and re-check the "Include?" check box to refresh this field.

The "Ins Type" is copied into the Contracts / Insurance "Insurance Category" field when a quote is accepted.

When a variant does not have a stored "Ins Type" you will see this warning icon that has a tool tip message "Warning: No Insurance Type on Profile".
To add or correct a variant's "Ins Type", follow these steps to update the variant profile.

[qt_quote_insurance]insurance_type_id

Claim Excess

Number

This defaults from the [qt_insurance_types] table and can be edited.
This choice carries into the Contracts / Insurance "Claim Excess" field when a quote is accepted.

[qt_quote_insurance]claim_excess

Annual Insurance Lock

Check Box

Check this to lock the amount entered or calculated into the "Annual Ins" field. Once locked, the amount remains fixed.
However, if one of the insurance variables gets updated, the lock will un-check automatically and "Annual Ins" will re-calculate.

[qt_quotes]lock_comprehensive_insurance_flag

Annual Ins

Number

The annual insurance amount is calculated by the system if this is configured. This amount can be edited.
This amount will respect the upper and lower limit amounts in the set up to adjust accordingly if the value set in the control comprehensive_insurance_basis is adjusted into a different insurance bracket.
If one of the insurance variables gets updated, the annual insurance amount will be re-calculated.
The insurance variables are "Effective Date", "Term", "Client Code", "Location", "Variant" and "Amount Financed".

[qt_quote_insurance]annual_insurance

Fund 1st Year?

Check Box

If checked, the 1st year's insurance is included in the Quotes / Finance Broker "Comprehensive Insurance" field.
The "Fund 1st Year?" checkbox default is a Contract Type setting.

[qt_quote_insurance]fund_1st_year_flag

Monthly Budget

Number

Calculated by the system based on the above.

[qt_quote_budgets]amount_net

Total Budget

Number

Calculated by the system based on the above.

[qt_quote_budgets]total_amount_net

Fuel (F)

Visit the Fuel (F) page for all the details about how to use and set-up the Fuel profile.

Field

Type

Description

[table]field

Include?

Check Box

Check to include fuel in the quote.

Fuel Type

Drop List

Fuel Type will default from the selected variant's stored fuel type. You can edit this.

[qt_quote_fuel]fuel_type_id
[qt_fuel_types]fuel_name

Cost per Litre
Cost per Kwh

Number

Cost per Litre (CPL) will calculate when a fuel type is selected. You can edit this.
If the selected fuel type is 'Electric', the field name "Cost per Kwh" is shown.

[qt_quote_fuel]cost_per_litre

Fuel Usage

Drop List

Select the kind of fuel usage this vehicle is expected to have (Combined, Country, Metro).
Each usage has a corresponding Litres per 100KM that reflects the usage and changes the calculated budget accordingly.
Your system has a stored default that is put into new quotes. This can be edited.

Litres per 100KM
Kwh per 100KM

Number

This defaults from the selected variant's stored mileage use. You can edit this.
If the selected fuel type is 'Electric', the field name "Kwh per 100KM" is shown.
These values come from data imports from either Glasses or RedBook (your vehicle data provider).
Refer to Glasses or RedBook directly if you have any queries about the set values.

Monthly Budget

Number

Calculates based on the fuel type, cost and mileage. You can edit this.

[qt_quote_budgets]amount_net

Total Budget

Number

[qt_quote_budgets]total_amount_net

Extended Warranty (EW)

Field

Type

Description

[table]field

Include?

Check Box

Check if you want to add an Extended Warranty budget to this quote.

Plan

Drop List

If "Include?" is checked, select the plan you want.

Category

Drop List

Select the category you want.

Months

Drop List

Select the number of months the warranty is to cover. This can be different to the quote's "Term".
E.g. a driver may choose a cover that is longer than the lease term.

Kilometres

Drop List

Select the number of kilometres the warranty is to cover. This will default in if there is only one choice.

Premium

The premium stored for the selected warranty will populate here. It can be edited by the user.

Monthly Budget

Number

The "Monthly Budget" is calculated by dividing the "Premium" by the number of billing periods there will be.
Open the Monthly Budget Calculation for an illustration of this.

[qt_quote_budgets] amount_net

Total Budget

Number

Shows the total cost of the warranty.

[qt_quote_budgets] total_amount_net

Financed?

Check Box

If your system is configured to finance this product this check box will be checked by default and cannot be edited.
If the premium is being financed, the total will be stored and displayed in the Quotes / Finance Broker "Extended Warranty" field.

Small Damage Repairs (SDR)

Field

Type

Description

[table]field

Include?

Check Box

Check if you want to add a Small Damage Repairs budget to this quote.

[qt_quote_small_damage_repairs] included_flag

Years

Drop List

If "Include?" is checked, and you have a stored set of premium records, the 'best fit' premium record is selected based on the term of the quote.
The calculated number of years it's being offered for is shown here. You can change the selected premium record.

[qt_quote_small_damage_repairs] months

Premium

If "Include?" is checked, the 'best fit' premium record will default into the profile.
You can change the selected premium by changing the "Years" selection or by directly editing the premium here.
If the Quotes / Contract "Term (Months)" is changed, the profile will also update to the 'best fit' premium.

[qt_quote_small_damage_repairs] premium

Monthly Budget

Number

The "Monthly Budget" is calculated by dividing the "Premium" by the number of billing periods there will be.
Open the Monthly Budget Calculation for an illustration of this.

[qt_quote_budgets] amount_net

Financed?

Check Box

If your system is configured to finance Small Damage Repairs this check box will be checked by default and cannot be edited.
If the premium is being financed, it will be stored in the Quotes / Finance Broker "Small Damage Repairs" field.

[qt_quote_small_damage_repairs] qt_quote_small_damage_repairs

Roadside Assistance (RSA)

Field

Type

Description

[table]field

Supplier

List

Select the Roadside plan that is applicable to this quote.
A default entry will come from the Clients / Quote Defaults "Roadside Assistance" field if recorded, otherwise it will be blank until selected.

[qt_roadside_assistance_plans] roadside_assistance_plan_name

Premium

List

When the "Supplier" has been selected, the stored premium will populate here. This is an annual cost and can be edited.

[qt_quote_roadside_assistance_plans] premium

Monthly Budget

Number

Calculated by the system based on the "Premium" amount.

[qt_quote_budgets] amount_net

Total Budget

Number

Calculated by the system based on the "Premium" amount.

[qt_quote_budgets] total_amount_net

Maintenance Program (VMP)

If configured to do so, a Maintenance Program profile and budget will be available when quotes are created or edited.
If a value is stored in the client record, this budget will be selected and a "Monthly Budget" amount will be added automatically. You can edit the budget amount.
If the profile is available but not selected, you can select it and add a "Monthly Budget" if you want.

Carbon Emissions Offset (CEO)

Configure this budget profile by adding 'CEO' to the Contract Types / Accrual tab and use the Clients / Quote Defaults "Carbon Emission Offset" check box to set a client preference for this profile.
Choose which calculation method you would like to use. If both controls are populated, the second is used as the default.

  1. Fixed amount per month. Enter a default monthly net amount in [gb_controls]carbon_emissions_offset.

  2. Amount per tonne. Enter a per tonne cost in [gb_controls] carbon_emissions_offset_per_tonne. The amount stored in the variant's "CO2 Emissions" field is used to calculate the total budget which is then divided into months.

"Monthly Budget" = [qt_variants]co2_emissions * [qt_quotes]contract_kms / 1000 / 1000 * [gb_controls]carbon_emissions_offset_per_tonne / ROUND((Term - Months Deferred),2) * Term

This budget profile is a calculated read-only field.

Accident Management (AMFEE)

If configured to do so, an Accident Management budget will be available on new quotes when they are created.
If a value is stored in the client record, this budget will be selected and a "Monthly Budget" amount will be added automatically. You can edit the budget amount.
If the profile is available but not selected, you can select it and add a "Monthly Budget" if you want.
If a quote has an Accident Management budget selected, the Contracts / Vehicle "Accident Management" field will be checked when the linked quote is accepted or settled.

Loan Termination Insurance (LTI)

Loan Termination Insurance can be included in the amount financed in the Quote. The premium is added as a brokerage item on the Quote / Finance screen. Refer to Loan Termination Insurance for more detail.

Warrant of Fitness (WOF)

The Warrant of Fitness profile is similar to the Registration profile and is useful in New Zealand only. Refer to the Warrant of Fitness page for more detail.

Inclusion Products

Lease inclusions holds budgeted, financed and non-cost options provided in the lease.

Budget

Accrual

Settings

Comments

Excess KM Charge

Contract Type

It is checked by default if the Contract Type / Details "Quote Excess Km" field is checked.

Redundancy Insurance

Contract Type

It is checked by default if Contract Type / Details "Quote Redundancy Insurance" is checked.

Walkaway

An older inclusion that can be hidden if not in use.

Tyre and Rim Insurance

Tables

Lease Inclusion Plans

Tables

Can be configured for simple user selection through to default selections and calculation based on term and/or vehicle value ranges.

After Hours Assistance

Control

Excess KM Charge

Field

Type

Description

[table]field

Select

Check Box

Check if you want to add an Excess KM Charge to this quote.
It is checked by default if the Contract Type / Details "Quote Excess Km" field is checked.

$ Per KM

Number (4dp)

If unchecked, this field will display as '0.0000'.
If checked, a default amount will populate into this field, but can be updated.
Depending on your system's configuration, the default amount will either be

Calculated using a factor of the quoted maintenance cost per km
A flat rate from the Clients / Quote Defaults "Excess KM Rate" field.

Redundancy Insurance

Visit the Redundancy Insurance page for complete details of this feature. This field may be updated via the Refresh Base Rate or RefreshQuoteBaseRate feature.

Field

Type

Description

[table]field

Select

Check Box

Check if you want to add Redundancy Insurance to this quote. It is checked by default if Contract Type / Details "Quote Redundancy Insurance" is checked.

Redundancy Insurance

Text

Displays the product name. The default name is Redundancy Insurance, but it can be re-named.

Rate

%

Enter a percentage to calculate this inclusion or review the displayed rate. This will display a re-calculated % if you enter a total on the Quotes / Finance tab.
Access to this field can be role restricted.

Total

Number

Displays the calculated total for this inclusion. You may be able to enter a different total on the Quotes / Finance tab.

Lock

Check Box

Check if you want to hold the stored total constant, regardless of other changes you make to the quote.

Walkaway

Walkaway is a legacy inclusion that is hidden by default in new systems.

Field

Type

Description

[table]field

Select

Check Box

Check if you want to add Walkaway to this quote.

[qt_quotes]walkaway_flag

Inclusion

Text

This inclusion may be called Walkaway, or it may have a different name in your system to suit your organisation.
Visit the Field Names page for more details. If renamed, validation errors about this inclusion will refer to your field name alias.

Plan

Drop List

Select the plan you want from the list. The plan name is shown when you are editing. The plan code is shown when you are viewing the record.

[qt_walkaway_plans]walkaway_plan_code

Retail

Number

Shows the Retail (GST inclusive) total to pay for this inclusion.
This amount is also shown in the Quotes / Finance "Walkaway" field and also forms part of the value of the "Total Brokerage" and "Amount Financed" fields.

[qt_quotes]walkaway

Tyre and Rim Insurance

Visit the Tyre and Rim Insurance page for complete details of this inclusion.

Field

Type

Description

[table]field

Select

Check Box

Check if you want to add Tyre and Rim Insurance to this quote.

[qt_quotes]tyre_rim_insurance_flag

Inclusion

Text

This inclusion may be called Tyre and Rim, or it may have a different name in your system to suit your organisation.

Plan

Drop List

Select the plan you want from the list. The plan name is shown when you are editing. The plan code is shown when you are viewing the record.

[qt_tyre_rim_insurance_plans] tyre_rim_insurance_plan_id

Retail

Number

Shows the total to pay for this inclusion.

[qt_quotes]tyre_rim_insurance

Lease Inclusion Plans

If configured, there can be one or more inclusion products shown here. If no inclusion plans are in use, these fields will be hidden.
Visit the Lease Inclusion Plans page for complete details of this feature. The Retail Gross (GST inclusive) value is shown (when [qt_inclusions]calculate_gst_flag = 'yes').

Field

Type

Description

[table]field

Select

Check Box

Check if you want to add the selected Inclusion to this quote.

Inclusion

Text

The name of the inclusion is shown here.
If configured, an inclusion may select automatically, or it may be hidden for selected Clients, Makes, Models or Variants.

Plan

Drop List

Select the plan you want from the list. If only one plan is available, it will populate here if you select the inclusion.
If there are no eligible plans available, this field will be disabled.

Retail

Number

Displays the calculated total for the selected plan. You may be able to edit this field, or it may be display only.
If a plan cannot be selected, this field will be disabled.
If this inclusion is being financed, this total will be part of the value of the Quotes / Finance "Total Inclusion Plans" field.
It also becomes part of the "Total Brokerage" and "Amount Financed" values.
If the selected inclusion is an Eric or client specific product, then the "Retail" amount will be display-only and will display as '0.00' until the Eric Interface has run successfully and returned the pricing.

After Hours Assistance

Non cost option. This can be defaulted to either on or off when a new quote is created. The default is set-up using the [gb_controls]after_hours_assistance_flag setting.

Business Rules

Negative Budgets

Negative budgets may occur in a quote under certain circumstances, e.g. if the lock lease rate is set and a user adds options to a vehicle then the MFEE budget may become negative. If a negative budget occurs, users are given validation messages:

  • Manager, Admin or Super roles are given a popup warning - '…budget contains negative values!' but are allowed to save the quote.

  • All other users are given the error message, but cannot save the quote in its current form. They must either remove the negative value, or "Cancel" their changes.

  • A save is allowed if the user's role does not have access to the Lease screen and cannot adjust the budgets directly, e.g. the 'user' role. However, if the quote has a status of 'Requested' or 'Draft' then the user cannot print the quote until it is reviewed. This means another user who edits and saves the quote at a later point will become aware of the negative budget value before the quote is sent out.

Some budget class codes (e.g. ECMC) may be deliberately set to a negative amount. Class codes which are allowed to be negative are listed in the Global Control qt.posting_class_code_allow_negative.

Profile set to defaults

All profiles, included or not, are set to default values following these actions:

  • Changing Effective Date, Client Code on the Contract screen

  • Changing Variant on the Vehicle screen

Only profiles that have been included are set to default values following these actions:

  • Changing Contract Kms on the Contract page defaults the Maintenance, Tyres, and Fuel profiles

  • Changing Location Rego on the Contract page defaults the Fuel profile

Action Buttons

Button

Description

View

Edit

Click to edit the selected record.

Edit

Save

When you have finished editing the record, click to save.

Cancel

Cancel if you don't want to save your current edits.

Validations and Alerts

Create or Save

Alert

Comments

Annual Insurance must be more than $0.00!

Your insurance selections or a change in the selections have caused the Insurance profile to calculate with an "Annual Ins" of 0.
Click OK and you will be navigated to Quotes / Lease to update this field.

Client Margin must be 0 or a positive number

Quotes / Finance "Client Margin" cannot be negative.
You will be alerted on Save, or when you try to navigate away from the Finance tab.
This is managed by a [gb_controls] setting and this can be updated after quotes have been created with negative margins.
In these cases, these quotes cannot be updated unless the margin is updated to a positive value.

This vehicle no longer qualifies for the FBT Exemption –
enter the Date First Held and tick either Yes or No for
Luxury Car Tax Paid.

Click OK to exit the alert. The quote is saved with the following
"FBT Treatment Type" is 'Standard'
"Use ECM?" reverts to the Client's setting (usually checked).
The required conditions to use 'EV Exempt Reportable' have not been met.
If the vehicle is 'Used' or 'Demonstrator', check that the "Date First Held" and "Luxury Car Tax Paid" fields have been populated appropriately.

This vehicle qualifies for the FBT exemption.

OK to save the quote with the following changes
"FBT Treatment Type" reverts to 'EV Exempt Reportable'
"Use ECM?" flag is checked OFF.
Cancel to save the quote without changes

"FBT Treatment Type" remains unchanged as 'Standard'

Vehicle Type is not FBT Payable Exempt - are you sure?

When "FBT Treatment Type" is set to 'EV Exempt Reportable' and the linked [qt_vehicle_types]fbt_payable_exempt_flag is not 'yes', this alert will appear.
[OK] will accept the warning and Save.
[Cancel] will leave "FBT Treatment Type" unchanged and Save.

A valid Insurance Postcode is required!
or
Insurance Location not found for this Postcode!

1. The selected insurer was once configured with calculated insurance rates, and this error happens when the selected "Policy Owner" is 'Client' or 'Driver'.
The fix: Update the supplier record to have an inactive status. Create a new Insurer record for selection in this situation.
2. The selected insurer is an internal insurer that has not been configured correctly.
The fix: Contact your Account Manager for assistance.

Maintenance Program budget contains negative values!

The Maintenance Program (VMP) profile has a negative budget value. Click OK to proceed or Cancel to return to the quote to change the budget.

Retail must be a positive number when Walkaway is included, you must select a Plan.

Select a walkaway plan.

Retail must be a positive number when Inclusion is included.

Enter a positive value in the "Retail" field.

You must select a plan when Inclusion is included.

Select a plan for the inclusion that is displayed in the alert.

Save - Eric Interface

Alert

Comments

Client error: `POST [Eric API endpoint]` resulted in a `401 Missing access token` response:\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\r\n<html xml (truncated...)

Your Eric Login is not set-up or is incorrect

ericQuoteValidationErrors
Code: BQE01 Description: Missing dealer identifier

Check and add the Dealer to the configured Dealer records.

Eric Financier configuration not found for Supplier Id #100634. Aborting…

Check and add the Financier to the configured Financier records.

The Eric Pricing submission cannot proceed until the following inputs have been corrected:
Validation error(s):
1. Mobile 0 Value is required and can't be empty

You will see an alert like this if the quote is missing required information. Visit Catch-e system validations for a full list of the validated fields.

An API error occurred… Please see details below:
(example only) EricCannotQuoteAllItems
CoverType: TC1
Product: TAI
ProductCode:
GroupId: a785561d-0de1-4d04-a93c-5e5dedd3a8b5
Description: Cannot quote TAI()/TC1 in quote group:
d1754bb1-497f-4045-8d89-11c62884403a

You will see an alert like this if a quote submission to eric has failed. Visit Eric system validations for a list of the error codes that are known. These checks are not done in Catch-e as they vary by product and are managed by Eric.

90 Day check

You will be alerted if you are saving a quote that has pricing that has expired. Eric pricing expires after 90 days.

unhandledEricApiError

Catch-e has tried to obtain pricing from Eric Insurance which has failed after 3 attempts.

Save an 'Accepted' quote - Eric Interface

Alert

Comments

Quote has been Accepted! Do you wish to source new Eric pricing?

If your quote changes do not affect the quote's pricing, choose Cancel. E.g. You are updating the colour. Click OK to refresh the Eric pricing if the quote pricing has changed.
We recommend working with Eric to understand when a pricing refresh is required in this situation.

Inclusion 'Eric Loan Termination Insurance' has been disabled because
the amount financed now exceeds $150,000.

Eric Insurance will not accept inclusions when the Amount Financed is under 8,000 or over 150,000. The selection will be removed and the check box disabled if this situation occurs.

Print - Eric Interface

Alert

Comments

The last Eric Quote was not successful!
You must request new pricing before you can proceed.

Quotes that have failed a Catch-e or Eric system validation cannot be printed or emailed, because the quote is in an incomplete state (pricing has not been received).

Troubleshooting

Visit the main Troubleshooting page for a list of all the available problem-solving tips.

If your quote budgets are calculating with a deferral, but you want the budgets to calculate over the term, check the following

  • Setup / Reference Data 'qt_financier_posting_map_defaults' "Finance Budget Term Deferred" is either 'any' or 'no'.

  • Clients / Contract Defaults "Finance Budget Term Deferred" is un-checked

Go to the Months Deferred page for more set-up details.

Quotes / Lease - Fuel (F) profile "Litres per 100KM" is not right

The values stored for each variant's fuel usage come from data imports provided by either Glasses or RedBook. These values are not normally altered by Catch-e.
Glasses or RedBook are the original source of this data, so refer to them directly to ask about set values.

Quotes / Lease - Carbon Emission Offset (CEO) does not calculate

Your Carbon Emissions Offset (CEO) budget will not calculate if:

  • the amount stored in the variant's "CO2 Emissions" field is blank.

  • you are using the [gb_controls] carbon_emissions_offset_per_tonne calculation method.

If this is the case:

  • Ask your data provider (RedBook or Glasses) to advise you of the amount.

  • Go to the Setup / Reference Data → qt_variants "CO2 Emissions" field and add this in.

Quotes / Lease - Redundancy Insurance - does not default into new quotes

If Contract Types / Details "Quote Redundancy Insurance" is checked and "Redundancy Insurance" does not calculate, there are three reasons this can happen.

  1. There are no records stored in the [qt_redundancy_insurance_rates] table. If the rates are missing, "Redundancy Insurance" will not default on, as it cannot be 0.

  2. You have stopped using "Redundancy Insurance" and the [qt_redundancy_insurance_rates] table are set to 0 to prevent rates from calculating. If the rates are 0, "Redundancy Insurance" will not default on, as it cannot be 0.

  3. The chosen vehicle has a value that is higher than the [qt_redundancy_insurance_rates]upper_limit value of the available records. In this case, no records are considered a match and no value will be applied.

To investigate and check your set-up, export data from the table [qt_redundancy_insurance_rates] and review the current values in this table.

Quotes / Lease - Tyre and Rim Insurance - plans don't show

If existing Tyre and Rim plans do not show in the Quotes / Lease "Tyre and Rim" selection list, your plan records may have recently been updated.
If the field [qt_tyre_rim_insurance_plans]state is NULL, create an upload file where the [qt_tyre_rim_insurance_plans]state field is empty (i.e. do not include the text 'NULL')
Use Import data to a table to upload the file to correct the data.

Quotes / Lease - Lease Inclusion Plans - the Inclusion is visible, but the check box is disabled

The quote's "Effective Date" must be on or after the date stored in [qt_inclusion_plans]effective_date.