patchQuote: Inclusion Rules by Contract Type
Overview
The patchQuote API has been enhanced to enforce Inclusion eligibility rules based on the Contract Type configuration. This enhancement ensures that Inclusion products configured as Unavailable or Preselected behave consistently whenever a quote is updated through the API. See Set Lease Inclusions by Contract Type.
The new logic applies when:
An Inclusion is explicitly added to a quote via the API.
A Contract Type change is submitted through the patchQuote API.
Unavailable Inclusions Are Now Blocked
If an API request attempts to add an Inclusion that has been configured as Unavailable for the quote's current Contract Type, the request will be rejected.
The message reads: "Inclusion '<name>' is not available for this Contract Type".
Outcome
The API returns a 422 Unprocessable Entity response.
The quote is not modified.
The validation cannot be bypassed using
override_warnings_flag.
Contract Type Changes Automatically Remove Invalid Inclusions
When a Contract Type is changed through the patchQuote API, Catch-e evaluates all existing Inclusion products on the quote against the rules configured for the new Contract Type.
Any Inclusion configured as Unavailable for the new Contract Type is automatically removed from the quote.
Outcome
Invalid Inclusions are removed automatically.
No validation error is returned.
Audit records are created for each removal.
Preselected Inclusions Can Be Added Automatically
When a Contract Type change occurs, Catch-e identifies any Inclusion products configured as Preselected for the new Contract Type.
Where a Preselected Inclusion has exactly one available plan, the system automatically adds the Inclusion to the quote.
Inactive and suspended Inclusions are not added automatically.
During a Contract Type change, an active Preselected Inclusion with exactly one plan is added even if the request excludes it. Outside a Contract Type change, an exclusion in the request is honoured.
Outcome
Active Preselected Inclusions are added automatically.
Existing quote Inclusions are not duplicated.
Audit records are created for automatic additions.
Contract Type Changes May Be Blocked
A Contract Type change cannot proceed if a required preselected Inclusion has multiple available plans and the system cannot determine which plan should be applied automatically.
The plan count includes every active plan for the Inclusion, regardless of the quote's term or vehicle value. The message key is preselectedInclusionMultiplePlansForContractType, and the message ends "...before changing the Contract Type."
Outcome
The API returns a 422 Unprocessable Entity response.
The Contract Type change is not applied.
No Inclusion additions or removals occur.
The response identifies the Inclusion requiring plan selection.
Adding Inclusions
To add an Inclusion, send inclusion_plan_code_qualified with included_flag. The inclusion_code_generated and financed_flag fields returned by getQuote aren't accepted as input.
Important Processing Rule
Before any Contract Type change is applied, Catch-e first checks whether any Preselected Inclusions have multiple available plans. If any are found, the entire update is stopped before any quote changes are made. This ensures the Contract Type update is processed as an all-or-nothing transaction.
Was this helpful?
More in Update Quote Endpoints
PatchQuotePatchQuote - Options TabPatchQuoteEventListStill need help? Ask the team