Get Proposal Field Metadata

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Returns field metadata for building insurance proposal forms without requiring an existing Proposal record. This is the "extended" version of /api/MetaData/ProposalFields that lets you simulate a hypothetical proposal by providing key parameters instead of a ProposalID

Key Difference from api/MetaData/ProposalFields:

  • ProposalFields: Requires existing proposalId - loads real proposal context from database
  • ProposalFieldsEx: No database record needed - creates in-memory proposal from parameters you provide

Important: This endpoint creates an in-memory proposal only - no database record is created or modified. It's purely for metadata retrieval.

Use Case

This endpoint is useful when you need to know "What fields would appear IF a user selected these options?" before committing to creating a proposal record. Common scenarios:

  • Preview forms during insurance program/carrier selection
  • Template-based form generation
  • "Configure before create" workflows
  • Dynamic form previews based on user selections

Use ProposalFieldsEx when:

  • ✅ Building a multi-step wizard where proposal isn't created until the final step
  • ✅ You need to preview fields BEFORE creating a proposal record
  • ✅ Showing "what fields will I need to fill?" based on carrier/program/state selection
  • ✅ Template or form builder applications
  • ✅ You don't have a ProposalID yet

Use ProposalFields instead when:

  • ❌ You already have an existing Proposal record (use proposalId)
  • ❌ Editing an in-progress quote
  • ❌ You need access to proposal-specific calculated fields or history
Query Params
integer
required

The ID of the rating company/carrier. Determines carrier-specific form fields and validations.

integer
required

The ID of the insurance program. Identifies the product/program being quoted, which determines available policy lines and rate structures.

date-time
required

The policy effective date. Affects form definitions, rating rules, and carrier availability.
Format: YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss

integer

The jurisdiction state ID. If provided, returns state-specific fields and validations. If omitted, returns generic (non-state-specific) fields only.

string

The Line of Business code (e.g., "WC" for Workers Comp, "GL" for General Liability, "CA" for Commercial Auto). This determines which LOB-specific form fields are returned. Different policy lines have different field sets.

string

Comma-separated list of specific fields to return. If omitted, returns all applicable fields. Example: "Premium,Deductible,RetroDate"

boolean

Exclude fields that are never applicable from the metadata result.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json