Data Lake Table Index
This page provides an index of the tables available in the Socotra Data Lake.
The order of fields shown in this table index is for reference only and may differ from the order in the underlying Data Lake schema or Delta Files. The exact schema may also vary between the Data Lake and Delta Files. To view the authoritative schema, connect directly to the Data Lake using your provided credentials or download the createTableFile provided by the Delta Files API.
Index of Tables
Policy Service Entity Tables
- accounts
- account_data_extensions
- quotes
- quote_elements
- quote_data_extensions
- quote_element_tree
- quote_element_charges
- quote_coverage_terms
- quote_element_underwriting_flags
- policies
- terms
- transactions
- affected_transactions
- segments
- policy_data_extensions
- policy_segment_elements
- policy_element_tree
- policy_element_charges
- policy_coverage_terms
- policy_element_underwriting_flags
- policy_auto_renewals
- policy_transaction_change_instructions
- policy_preferences
- policy_status
Billing Service Entity Tables
- installments
- installment_items
- invoices
- invoice_items
- payments
- payment_data_extensions
- disbursements
- disbursement_data_extensions
- delinquencies
- delinquency_references
- billing_holds
- write_offs
- credit_items
- credit_distributions
- ledger_accounts
- ledger_account_line_items
- fa_transactions
- fa_transaction_account_lines
- installment_settings
Claims Service Entity Tables
Work Management Service Entity Tables
Producer Management Service Entity Tables
Auxiliary Data Service Entity Tables
Moratoriums Entity Tables
Policy Service Entity Tables
accounts Table
See the Accounts API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the account (ULID) |
| account_state | varchar(32) | no | Current state of the account |
| billing_level | varchar(50) | no | Level at which billing within the account takes place. Value may be policy or account |
| type | varchar(128) | no | The account type per the tenant configuration |
| region | varchar(128) | yes | The region assigned to the account (if any) |
| auto_renewal_plan_name | varchar(128) | yes | Name of the account's auto-renewal plan (if any) |
| delinquency_plan_name | varchar(128) | yes | Name of the account's delinquency plan (if any) |
| excess_credit_plan_name | varchar(128) | yes | Name of the account's excess credit plan (if any) |
| shortfall_tolerance_plan_name | varchar(128) | yes | Name of the account's shortfall tolerance plan (if any) |
| account_number | varchar(128) | yes | The custom number assigned to the account (if any) |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
account_data_extensions Table
See the Accounts API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| account_locator | char(26) | no | (PK) Identifier of the account the data is associated with (UULD) |
| field_name_md5 | char(32) | no | (PK) The MD5 hash of the field_name |
| field_name | varchar(4096) | no | The key name of the extension data field |
| field_value | varchar(1024) | yes | The value of the extensions data field |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
quotes Table
See the Quotes API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the quote (UULD) |
| account_locator | char(26) | no | Unique identifier of the quote's parent account (UULD) |
| group_locator | char(26) | yes | Unique identifier of the group the quote belongs to, if any (UULD) |
| product_name | varchar(128) | yes | The name of the configured product the quote is based on |
| quote_state | varchar(50) | no | The state in which the quote currently resides |
| billing_level | varchar(50) | no | Level at which billing within the account takes place policy or account |
| policy_locator | char(26) | yes | The identifier of the resultant policy (if quote has been issued) |
| quick_quote_locator | char(26) | yes | The identifier of the originating quick quote (if any) |
| region | varchar(128) | yes | The region assigned to the quote (if any) |
| jurisdiction | varchar(128) | yes | The jurisdiction assigned to the quote (if any) |
| producer_code | varchar(128) | yes | The producer code assigned to the quote (if any) |
| auto_renewal_plan_name | varchar(128) | yes | Name of the quote's auto-renewal plan (if any) |
| delinquency_plan_name | varchar(128) | yes | Name of the quote's delinquency plan (if any) |
| issued_time_utc | datetime(6) | yes | Timestamp the quote was issued |
| start_time_utc | datetime(6) | yes | Timestamp quote is effective as of |
| end_time_utc | datetime(6) | yes | Timestamp quote coverage ends |
| accepted_time_utc | datetime(6) | yes | Timestamp the quote was moved to the accepted state |
| created_at_utc | datetime(6) | no | Timestamp the quote was created |
| created_by | char(36) | no | The identifier of the user that created the quote |
| currency | varchar(128) | yes | Currency the quote was written in |
| duration | decimal(19,15) | yes | The number of units of duration_basis the quote spans |
| duration_basis | varchar(32) | yes | The units of time that the duration of the quote is expressed in |
| timezone | varchar(128) | yes | The timezone the quote was written in |
| expiration_time_utc | datetime(6) | yes | The timestamp after which the quote can no longer be accepted or issued |
| underwriting_status | varchar(50) | yes | The outcome of the underwriting process (if completed) |
| quote_number | varchar(128) | yes | The custom number assigned to the quote (if any) |
| invoice_fee_amount | decimal(19,3) | yes | Amount of the quote's invoice fee (if any) |
| anonymized_time_utc | datetime(6) | yes | Time in UTC the quote was anonymized |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
quote_data_extensions Table
See the Quotes API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| quote_locator | char(26) | no | Identifier of the quote the element data is associated with (ULID) |
| element_locator | char(26) | no | (PK) Identifier of the element the data is associated with (ULID) |
| element_category | varchar(128) | yes | The category the element type is based on |
| element_type | varchar(128) | no | The configured type the element is based on |
| is_static | bool | no | (PK) Whether the data is static or not |
| field_name_md5 | char(32) | no | (PK) The MD5 hash of the field_name |
| field_name | varchar(4096) | no | The key name of the extension data field |
| field_value | varchar(1024) | yes | The value of the extensions data field |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
quote_elements Table
See the Quotes API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the quote element (ULID) |
| quote_locator | char(26) | no | Identifier of the quote the element is associated with (ULID) |
| parent_locator | char(26) | yes | Identifier of the parent element immediately above in the quotes data hierarchy |
| category | varchar(128) | yes | The category the element type is based on |
| type | varchar(128) | no | The configured type the element is based on |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
quote_element_tree Table
See the Quotes API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| quote_locator | char(26) | no | Identifier of the quote the element is associated with (ULID) |
| parent_locator | char(26) | no | Identifier of the element immediately above in the quote's data hierarchy (ULID) |
| child_locator | char(26) | no | Identifier of an element immediately below in the quote's data hierarchy (ULID) |
| depth | int | no | The number of levels of child elements below in the quote's data hierarchy |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
quote_element_charges Table
See the Quotes API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the quote charge (ULID) |
| account_locator | char(26) | no | Identifier of the account the charge is associated with (ULID) |
| quote_locator | char(26) | no | Identifier of the quote the charge is associated with (ULID) |
| product_name | varchar(128) | no | The name of the configured product the quote is based on |
| element_locator | char(26) | no | Identifier of the element the charge is directly associated with (ULID) |
| element_category | varchar(128) | yes | The category the element type is based on |
| element_type | varchar(128) | no | The configured type the element is based on |
| start_time_utc | datetime(6) | no | Start of the period covered by the charge |
| end_time_utc | datetime(6) | no | End of the period covered by the charge |
| duration | decimal(19,15) | yes | The number of units of duration_basis the charge spans |
| duration_basis | varchar(32) | yes | The units of time that the duration of the quote is expressed in |
| charge_category | varchar(128) | no | The category the charge type is based on |
| charge_type | varchar(128) | no | The configured type the charge is based on |
| amount | decimal(19,3) | no | The amount of the charge |
| rate | decimal(19,10) | no | Rate describes the amount per unit time (rate * duration = amount) |
| reference_rate | decimal(19,10) | no | The reference rate for the charge returned in the rater (if any) |
| invoicing | varchar(128) | no | Indicates how the system invoices the charge according to its charge_type, with possible values listed as invoicing in ChargeRef |
| handling | varchar(128) | no | Indicates how the system handles the charge according to its charge_type, with possible values listed as handling in ChargeRef |
| tag | varchar(128) | yes | The tag for the charge returned in the rater (if any) |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
quote_coverage_terms Table
See the Quotes API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| quote_locator | char(26) | no | Identifier of the quote the coverage term is associated with (ULID) |
| element_locator | char(26) | no | (PK) Identifier of the element the coverage term is associated with (ULID) |
| element_category | varchar(128) | yes | The category the associated element type is based on |
| element_type | varchar(128) | no | The configured type the associated element is based on |
| name_md5 | char(32) | no | (PK) The MD5 hash of the name |
| name | varchar(1024) | no | The configured name of the coverage term |
| option | varchar(1024) | no | The selected option or value of the coverage term |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
quote_element_underwriting_flags Table
See the Quotes API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the underwriting flag for the quote element (ULID) |
| quote_locator | char(26) | no | Identifier of the quote the underwriting flag is associated with (ULID) |
| element_locator | char(26) | yes | Identifier of the quote element the underwriting flag is associated with (ULID) |
| element_category | varchar(128) | yes | The category the associated element type is based on |
| element_type | varchar(128) | yes | The configured type the associated element is based on |
| level | varchar(128) | no | The level of the underwriting flag, with possible values listed as level in UnderwritingFlagResponse |
| task_locator | char(26) | yes | Identifier of the task associated with the underwriting flag (ULID) |
| note | varchar(1024) | yes | The custom note associated with the underwriting flag |
| created_by | char(36) | yes | Identifier of the user that created the underwriting flag (UUID) |
| created_time_utc | datetime(6) | no | Time in UTC the underwriting flag was created |
| cleared_by | char(36) | yes | Identifier of the user that cleared the underwriting flag (UUID) |
| cleared_time_utc | datetime(6) | yes | Time in UTC the underwriting flag was cleared |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
policies Table
See the Policies API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the policy (ULID) |
| account_locator | char(26) | no | Identifier of the account the policy is associated with (ULID) |
| issued_transaction_locator | char(26) | no | Identifier of the transaction that issued the policy (ULID) |
| latest_term_locator | char(26) | no | Identifier of the latest term for the policy (ULID) |
| latest_segment_locator | char(26) | yes | Identifier of the latest segment for the policy (ULID) |
| product_name | varchar(128) | no | Name of the product associated with the policy |
| start_time_utc | datetime(6) | no | Time in UTC the policy goes into effect |
| end_time_utc | datetime(6) | no | Time in UTC the policy is no longer effective |
| coverage_end_time_utc | datetime(6) | yes | Time in UTC the policy coverage ends |
| currency | varchar(128) | yes | Currency the policy was written in |
| duration_basis | varchar(32) | yes | The units of time that the duration of the policy is expressed in |
| timezone | varchar(128) | yes | The timezone the policy was written in |
| billing_level | varchar(50) | no | Level at which billing for the policy takes place. Value may be policy or account |
| created_time_utc | datetime(6) | no | Time in UTC the policy was created |
| created_by | char(36) | no | Identifier of the user that created the policy (UUID) |
| region | varchar(128) | yes | The region assigned to the policy (if any) |
| jurisdiction | varchar(128) | yes | The jurisdiction assigned to the policy (if any) |
| auto_renewal_plan_name | varchar(128) | yes | Name of the policy's auto-renewal plan (if any) |
| delinquency_plan_name | varchar(128) | yes | Name of the policy's delinquency plan (if any) |
| invoice_fee_amount | decimal(19,3) | yes | Amount of the policy's invoice fee (if any) |
| policy_number | varchar(128) | yes | The custom number assigned to the policy (if any) |
| anonymized_time_utc | datetime(6) | yes | Time in UTC the policy was anonymized |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
terms Table
See the Policy Terms API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the term (UUID) |
| static_locator | char(26) | no | Static identifier of the term that persists across changes (ULID) |
| policy_locator | char(26) | no | Identifier of the policy the term is associated with (ULID) |
| originating_transaction_locator | char(26) | no | Identifier of the transaction the term is associated with (ULID) |
| start_time_utc | datetime(6) | no | Time in UTC the term is effective |
| end_time_utc | datetime(6) | no | Time in UTC the term is no longer effective |
| number | int(11) | no | Sequential number of the term within the policy |
| auto_renewal_locator | char(26) | yes | Identifier of the auto-renewal associated with the term (ULID), if any |
| previous_term_locator | char(26) | yes | Identifier of the term that preceded this term (ULID), if any |
| supersedes_term_locator | char(26) | yes | Identifier of the term that this term supersedes (ULID), if any |
| term_number | varchar(128) | yes | The custom number assigned to the term, if any |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
transactions Table
See the Policy Transactions API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the transaction (ULID) |
| policy_locator | char(26) | no | Identifier of the policy the transaction is associated with (ULID) |
| term_locator | char(26) | no | Identifier of the term the transaction is associated with (ULID) |
| effective_time_utc | datetime(6) | no | Time in UTC the transaction becomes effective |
| transaction_state | varchar(50) | no | Current state of the transaction |
| category | varchar(50) | no | Category of the transaction |
| type | varchar(128) | no | The configured type of the transaction |
| created_by | char(36) | no | Identifier of the user that created the transaction (UUID) |
| created_time_utc | datetime(6) | no | Time in UTC the transaction was created |
| aggregate_transaction_locator | char(26) | yes | Identifier of the aggregate transaction this transaction is part of (ULID), if any |
| base_transaction_locator | char(26) | yes | Identifier of the transaction this transaction is derived from (ULID), if any |
| reapplication_of_locator | char(26) | yes | Identifier of the transaction this transaction is a reapplication of (ULID), if any |
| static_locator | char(26) | yes | Static identifier of the transaction that persists across changes (ULID) |
| issued_time_utc | datetime(6) | yes | Time in UTC the transaction was issued |
| accepted_time_utc | datetime(6) | yes | Time in UTC the transaction was accepted |
| underwriting_status | varchar(50) | yes | The outcome of the underwriting process (if completed) |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
affected_transactions Table
See the Policy Transactions API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| transaction_locator | char(26) | no | (PK) Unique identifier of the affecting transaction (ULID) |
| affected_transaction_locator | char(26) | no | (PK) Unique identifier of the affected transaction (ULID) |
| action | varchar(50) | no | Action taken by the affecting transaction onto the affected transaction. Value may be reversed or invalidated |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
segments Table
See the Policy Transactions API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the segment (ULID) |
| policy_locator | char(26) | no | Identifier of the policy the segment is associated with (ULID) |
| transaction_locator | char(26) | no | Identifier of the transaction that created the segment (ULID) |
| term_locator | char(26) | no | Identifier of the term the segment is associated with (ULID) |
| start_time_utc | datetime(6) | no | Time in UTC the segment begins |
| end_time_utc | datetime(6) | no | Time in UTC the segment ends |
| duration | decimal(19,15) | no | The number of units of duration_basis the segment spans |
| duration_basis | varchar(32) | yes | The units of time that the duration of the segment is expressed in |
| type | varchar(50) | no | The type of segment |
| based_on | char(26) | yes | Identifier of the segment this segment is based on (ULID), if any |
| producer_code | varchar(128) | yes | The producer code assigned to the segment (if any) |
| producer_code_of_record | varchar(128) | yes | The producer code of record assigned to the segment (if any) |
| anonymized_time_utc | datetime(6) | yes | Time in UTC the segment was anonymized |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
policy_data_extensions Table
See the Policies API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| policy_locator | char(26) | no | Identifier of the policy the element data is associated with (ULID) |
| transaction_locator | char(26) | no | Identifier of the transaction the element data is associated with (ULID) |
| segment_locator | char(26) | no | Identifier of the segment the element data is associated with (ULID) |
| segment_element_locator | char(26) | no | (PK) Identifier of the element the data is associated with (ULID) |
| element_category | varchar(128) | yes | The category the element type is based on |
| element_type | varchar(128) | no | The configured type the element is based on |
| is_static | bool | no | (PK) Whether the data is static or not |
| field_name_md5 | char(32) | no | (PK) The MD5 hash of the field_name |
| field_name | varchar(4096) | no | The key name of the extension data field |
| field_value | varchar(1024) | yes | The value of the extensions data field |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
policy_segment_elements Table
See the Policy Transactions API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the segment element (UUID) |
| policy_locator | char(26) | no | Identifier of the policy the segment element is associated with (ULID) |
| transaction_locator | char(26) | no | Identifier of the transaction the segment element is associated with (ULID) |
| segment_locator | char(26) | no | Identifier of the segment the element is associated with (ULID) |
| parent_locator | char(26) | yes | Identifier of the parent element immediately above in the policy data hierarchy (ULID) |
| static_locator | char(26) | no | Static identifier of the segment element that persists across changes (ULID) |
| category | varchar(128) | yes | The element category the element type is based on |
| type | varchar(128) | no | The configured type the element is based on |
| original_effective_time_utc | datetime(6) | yes | Time in UTC of the original effective date of the segment element |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
policy_element_tree Table
See the Policy Transactions API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| policy_locator | char(26) | no | Identifier of the policy the element tree is associated with (ULID) |
| transaction_locator | char(26) | no | Identifier of the transaction the element tree is associated with (ULID) |
| segment_locator | char(26) | no | (PK) Identifier of the segment the element tree is associated with (ULID) |
| parent_locator | char(26) | no | (PK) Identifier of the element immediately above in the policy's data hierarchy (ULID) |
| child_locator | char(26) | no | (PK) Identifier of an element immediately below in the policy's data hierarchy (ULID) |
| depth | int | no | The number of levels of child elements below in the policy's data hierarchy |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
policy_element_charges Table
See the Policy Transactions API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the charge (ULID) |
| account_locator | char(26) | no | Identifier of the account the charge is associated with (ULID) |
| policy_locator | char(26) | no | Identifier of the policy the charge is associated with (ULID) |
| transaction_locator | char(26) | no | Identifier of the transaction the charge is associated with (ULID) |
| segment_locator | char(26) | no | Identifier of the segment the charge is associated with (ULID) |
| product_name | varchar(128) | no | The name of the configured product the policy is based on |
| segment_element_locator | char(26) | no | Identifier of the segment element the charge is directly associated with (ULID) |
| element_static_locator | char(26) | yes | Static identifier of the element that persists across changes (ULID) |
| element_category | varchar(128) | yes | The category the element type is based on |
| element_type | varchar(128) | no | The configured type the element is based on |
| start_time_utc | datetime(6) | no | Time in UTC the period covered by the charge begins |
| end_time_utc | datetime(6) | no | Time in UTC the period covered by the charge ends |
| duration | decimal(19,15) | yes | The number of units of duration_basis the charge spans |
| duration_basis | varchar(32) | yes | The units of time that the duration of the charge is expressed in |
| charge_category | varchar(128) | no | The category the charge type is based on |
| charge_type | varchar(128) | no | The configured type the charge is based on |
| amount | decimal(19,3) | no | The amount of the charge |
| rate | decimal(19,10) | no | Rate describes the amount per unit time (rate * duration = amount) |
| reference_rate | decimal(19,10) | no | The reference rate for the charge returned in the rater (if any) |
| rate_difference | decimal(19,10) | no | The difference between the rate and reference rate (if any) |
| reversal_of_locator | char(26) | yes | Identifier of the charge reversed by this charge (if any) |
| tag | varchar(128) | yes | The tag for the charge returned in the rater (if any) |
| invoicing | varchar(128) | no | Indicates how the system invoices the charge according to its charge_type, with possible values listed as invoicing in ChargeRef |
| handling | varchar(128) | no | Indicates how the system handles the charge according to its charge_type, with possible values listed as handling in ChargeRef |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
policy_coverage_terms Table
See the Policy Transactions API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| policy_locator | char(26) | no | Identifier of the policy the element data is associated with (ULID) |
| transaction_locator | char(26) | no | Identifier of the transaction the element data is associated with (ULID) |
| segment_locator | char(26) | no | Identifier of the segment the element data is associated with (ULID) |
| segment_element_locator | char(26) | no | (PK) Identifier of the element the coverage term is associated with (ULID) |
| element_category | varchar(128) | yes | The category the associated element type is based on |
| element_type | varchar(128) | no | The configured type the associated element is based on |
| name_md5 | char(32) | no | (PK) The MD5 hash of the name |
| name | varchar(1024) | no | The configured name of the coverage term |
| option | varchar(1024) | no | The selected option or value of the coverage term |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
policy_element_underwriting_flags Table
See the Policy Transactions API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the underwriting flag (ULID) |
| policy_locator | char(26) | no | Identifier of the policy the underwriting flag is associated with (ULID) |
| transaction_locator | char(26) | no | Identifier of the transaction the underwriting flag is associated with (ULID) |
| segment_locator | char(26) | yes | Identifier of the segment the underwriting flag is associated with (ULID) |
| segment_element_locator | char(26) | yes | Identifier of the policy element the underwriting flag is associated with (ULID) |
| element_category | varchar(128) | yes | The category the associated element type is based on |
| element_type | varchar(128) | yes | The configured type the associated element is based on |
| level | varchar(128) | no | The level of the underwriting flag |
| note | varchar(1024) | yes | The custom note associated with the underwriting flag |
| task_locator | char(26) | yes | Identifier of the task associated with the underwriting flag (ULID) |
| created_by | char(36) | yes | Identifier of the user that created the underwriting flag (UUID) |
| created_time_utc | datetime(6) | no | Time in UTC the underwriting flag was created |
| cleared_by | char(36) | yes | Identifier of the user that cleared the underwriting flag (UUID) |
| cleared_time_utc | datetime(6) | yes | Time in UTC the underwriting flag was cleared |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
policy_auto_renewals Table
See the Policy Auto-Renewal API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the policy auto-renewal (ULID) |
| term_locator | char(26) | no | Identifier of the term the auto-renewal is associated with (ULID) |
| policy_locator | char(26) | no | Identifier of the policy the auto-renewal is associated with (ULID) |
| state | varchar(50) | no | Current state of the auto-renewal |
| renewal_transaction_type | varchar(128) | no | The configured type of the renewal transaction |
| renewal_transaction_locator | char(26) | yes | Identifier of the renewal transaction (ULID), if created |
| new_term_duration | int(11) | yes | Duration of the new term in units of the policy's duration_basis, if specified |
| renewal_transaction_create_time_utc | datetime(6) | no | Time in UTC scheduled for the renewal transaction creation |
| renewal_transaction_created_time_utc | datetime(6) | yes | Time in UTC the renewal transaction was created |
| renewal_transaction_accept_time_utc | datetime(6) | yes | Time in UTC scheduled for the renewal transaction acceptance |
| renewal_transaction_accepted_time_utc | datetime(6) | yes | Time in UTC the renewal transaction was accepted |
| renewal_transaction_issue_time_utc | datetime(6) | yes | Time in UTC scheduled for the renewal transaction issuance |
| renewal_transaction_issued_time_utc | datetime(6) | yes | Time in UTC the renewal transaction was issued |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
policy_transaction_change_instructions Table
See the Policy Transactions API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the change instruction (ULID) |
| policy_locator | char(26) | no | Identifier of the policy the change instruction is associated with (ULID) |
| transaction_locator | char(26) | no | Identifier of the transaction the change instruction is associated with (ULID) |
| action | varchar(50) | no | The action to be performed by the change instruction |
| data | longtext | yes | Structured data defining the change instruction details |
| effective_time_utc | datetime(6) | yes | Time in UTC the change instruction becomes effective |
| static_locator | char(26) | yes | Static identifier of the element the change instruction applies to (ULID), if applicable |
| new_policy_end_time_utc | datetime(6) | yes | Time in UTC the policy ends, if the change instruction modifies it |
| trigger_billing_change | bool | yes | Indicates whether the change instruction should trigger billing changes |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
policy_preferences Table
See the Policy Transactions API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| policy_locator | char(26) | no | Identifier of the policy the preferences are associated with (ULID) |
| transaction_locator | char(26) | no | (PK) Identifier of the transaction the preferences are associated with (ULID) |
| billing_plan_name | varchar(128) | yes | Name of the billing plan assigned to the policy, if any |
| billing_level | varchar(128) | yes | Level at which billing for the policy takes place (policy or account) |
| installment_weights | varchar(1024) | yes | Custom weights for installment amounts, if specified |
| installment_plan_name | varchar(128) | yes | Name of the installment plan assigned to the policy, if any |
| anchor_mode | varchar(128) | yes | Mode for anchoring installment generation timing |
| anchor_time_utc | datetime(6) | yes | Time in UTC to anchor installment generation, if applicable |
| anchor_type | varchar(128) | yes | Type of anchor for installment generation timing |
| cadence | varchar(128) | yes | Frequency of installment generation (e.g., monthly, quarterly) |
| day_of_month | varchar(128) | yes | Day of the month for installment generation, if applicable |
| day_of_week | varchar(128) | yes | Day of the week for installment generation, if applicable |
| due_lead_days | varchar(128) | yes | Number of days before due date that invoices are generated |
| generate_lead_days | varchar(128) | yes | Number of days in advance to generate installments |
| max_installments_per_term | int | yes | Maximum number of installments allowed per term, if specified |
| week_of_month | varchar(128) | yes | Week of the month for installment generation, if applicable |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
policy_status Table
This table contains one record per policy. Each record represents the current status of that policy. Multiple status fields may be true for a given policy.
See the Policy Status guide for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| policy_locator | char(26) | no | (PK) Identifier of the policy the status record corresponds to (ULID) |
| on_risk | tinyint(1) | no | Indicates if the policy is in a status of onRisk |
| pending | tinyint(1) | no | Indicates if the policy is in a status of pending |
| expired | tinyint(1) | no | Indicates if the policy is in a status of expired |
| cancelled | tinyint(1) | no | Indicates if the policy is in a status of cancelled |
| cancel_pending | tinyint(1) | no | Indicates if the policy is in a status of cancelPending |
| delinquent | tinyint(1) | no | Indicates if the policy is in a status of delinquent |
| do_not_renew | tinyint(1) | no | Indicates if the policy is in a status of doNotRenew |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
Billing Service Entity Tables
installments Table
See the Installments API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the installment (ULID) |
| account_locator | char(26) | no | Identifier of the account the installment is associated with (ULID) |
| due_time_utc | datetime(6) | no | Time in UTC the installment payment is due |
| generate_time_utc | datetime(6) | no | Time in UTC the installment was generated |
| autopay_time_utc | datetime(6) | yes | Time in UTC the installment payment execution will be triggered |
| currency | varchar(128) | no | Currency of the installment |
| timezone | varchar(128) | no | Timezone in which the installment was generated |
| coverage_duration | decimal(19,3) | no | Duration of coverage represented by the installment |
| coverage_start_time_utc | datetime(6) | no | Time in UTC when coverage for the installment begins |
| coverage_end_time_utc | datetime(6) | no | Time in UTC when coverage for the installment ends |
| installment_duration | decimal(19,3) | no | Duration of the installment period |
| installment_start_time_utc | datetime(6) | no | Time in UTC when the installment period begins |
| installment_end_time_utc | datetime(6) | no | Time in UTC when the installment period ends |
| installment_frame_index | int(11) | no | Index of the installment within the billing frame sequence |
| installment_lattice_locator | char(26) | no | Identifier of the installment lattice that this installment corresponds from |
| installment_settings_locator | char(26) | yes | Identifier of the installment settings locator that applies to this installment |
| reversal_of_locator | char(26) | yes | Identifier of the installment that this installment is a reversal of, if applicable |
| migrated_from_locator | char(26) | yes | Identifier of the installment that this installment was migrated from, in the case of a billing mode change |
| enhanced_by_plugin | tinyint(1) | yes | Indicates if this installment was enhanced by the Installment Plugin or follows default installment settings |
| created_by | char(36) | no | Identifier of the user that created the installment (UUID) |
| created_at_utc | datetime(6) | no | Time in UTC the installment was created |
| updated_by | char(36) | no | Identifier of the user that last updated the installment (UUID) |
| updated_at_utc | datetime(6) | no | Time in UTC the installment was last updated |
| invoice_locator | char(26) | yes | Identifier of the invoice the installment is associated with (ULID), if any |
| policy_locator | char(26) | yes | Identifier of the policy the installment is associated with (ULID), if any |
| term_locator | char(26) | yes | Identifier of the term the installment is associated with (ULID), if any |
| quote_locator | char(26) | yes | Identifier of the quote the installment is associated with (ULID), if any |
| transaction_locator | char(26) | yes | Identifier of the transaction that triggered the installment (ULID), if any |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
installment_items Table
See the Installments API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the installment item (ULID) |
| installment_locator | char(26) | no | Identifier of the installment the installment item is associated with (ULID) |
| charge_locator | char(26) | no | Identifier of the charge the installment item is associated with (ULID) |
| segment_element_locator | char(26) | no | Identifier of the segment element the installment item is associated with (ULID) |
| charge_category | varchar(128) | no | Category of the associated charge |
| charge_type | varchar(128) | no | Type of the associated charge |
| amount | decimal(19,3) | no | Amount of the installment item |
| created_time_utc | datetime(6) | no | Time in UTC the installment item was created |
| created_by | char(36) | yes | Identifier of the user that created the installment item (UUID) |
| element_static_locator | char(26) | no | Static identifier of the associated segment element (ULID) |
| invoice_item_locator | char(26) | yes | Identifier of the associated invoice item (ULID), if any |
| reversal_of_locator | char(26) | yes | Identifier of the installment item reversed by this installment item (ULID), if any |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
invoices Table
See the Invoices API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the invoice (ULID) |
| account_locator | char(26) | no | Identifier of the account the invoice is associated with (ULID) |
| start_time_utc | datetime(6) | no | Time in UTC when the invoice period begins |
| end_time_utc | datetime(6) | no | Time in UTC when the invoice period ends |
| due_time_utc | datetime(6) | no | Time in UTC when the invoice is due |
| generated_time_utc | datetime(6) | no | Time in UTC the invoice was generated |
| currency | varchar(128) | no | Currency of the invoice |
| timezone | varchar(128) | no | Timezone in which the invoice was generated |
| invoice_state | varchar(50) | no | Current state of the invoice |
| invoice_number | varchar(128) | yes | The custom number assigned to the invoice, if any |
| total_amount | decimal(19,3) | yes | Total amount of the invoice |
| total_remaining_amount | decimal(19,3) | yes | Remaining unpaid amount of the invoice |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
invoice_items Table
See the Invoices API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the invoice item (ULID) |
| invoice_locator | char(26) | no | Identifier of the invoice the item is associated with (ULID) |
| timezone | varchar(128) | no | Timezone for the invoice item |
| amount | decimal(19,3) | yes | Amount of the invoice item |
| charge_category | varchar(128) | no | Category of the associated charge |
| charge_type | varchar(128) | no | Configured type of the associated charge |
| policy_locator | char(26) | yes | Identifier of the policy the invoice item is associated with (ULID), if any |
| quote_locator | char(26) | yes | Identifier of the quote the invoice item is associated with (ULID), if any |
| element_static_locator | char(26) | yes | Static identifier of the element associated with the invoice item (ULID), if any |
| remaining_amount | decimal(19,3) | yes | Remaining unpaid amount of the invoice item |
| settlement_time_utc | datetime(6) | yes | Time in UTC when the invoice item was fully settled |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
payments Table
See the Payments API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the payment (UUID) |
| currency | varchar(128) | no | Currency of the payment |
| payment_state | varchar(30) | no | Current state of the payment |
| amount | decimal(19,3) | yes | Amount of the payment |
| type | varchar(128) | no | The configured type of the payment |
| created_by | char(36) | no | Identifier of the user that created the payment (UUID) |
| created_at_utc | datetime(6) | no | Time in UTC the payment was created |
| account_locator | char(26) | yes | Identifier of the account the payment is associated with (ULID), if any |
| ext_cash_trx_locator | char(26) | yes | Identifier of the external cash transaction (ULID), if any |
| posted_at_utc | datetime(6) | yes | Time in UTC the payment was posted |
| remaining_amount | decimal(19,3) | yes | Remaining unapplied amount of the payment |
| reversal_reason | varchar(1024) | yes | Reason for the payment reversal, if reversed |
| reversed_at_utc | datetime(6) | yes | Time in UTC the payment was reversed |
| reversed_by | char(36) | yes | Identifier of the user who reversed the payment (UUID) |
| aggregate_payment_locator | char(26) | yes | Identifier of the aggregate payment this payment belongs to (ULID), if any |
| payment_mode | varchar(128) | yes | Indicates the mode of the payment (e.g., normal, aggregate) |
| retry_plan_name | varchar(128) | yes | Name of the payment execution retry plan associated with the payment, if any |
| next_request_time_utc | datetime(6) | yes | Time in UTC the next payment request will be attempted |
| payment_number | varchar(128) | yes | The custom number assigned to the payment (if any) |
| anonymized_time_utc | datetime(6) | yes | Time in UTC the payment was anonymized |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
payment_data_extensions Table
See the Payments API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| payment_locator | char(26) | no | (PK) Identifier of the payment the extension data is associated with (ULID) |
| field_name_md5 | char(32) | no | (PK) The MD5 hash of the field_name |
| field_name | varchar(4096) | no | The key name of the extension data field |
| field_value | varchar(1024) | yes | The value of the extensions data field |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
disbursements Table
See the Disbursements API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the disbursement (UUID) |
| currency | varchar(128) | no | Currency of the disbursement |
| disbursement_state | varchar(30) | no | Current state of the disbursement |
| amount | decimal(19,3) | yes | Amount of the disbursement |
| type | varchar(128) | no | The configured type of the disbursement |
| created_by | char(36) | no | Identifier of the user that created the disbursement (UUID) |
| created_at_utc | datetime(6) | no | Time in UTC the disbursement was created |
| account_locator | char(26) | yes | Identifier of the account the disbursement is associated with (ULID), if any |
| ext_cash_trx_locator | char(26) | yes | Identifier of the external cash transaction (ULID), if any |
| disbursement_number | varchar(128) | yes | The custom number assigned to the disbursement (if any) |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
disbursement_data_extensions Table
See the Disbursements API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| disbursement_locator | char(26) | no | (PK) Identifier of the disbursement the extension data is associated with (ULID) |
| field_name_md5 | char(32) | no | (PK) The MD5 hash of the field_name |
| field_name | varchar(4096) | no | The key name of the extension data field |
| field_value | varchar(1024) | yes | The value of the extensions data field |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
delinquencies Table
See the Delinquency API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the delinquency (ULID) |
| account_locator | char(26) | no | Identifier of the account the delinquency is associated with (ULID) |
| timezone | varchar(128) | no | Timezone for the delinquency |
| delinquency_state | varchar(52) | no | Current state of the delinquency |
| advance_lapse_to | varchar(128) | no | The state to which the system should automatically advance the lapse transaction |
| grace_period_days | int(11) | no | Number of days in the grace period before lapse |
| lapse_transaction_type | varchar(128) | no | The configured type of lapse transaction to be created |
| delinquency_level | varchar(128) | yes | Level at which the delinquency is applied. Value may be policy or invoice |
| created_at_utc | datetime(6) | no | Time in UTC the delinquency was created |
| updated_at_utc | datetime(6) | no | Time in UTC the delinquency was last updated |
| grace_end_at_utc | datetime(6) | yes | Time in UTC when the grace period ends |
| grace_started_at_utc | datetime(6) | yes | Time in UTC when the grace period started |
| lapse_transaction_effective_date_utc | datetime(6) | yes | Effective date in UTC for the lapse transaction, if applicable |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
delinquency_references Table
This table contains multiple records per delinquency. Each record represents a relationship between a delinquency and another entity, such as a policy or invoice.
See the Delinquency API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the delinquency reference (ULID) |
| delinquency_locator | char(26) | no | Identifier of the delinquency that the referenced entity is associated with (ULID) |
| reference_locator | char(26) | no | Identifier of the reference, with referenced entity defined by reference_type (ULID) |
| reference_type | varchar(128) | no | Reference type of the delinquency reference, with possible values listed as referenceType in DelinquencyReference |
| transaction_locator | char(26) | yes | Identifier of the lapse transaction associated with this delinquency reference |
| preempting_lapse_transaction_locator | char(26) | yes | Identifier of the lapse transaction associated with another delinquency reference that preempts this one |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
billing_holds Table
See the Billing Holds API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the billing hold (ULID) |
| account_locator | char(26) | no | Identifier of the account the billing hold is associated with (ULID) |
| hold_state | varchar(50) | no | Current state of the billing hold |
| target_type | varchar(50) | no | The type of entity the billing hold applies to |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
write_offs Table
See the Write-Offs API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the write-off (ULID) |
| account_locator | char(26) | no | Identifier of the account the write-off is associated with (ULID) |
| currency | varchar(128) | no | Currency of the write-off |
| write_off_state | varchar(30) | no | Current state of the write-off |
| amount | decimal(19,3) | no | Amount of the write-off |
| credit_type | varchar(128) | no | Type of credit associated with the write-off |
| created_by | char(36) | no | Identifier of the user that created the write-off (UUID) |
| created_at_utc | datetime(6) | no | Time in UTC the write-off was created |
| reversal_reason | varchar(1024) | yes | Reason for the write-off reversal, if reversed |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
credit_items Table
See the Credits API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| credit_locator | char(26) | no | (PK) Identifier of the associated credit (ULID), with referenced entity defined by credit_type |
| credit_type | varchar(128) | no | Type of the associated credit, with possible values listed as creditType in CreditResponse |
| container_locator | char(26) | no | (PK) Identifier of the associated source or target container (ULID), with referenced entity defined by container_type |
| container_type | varchar(128) | no | (PK) Type of the associated container, with possible values listed as containerType in CreditItem |
| amount | decimal(19,3) | yes | Amount of the credit item |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
credit_distributions Table
See the Credit Distribution API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the credit distribution (ULID) |
| account_locator | char(26) | no | Identifier of the associated account (ULID) |
| currency | varchar(128) | no | Currency of the credit distribution |
| credit_distribution_state | varchar(30) | no | State in which the credit distribution currently resides, with possible values listed as creditDistributionState in CreditDistributionResponse |
| amount | decimal(19,3) | no | Amount of the credit distribution |
| created_time_utc | datetime(6) | no | Time in UTC the credit distribution was created |
| created_by | char(36) | yes | Identifier of the user that created the credit distribution (UUID) |
| execution_time_utc | datetime(6) | yes | Time in UTC the credit distribution was executed |
| reversal_reason | varchar(1024) | yes | Reason for the credit distribution reversal |
| reversal_time_utc | datetime(6) | yes | Time in UTC the credit distribution was reversed |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
ledger_accounts Table
See the Accounting API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| reference_type | char(68) | no | (PK) Reference type of the ledger account balance, with possible values listed as referenceType in LedgerAccountResponse |
| reference_locator | char(26) | no | (PK) Identifier of the reference, with referenced entity defined by reference_type (ULID) |
| currency | varchar(128) | no | (PK) Currency of the ledger account balance |
| balance | decimal(19,3) | no | Balance of the ledger account |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
ledger_account_line_items Table
See the Accounting API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| reference_type | char(68) | no | (PK) Reference type of the ledger account line item, with possible values listed as referenceType in LedgerAccountResponse |
| reference_locator | char(26) | no | (PK) Identifier of the reference, with referenced entity defined by reference_type (ULID) |
| ordering_number | int(11) | no | (PK) Ordering number of the ledger account line item |
| fa_transaction_locator | char(26) | no | Unique identifier of the financial accounting transaction (ULID) |
| fa_transaction_time_utc | datetime(6) | no | Time in UTC the financial accounting transaction was created |
| fa_transaction_note | varchar(128) | yes | Note associated with the financial accounting transaction |
| accounting_type | varchar(10) | no | Indicates the accounting side of the entry (debit or credit) |
| amount | decimal(19,3) | no | Amount of the ledger account line item |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
fa_transactions Table
See the Accounting API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the financial accounting transaction (ULID) |
| transaction_time_utc | datetime(6) | no | Time in UTC the financial accounting transaction was created |
| transaction_note | varchar(128) | yes | Note associated with the financial accounting transaction |
| currency | varchar(128) | no | Currency of the financial accounting transaction |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
fa_transaction_account_lines Table
See the Accounting API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| fa_transaction_locator | char(26) | no | (PK) Unique identifier of the financial accounting transaction (ULID) |
| ordering_number | int(11) | no | (PK) Ordering number of the financial accounting transaction account line |
| reference_type | char(68) | no | Reference type of the financial accounting transaction account line, with possible values listed as referenceType in LedgerAccountResponse |
| reference_locator | char(26) | no | Identifier of the reference, with referenced entity defined by reference_type (ULID) |
| accounting_type | varchar(10) | no | Indicates the accounting side of the entry (debit or credit) |
| amount | decimal(19,3) | no | Amount of the financial accounting transaction account line |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
installment_settings Table
See the Installment Lattices API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the installment settings (UUID) |
| installment_weights | varchar(1024) | yes | Custom weights for installment amounts, if specified |
| anchor_mode | varchar(128) | no | Mode for anchoring installment generation timing |
| anchor_time_utc | datetime(6) | yes | Time in UTC to anchor installment generation, if applicable |
| anchor_type | varchar(128) | yes | Type of anchor for installment generation timing |
| cadence | varchar(128) | no | Frequency of installment generation (e.g., monthly, quarterly) |
| day_of_month | varchar(128) | yes | Day of the month for installment generation, if applicable |
| day_of_week | varchar(128) | yes | Day of the week for installment generation, if applicable |
| week_of_month | varchar(128) | yes | Week of the month for installment generation, if applicable |
| due_lead_days | varchar(128) | no | Number of days before due date that invoices are generated |
| generate_lead_days | varchar(128) | no | Number of days in advance to generate installments |
| autopay_lead_days | varchar(128) | yes | Number of days in advance of the due date to trigger autopay for an invoice |
| max_installments_per_term | int(11) | yes | Maximum number of installments allowed per term, if specified |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
Claims Service Entity Tables
fnols Table
See the FNOL API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the first notice of loss or FNOL (UUID) |
| type | varchar(128) | no | The configured type of the FNOL |
| fnol_state | varchar(128) | no | Current state of the FNOL |
| account_locator | char(26) | yes | Identifier of the account the FNOL is associated with (ULID), if any |
| policy_locator | char(26) | yes | Identifier of the policy the FNOL is associated with (ULID), if any |
| segment_locator | char(26) | yes | Identifier of the segment the FNOL is associated with (ULID), if any |
| region | varchar(128) | yes | The region assigned to the FNOL, if any |
| fnol_number | varchar(128) | yes | The custom number assigned to the FNOL, if any |
| created_by | char(36) | no | Identifier of the user that created the FNOL (UUID) |
| created_at_utc | datetime(6) | no | Time in UTC the FNOL was created |
| updated_by | char(36) | yes | Identifier of the user that last updated the FNOL (UUID) |
| updated_at_utc | datetime(6) | yes | Time in UTC the FNOL was last updated |
| incident_time_utc | datetime(6) | yes | Time in UTC when the incident occurred |
| incident_timezone | varchar(126) | yes | Timezone in which the incident occurred |
| incident_summary | longtext | yes | Summary description of the incident |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
fnol_data_extensions Table
See the FNOL API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| fnol_locator | char(26) | no | (PK) Identifier of the FNOL the extension data is associated with (ULID) |
| field_name_md5 | char(32) | no | (PK) The MD5 hash of the field_name |
| field_name | varchar(4096) | no | The key name of the extension data field |
| field_value | varchar(1024) | yes | The value of the extensions data field |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
claims Table
See the FNOL API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the claim (ULID) |
| type | varchar(128) | no | The configured type of the claim |
| fnol_locator | char(26) | yes | Identifier of the FNOL the claim is associated with (ULID) |
| created_by | char(36) | no | Identifier of the user that created the claim (UUID) |
| created_at_utc | datetime(6) | no | Time in UTC the claim was created |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
claim_data_extensions Table
See the FNOL API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| claim_locator | char(26) | no | (PK) Identifier of the claim the extension data is associated with (ULID) |
| field_name_md5 | char(32) | no | (PK) The MD5 hash of the field_name |
| field_name | varchar(4096) | no | The key name of the extension data field |
| field_value | varchar(1024) | yes | The value of the extensions data field |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
Work Management Service Entity Tables
tasks Table
See the Work Management API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the task (ULID) |
| task_category | varchar(128) | no | The configured category of the task |
| task_type | varchar(128) | no | The configured type of the task |
| task_state | varchar(128) | no | Current state of the task |
| description | varchar(2048) | yes | The description of the task, if any |
| task_number | varchar(128) | yes | The custom number assigned to the task, if any |
| deadline_time_utc | datetime(6) | yes | Time in UTC of the task deadline |
| assigned_to | char(36) | yes | Identifier of the user that the task is assigned to (UUID) |
| completed_by | char(36) | yes | Identifier of the user that completed the task (UUID) |
| completed_time_utc | datetime(6) | yes | Time in UTC the task was completed |
| created_by | char(36) | no | Identifier of the user that created the task (UUID) |
| created_time_utc | datetime(6) | no | Time in UTC the task was created |
| updated_by | char(36) | yes | Identifier of the user that last updated the task (UUID) |
| updated_time_utc | datetime(6) | yes | Time in UTC the task was last updated |
| deadline_time_utc | datetime(6) | yes | Time in UTC of the task deadline |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | yes | Time in UTC the record was last updated |
task_references Table
See the Work Management API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| task_locator | char(26) | no | (PK) Identifier of the task associated with the referenced entity (ULID) |
| reference_locator | char(26) | no | (PK) Identifier of the entity associated with the task, with referenced entity defined by reference_type (ULID) |
| reference_type | varchar(128) | no | (PK) Type of the associated entity, with possible values listed as referenceType in TaskReference |
| underwriting_flag_entity_type | varchar(128) | yes | If reference_type = underwritingFlag, this indicates whether the flag is associated with a quote or policy |
| deleted | tinyint(1) | no | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
user_qualifications Table
See the Work Management API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| user_locator | char(26) | no | (PK) Unique identifier of the user (UUID) |
| qualification_category | varchar(64) | no | (PK) The configured category of the qualification level assigned to the user |
| qualification_level | varchar(64) | no | (PK) The qualification level assigned to the user |
| deleted | tinyint(1) | no | Time in UTC the claim was created |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
user_associations Table
See the Work Management API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Identifier of the user association record (ULID) |
| user_locator | char(36) | no | Identifier of the user given the association (UUID) |
| user_association_role | varchar(128) | no | The role given to the user as part of the association |
| user_association_state | varchar(4096) | no | The current state of the user association |
| reference_locator | char(26) | no | Identifier of the entity that is part of the association, with referenced entity defined by reference_type (ULID) |
| reference_type | varchar(128) | no | (PK) Type of the associated entity, with possible values listed as referenceType in UserAssociation |
| underwriting_flag_entity_type | varchar(128) | yes | If reference_type = underwritingFlag, this indicates whether the flag is associated with a quote or policy |
| created_by | char(36) | no | Identifier of the user that created the user association (UUID) |
| created_time_utc | datetime(6) | no | Time in UTC the user association was created |
| updated_by | char(36) | yes | Identifier of the user that last updated the user association (UUID) |
| updated_time_utc | datetime(6) | yes | Time in UTC the user association was last updated |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
Producer Management Service Entity Tables
producers Table
See the Producer Management API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the producer (ULID) |
| producer_state | varchar(50) | no | Current state of the producer |
| producer_type | varchar(50) | no | The configured type of the producer |
| parent_locator | char(26) | yes | Identifier of the producer's parent producer (ULID), if any |
| created_by | char(36) | no | Identifier of the user that created the producer (UUID) |
| created_time_utc | datetime(6) | no | Time in UTC the producer was created |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
producer_data_extensions Table
See the Producer Management API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| producer_locator | char(26) | no | (PK) Identifier of the producer the data is associated with (ULID) |
| producer_type | varchar(50) | no | The configured type of the producer |
| field_name_md5 | char(32) | no | (PK) The MD5 hash of the field_name |
| field_name | varchar(4096) | no | The key name of the extension data field |
| field_value | varchar(1024) | yes | The value of the extension data field |
| deleted | tinyint(1) | no | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
producer_hierarchy Table
See the Producer Management API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| parent_locator | char(26) | no | (PK) Identifier of the parent producer in the hierarchy (ULID) |
| child_locator | char(26) | no | (PK) Identifier of the child producer in the hierarchy (ULID) |
| depth | int(11) | no | The number of levels between the parent and child producers in the hierarchy |
| deleted | tinyint(1) | no | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
producer_codes Table
See the Producer Management API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Unique identifier of the producer code (ULID) |
| producer_locator | char(26) | no | Identifier of the producer the producer code is associated with (ULID) |
| producer_code_state | varchar(30) | no | Current state of the producer code |
| producer_code_type | varchar(50) | no | The configured type of the producer code |
| producer_code | varchar(128) | yes | The code value assigned to the producer code (if any) |
| created_by | char(36) | no | Identifier of the user that created the producer code (UUID) |
| created_time_utc | datetime(6) | no | Time in UTC the producer code was created |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
producer_code_data_extensions Table
See the Producer Management API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| producer_code_locator | char(26) | no | (PK) Identifier of the producer code the data is associated with (ULID) |
| producer_code_type | varchar(50) | no | The configured type of the producer code |
| producer_code | varchar(128) | yes | The code value assigned to the producer code (if any) |
| field_name_md5 | char(32) | no | (PK) The MD5 hash of the field_name |
| field_name | varchar(4096) | no | The key name of the extension data field |
| field_value | varchar(1024) | yes | The value of the extension data field |
| deleted | tinyint(1) | no | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
Auxiliary Data Service Entity Tables
aux_data Table
See the Aux Data API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | varchar(64) | no | (PK) User-defined identifier for grouping auxiliary data keys (e.g., an entity locator or global) |
| key_name | varchar(126) | no | (PK) Name of the auxiliary data key, unique within the given locator |
| var_value | longtext | no | Value assigned to the auxiliary data key, stored as text |
| ui_type | varchar(64) | no | Indicates how the auxiliary data should appear in the UI; value may be normal, readonly, or hidden |
| created_time_utc | datetime(6) | no | Time in UTC the auxiliary data was created |
| updated_time_utc | datetime(6) | no | Time in UTC the auxiliary data was last updated |
| updated_by | char(36) | yes | Identifier of the user who created the auxiliary data (UUID) |
| expiration_time_utc | datetime(6) | yes | Time in UTC the auxiliary data expires |
| aux_data_settings_name | varchar(128) | yes | Name of the settings that apply to the auxiliary data |
| deleted | tinyint(1) | yes | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
diaries Table
See the Diary API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| locator | char(26) | no | (PK) Identifier of the diary entry |
| reference_locator | varchar(64) | no | Identifier of the entity that is associated with the diary entry, with referenced entity defined by reference_type (ULID) |
| reference_type | varchar(32) | no | Type of the associated entity, with possible values listed as referenceType in DiaryEntryResponse |
| underwriting_flag_entity_type | varchar(128) | yes | If reference_type = underwritingFlag, this indicates whether the flag is associated with a quote or policy |
| diary_state | varchar(50) | no | Current state of the diary, with possible values listed as diaryState in DiaryEntryResponse |
| diary_category | varchar(256) | yes | An optional category that can be given to a diary entry |
| contents | longtext | no | Contents of the diary entry, stored as text |
| created_by | char(36) | no | Identifier of the user that created the diary entry (UUID) |
| created_time_utc | datetime(6) | no | Time in UTC the diary entry was created |
| updated_by | char(36) | yes | Identifier of the user that last updated the diary entry (UUID) |
| updated_time_utc | datetime(6) | yes | Time in UTC the diary entry was last updated |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
Moratoriums Entity Tables
moratoriums Table
See the Moratoriums API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| moratorium_name | varchar(128) | no | (PK) Unique name of the moratorium |
| moratorium_type | varchar(128) | no | The type of the moratorium |
| description | varchar(512) | yes | The description of the moratorium |
| application_mode | varchar(128) | no | Indicates whether the moratorium applies to all eligible policies or whether there is an option to opt in or out. Value may be mandatory, optIn, or optOut |
| effective_time_utc | datetime(6) | no | Time in UTC the moratorium takes effect |
| end_time_utc | datetime(6) | yes | Time in UTC the moratorium ends |
| is_effective_time_waived | tinyint(1) | yes | Indicates whether eligible policies issued after the moratorium effective time are affected |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
moratorium_elections Table
See the Moratoriums API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| moratorium_name | varchar(128) | no | (PK) Unique name of the moratorium |
| entity_type | varchar(128) | no | (PK) The type of the entity associated with the moratorium election. Value may be quote or policy |
| entity_locator | char(26) | no | (PK) The locator of the entity associated with the moratorium election (ULID) |
| election | varchar(128) | no | The election made for the moratorium. Value may be optIn or optOut |
| is_deleted | tinyint(1) | no | Indicates whether the record has been deleted |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |
moratorium_statuses Table
See the Moratoriums API for reference.
| Column Name | Type | Nullable | Description |
|---|---|---|---|
| tenant_locator | char(36) | no | (PK) Unique identifier of the tenant (UUID) |
| moratorium_name | varchar(128) | no | (PK) Unique name of the moratorium |
| entity_type | varchar(128) | no | (PK) The type of the entity associated with the moratorium status. Value may be quote or policy |
| entity_locator | char(26) | no | (PK) The locator of the entity associated with the moratorium status (ULID) |
| is_applicable | tinyint(1) | no | Indicates whether the moratorium is applicable to the associated entity |
| is_eligible | tinyint(1) | no | Indicates whether the associated entity is eligible for the moratorium |
| is_in_scope | tinyint(1) | no | Indicates whether the associated entity is governed by the moratorium based on both applicability and eligibility |
| application_mode | varchar(128) | no | Indicates whether the moratorium applies to all eligible policies or whether there is an option to opt in or out. Value may be mandatory, optIn, or optOut |
| datalake_created_timestamp | datetime(6) | no | Time in UTC the record was created |
| datalake_updated_timestamp | datetime(6) | no | Time in UTC the record was last updated |