PatchQuote - Lease tab

PatchQuote Budgets and Profiles

Each budget can be updated using patchQuote, listed in separate sections below.

If budget does not need changes, leave related bracket out of API.

If budget being removed, only identifier field needs to be passed.

If budget being added or modified, Mandatory column marked 'Yes' for required fields.

Profiles Exc. GST

Maintenance (MAINT)

Include when updating quote's Contracts / Lease Maintenance (MAINT) profile. Visit Maintenance (MAINT) profile page for calculation rules.

Field	Format	Notes	Mandatory
maintenance_service	string	Include to update Maintenance profile	Yes
included_flag	string	yes to add, no to remove	Yes
maintenance_service_profile_id	string	Override default (if profiled). Use getMaintenanceServiceProfiles API to obtain list	No
service_mths	number	Override default Interval Months	No
service_kms	number	Override default Interval KMs	No
monthly_amount_net	number	Override calculated value	No

Tyres (T)

Include when updating quote's Contracts / Lease Tyres (T) profile. Visit Tyres (T) profile page for calculation rules.

Field	Format	Notes	Mandatory
tyres	string	Include to update Tyres profile	Yes
included_flag	string	yes to add, no to remove	Yes
tyre_id	string	Override default (if profiled). Use GetTyres API to obtain list	No
tyres_per_set	number	Override default value	No
tyre_km_interval	number	Override default value	No
unit_cost_net	number	Override default value	No
limit_flag	string	yes or no (default: no). Report only, not used in calculations	No
tyres_estimated	number	Override default value	No
monthly_amount_net	number	Override calculated value	No

Carbon Emissions Offset (CEO)

Include when updating quote's Contracts / Lease Carbon Emissions Offset profile. Visit Carbon Emissions Offset profile page for calculation rules.

Field	Format	Notes	Mandatory
carbon_emissions_offset	string	Include to update CEO profile	Yes
included_flag	string	yes to add/recalculate, no to remove	Yes

Fuel (F)

Include when updating quote's Contracts / Lease Fuel profile. Visit Fuel profile page for calculation rules.

Field	Format	Notes	Mandatory
litres_per_100km	number	Include to update Fuel profile	Yes
included_flag	string	yes to add/recalculate, no to remove	Yes
fuel_type_id	string	Use getFuelTypes if cannot be system calculated. Fuel Types stored on Variants screen	No
cost_per_litre	number	If cannot be system calculated, include here. Linked to Fuel Type	No
usage_type	string	System calculated from Global Control qt_fuel_usage. Values: metro, country, combined. Case sensitive	No
monthly_amount_net	number	Override system calculation	No

Comprehensive Insurance (INS)

Include when updating quote's Contracts / Lease Comprehensive Insurance profile. Visit Comprehensive Insurance profile page for calculation rules.

Core Insurance Fields

Field	Format	Notes	Mandatory
insurance	string	Include to update Insurance profile	Yes
included_flag	string	yes to add, no to remove	Yes
supplier_id	string	Adds Insurer. Mandatory if Policy Owner cannot link to stored rates, along with annual_insurance or monthly_amount_net	Maybe
insurance_type_id	string	Stored in qt_variant_profiles. Factor in insurance premium calculation. Lookup on Insurance Types	No
billing_type	string	Defaults to Monthly. Can use Reimbursement or Excluded	No
claim_excess	number	Defaults from stored rates. Can be overwritten	No
lock_comprehensive_insurance_flag	string	Lock Annual Insurance. Defaults to no	No
annual_insurance	number	Override system calculation. If both annual_insurance and monthly_amount_net included, monthly_amount_net ignored	No
fund_1st_year_flag	string	Out of scope. Leave blank or set to no	No
monthly_amount_net	number	Override system calculation. Ignored if annual_insurance also included	No

Policy Owner & Location Fields

Field	Format	Notes	Mandatory
policy_owner_type	string	insurer_internal, client, or driver. Default from Clients / Quote Defaults if recorded	No
insurer_location_id	string	When stored rates found for Policy Owner. Use getInsurerLocations API. One of location_id or postcode required	No
insurer_location_postcode	string	When stored rates found for Policy Owner. One of location_id or postcode required	No

Report Only Fields

Field	Format	Notes	Mandatory
insurance_loss_licence_flag	string	Report only. Does not impact calculation. yes or no	No
insurance_at_fault_flag	string	Triggers adjustment to Insurance Premium. Refer Global Controls insurance_at_fault_rate	No
insurance_conviction_flag	string	Report only. Does not impact calculation. yes or no	No

Insurance Loading Types

Include one, two or three loading types as applicable. List obtained via getInsuranceLoadingTypes API.

Field	Format	Notes	Mandatory
insurance_loading_types	string	Include loading types in nested braces	No
past_claims	string	Include relevant loading code	No
licence	string	Include relevant loading code	No
driver_restriction	string	Include relevant loading code	No

Insurance Recalculation Logic

patchQuote always attempts to recalculate Insurance budget except:

If lock_comprehensive_insurance_flag = yes
If patchQuote payload contains lock_comprehensive_insurance_flag = yes
If recalculation resolves to $0.00 annual premium and quote already contains Annual Premium (existing used)

