Overview
Configuration rating outputs define the fields that display rating engine results (e.g., annual rate, monthly rate). All rating output fields use the entity namerating_engine_display and are stored in company_fields with an association in company_entity_fields.
Each rating output field automatically gets a smart tag created with the naming convention AII{key}PrimaryInsured, enabling the field’s output to be referenced in policy and quote documents.
Key Concepts
- fieldDefinition: A JSON object defining the field’s type (
className), unique key, data path, and optional properties like label and display flag - className: Currently restricted to
InputField(the only type used for rating outputs) - Smart tag: Always auto-created with name
AII{key}PrimaryInsuredand categories["policy", "quote"]. The field key must be alphanumeric. - displayNeeded: Whether this field appears in rating output display tables
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /configuration/rating/outputs | Create a new rating output field |
Permissions
| Action | Permission |
|---|---|
| Create field | company:update |
Field Definition Properties
| Property | Type | Required | Description |
|---|---|---|---|
| className | string | Yes | Field type: InputField |
| key | string | Yes | Unique field key (cannot be companyId; must be alphanumeric) |
| path | string | Yes | Dot-notation path for the field value in entity 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 |
| displayNeeded | boolean | No | Whether this field is displayed in rating output tables |