Overview

Configuration rating fields define the input fields that feed data into the rating engine. Each field has a definition specifying its type, key, display label, and optional configuration like select options or display conditions. Fields are associated with an entity type (e.g., “policies”, “dealership”) and a rating engine revision. These endpoints manage rating input fields only. Entity fields (events, insureds, policies) are managed through /configuration/fields endpoints.

Key Concepts

fieldDefinition: A JSON object defining the field’s type (className), unique key, data path, and optional properties like label, section, and display conditions
entityType: The rating entity type the field applies to — can be policies or any exposure type (e.g., dealership, company)
ratingEngineRevisionId: The rating engine revision this field belongs to — must already exist
revisionStrategy: Controls how the revision is updated — UpdateExistingRevision modifies the specified revision in place. CreateNewRevision is not yet implemented.
className: The field type — AddressField, DateField, GroupField, InputField, LocalCurrency, MultiSelectField, SelectField, or StaticField
rank: UI rendering order within the entity type — lower values render first, null renders last. Returned on list responses. Set via PUT /configuration/rating/fields/rank; not set on creation. Not used as the list endpoint’s sort key.

API Endpoints

Method	Endpoint	Description
GET	`/configuration/rating/fields`	List rating input fields
POST	`/configuration/rating/fields`	Create a new rating input field
DELETE	`/configuration/rating/fields/{fieldId}`	Delete a rating input field
PUT	`/configuration/rating/fields/rank`	Reorder rating input fields within an entity type

Permissions

Action	Permission
List fields	`company:read`
Create field	`company:update`
Delete field	`company:update`
Reorder fields	`company:update`

Field Definition Properties

Property	Type	Required	Description
className	string	Yes	Field type: `AddressField`, `DateField`, `GroupField`, `InputField`, `LocalCurrency`, `MultiSelectField`, `SelectField`, `StaticField`
key	string	Yes	Unique field key (cannot be `companyId`)
path	string	Yes	Dot-notation path for the field value in rating data
label	string	No	Human-readable label
section	string	No	UI section grouping
required	boolean	No	Whether the field is required
fields	object	No	Sub-field configuration (e.g., select options)
displayCondition	string \| boolean \| object	No	Condition controlling when the field is displayed. Create accepts a string; list responses may also return a boolean or structured conditional object.
displayConditions	object	No	Multiple display conditions
value	string \| object	No	Default value. Create accepts a string; list responses may also return a structured value reference (e.g., path-based lookup).

Getting Started

Submissions

Quotes

Assignees

Notes

Events

Brokerages

Brokers

Payees

Transaction Categories

Event Financials

Policies

Exposures

Attorneys

Lawsuits

Defendants

Configuration Fields

Configuration Rating Fields

Configuration Rating Outputs

Configuration Rating Presets

Configuration Rating Form Logic

Configuration Presets

Exposure Types

Coverage Types

Smart Tags

Address

Reference

Overview

Overview

Key Concepts

API Endpoints

Permissions

Field Definition Properties

​Overview

​Key Concepts

​API Endpoints

​Permissions

​Field Definition Properties

Overview

Key Concepts

API Endpoints

Permissions

Field Definition Properties