In all other cases, validation rules enforced and may result in error:

{ "validation_messages": { "insurance": { "annual_insurance": { "invalidAmount": "Annual insurance must be greater than 0.00" } } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Registration & CTP (REG/CTP)

Include when updating quote's Contracts / Lease Registration (REG/CTP) profile. Visit Registration (REG/CTP) profile page for calculation rules.

Field	Format	Notes	Mandatory
reg_ctp	string	Include to update Registration & CTP profile	Yes
included_flag	string	yes to add/recalculate, no to remove	Yes
annual_reg	number	Override system calculated value	No
annual_ctp	number	Override system calculated value	No
annual_plates	number	Override system calculated value	No
renewals	number	Override system calculated value	No
monthly_amount_net	number	Override system calculated value	No

Roadside Assistance (RSA)

Include when updating quote's Contracts / Lease Roadside Assistance (RSA) profile. Visit Roadside Assistance (RSA) profile page for calculation rules.

Field	Format	Notes	Mandatory
roadside_assistance	string	Include to update RSA profile	Yes
included_flag	string	yes to add/recalculate, no to remove	Yes
roadside_assistance_plan_id	string	Override default RSA Supplier. See getRoadsideAssistancePlans	No
premium	number	Override system calculated value	No
cost	number	Override system calculated value	No
monthly_amount_net	number	Override system calculated value. If both premium and monthly_amount_net included, monthly_amount_net ignored	No
after_hours_assistance_flag	string	Updates After Hours Assistance checkbox	No

Small Damage Repairs (SDR)

When changing Term on quote via patchQuote, Contract Term used to update SDR premium term (months). If no match found, use next match rounding up. Example: Quote Term = 40, use = 48 record.

Field	Format	Notes	Mandatory
included_flag	string	yes to add, no to remove. See Small Damage Repairs (SDR) for default behaviour	Yes
small_damage_repairs_id	string	Linked to Years listbox. Can override default	No
premium	number	Can override default	No
monthly_amount_net	string	Can override default if GB Control small_damage_repairs_type = userdefined	No

Loan Termination Insurance (LTI)

Include when updating quote's Contracts / Lease Loan Termination Insurance (LTI) profile. Visit LTI profile page for calculation rules.

Field	Format	Notes	Mandatory
lti	string	Include to update LTI profile	Yes
included_flag	string	yes to add, no to remove	Yes
lti_topup_benefit_id	string	Add Top Up Benefit ID. Visit LTI profile or PatchQuote Supporting APIs for more	Yes
retail_price_gross	string	Override system calculation	No

Vehicle Maintenance Program (VMP)

Include when updating quote's Contracts / Lease Maintenance Program profile. Visit Maintenance Program profile page for calculation rules.

Field	Format	Notes	Mandatory
vehicle_maintenance_program	string	Include to update VMP profile	Yes
included_flag	string	yes to add, no to remove	Yes
monthly_amount_net	string	Override system calculation	No

Inclusions

Excess KM Charge

Note: This section not available via patchQuote yet.

Redundancy Insurance

Field	Format	Notes	Mandatory
included_flag	string	yes to add, no to remove	Yes

Walkaway (WALK)

Field	Format	Notes	Mandatory
included_flag	string	yes to add, no to remove	Yes
walkaway_plan_id	string	Override default behaviour. See getWalkawayPlans	No

Tyre and Rim Insurance (T&R)

Field	Format	Notes	Mandatory
included_flag	string	yes to add, no to remove	Yes
tyre_rim_insurance_plan_id	string	Override default behaviour. See getTyreRimInsurancePlans	No

Lease Inclusion Plans

Include when updating one or more Quotes / Lease > Lease Inclusion Plans. Expressed as array [] for multiple plans. Each plan passed as separate bracket {} within array [].

Example structure:

"inclusion_plans": [ { "inclusion_code": "INCL_CODE1", "inclusion_plan_code": "INCL_PLAN1", "included_flag": "yes" }, { "inclusion_code": "INCL_CODE2", "inclusion_plan_code": "INCL_PLAN2", "included_flag": "yes" } ]

Lease Inclusion Plans Fields

Field	Format	Notes	Mandatory
inclusion_plans	string	Header expressed as array []. Multiple plans with separate braces {}	Yes
inclusion_code	string	Include Inclusion Code. Optional if inclusion_plan_code_qualified used	Maybe
inclusion_plan_code	string	Required only if inclusion_code passed and multiple active plans. Not required if only one active plan with inclusion_plan_code_qualified	Maybe
inclusion_plan_code_qualified	string	Use to target specific qualified record. If inclusion_code and/or inclusion_plan_code also passed with conflict, this ignored. Effective date validations not run with this	Maybe
included_flag	string	yes to add, no to remove	No
retail_price_gross	string	Override system calculated Retail price. Used only if corresponding included_flag = yes	No

Lease Inclusion Plans Rules

Input rules for:

Default Lease Inclusion Plans
Excluding selected Lease Inclusion Plans
Pricing of Plans

Found on Lease Inclusion Plans page. All rules and logic applied to patchQuote functionality.