Get Proposal Schedule Field Metadata

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

Overview

Returns field metadata for schedule (repeating data) domains within an insurance proposal. Schedules represent repeatable items that are quoted or rated, such as locations, vehicles, buildings, drivers, or equipment.

What is a Schedule? A schedule is a collection of similar items that need to be individually tracked within a proposal. Think of it as a "sub-table" or "child records" attached to the proposal:

  • Location Schedule: Multiple insured locations (addresses, building values, etc.)
  • Vehicle Schedule: Multiple vehicles in a commercial auto policy
  • Driver Schedule: Multiple drivers covered by the policy
  • Building Schedule: Multiple buildings at a location
  • Equipment Schedule: Tools, machinery, or specialized equipment

Each schedule item has its own fields for tracking item-specific data (VIN numbers, addresses, equipment serial numbers, values, etc.).

Key Concept:

Proposal (quote)
  └─ Commercial Auto (LOB)
       ├─ Auto Liability (coverage)
       ├─ Auto Physical Damage (coverage)
       └─ Schedule Data:
            ├─ Location Schedule (repeating) ← This endpoint
            │    ├─ Location #1: 123 Main St
            │    ├─ Location #2: 456 Oak Ave
            │    └─ Location #3: 789 Elm Blvd
            │
            └─ Vehicle Schedule (repeating) ← This endpoint
                 ├─ Vehicle #1: 2020 Ford F-150
                 ├─ Vehicle #2: 2021 Chevy Silverado
                 └─ Vehicle #3: 2019 Toyota Camry

When to Use This Endpoint

Use ProposalScheduleFields when:

  • ✅ Building forms for schedule data (locations, vehicles, buildings, drivers, equipment)
  • ✅ You need metadata for repeatable items within a proposal
  • ✅ Working with schedule domains (not base proposal or coverage domains)
  • ✅ Building grids/tables where each row is a schedule item

Do NOT use this endpoint for:

  • ❌ Base proposal-level fields (use /api/MetaData/ProposalFields)
  • ❌ Coverage-specific fields like limits and deductibles (use /api/MetaData/ProposalCoverageFields)
  • ❌ One-time fields (those belong on the proposal or coverage level)
Query Params
integer
required

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

string
required

The schedule domain name (e.g., "LocationSchedule", "VehicleSchedule", "BuildingSchedule", "DriverSchedule"). This identifies which type of schedule for which you are retrieving metadata.

string

The Line of Business code (e.g., "CA" for Commercial Auto, "WC" for Workers Comp). If provided, returns LOB-specific schedule fields. If omitted, returns generic schedule fields.

integer

For state-specific schedules (e.g., Location schedules may have state-specific fields). If provided, returns state-specific fields and validations.

integer

For child schedules (e.g., Vehicle Schedule is a child of Location Schedule). Provide the parent schedule item's ID (e.g., LocationID) to get context-specific metadata for child items.

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