Validate Pricing Setup (POST)

Validate pricing configuration, including transaction type resolution, procedure plan existence and effective dates, pricing procedure versions, and the context definition.

Use this resource at design time to confirm that pricing infrastructure is correctly configured before quote execution or product rating. Provide an optional quote ID, transaction type, and product IDs. The API validates procedure plans, pricing procedures, effective dates, and context definitions for the specified transaction.

When quoteId or transactionType is provided, quote-level checks confirm that the transaction type is valid and resolvable; that a quote-level procedure plan is defined; that procedure plan effective dates cover the quote’s date range; that the quote-level pricing procedure has an active version for the evaluation date; and that the procedure plan’s context definition is a valid Insurance context.

When productIds is provided, product-level checks confirm that a product-level procedure plan is defined for each product, that the product-level pricing procedure has an active version for the evaluation date, and that the product procedure plan’s context definition is a valid Insurance context.

When pricing setup is valid, isValid is true. When setup fails, isValid is false and errors lists the failures. Pricing setup failures are returned in the response body with HTTP status 200. Examples include:

  • SF-INS-DSAV-00062 — the transaction type isn’t valid or couldn’t be resolved.
  • SF-INS-DSAV-00063 — no quote-level procedure plan is defined for the transaction type.
  • SF-INS-DSAV-00064 — procedure plan effective dates aren’t valid for the request.
  • SF-INS-DSAV-00066 — no product-level procedure plan is defined for a submitted product.
  • SF-INS-DSAV-00067 — the quote-level pricing procedure doesn’t have an active version for the evaluation date.
  • SF-INS-DSAV-00068 — the product-level pricing procedure doesn’t have an active version for the evaluation date.

Insufficient access, or Digital Insurance not enabled for the org, returns INSUFFICIENT_ACCESS with HTTP status 403. An unexpected failure returns INTERNAL_SERVER_ERROR with HTTP status 500.

Resource 

1/connect/insurance/design-advisor/pricing-setup-validation

Resource Example 

Replace {yourInstance} with the My Domain name of your Salesforce org.

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/design-advisor/pricing-setup-validation

Available Version 

68.0

HTTP Methods 

POST

Request Body for POST 

JSON Example 

1{
2  "quoteId": "0Q0xx0000006iPnAAI",
3  "productIds": ["01txx0000006iPnAAI", "01txx0000006iPmAAI"]
4}

Properties 

Provide at least one of quoteId, transactionType, or productIds for meaningful validation. If none are provided, the API returns isValid as true with no errors.

NameTypeDescriptionRequired or OptionalAvailable Version
productIdsString[]List of Product2 record IDs to validate for product-level procedure plan configuration.Optional68.0
quoteIdStringQuote record ID. When provided, the quote’s transaction type and date context are used for quote-level validation.Optional68.0
transactionTypeStringTransaction type developer name. Used for quote-level validation when quoteId isn’t provided, or to override the quote’s transaction type.Optional68.0

Response Body for POST 

Insurance Pricing Setup Validation Response