Get Proposal-Level Coverage Field Metadata

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

Overview

Returns field metadata for coverage-specific fields within an insurance proposal. While /api/MetaData/ProposalFields returns LOB-level fields (Workers Comp fields, Auto fields, etc.), this endpoint returns metadata for individual coverages within those lines of business.

What is a ProposalCoverage? A ProposalCoverage represents one specific insurance coverage within a proposal. For example:

  • Within Workers Comp LOB: Employers Liability coverage
  • Within Commercial Auto LOB: Auto Liability coverage, Auto Physical Damage coverage, Hired Auto coverage
  • Within Commercial Property LOB: Building coverage, Business Personal Property coverage

Each coverage has its own set of fields for limits, deductibles, premiums, and coverage-specific options.

Key Concept:

Proposal (quote)
  ├─ Workers Comp (LOB)
  │    ├─ WC Employers Liability (coverage) ← This endpoint
  │    └─ WC Statutory (coverage) ← This endpoint
  │
  └─ Commercial Auto (LOB)
       ├─ Auto Liability (coverage) ← This endpoint
       ├─ Auto Physical Damage (coverage) ← This endpoint
       └─ Hired Auto (coverage) ← This endpoint

When to Use This Endpoint

Use ProposalCoverageFields when:

  • ✅ Building forms for specific coverages within a proposal (not the proposal itself)
  • ✅ You need metadata for coverage-level fields: Limit, Deductible, Premium, EffectiveDate, ExpiryDate
  • ✅ Working with the ProposalCoverage domain
  • ✅ Building multi-coverage forms where each coverage has different options

Do NOT use this endpoint for:

  • ❌ Base proposal-level fields (use /api/MetaData/ProposalFields)
  • ❌ LOB-specific proposal fields like Workers Comp payroll or Auto fleet info (use /api/MetaData/ProposalFields)
  • ❌ Schedule data (locations, vehicles, etc.) - those have separate endpoints
Query Params
integer
required

The existing Proposal record ID. Must be a real proposal - cannot simulate with hypothetical data.

string
required

The coverage display code (e.g., "APD" for Auto Physical Damage, "GL" for General Liability, "CFBLDG" for Commercial Property Building). This identifies which specific coverage within the proposal for which you are retrieving metadata.

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