# Release Notes
The structure and use of the API does not change when names of entities or endpoint operation IDs change. These changes are typically made for clarity and consistency.
All changes to the API listed here are also reflected in our [Open API definition file](/other-resources/open-api-specification).
{/* TODO: Document https://socotra.atlassian.net/browse/KERN-3822 */}
{/* TODO: support x-internalAPI extension in openapi */}
Upcoming Releases [#upcoming-releases]
This section provides advanced notice of updates in upcoming releases. It does not represent a comprehensive list of changes in a release, and all items are subject to change prior to the release date.
June 24, 2026 [#june-24-2026]
The following deprecated features will be permanently removed during this release:
* `ParamsChangeInstruction#inherit_settings` - This API object has been deprecated since May 2024
* `Payment#state()` - This plugin method has been replaced by the `paymentState()` method, and has been deprecated since July 2024
July 15, 2026 [#july-15-2026]
The `extended` query parameter is being phased out from all `/list` API endpoints. This parameter previously gated access to the new response model, `ListPageResponse`. Going forward, `ListPageResponse` becomes the default and only response shape for these endpoints.
**Migration Path**
On May 26, 2026:
* Pass `extended=true` on any `/list` endpoint to opt into the new `ListPageResponse` model.
* `ListPageResponse<T>` wraps the previous flat list in a structured payload with two fields: `items` (the page of results) and `listCompleted` (a boolean indicating whether the returned page is the last one, meaning no further pages to fetch).
* Update your integrations to consume `ListPageResponse` while the legacy flat-list response is still available as the default.
On July 15, 2026:
* The `extended` query parameter will be removed entirely.
* `ListPageResponse` becomes the sole response shape — No change to clients already migrated.
* Clients may (and should) stop passing extended since the parameter will no longer exist.
**Recommended Action**
Migrate clients to send `extended=true` and consume `ListPageResponse` before July 15, 2026. After the cutover, drop the `extended` query parameter from your calls. The response shape stays the same.
**Affected Endpoints**
Billing (29 endpoints)
* `GET /credits/list`
* `GET /writeOffs/list`
* `GET /shortfallCredits/list`
* `GET /creditDistributions/list`
* `GET /creditDistributions/{locator}/invoices/list`
* `GET /installments/quotes/{quoteLocator}/list`
* `GET /installments/policies/{policyLocator}/list`
* `GET /installments/transactions/{transactionLocator}/list`
* `GET /jobs/installments/quotes/{locator}/list`
* `GET /jobs/installments/transactions/{locator}/list`
* `GET /jobs/invoices/accounts/{locator}/list`
* `GET /jobs/delinquencies/invoices/{invoiceLocator}/list`
* `GET /jobs/delinquencies/{delinquencyLocator}/list`
* `GET /financialInstruments/list`
* `GET /holds/accounts/{accountLocator}/list`
* `GET /disbursements/list`
* `GET /payments/list`
* `GET /payments/{locator}/invoices/list`
* `GET /accounting/ledgerAccounts/cash/list`
* `GET /installmentLattices/policies/{policyLocator}/list`
* `GET /delinquencies/accounts/{accountLocator}/list`
* `GET /delinquencies/policies/{policyLocator}/list`
* `GET /delinquencies/invoices/{invoiceLocator}/list`
* `GET /invoices/{locator}/payments/list`
* `GET /invoices/{locator}/creditDistributions/list`
* `GET /invoices/{locator}/credits/list`
* `GET /invoices/quotes/{quoteLocator}/list`
* `GET /invoices/policies/{policyLocator}/list`
* `GET /invoices/accounts/{accountLocator}/list`
Events (1 endpoint)
* `GET /webhooks/list`
Aux Data (2 endpoints)
* `GET /mediadata/{locator}/list`
* `GET /mediadata/search/{referenceType}/{referenceLocator}/list`
Plugins (1 endpoint)
* `GET /logs/list`
Documents (6 endpoints)
* `GET /documents/segment/{locator}/list`
* `GET /documents/segment/{locator}/jobs/list`
* `GET /documents/transaction/{locator}/list`
* `GET /documents/transaction/{locator}/jobs/list`
* `GET /documents/quote/{locator}/list`
* `GET /documents/quote/{locator}/jobs/list`
Resources (3 endpoints)
* `GET /groups/list`
* `GET /resources/list`
* `GET /resources/type/{type}/list`
Users (5 endpoints)
* `GET /roles/list`
* `GET /users/list`
* `GET /users/basic/list`
* `GET /tenants/list`
* `GET /tenants/mytenants/list`
Policies (10 endpoints)
* `GET /accounts/list`
* `GET /accounts/{locator}/quotes/list`
* `GET /accounts/{locator}/policies/list`
* `GET /accounts/{locator}/policies/snapshot/list`
* `GET /policies/{locator}/issuedTransactions/list`
* `GET /policies/{locator}/terms/list`
* `GET /quickquotes/list`
* `GET /quickquotes/group/{locator}/list`
* `GET /quotes/list`
* `GET /quotes/group/{locator}/list`
Total: 57 endpoints across 8 services.
***
**Past Releases**
June 17, 2026 [#june-17-2026]
New Documentation Experience [#new-documentation-experience]
The new documentation experience previously available at [docs-beta.socotra.com ](https://docs-beta.socotra.com) during the beta period is now the default experience on [docs.socotra.com ](https://docs.socotra.com).
Some content page URLs differ from the legacy documentation site, but redirects are in place to route old URLs to their corresponding new pages. The published OpenAPI specification also includes some minor revisions and additional schema context.
The new documentation experience includes:
* **Refreshed design** - Modernized interface with a right-side navigation panel, dark mode, and more
* **Socotra Assistant** - Our AI assistant is built directly into the docs for fast, in-context help
* **AI-friendly format** - Markdown-based source makes it easier to use docs alongside AI tools
Feedback on the new documentation experience is welcome. Please share any comments with your Socotra representative.
New Feature: Preferred Quotes [#new-feature-preferred-quotes]
A maximum of one quote locator can now be marked as a `preferredQuoteLocator` within each quote group, which can be used to indicate that the specified quote is the most likely quote to be issued. See the [Quote Groups](/features/policy-quotation/quote-groups#PreferredQuotes) feature guide for more information.
Data Lake Enhancements [#data-lake-enhancements]
On Friday, May 29, we released a change to Data Lake and Delta Files in the sandbox environment that prevents unnecessary no-op record updates. On Friday, June 12, we released this change to production environments. This change makes update timestamps more accurate and improves replication efficiency.
As part of this release, Data Lake records and Delta Files in each production environment, across all business accounts and tenants, have been successfully deleted and regenerated, with resulting `datalake_updated_timestamp` and `datalake_created_timestamp` values reflecting the time of data regeneration.
Other Enhancements [#other-enhancements]
* When a reversal charge is created, all tags associated with the original charge will now be copied and associated with the reversal charge. See the [Flat Charges](/features/billing/flat-charges#InvoicingBehavior) feature guide for more information.
* The `endTime` will now be automatically calculated for quotes if no value for `endTime` is provided when creating or updating quotes. See the [Quotes](/features/policy-quotation/quotes#CalculatingEndTime) feature guide for more information.
* The `accountLocator` associated with a quote can now be updated when updating quotes. See the [Quotes](/features/policy-quotation/quotes#UpdatingAccountLocator) feature guide for more information.
* Policy transaction data now includes an `expirationTime`. See the [Policy Transaction Stack](/features/policy-management/policy-transaction-stack#TransactionData) guide for more information.
June 10, 2026 [#june-10-2026]
Producer Management Enhancements [#producer-management-enhancements]
The [producer management](/features/producer-management/producer-management-overview) feature has been updated to support the following functionality:
* Producers can now be associated with [licenses](/features/producer-management/licenses) and [appointments](/features/producer-management/appointments), which authorize producers to conduct business in relation to specific [products ](/getting-started/create-a-tenant-configuration-file#what-is-an-insurance-product) and [jurisdictions](/features/jurisdictions).
* Products can now be configured to require producers associated with a quote or policy transaction to have a valid license or appointment when an underwriting request is processed.
Bug Fixes [#bug-fixes]
{/* KERN-7683, KERN-8131 */}
* Fixed an issue that caused calls to the API endpoint to fail for transactions in the `draft` or `validated` state.
* Fixed an issue that allowed installments to have an `autopayTime` earlier than the `generateTime`.
June 3, 2026 [#june-3-2026]
New Feature: External Numbering Support [#new-feature-external-numbering-support]
The Socotra Insurance Suite now supports quote and policy numbering by external systems. See the [External Numbering Support](/configuration/general-topics/external-numbering-support) feature guide for more information.
Other Enhancements [#other-enhancements-1]
* Diary entries can now be associated with elements within a quote or policy segment through the and API endpoints. See the [Diaries](/features/work-management/diaries) feature guide for more information.
* The API endpoint can be used to modify the `generateTime`, `dueTime`, and `autopayTime` of uninvoiced installments. See the [Invoicing](/features/billing/invoicing#installmentTiming) feature guide for more information.
* Invoice consolidation on cancellation functionality can now be configured through configuration objects. See the [Invoicing](/features/billing/invoicing#InvoiceConsolidation) feature guide for more information.
Data Lake Updates in Sandbox [#data-lake-updates-in-sandbox]
On Friday, May 29, we released a change to Data Lake and Delta Files in the sandbox environment that prevents unnecessary no-op record updates. This change made update timestamps more accurate and improved replication efficiency.
As part of this release, Data Lake records and Delta Files in sandbox, across all business accounts and tenants, have been deleted and regenerated.
The production release for this feature is expected to follow in mid-June.
Bug Fixes [#bug-fixes-1]
{/* KERN-8145 */}
* Fixed an issue that prevented updates to FNOLs after enabling data anonymization.
May 27, 2026 [#may-27-2026]
New Feature: Socotra Assistant Email Intake Workflow [#new-feature-socotra-assistant-email-intake-workflow]
The Socotra Assistant can now intercept emails and extract email data to assist with the underwriting process. See the [Email Intake Workflow](/ai-guide/assistant/email-intake) feature guide for more information.
New Documentation Experience: Beta Launch [#new-documentation-experience-beta-launch]
The updated Socotra documentation experience launched in beta at [docs-beta.socotra.com ](https://docs-beta.socotra.com). See the New Documentation Experience (Beta) section above for details on what's new and the beta timeline.
Other Enhancements [#other-enhancements-2]
The `description` field for moratoriums now has a character limit of 1024. Previously, the character limit was 512.
Deprecations [#deprecations]
The following deprecated features have been permanently removed with this release:
* `AutopayPluginRequest` - This single-parameter plugin request constructor has been replaced by the two-parameter constructor (Invoice, boolean), and has been deprecated since July 2025
* `ChargeRef#category` - Enum values `commission`, `flatPremium`, `flatTax`, `flatCommission`, and `flatCededPremium` for this configuration field have been deprecated since January 2025, and all flat charge categories are now handled through flat fee functionality
* `InstallmentPlanDetails` - Constructors for this plugin object have been kept to support backwards compatibility of older deployments, and have been deprecated since May 2025
* `InstallmentPlanRef#invoiceFeeAmounts` - This configuration field is now handled through the `InvoicingPlanRef` object, deprecated since March 2025
* `DelinquencyEventConfiguration#offsetBasis` - The enum value `delinquencyCreation` for this configuration field has been deprecated since November 2024
* `WriteOffTolerancePlan` - This configuration object has been replaced by the `ShortfallTolerancePlanRef` object, and has been deprecated since March 2024
In preparation for forthcoming configuration versioning capabilities, has been updated to include a new `staticVersionLocator` property.
May 20, 2026 [#may-20-2026]
Documentation Updates [#documentation-updates]
* New details on issuance policy transactions and reversal policy transactions have been added to the [Execute policy transactions](/getting-started/execute-policy-transactions#policyTransaction) guide.
Deprecations [#deprecations-1]
The following deprecated features have been permanently removed with this release:
* `BillingTrigger` - The `accept` value for this configuration object has been deprecated since September 2025
* `BillingPreferences` - This API request object has been deprecated since July 2024
* `PolicyInvoiceSummary` - This API response object has been replaced by the `invoiceSummaries` field within the `InvoiceDetailsResponse` object, and has been deprecated since February 2025
* `transactionLocator` - The `transactionLocator` field within the `InvoiceItemResponse` API response object has been replaced by the `transactionLocators` field, and has been deprecated since January 2026
* `Invoice#state()` - This plugin method has been replaced by the `invoiceState()` method, and has been deprecated since August 2024
* `DelinquencyReferenceType#quote` - This plugin enum and API response enum was previously used for billing on quote acceptance, which is not supported anymore, and has been deprecated since June 2025
Bug Fixes [#bug-fixes-2]
{/* KERN-8005 */}
* Fixed an issue that caused account validation to succeed when required fields were missing.
May 13, 2026 [#may-13-2026]
Producer Management Enhancements [#producer-management-enhancements-1]
The producer management feature has been updated to support the following functionality:
* Associating a producer code with a quote or policy transaction
* Viewing producer code history
* Customizing the underwriting flag that will be automatically added to a quote or policy transaction if the associated producer code or the producers associated with the producer code are invalid
See the [Producer Management](/features/producer-management/producer-management-overview) feature guide for more information.
Other Enhancements [#other-enhancements-3]
Today's release changes the way billing operates at the time of quote issuance to ensure billing consistency across the policy lifecycle.
Historically, because we could trigger billing at quote acceptance (deprecated), billing at quote issuance was also centered around the quote entity. Going forward, billing at issuance will be centered around the policy issuance transaction, meaning billing is now always initiated when the issuance transaction is issued, rather than when the quote moves to the `issued` state. As a result, all billing operations now reference a policy rather than a quote.
Key changes:
**Default billing trigger configuration property has been removed**
* The `defaultBillingTrigger` configuration property has been removed and will no longer be accepted in tenant configs.
* Any tenants that still have `defaultBillingTrigger` set must remove it to avoid deployment failures.
**Quote accounting reference type has been removed**
* The `GET /billing/{tenant}/accounting/ledgerAccounts/quote/{locator}` API endpoint is no longer valid.
* Clients querying ledger account balances for a policy by its quote locator should switch to `GET /billing/{tenant}/accounting/ledgerAccounts/policy/{locator}`.
**Installment job response properties have been removed**
* The `jobType` and `referenceType` fields are no longer returned in installment job API list responses:
* `GET /billing/{tenant}/jobs/installments/quotes/{locator}/list`
* `GET /billing/{tenant}/jobs/installments/transactions/{locator}/list`
**Data Lake implications**
* The `charge_locator` in the `installment_items` table now reflects `policy_element_charges.locator` rather than `quote_element_charges.locator`. Historical records are not impacted.
* The `reference_type` in `ledger_accounts`, `ledger_account_line_items`, and `fa_transaction_account_lines` no longer returns a value of `quote`. Historical records are not impacted.
We recommend ensuring that the `defaultBillingTrigger` is not present in any configurations, which could impact deployment.
May 6, 2026 [#may-6-2026]
New Feature: Negative Invoice Processing [#new-feature-negative-invoice-processing]
Accounts can now be configured to automatically settle open, unsettled invoices using credits that originated from negative invoices. See the [Negative Invoice Processing](/features/billing/excess-credits#NegativeInvoiceProcessing) feature guide for more information.
New Feature: Custom Schedule Item Processing [#new-feature-custom-schedule-item-processing]
The Deserialization Plugin can be used to define asynchronous processing logic for large lists of schedule items. See the [Custom Schedule Item Processing](/features/schedules#CustomScheduleItemProcessing) feature guide for more information.
Documentation Updates [#documentation-updates-1]
* New details on list endpoints and pagination have been added to the [API Overview](/api) guide.
Bug Fixes [#bug-fixes-3]
{/* KERN-7952, KERN-7838, KERN-7767, KERN-7792, KERN-7881 */}
* Fixed an issue that caused CSV-formatted delta files to be duplicated when processing more than one file per generation job.
* Fixed an issue that caused automatic policy renewals to fail.
* Fixed an issue that prevented write-off generation during migrations.
* Fixed an issue that caused invoice `dueTime` to be off by 1 hour when the due date occurs on the DST start date.
* Fixed an issue that caused invoices to remain open after a write-off.
April 29, 2026 [#april-29-2026]
New Feature: Quote Groups [#new-feature-quote-groups]
Quote groups can be used to categorize quote variants that represent a single prospective contract or marketing opportunity. See the [Quote Groups](/features/policy-quotation/quote-groups) feature guide for more information.
Documentation Updates [#documentation-updates-2]
* New details on retrieving policy transaction descriptions have been added to the [Policy Transaction Stack](/features/policy-management/policy-transaction-stack) feature guide.
April 22, 2026 [#april-22-2026]
New Feature: Tenant Events [#new-feature-tenant-events]
Custom scheduled events now support tenant-level events in addition to policy-level events. See the [Custom Scheduled Events](/configuration/general-topics/scheduled-events#TenantEvents) feature guide for more information.
Other Enhancements [#other-enhancements-4]
* [Invoice Consolidation on Cancellation](/features/billing/invoicing#InvoiceConsolidation): When a cancellation [transaction](/features/policy-management/policy-transactions) is issued, the system will consolidate all remaining uninvoiced installments for the cancelled period into the next eligible installment for that period. Invoice [previews](/features/preview-operations) will also reflect this change. This consolidation logic is the default system behavior for all customers. See the [Invoicing](/features/billing/invoicing#InvoiceConsolidation) feature guide for more information.
Documentation Updates [#documentation-updates-3]
* External documents, which are documents manually attached through the Attach Document API endpoint, can be deleted using the Delete Document API endpoint. See the [Document Management](/features/documents/document-management#DeletingDocuments) guide for more information.
Bug Fixes [#bug-fixes-4]
{/* KERN-7781 */}
* Fixed an issue that prevented failed migrations from recovering.
April 15, 2026 [#april-15-2026]
Documentation Updates [#documentation-updates-4]
* The [Cancellation Plugin](/configuration/plugins/cancellation) feature guide has been improved as part of a rollout of updated plugin documentation.
* The [Producer Management](/features/producer-management/producer-management-overview) feature guide has been updated to provide additional information on numbering plans and the lifecycle for producers and producer codes.
April 8, 2026 [#april-8-2026]
Documentation Updates [#documentation-updates-5]
* The [Underwriting Plugin](/configuration/plugins/underwriting) and [Installments Plugin](/configuration/plugins/installments) feature guides have been improved as part of a rollout of updated plugin documentation.
* Additional details have been added to the upcoming deprecation notices to help our customers replace deprecated functionality scheduled for permanent removal.
Bug Fixes [#bug-fixes-5]
{/* KERN-7304, KERN-7153 */}
* Fixed an issue that caused the Fetch Underwriting Flags API endpoint to return incorrect underwriting flag locators.
* Fixed an issue that prevented the system from enforcing [numbering plans](/configuration/general-topics/entity-numbering).
April 1, 2026 [#april-1-2026]
Data Lake Enhancements [#data-lake-enhancements-1]
The following tables have been added to [Data Lake](/features/reporting/datalake) to support reporting for the [Producer Management](/features/producer-management/producer-management-overview) feature set:
* [producers](/features/reporting/tables#producers)
* [producer\_data\_extensions](/features/reporting/tables#producer_data_extensions)
* [producer\_hierarchy](/features/reporting/tables#producer_hierarchy)
* [producer\_codes](/features/reporting/tables#producer_codes)
* [producer\_code\_data\_extensions](/features/reporting/tables#producer_code_data_extensions)
Bug Fixes [#bug-fixes-6]
{/* KERN-7687 */}
* Fixed an issue that prevented the [Precommit Plugin](/configuration/plugins/precommit) from modifying producer codes.
March 25, 2026 [#march-25-2026]
New Feature: Producer Management [#new-feature-producer-management]
Producer management refers to a set of features within Socotra designed to support producers such as brokers and agents. See the [Producer Management](/features/producer-management/producer-management-overview) feature guide for more information.
Data Lake Enhancements [#data-lake-enhancements-2]
* The following fields were added to the listed [Data Lake](/features/reporting/datalake) tables, resulting in the regeneration of all historical data in each table:
* [policy\_segment\_elements](/features/reporting/tables#policy_segment_elements) - `original_effective_time_utc`
* [policy\_element\_charges](/features/reporting/tables#policy_element_charges) - `invoicing`, `handling`
* [quote\_element\_charges](/features/reporting/tables#quote_element_charges) - `invoicing`, `handling`
* [disbursements](/features/reporting/tables#disbursements) - `disbursement_number`
* Fixed an issue in the Gross Written Premium (GWP) [Metric](/features/reporting/metrics) returned by the Fetch GWP Metrics API by updating its definition to properly account for out-of-sequence (OOS) and reversal transactions, ensuring historical periods are not retroactively modified.
Other Enhancements [#other-enhancements-5]
{/* KERN-7507 */}
* For newly created business accounts, the new login page will present a more uniform, branded, and streamlined experience when entering a username and password. An example of the new login page can be seen [here ](/getting-started/log-into-socotra#steps). The new login page is available for existing business accounts upon request.
* Reinstatements will no longer be reapplied for out-of-sequence cancellations, yielding more intuitive results in the vast majority of real-world scenarios, such as flat cancellations. Following this change, users will need to manually create and issue any reinstatements required after issuing an out-of-sequence cancellation.
* New fields have been added to the `InvoiceDetailsResponse` object: `settledTime` and `unsettledTime`.
Bug Fixes [#bug-fixes-7]
{/* KERN-7546 */}
* Fixed an issue that caused a server error when refusing a renewal transaction.
March 18, 2026 [#march-18-2026]
New Features: Workgroups, Auto-Assign, and Workplans [#new-features-workgroups-auto-assign-and-workplans]
* [Workgroups](/features/work-management/workgroups) are hierarchical groupings of tasks, users, and entities such as quotes and policies.
* [Auto-Assign](/features/work-management/workgroups#AutoAssign) automatically assigns tasks and creates associations.
* [Workplans](/features/work-management/workplans) are templates that automatically create tasks and assign tasks in response to system events.
Data Lake Enhancements [#data-lake-enhancements-3]
* The `group_locator` field in the [Data Lake](/features/reporting/datalake) [quotes](/features/reporting/tables#quotes) table has been updated from `non-nullable` to `nullable` to support an upcoming feature, and two new fields `invoice_fee_amount` and `anonymized_time_utc` have been added, resulting in the regeneration of all historical data in the table.
* A fix for an issue preventing subpayments from being reflected in the [Data Lake](/features/reporting/datalake) [payments](/features/reporting/tables#payments) and [payment\_data\_extensions](/features/reporting/tables#payment_data_extensions) tables has been released, resulting in the regeneration of all historical data in both tables.
Bug Fixes [#bug-fixes-8]
{/* KERN-7008 */}
* Fixed an issue that prevented transaction locators from appearing for flat charges when viewing invoices.
March 11, 2026 [#march-11-2026]
New Feature: Socotra Assistant [#new-feature-socotra-assistant]
The Socotra Assistant is an AI-powered agent that automates the underwriting workflow within the Operations Workbench and performs tasks such as extracting data from documents, checking for missing or invalid data, and generating underwriting insights.
See the [Socotra Assistant](/ai-guide/assistant/overview) feature guide for more information.
UI Enhancements [#ui-enhancements]
The work management dashboard now displays a link to view all tasks if no tasks are assigned to you.
Data Lake Enhancements [#data-lake-enhancements-4]
* New [Data Lake](/features/reporting/datalake) tables are now available for [affected\_transactions](/features/reporting/tables#affected_transactions) and [installment\_settings](/features/reporting/tables#installment_settings).
* A performance fix was made to the [quote\_element\_tree](/features/reporting/tables#quote_element_tree) and [policy\_element\_tree](/features/reporting/tables#policy_element_tree) [Data Lake](/features/reporting/datalake) tables, resulting in the regeneration of all historical data in each table.
* The `producer_code` and `producer_code_of_record` fields were from the [Data Lake](/features/reporting/datalake) [policies](/features/reporting/tables#policies) table and added to the [segments](/features/reporting/tables#segments) table to support an upcoming feature set.
* The following fields were added to the listed [Data Lake](/features/reporting/datalake) tables, resulting in the regeneration of all historical data in each table:
* [policies](/features/reporting/tables#policies) - `coverage_end_time_utc`, `invoice_fee_amount`, `anonymized_time_utc`
* [segments](/features/reporting/tables#segments) - `producer_code`, `producer_code_of_record`, `anonymized_time_utc`
* [installments](/features/reporting/tables#installments) - `installment_lattice_locator`, `installment_settings_locator`, `reversal_of_locator`, `migrated_from_locator`, `term_locator`, `autopay_time_utc`, `enhanced_by_plugin`
* [payments](/features/reporting/tables#payments) - `payment_number`, `payment_mode`, `aggregate_payment_locator`, `reversed_by`, `retry_plan_name`, `next_request_time_utc`, `anonymized_time_utc`
March 4, 2026 [#march-4-2026]
Bug Fixes [#bug-fixes-9]
{/* KERN-7185, KERN-7454 */}
* Fixed an issue that generated an additional invoice after migration.
* Fixed an issue that caused an internal server error when validating a policy transaction.
* An incorrect data type for the `reference_locator` field in the [diaries](/features/reporting/tables#diaries) table has been fixed, resulting in the regeneration of all historical data in the table.
* An incorrect nullable indicator for the `datalake_updated_timestamp` field in the [tasks](/features/reporting/tables#tasks) table has been fixed, resulting in the regeneration of all historical data in the table.
February 25, 2026 [#february-25-2026]
Data Lake Enhancements [#data-lake-enhancements-5]
* An issue causing incorrect values for `grace_started_at` and `grace_end_at` in the [Data Lake](/features/reporting/datalake) [delinquencies](/features/reporting/tables#delinquencies) table has been fixed, resulting in the regeneration of all historical data in the table.
* New [Data Lake](/features/reporting/datalake) tables are now available for [policy\_status](/features/reporting/tables#policy_status) and [delinquency\_references](/features/reporting/tables#delinquency_references).
Config SDK Enhancements [#config-sdk-enhancements]
API client stability has been improved in Config SDK v0.6.9.
Bug Fixes [#bug-fixes-10]
{/* KERN-7438 */}
* Fixed an issue that prevented failed migrations from recovering.
February 18, 2026 [#february-18-2026]
Config SDK Enhancements [#config-sdk-enhancements-1]
The [Config SDK template ](https://github.com/socotra/config-sdk-template) has been updated to make testing easier. This version of the Config SDK template uses Config SDK v0.6.9 by default.
Data Lake Enhancements [#data-lake-enhancements-6]
The following tables have been added to [Data Lake](/features/reporting/datalake) to support reporting for the [Work Management](/features/work-management/work-management-overview) feature set:
* [tasks](/features/reporting/tables#tasks)
* [task\_references](/features/reporting/tables#task_references)
* [user\_qualifications](/features/reporting/tables#user_qualifications)
* [user\_associations](/features/reporting/tables#user_associations)
* [diaries](/features/reporting/tables#diaries)
Bug Fixes [#bug-fixes-11]
{/* KERN-7365, KERN-7293 */}
* Fixed an issue that caused a compilation error when executing the `validateConfig` and `refreshReferenceDatamodel` Gradle tasks.
* Fixed an issue that prevented the [Plugin Data Fetcher](/configuration/plugins/overview#PluginDataFetcher) from retrieving transaction pricing data.
February 11, 2026 [#february-11-2026]
Documentation Updates [#documentation-updates-6]
* The [Document Data Snapshot Plugin](/configuration/plugins/document-data-snapshot) and [Document Selection Plugin](/configuration/plugins/document-selection) feature guides have been improved as part of a rollout of updated plugin documentation.
Other Enhancements [#other-enhancements-6]
* Installment locators are now included in invoice preview responses.
Bug Fixes [#bug-fixes-12]
{/* KERN-7314 */}
* Fixed an issue that resulted in incorrect invoice details after a reversal transaction.
February 4, 2026 [#february-4-2026]
Data Lake Enhancements [#data-lake-enhancements-7]
New fields have been added to [Data Lake](/features/reporting/datalake) to support [Work Management](/features/work-management/work-management-overview) reporting:
* The `task_locator` field has been added to the [policy element underwriting flags](/features/reporting/tables#policy_element_underwriting_flags) and [quote element underwriting flags](/features/reporting/tables#quote_element_underwriting_flags) tables.
Other Enhancements [#other-enhancements-7]
* The `completedAt` and `completedBy` attributes have been added to Tasks.
* Name length limits for configuration elements have been adjusted. See the [Configuration Deployment](/configuration/general-topics/deployment#configuration_element_name_length_limits) guide for more information.
January 28, 2026 [#january-28-2026]
Documentation Updates [#documentation-updates-7]
* The [Validation Plugin](/configuration/plugins/validation) and [Rating Plugin](/configuration/plugins/rating) feature guides have been improved as part of a rollout of updated plugin documentation.
Bug Fixes [#bug-fixes-13]
{/* KERN-7221, KERN-7188 */}
* Fixed an issue that prevented billing mode changes from taking effect.
* Fixed an issue that generated incorrect events when an invoice is settled with a credit distribution and a shortfall write-off.
January 21, 2026 [#january-21-2026]
New Feature: Jurisdictions [#new-feature-jurisdictions]
The [resource selection](/configuration/resources/versioned-resource-selection) process now automatically selects resource instances for products based on jurisdiction. See the [Jurisdictions](/features/jurisdictions) guide for more details.
Data Lake Enhancements [#data-lake-enhancements-8]
New fields have been added to [Data Lake](/features/reporting/datalake) to support an upcoming feature set:
* The `producer_code` field has been added to the [policies](/features/reporting/tables#policies) and [quotes](/features/reporting/tables#quotes) tables.
* The `producer_code_of_record` field has been added to the [policies](/features/reporting/tables#policies) table.
Other Enhancements [#other-enhancements-8]
* The [Auto-Renewal Plugin](/features/policy-management/renewal-management#auto_renewal_plugin) can now be implemented both globally and at the product level.
Bug Fixes [#bug-fixes-14]
{/* KERN-7136, KERN-7151 */}
* Fixed an issue that caused policy snapshots to display incorrect preferences.
* Fixed an issue that resulted in incorrect invoice data after a billing mode change and an [out-of-sequence](/features/policy-management/out-of-sequence-transactions) change.
January 14, 2026 [#january-14-2026]
Data Lake Enhancements [#data-lake-enhancements-9]
* The `jurisdiction` field has been added to the [policies](/features/reporting/tables#policies) and [quotes](/features/reporting/tables#quotes) tables in [Data Lake](/features/reporting/datalake) to support upcoming feature sets.
* The `static_locator` and `reapplication_of_locator` fields have been added to the [transactions](/features/reporting/tables#transactions) table in [Data Lake](/features/reporting/datalake).
Bug Fixes [#bug-fixes-15]
{/* KERN-7001, KERN-7005 */}
* Fixed an issue that applied billing mode changes to the wrong billing period.
* Fixed an issue that caused the due time of certain invoices to be unintentionally backdated when the billing mode is modified.
January 8, 2026 [#january-8-2026]
Data Lake Enhancements [#data-lake-enhancements-10]
* New [Data Lake](/features/reporting/datalake) tables are now available for [ledger account line items](/features/reporting/tables#ledger_account_line_items) and [financial transaction account lines](/features/reporting/tables#fa_transaction_account_lines).
Bug Fixes [#bug-fixes-16]
{/* KERN-7086, KERN-7087, KERN-7040, KERN-6982 */}
* Fixed an issue that caused invoices to be generated multiple times for the same billing period.
* Fixed an issue with automatic credit distribution when the billing mode is modified.
* Fixed an issue that prevented surcharges from appearing in invoices displayed in the Operations Workbench.
* Fixed an issue with the Installments Plugin that caused an incorrect due date to appear in invoices.
December 17, 2025 [#december-17-2025]
Transaction Charge Bundling [#transaction-charge-bundling]
Flat and retention charges with `next` invoicing can now be bundled with invoices corresponding to a specific transaction. When bundling is enabled, charges will be billed on the next invoice with installments originating from the specified transaction, ensuring transaction-related fees are invoiced together. See the transaction bundling guides for [flat](/features/billing/flat-charges#transaction_flat_charge_bundling) and [retention](/features/billing/retention-charges#transaction_retention_charge_bundling) charges for more details.
API Updates [#api-updates]
* The `recordCount` and `md5HashSum` fields have been added to the object to assist with the reconciliation of [delta files](/features/reporting/delta-files).
This is the final 2025 release. There will be no release on December 24, and no release the following week (December 31). The next release will be available on Thursday, January 8.
December 10, 2025 [#december-10-2025]
Moratoriums Reporting Updates [#moratoriums-reporting-updates]
The following updates have been made to Moratoriums reporting in Data Lake and Delta Files:
* The `is_deleted` field has been removed from the `moratorium_statuses` table. This table now reflects the status of any policy or quote, rather than only those eligible for Moratoriums.
* Delta Files now include three separate `transformationTable` values for Moratoriums (`DataLakeMoratoriums`, `DataLakeMoratoriumStatuses`, `DataLakeMoratoriumElections`), rather than a single value (`DataLakeMoratoriumReports`).
Documentation Updates [#documentation-updates-8]
* New documentation has been created for the [Range Tables](/configuration/resources/range-tables) feature. Range Tables provide range-based and interpolated table lookup capabilities.
* The [Precommit Plugin](/configuration/plugins/precommit) feature guide has been improved as part of a rollout of updated plugin documentation. Keep an eye out for more improvements to our plugin documentation over the course of the next few releases.
December 3, 2025 [#december-3-2025]
New Feature: Tenant Roles [#new-feature-tenant-roles]
Tenant roles allow admins to grant tenant-specific permissions to users. See the [Tenant Roles](/features/security/roles-and-permissions#tenant_roles) guide for more details.
API Updates [#api-updates-1]
* Failed billing jobs can now be retried using the Retry Failed Transactions API endpoint. See the [Installment Lattices](/features/billing/installments-and-installment-lattices#retrying_failed_billing_jobs) guide for more details.
Other Enhancements [#other-enhancements-9]
* [Delta files](/features/reporting/delta-files) are now available in CSV format, providing more seamless ingestion into data warehouses.
* [Data Lake](/features/reporting/datalake) tables are now available for ledger accounts and financial accounting transactions.
Bug Fixes [#bug-fixes-17]
{/* KERN-6511 */}
* Fixed an issue that prevented the Fetch Invoice Details API endpoint from returning `elementType`.
November 19, 2025 [#november-19-2025]
Config SDK Upgrade Requirement [#config-sdk-upgrade-requirement]
Config SDK developers are now required to upgrade to the latest [Config SDK release (v0.6.8) ](https://github.com/socotra/config-sdk-template/packages/2234611) and Java 21.
API Updates [#api-updates-2]
* The `excludeRetired` and `excludeActive` filtering options are now available when calling the Fetch all Resource Groups API endpoint.
There will be no release on November 26. The next release will be available on Wednesday, December 3.
November 12, 2025 [#november-12-2025]
New Feature: Automation Plugin (Beta) [#new-feature-automation-plugin-beta]
The Automation Plugin is a new feature that allows you to implement custom business logic, create your own Socotra API endpoints, define request and response objects, and send HTTP requests to both third-party and Socotra API endpoints. See the [Automation Plugin](/configuration/plugins/automation) guide for more details.
API Updates [#api-updates-3]
* New endpoints have been added to the Events API to support the management of [failed scheduled events](/api/events/events).
* A new endpoint has been added to the Documents API to support fetching documents by term.
Other Enhancements [#other-enhancements-10]
* The `AccountMigrationRequest` entity now includes the `AccountingMigrationRequest` field to support the migration of account balances.
* The `staticLocator` field has been added to policy transactions. The `staticLocator` field refers to the locator of the original transaction and will remain unchanged for a policy transaction, even when a policy transaction is reversed and reapplied.
* The getTermSubsegmentSummaries() method has been added to the [Plugin Data Fetcher](/configuration/plugins/overview#PluginDataFetcher), allowing users to view a summary for each segment in a term.
**Upcoming Config SDK Upgrade Required:** As previously mentioned, we are targeting the release of November 19th to upgrade our services from Java 17 to Java 21. To ensure compatibility, all developers must upgrade to the latest [Config SDK release (v0.6.8) ](https://github.com/socotra/config-sdk-template/packages/2234611) and update their local environments to Java 21 by this date.
November 5, 2025 [#november-5-2025]
Documentation Updates [#documentation-updates-9]
* New documentation has been created for [service accounts](/features/security/authentication#service_accounts). Service accounts are used by software integrations to access Socotra API endpoints using [Personal Access Tokens (PATs)](/features/security/personal-access-tokens).
* Our feature guide on [First Notice of Loss (“FNOL”)](/features/claims/fnol) has been updated to clarify that an FNOL in the `onClaim` state will revert to the `validated` state if any of its data is modified.
Bug Fixes [#bug-fixes-18]
{/* KERN-6738 */}
* Fixed an issue that prevented Fivetran from recognizing data lake tables that use an unsupported format for primary keys.
**Upcoming Config SDK Upgrade Required:** As previously mentioned, we are targeting the release of November 19th to upgrade our services from Java 17 to Java 21. To ensure compatibility, all developers must upgrade to the latest [Config SDK release (v0.6.8) ](https://github.com/socotra/config-sdk-template/packages/2234611) and update their local environments to Java 21 by this date.
October 29, 2025 [#october-29-2025]
Bug Fixes [#bug-fixes-19]
{/* KERN-6655 */}
* Fixed an issue that caused previously invoiced installments to appear in invoice previews for [migrated](/features/migration) policies.
**Upcoming Config SDK Upgrade Required:** As previously mentioned, we are targeting the release of November 19th to upgrade our services from Java 17 to Java 21. To ensure compatibility, all developers must upgrade to the latest [Config SDK release (v0.6.8) ](https://github.com/socotra/config-sdk-template/packages/2234611) and update their local environments to Java 21 by this date.
October 22, 2025 [#october-22-2025]
Cancellation Plugin [#cancellation-plugin]
The new [Cancellation Plugin](/configuration/plugins/cancellation) allows adjustments to the amount retained at policy cancellation through the creation of [retention charges](/features/billing/retention-charges). This supports enforcement of minimum earned premium plans, short-rate penalties, and other fees or refunds according to custom business rules at cancellation.
New Data Security Features (Beta) [#new-data-security-features-beta]
The new [Data Access Controls](/features/security/data-access-controls), [Data Masking](/features/security/data-masking), and [Data Anonymization](/features/security/data-anonymization) features provide enhanced capabilities for managing sensitive data, allowing admins to control field-level and entity-level access by user role, redact sensitive data in responses and UI, and anonymize data for analytics and compliance. See the [Security Feature Guide](/features/security/security-overview) for details.
As part of this release, the existing [Data Access Controls APIs](/api/configuration-and-development/data-access-controls) have been deprecated and replaced with the new [Data Access APIs](/api/configuration-and-development/data-access).
Service Accounts [#service-accounts]
A service account is a new type of user enabling secure, programmatic API access. Service accounts have no login credentials and authenticate using Personal Access Tokens (PATs).
Admins create service accounts by setting the `serviceAccount` boolean in the to `true`, then generate PATs for them using the new API.
Delta File Generation Schedule Update [#delta-file-generation-schedule-update]
Delta files are now generated at most once every two hours following Data Lake updates, rather than immediately after each update. If an update occurs within two hours of the previous delta file generation, the system will generate the next set once the interval has elapsed. See the [Delta File](/features/reporting/delta-files) guide for details.
Bug Fixes [#bug-fixes-20]
{/* KERN-6658 */}
* Fixed an issue that caused redeployments to fail when an extension data field was changed from optional to required with a `defaultValue` specified.
**Upcoming Config SDK Upgrade Required:** We are targeting the release of November 19th to upgrade our services from Java 17 to Java 21. To ensure compatibility, all developers must upgrade to the latest [Config SDK release (v0.6.8) ](https://github.com/socotra/config-sdk-template/packages/2234611) and update their local environments to Java 21 by this date.
October 15, 2025 [#october-15-2025]
Search Enhancements for Entity Numbers [#search-enhancements-for-entity-numbers]
Search requests for [entity numbers](/configuration/general-topics/entity-numbering) now offer improved flexibility and discoverability. Non-alphanumeric symbols are now ignored during entity number searches, allowing users to search with or without symbols. For example, searches for `PA-000001` or `PA000001` will return the same results. In addition, relevancy scores for entity number matches are now boosted to ensure they appear prominently in search results.
See the [Search](/features/search) feature guide for more information.
Search requests must now use `entity_number` as the `fieldName` for all entity number search requests, regardless of entity type. To maintain compatibility, update any entity number search implementations to use the new syntax. For example, `policy_number:PA-000001` or `quote_number:PA-000001` must be updated to `entity_number:PA-000001`.
Data Lake Consolidated Schema [#data-lake-consolidated-schema]
A consolidated schema containing data for all tenants within the business account is now available as an option to users when enabling Data Lake. See the [Data Lake](/features/reporting/datalake) guide for details.
Other Enhancements [#other-enhancements-11]
* [Diary](/features/work-management/diaries) records may now be accessed from within plugins using the [Plugin Data Fetcher](/configuration/plugins/overview#PluginDataFetcher) `getDiaries()` method.
* [Subpayments](/api/billing/payments) within an aggregate payment may now be applied directly to invoice items by setting the `containerType` of any `CreditItem` in its `targets` to `invoiceItem`.
* [Billing Holds](/features/billing/billing-holds) now emit events throughout their life cycle. See the [Event Definitions](/configuration/general-topics/event-definitions) page for more information.
Bug Fixes [#bug-fixes-21]
{/* KERN-6543 */}
* Underwriting flags can no longer be added to transactions in terminal states.
October 8, 2025 [#october-8-2025]
Moratoriums Reporting [#moratoriums-reporting]
[Data Lake](/features/reporting/datalake) now includes [Moratoriums](/features/moratoriums/moratoriums) tables containing moratorium details, quote and policy opt-in and opt-out records, and lists of affected quotes and policies.
Bug Fixes [#bug-fixes-22]
{/* KERN-6513, KERN-6509, KERN-6094 */}
* Fixed an issue where the `originalEffectiveTime` on migrated policies incorrectly updated to the latest renewal date.
* Migration payloads containing more than one issuance transaction will no longer pass validation.
* Fixed an issue where issuance transaction invoice previews failed to generate for migrated policies.
October 1, 2025 [#october-1-2025]
Config SDK Enhancements [#config-sdk-enhancements-2]
A new [Config SDK release (v0.6.8) ](https://github.com/socotra/config-sdk-template/packages/2234611) includes the following updates:
* A new `createArchive` task that creates a deployable configuration archive for deployment.
* Support for [bootstrap resources](/configuration/general-topics/bootstrap) in the `socotra-config`.
* Fixed a bug in the `uploadBundleAndBuild` auxiliary task that could cause config deployment attempts to fail.
`createArchive` has been introduced as a convenience since it is no longer expected to have a `plugins` directory under `socotra-config`; instead, canonical plugin code continues to live under `src/`. All Config SDK tasks pulling deployed configs will automatically place the plugin code in `src/` exclusively, and will use code from that directory whenever creating an archive for deployment. If you wish to create a config for deployment, we recommend using `createArchive` instead of manually copying files from `src/` and `socotra-config`.
The [Config SDK template ](https://github.com/socotra/config-sdk-template) has been updated to pull `v0.6.8` by default. **Java 21, not 17, is now required to use the Config SDK**.
See the [Configuration SDK Guide](/configuration/general-topics/configuration-sdk) for details.
Other Enhancements [#other-enhancements-12]
* The [Payment Execution Service](/features/billing/payment-execution-service) now supports Stripe as a payment provider.
* Fields may now be rendered in the UI as visible but not editable using the `readOnly` tag. See the [Rendering Customizations](/ui-sdk/components/rendering-customizations) guide for details.
* The [Credit Distributions](/api/billing/credit-distribution) entity is now available in [Data Lake](/features/reporting/datalake).
* now contains a
`candidateInstallmentsCount` property that shows the number of candidate
installments intended to be invoiced.
September 24, 2025 [#september-24-2025]
Underwriting Flag Enhancements [#underwriting-flag-enhancements]
New granular permissions and corresponding APIs enable users to create or clear individual underwriting flags of each level (`block`, `decline`, `reject`, `approve`, and `info`) for [Quotes](/api/quotes/quotes) and [Transactions](/api/policy-management/policy-transactions).
Each permission for adding or clearing underwriting flags has its own API endpoint requiring the corresponding permission.
UI Customizations [#ui-customizations]
The new Display Hints entity supports UI customization of names and ordering for Coverage Term Options and Transaction Types through the `displayName` and `displayOrder` attributes. This entity will be proliferated to other configuration entities in future releases.
Bug Fixes [#bug-fixes-23]
{/* KERN-6349 */}
* Fixed an issue where flat charges added to invoices via the API with a `policyLocator` specified in the request were incorrectly applied within the account.
September 17, 2025 [#september-17-2025]
New Feature: Moratoriums (BETA) [#new-feature-moratoriums-beta]
Moratoriums is a new feature that enables the temporary suspension of certain policy and billing operations across a designated group of policies, supporting compliance with regulatory or business requirements. See the [Moratoriums Guide](/features/moratoriums/moratoriums) for details.
New Feature: Socotra MCP Server [#new-feature-socotra-mcp-server]
Socotra's new MCP server unlocks automated workflows and AI-powered operations for users by enabling quick and secure integrations of their Socotra Insurance Suite business accounts with AI applications. See the [MCP Server Guide](/ai-guide/mcp-server/overview) for details.
Contact your Socotra representative to request access to the MCP Server for your business account.
Notice: Payment Execution Service Changes [#notice-payment-execution-service-changes]
We are making breaking changes to the recently released [Payment Execution Service APIs](/api/billing/payment-execution) to ensure a more consistent and flexible design moving forward.
* The , , and endpoints now use a `paymentProviderLocator` in the URL instead of `paymentProvider`. These endpoints return a object with the following properties: `locator`, `paymentServiceProvider`, and `paymentProviderState`.
* The and objects for the , , and endpoints now use `paymentServiceProvider` instead of `paymentProviderLocator`.
Other Enhancements [#other-enhancements-13]
{/* KERN-6380, 6292, 6270 */}
* More granular permissions (`validate`, `price`, `underwrite`, `accept`, and `issue`) are available for the corresponding [Quote](/api/quotes/quotes) and [Transaction](/api/policy-management/policy-transactions) lifecycle endpoints.
* Search performance has been significantly improved for data extension fields and numbering plan values.
* [Payments](/api/billing/payments) may be applied directly to invoice items by setting the `containerType` of any `CreditItem` in its `targets` to `invoiceItem`. The ability to apply subpayments directly to invoice items as part of aggregate payments will be included in a future release.
September 10, 2025 [#september-10-2025]
Data Lake Enhancements [#data-lake-enhancements-11]
As previously announced, this release introduces [Data Lake](/features/reporting/datalake) improvements. Key changes include:
* **Multi-Tenant Schema**: Added a `tenant_locator` field to all tables and created new composite primary keys that combine the tenant locator with existing keys to enable future consolidated reporting across multiple Business Account tenants.
* **Soft Deletion**: Introduced soft deletion capability with a new `deleted` field on tables subject to record deletion, improving change management and enabling future support for additional [Delta File](/features/reporting/delta-files) formats like CSV.
* **Enhanced Change Detection**: Added an index to the `datalake_updated_timestamp` field for more efficient change detection and data ingestion.
* **Improved Data Extension Keys**: Replaced auto-increment `id` primary keys with composite keys (tenant locator + entity locator + hashed field name) to ensure unique record identification and accurate updates.
Documentation Updates [#documentation-updates-10]
* The [Underwriting Plugin guide](/configuration/plugins/underwriting) has been enhanced to include comprehensive best practices for interpreting, adding, and clearing underwriting flags via the plugin.
Bug Fixes [#bug-fixes-24]
{/* KERN-6270 */}
* The `issuedTime` on a migrated transaction will now be set to the value from the when provided, defaulting to the segment `startTime` only when the transaction `issuedTime` is not specified in the request.
September 4, 2025 [#september-4-2025]
New Features: Autopay and Payment Execution Service [#new-features-autopay-and-payment-execution-service]
The new [Autopay](/features/billing/autopay) and [Payment Execution Service](/features/billing/payment-execution-service) feature set streamlines payment workflows by enabling automated generation of payment requests and execution through third-party payment providers.
In addition, our [Security Topic](/features/security/security-overview) now includes a [PCI Compliance Statement](/features/security/pci-compliance-statement) outlining Socotra's position on PCI Compliance.
Other Changes [#other-changes]
* The Preview Invoices endpoints for Quotes, Stateless Quotes, and Transactions now include a `count` query parameter to request the number of invoices to preview.
* The [Document Data Snapshot Plugin](/configuration/plugins/document-data-snapshot) is now called for documents configured with a `rendering` value of `prerendered`, allowing the metadata of the given document instance to be set programmatically.
Upcoming Data Lake Enhancements [#upcoming-data-lake-enhancements]
As previously announced, the next release on September 10th includes [Data Lake](/features/reporting/datalake) improvements that will require a period of downtime and data regeneration for this feature set. Key changes include:
* **Multi-Tenant Schema**: Adding a `tenant_locator` field to all tables and creating new composite primary keys that combine the tenant locator with existing keys to enable future consolidated reporting across multiple Business Account tenants.
* **Soft Deletion**: Introducing soft deletion capability with a new `deleted` field on tables subject to record deletion, improving change management and enabling future support for additional [Delta File](/features/reporting/delta-files) formats like CSV.
* **Enhanced Change Detection**: Adding an index to the `datalake_updated_timestamp` field for more efficient change detection and data ingestion.
* **Improved Data Extension Keys**: Replacing auto-increment `id` primary keys with composite keys (tenant locator + entity locator + hashed field name) to ensure unique record identification and accurate updates.
Bug Fixes [#bug-fixes-25]
{/* KERN-6294 */}
* Fixed an issue where installments were not generated when renewal transactions were reapplied after out-of-sequence endorsements.
August 27, 2025 [#august-27-2025]
Feature Enhancement: Target End State for Excess Credit Distributions [#feature-enhancement-target-end-state-for-excess-credit-distributions]
This enhancement enables custom workflows before execution of automatic distributions of excess funds by allowing users to specify a target end state for system-generated disbursements via the new `advanceDisbursementTo` property. See the [Excess Credits Guide](/features/billing/excess-credits) for details.
New Data Lake Entities [#new-data-lake-entities]
Data Lake tables are now available for installment items, credit items, and aux data. See the [Data Lake Guide](/features/reporting/datalake) for details.
Security Documentation Update [#security-documentation-update]
Our [security documentation](/features/security/security-overview) has been expanded and reorganized to provide clear, comprehensive, and user-friendly guides on security management within the Socotra Insurance Suite and your own applications.
Bug Fixes [#bug-fixes-26]
{/* KERN-6140, KERN-5979, KERN-6163, KERN-6117, KERN-5863 */}
* Fixed an issue where plugins failed to create tasks that set blocking underwriting flags.
* Negative invoice items are now settled immediately upon invoice generation.
* Plugins can now create coverages without an assigned locator by assigning a system-generated ULID locator.
* Resolved a syntax error in the `DataLakePolicyCoverageTerms` Data Lake transformation table.
* Prevented generation of empty consolidated documents when no subdocuments are available.
**Upcoming Data Lake Changes:** The previously announced enhancements to Data Lake are scheduled for the release of September 10th. Individual customer communications are ongoing, please reach out to your Socotra representative if more details are needed.
August 20, 2025 [#august-20-2025]
*Internal changes only for this release.*
API Docs Cleanup [#api-docs-cleanup]
References to the previously deprecated `billingTrigger` have been removed from the API documentation, including the `BillingTriggerUpdateRequest` entity and the `updatePolicyBillingTrigger` endpoint.
**Upcoming Data Lake Changes:** The previously announced enhancements to Data Lake are now scheduled for the release of September 10th. Individual customer communications are ongoing, please reach out to your Socotra representative if more details are needed.
August 13, 2025 [#august-13-2025]
New Feature: Auto Credit Application [#new-feature-auto-credit-application]
The new [Auto Credit Application](/features/billing/auto-credit-application) feature allows for automatic application of excess account credit balances to open invoices, streamlining the billing process. This feature is enabled by default for new accounts and can be configured per account.
August 6, 2025 [#august-6-2025]
Config Validation Requirement [#config-validation-requirement]
A longstanding configuration requirement is that Custom Data Types must be defined in `CamelCase`. It is now also a requirement that when such data types are referenced in the configuration, they must exactly match the defined name. This change will impact only new configuration deployments and redeployments; existing deployed tenant configurations will continue to function. See the section on [Configuration Case Sensitivity](/configuration/general-topics/deployment#configuration-case-sensitivity) for a complete overview.
Quote and Transaction Reset Clarification [#quote-and-transaction-reset-clarification]
We have updated the [quote](/features/policy-quotation/quotes#quote-reset) and [transaction](/features/policy-management/policy-transactions#trx-reset) flow overviews to clarify that quote and transactions in the `accepted` state must first be `refused` before they can be reset.
Bug Fixes [#bug-fixes-27]
{/* KERN-5925 & KERN-5926 */}
* Addressed a rounding issue leading to charge amounts in the Term Summary API to be some pennies off.
* Addressed a related issue where flat charges were prorated across segments in the same Term Summary API.
**Upcoming Data Lake Changes:** Some upcoming enhancements to Data Lake, targeted for the August 27th release, will require some downtime and a data regeneration period for that feature set. Your Socotra representative will be in touch with more details, and we will post further details ahead of the release.
July 30, 2025 [#july-30-2025]
New Feature: Schedules (BETA) [#new-feature-schedules-beta]
Schedules is a new feature that supports the efficient creation, rating and management of very large list of like-typed items, which can be used in various contexts such as policy transactions and quotes. See the [Schedules Guide](/features/schedules) for details.
Feature Enhancement: Granular Write Offs [#feature-enhancement-granular-write-offs]
This enhancement to the existing invoice write-off functionality allows users to write off specific invoice items or partial amounts, rather than only the remaining balance of the invoice. See the [Write-Offs Guide](/features/billing/write-offs) for details.
Open API Response Name Change [#open-api-response-name-change]
The response name in the [Open API definition file](/other-resources/open-api-specification) has been updated from `InstallmentInternal` to `Installment` for the following endpoints: , , and .
Bug Fixes [#bug-fixes-28]
{/* KERN-5905 */}
* Fixed a bug where reinstated policies were still reflecting a policy status of `cancelled`.
**Upcoming Data Lake Changes:** Some upcoming enhancements to Data Lake, targeted for the release of August 27th 2025, will include some downtime and a data regeneration period for that feature set. Your Socotra representative will be in touch with more details, and we will post further details ahead of the release.
July 23, 2025 [#july-23-2025]
Billing Preview for Stateless Quotes [#billing-preview-for-stateless-quotes]
A preview of prospective installments or invoices may now be generated for hypothetical quotes. See the [Previews Guide](/features/preview-operations) for more information.
Notice: Upcoming Open API Response Name Change [#notice-upcoming-open-api-response-name-change]
In the forthcoming release on July 30, 2025, the response name in the [Open API definition file](/other-resources/open-api-specification) will be updated from `InstallmentInternal` to `Installment` for the following endpoints: , , and .
Bug Fixes [#bug-fixes-29]
{/* KERN-5856, KERN-5788 */}
* Fixed a bug that prevented the update of loss information on a validated FNOL.
* Fixed a bug that caused an error when distributing very small amounts across many installments (e.g., 0.5 over 200) by assigning that amount to the first installment.
July 16, 2025 [#july-16-2025]
Installments Plugin [#installments-plugin]
The new [Installments Plugin](/configuration/plugins/installments) allows for more flexible installment scheduling, enabling the creation of installments at times that do not align with the current [Installment Lattice](/features/billing/installments-and-installment-lattices).
Migration Client Release and Updated Guidance [#migration-client-release-and-updated-guidance]
* A new version of the [Migration Client](/features/migration#migration-client) is available to download from the [config-sdk template package index ](https://github.com/socotra/config-sdk-template/packages/2312294), featuring improved retry logic and updated configuration template.
* The [Migration Guide](/features/migration) now includes a complete tutorial, along with an overview and tutorial specific to the Migration Client. These resources make use of our new [migration-tutorial ](https://github.com/socotra/migration-tutorial) repository, which includes assets necessary to get hands-on with a full end-to-end migration.
New Task Creation Methods [#new-task-creation-methods]
Tasks can now be created through Underwriting Flag creation and plugin execution. See the [Tasks Guide](/features/work-management/tasks) for more details.
July 9, 2025 [#july-9-2025]
New Feature: Custom Scheduled Events [#new-feature-custom-scheduled-events]
Custom events can now be scheduled to run at specified times or intervals and paired with webhooks to initiate workflows. See the [Custom Scheduled Events Guide](/configuration/general-topics/scheduled-events) for details.
New Feature: Policy Holds [#new-feature-policy-holds]
Policy holds can now be defined to prevent the processing of policy transactions. See the [Policy Holds Guide](/features/policy-management/policy-holds) for details.
Documentation Updates [#documentation-updates-11]
The [UI SDK documentation](/ui-sdk) now includes details of the [DataPropertyForm](/ui-sdk/components/data-property-form) component.
Notice: Autoclean of Abandoned Tenants Introduced to Sandbox [#notice-autoclean-of-abandoned-tenants-introduced-to-sandbox]
In order to maintain a clean and efficient environment, this release introduces an automated cleanup process to retire inactive tenants in sandbox.
Any tenants without plugin activity in the past 30 days will be considered inactive and subsequently retired, and the 30 day clock begins today.
For tenants that require an exception from this process, please contact your Socotra representative.
July 2, 2025 [#july-2-2025]
Deprecation: Quote Delinquency Reference [#deprecation-quote-delinquency-reference]
New delinquencies will no longer include a with `referenceType` of `quote`, and the `getDelinquenciesForQuote` endpoint is now deprecated. Existing delinquencies with a `quote` reference will remain retrievable.
June 25, 2025 [#june-25-2025]
Documentation Updates [#documentation-updates-12]
* The [Events Guide](/configuration/general-topics/events) now includes details on [defining and emitting custom events](/configuration/general-topics/events#custom-events).
Notice: Autoclean of Abandoned Tenants to be Introduced to Sandbox [#notice-autoclean-of-abandoned-tenants-to-be-introduced-to-sandbox]
In order to maintain a clean and efficient environment, the forthcoming release of July 9, 2025 will introduce an automated cleanup process to retire inactive tenants.
Any tenants without plugin activity in the past 30 days will be considered inactive and subsequently retired, and the 30 day clock will start July 9, 2025.
For tenants that require an exception from this process, please contact your Socotra representative.
Bug Fixes [#bug-fixes-30]
{/* KERN-5599 */}
* Fixed a bug where fetching FNOL by entity number did not return all data for the entity.
June 18, 2025 [#june-18-2025]
New Work Management Feature Set [#new-work-management-feature-set]
Introducing the first release of Socotra's major new Work Management feature set, which supports associations between users and entities such as accounts and quotes, and the ability to assign users specific tasks. See the [Work Management Guide](/features/work-management/work-management-overview) for more details.
Numbering Support for New Entity Types [#numbering-support-for-new-entity-types]
You can now configure automatic numbering for the following new entity types:
* Payments
* Tasks
Cancellation at Existing Policy End Time [#cancellation-at-existing-policy-end-time]
The system now supports a cancellation transaction effective time that matches the policy's existing end time, which is useful to distinguish between policies that were explicitly cancelled versus those allowed to expire.
Other Enhancements [#other-enhancements-14]
* `createdAt` and `createdBy` properties will now be returned in the
* The system now supports change instructions as part of a reinstatement transaction, allowing reinstatement of a policy with changes to coverages or other data. See the endpoint for details.
* You can now fetch the invoices associated with a payment that was later reversed, using the `includeReversed` query parameter on the endpoint.
Bug Fixes [#bug-fixes-31]
{/* KERN-5573 */}
* Fixed a bug where `defaultRegion` was not being applied on Quote validation
June 11, 2025 [#june-11-2025]
New Document Features: Snippets and Custom Fonts [#new-document-features-snippets-and-custom-fonts]
You can now configure reusable content for inclusion in documents, and have custom typefaces. See the [Dynamic Documents Guide](/features/documents/dynamic-documents) for details.
New Data Lake Entities: Claims [#new-data-lake-entities-claims]
Data Lake has been expanded to include information about claims and related FNOL entities. See the [Data Lake Guide](/features/reporting/datalake) for details.
Documentation Updates [#documentation-updates-13]
* The [UI SDK documentation](/ui-sdk) has been extensively revised and brought up-to-date with current capabilities.
* The [Coverage Checks Feature Guide](/features/claims/coverage-checks) details coverage check functionality for [first notice of loss ("FNOL")](/features/claims/fnol).
* The document consolidation feature now has [its own expanded guide](/features/documents/document-consolidation).
* A new Feature Guide is available for [Payment Shortfall Handling](/features/billing/payment-shortfall-handling), which helps settle invoices that have minimal remainder amounts after payments are applied.
June 4, 2025 [#june-4-2025]
Bug Fixes [#bug-fixes-32]
{/* KERN-5530, KERN-545 */}
* Introducing a `numberingString` in a configuration is now a [safe](/configuration/general-topics/redeployment#redeployment_safety) deployment change.
* Copied quotes will now have a [number](/configuration/general-topics/entity-numbering) assigned if the governing `numberingTrigger` is `creation`.
May 28, 2025 [#may-28-2025]
Bug Fix: FNOL Numbering [#bug-fix-fnol-numbering]
{/* KERN-5424 */}
Fixed a bug preventing the automatic generation of a [number](/configuration/general-topics/entity-numbering) for an FNOL when `autoValidate` is `true`.
May 21, 2025 [#may-21-2025]
Search Summary Enhancement [#search-summary-enhancement]
You can now supply a set of strings in the `fields` array of a , which will cause the `searchSummary` map in the to be populated with fields matching a string in the array, along with the associated value.
See the [Field Augmentation section of the Search Guide](/features/search#search-request-fields) for details.
Bug Fix: Document Consolidation [#bug-fix-document-consolidation]
{/* KERN-5395 */}
A consolidated document will still be produced if one or more of its sub-documents are unavailable, with the consolidated document simply omitting such sub-documents. This can occur if the [Document Selection Plugin](/configuration/plugins/document-selection) skips generation of some documents.
May 14, 2025 [#may-14-2025]
Policy Locators in Billing Events [#policy-locators-in-billing-events]
Billing events now include associated `policyLocators`, given as an array that will include up to 5 relevant policies and a `listCompleted` indicator. See the ["Payloads" section of the Events Guide](/configuration/general-topics/events#event-payloads) for details. You can see the complete listing of events and associated payloads on the [Event Definitions](/configuration/general-topics/event-definitions) page.
Bug Fixes [#bug-fixes-33]
{/* KERN-5404, KERN-5320 */}
* Updated excess credit handling to behave as expected when encountering one or more partially-paid invoices.
* Fixed a bug causing existing `auxDataSettings` to be wiped out when redeploying a partial configuration with no `auxDataSettings`.
May 7, 2025 [#may-7-2025]
New Feature: Invoice Fees [#new-feature-invoice-fees]
Invoice fees make it easy to configure the automatic addition of a flat charge to invoices. See the [Invoice Fees](/features/billing/invoicing#invoice-fees) section of the [Invoicing Guide](/features/billing/invoicing) for details.
New Diary Associations [#new-diary-associations]
[Diary entries](/features/work-management/diaries) can now be linked to underwriting flags, accounts, and invoices.
Update: Numbering [#update-numbering]
Entity numbers can now be assigned to accounts and quotes on creation.
April 30, 2025 [#april-30-2025]
New Feature: Document Consolidation [#new-feature-document-consolidation]
With document consolidation, you can configure an assemblage of documents to be produced as single unit. See the [Documents Guide](/configuration/resources/documents) for details.
Quick Quotes API Update [#quick-quotes-api-update]
Quick quote API responses, such as , now include an optional `validationResult` which can be inspected if post-validation endpoint requests fail due to a quick quote never having passed validation.
billingTrigger Deprecation [#billingtrigger-deprecation]
`billingTrigger` is deprecated. Billing is always triggered while issuing a quote or transaction, and after the May 7 release, attempts to set `billingTrigger` to anything other than `issue` will be blocked.
Deprecated Jobs API Endpoints Removed [#deprecated-jobs-api-endpoints-removed]
The deprecated `fetchEarlyInvoicingJob` and `fetchEarlyInvoicingJobsForAccount` endpoints have been removed. All invoicing jobs can now be fetched with and .
Bug Fixes [#bug-fixes-34]
{/* KERN-5104, KERN-5252 */}
* Updated error message to indicate full set of unexpected document names if such documents are erroneously returned by the [document selection plugin](/configuration/plugins/document-selection).
* Fixed a bug preventing the generation of expected negative installment items when a cancellation transaction is preceded by a non-cost-bearing transaction.
April 23, 2025 [#april-23-2025]
Media Data [#media-data]
{/* KERN-5032 */}
You can now upload various media data to Socotra and create associations with entities, in much the same way as with [contacts](/features/contacts). See the [Media Data Guide](/features/work-management/media) and [API documentation](/api/aux-data/media) for details.
Search Updates [#search-updates]
{/* KERN-4595 */}
Search has been enhanced in several ways:
* You can now search for [contacts](/features/contacts), [diaries](/features/work-management/diaries), [first notice of loss ("FNOL")](/features/claims/fnol), and [payments](/features/billing/payments).
* For entities supporting [numbering](/configuration/general-topics/entity-numbering), you can search by number, and will see the number exposed in the result search summary.
* The "fuzzy" default behavior is more intuitive, accounting for "starts with" when scoring results.
* Filtering on start and end creation time is available.
See the [Search Feature Guide](/features/search) for details.
Coverage Terms Data Model Update [#coverage-terms-data-model-update]
[Coverage terms](/features/policy-management/coverage-terms) are now represented in the data model as `Map<String, Object>` instead of `Map<String, String>`. This allows fetches of validated entries to use actual expected types for coverage term values, instead of representing all values as strings. The introduction of "value" coverage terms, as opposed to "options", necessitated this change. It should have no effect on creation or update requests.
Configuration Redeployment Update [#configuration-redeployment-update]
It is now possible to add new, required [data extensions](/configuration/data-extensions/overview) on redeployment, as long as you supply default values. The platform will apply the default value on subsequent transactions as needed if a value is not explicitly defined.
See the [Redeployment Guide](/configuration/general-topics/redeployment) for additional details.
April 16, 2025 [#april-16-2025]
Policy Status [#policy-status]
{/* KERN-4943 */}
You can now view a policy's status and stay apprised of status changes via the event stream. See the [Policy Status Guide](/features/policy-management/policy-status) for details.
Note that policy statuses will not be backfilled; statuses will only be included for new policies and when transactions to existing policies prompt the platform to update the status.
Bug Fixes [#bug-fixes-35]
{/* KERN-5161, KERN-5099 */}
* Fixed a bug preventing documents from generating as expected on reversal and out-of-sequence (OOS) transactions.
* Constraint table lookups with decimal values as keys will now work as expected, with a value-based test for equality. For example, if a table has a key value `340.98000`, values `340.98000`, `340.980`, and `340.98` will match it.
April 9, 2025 [#april-9-2025]
Search Update [#search-update]
Searches by policy locator or account locator now include any associated first notice of loss (FNOL) records.
More Contact Associations [#more-contact-associations]
{/* KERN-4945 */}
[Contacts](/features/contacts) can now be linked to policies, quotes, and quick quotes.
Ad-Hoc Execution of Precommit Plugin [#ad-hoc-execution-of-precommit-plugin]
{/* KERN-4922 */}
The [precommit plugin](/configuration/plugins/precommit) can be invoked manually via API for draft quotes and draft or initialized transactions.
Full Stateless Pricing of Quote and Transactions [#full-stateless-pricing-of-quote-and-transactions]
{/* KERN-4883 */}
The [previews](/features/preview-operations) feature has been expanded to allow for stateless pricing of quotes and transactions. See the [Quotes API](/api/quotes/quotes) and [Policy Transactions API](/api/policy-management/policy-transactions) for preview endpoint details.
Bug Fixes [#bug-fixes-36]
{/* KERN-5177, KERN-5173, KERN-5174, KERN-5165, KERN-5141, KERN-5013 */}
* Updated logic to ensure that data masking rules are followed for policy change transactions; for example, a user with a lower-privilege masking level cannot add coverages that have fields restricted above that user's level.
* Users with a certain masking level are allowed to modify fields on entities at that level or below, even if the element has some data extensions at a higher masking level.
* Fixed unexpected `500` error on calls to .
* Configuration redeployment will now succeed if a regular expression rule for a field is removed, effectively widening allowed values for the field.
* persists newly added elements as
expected.
* It is now possible to alter a payment's `paymentMode` from `aggregate` to `normal` when using to update a payment.
April 2, 2025 [#april-2-2025]
Notice: Classic Early Invoicing Endpoint Deprecation [#notice-classic-early-invoicing-endpoint-deprecation]
Over the last few months, we have been working on some upcoming features related to flat charges and invoice fees. To provide the best possible API design as part of this, we are making some API changes.
* The existing `fetchEarlyInvoicingJob` and `fetchEarlyInvoicingJobsForAccount` endpoints will be removed as of the April 30th 2025 release. See the deprecation notice from February 12, 2025.
* The existing and endpoints have been refactored to accommodate both early and immediate triggers for invoice generation.
*Internal changes only for this release.*
March 26, 2025 [#march-26-2025]
New Features [#new-features]
* [Aggregate payments](/features/billing/payments#aggregate-payments) allow you spread payments across accounts, supporting a wide range of use cases without compromising the ability to trace cash flows through the system.
* With [flat charges](/features/billing/flat-charges), you can invoice charges directly through the billing system and easily handle a variety of fee arrangements.
* [Previews](/features/preview-operations) allow you to view the outcome of certain key operations without committing to the changes.
Bug Fixes [#bug-fixes-37]
{/* KERN-5098, KERN-5029 */}
* Fixed a bug causing access tokens with an `expiresAt` in the future from being accepted as expected.
* `suppressRenderingData` now works as expected for all applicable [Documents API](/api/documents) endpoints, including .
March 19, 2025 [#march-19-2025]
*Internal changes only for this release.*
March 12, 2025 [#march-12-2025]
New Feature: Data Lake Delta Files [#new-feature-data-lake-delta-files]
Easily sync Socotra Data Lake tables with your own infrastructure using [Data Lake Delta Files](/features/reporting/delta-files)! This feature allows you to list and retrieve SQL-based Data Lake diffs, ensuring accurate and efficient table replication into your own data platform.
New Data Lake Entities: Billing [#new-data-lake-entities-billing]
Data Lake now exposes a number of billing tables. See the [updated schema and guide](/features/reporting/datalake) for details.
Configuration Deployments API Update [#configuration-deployments-api-update]
{/* KERN-4882 */}
You can now upload configuration files with brackets (`[]`) in the filename.
Classic Endpoint List Behavior Deprecation [#classic-endpoint-list-behavior-deprecation]
Over the last few months, we have posted notices about [impending updates to our list endpoint behavior](#list-endpoint-semantics-notice). The "classic" behavior for list endpoints is to return a simple array of objects; however, to better facilitate pagination, we have established a new convention in which list endpoints will return an object with a `listComplete` property and the `items` array (example: ). Our API documentation has been following this new convention, which you will observe when setting the URL query parameter `extended` to `true` on list requests.
We recommend that you revise API client code to use `extended=true` and consume paged responses accordingly.
Classic list behavior is deprecated. Starting with the **May 14 Socotra release**, all list endpoint responses will be returned with the `extended=true` form, and the query parameter will no longer have a functional effect.
March 5, 2025 [#march-5-2025]
New Feature: First Notice of Loss [#new-feature-first-notice-of-loss]
The First Notice of Loss ("FNOL") feature allows you to capture key loss details before the formal claims process begins. See the [FNOL Guide](/features/claims/fnol) and [API documentation](/api/claims) for details.
New Feature Guides [#new-feature-guides]
* [Single Sign-On (SSO)](/configuration/general-topics/identity-providers)
* [Regions Configuration and Usage](/configuration/general-topics/regions)
February 26, 2025 [#february-26-2025]
Bug Fix [#bug-fix]
{/* KERN-4784 */}
If a quote is created with a specific `timezone` and no explicit `endTime`, the quote's `timezone` will be used as the basis for determining the `endTime`.
February 19, 2025 [#february-19-2025]
Rating Plugin Interface Update [#rating-plugin-interface-update]
The rating plugin interface has been updated so that `rate` or `referenceRate` do not need to be provided on `RatingItems` if an absolute `amount` is provided instead. See additional details in [prior release notes](#plugin-interface-changes-notice).
Invoices API Update [#invoices-api-update]
Invoice records returned by the [Invoices API](/api/billing/invoices) list endpoints will no longer contain `invoiceItems`. An invoice and its `invoiceItems` will still be obtainable by fetching an invoice with its items.
Resource Selection Update [#resource-selection-update]
In plugins, you can now set a specific time for the resource selector to use as its reference point, like this:
```java
Optional tableRecord = ResourceSelectorFactory.getInstance()
.getSelector(Instant.now())
.getTable(VehicleTypeFactor.class)
.getRecord(VehicleTypeFactor.makeKey("toyota", "corolla", 2010));
```
Bug Fixes [#bug-fixes-38]
{/* KERN-4812, KERN-4796 */}
* Revised misleading error message on attempts to create users with invalid characters in the `userName`. The new error message clearly identifies the username as invalid, and why.
* Updated quote validation to check whether an invalid timezone was provided.
February 12, 2025 [#february-12-2025]
Policy Transactions API Update [#policy-transactions-api-update]
The list of will no longer include reapplied transactions. Instead, the `reapplicationOfLocator` on the will have the locator of the transaction being reapplied.
Jobs API Endpoint Deprecations [#jobs-api-endpoint-deprecations]
The `fetchEarlyInvoicingJob` and `fetchEarlyInvoicingJobsForAccount` endpoints are deprecated.
Bug Fix [#bug-fix-1]
{/* KERN-4722 */}
The `policy.quote.update` event will now fire when adding, modifying, or deleting elements.
Forthcoming Changes [#forthcoming-changes]
* [Invoices API](/api/billing/invoices): in next week's release, invoice records returned by list endpoints will no longer contain `invoiceItems`. An invoice and its `invoiceItems` will still be obtainable by fetching an invoice with its items.
* Plugin interface and list endpoint semantics update: see the January 22 release notes for details on [impending changes to the rating plugin interface](#plugin-interface-changes-notice) and [list endpoint semantics](#list-endpoint-semantics-notice) throughout the Socotra API.
February 5, 2025 [#february-5-2025]
Account Constraints [#account-constraints]
You can now configure [constraints](/configuration/data-extensions/data-extension-constraints) for data extensions on [accounts](/features/accounts). See the [Accounts API](/api/accounts) for details on corresponding constraint evaluation endpoints.
Documents API Update [#documents-api-update]
[Documents API](/api/documents) fetch endpoints have a new `suppressRenderingData` option. When set to `true`, the API allows you to fetch 100 items per page instead of 10, but items will not include metadata or rendering data.
Forthcoming Plugin Interface Changes [#forthcoming-plugin-interface-changes]
See [the January 22 release notes](#plugin-interface-changes-notice) for details on impending changes to the rating plugin interface and list endpoint semantics throughout the Socotra API.
January 29, 2025 [#january-29-2025]
*Internal changes only for this release.*
See last week's release notes for details on impending changes to the rating plugin interface and list endpoint semantics throughout the Socotra API.
January 22, 2025 [#january-22-2025]
Forthcoming Plugin Interface Changes [#forthcoming-plugin-interface-changes-1]
To facilitate upcoming support for flat charges and invoice fees, `RatingItem` objects returned from the rating plugin will no longer be required to have `rate` or `referenceRate` properties if an absolute `amount` is provided instead.
Existing plugin code that reads `rate()` or `referenceRate()` will need to recognize the returned values as `Optional`.
```java
// code that is currently valid but will need to be updated after this change is deployed:
BigDecimal rate = ratingItem.rate();
// equivalent code after this change is deployed:
Optional rate = ratingItem.rate();
```
In the `DocumentDataSnapshot` plugin, the following properties will also become optional, and will need to be handled in a similar way:
* `InvoiceItemSummary.elementType`
* `InvoiceItemSummary.elementStaticLocator`
* `InvoiceItem.elementStaticLocator`
**The provisional release date for these changes is February 19.**
We are analyzing deployed configurations to assess customer impact and ensure that configurations are updated for compatibility in coordination with this change rollout. Of course, deployment attempts after this change will fail with a compilation error if plugin code has not been updated to handle `Optional` types correctly.
Please contract your Socotra representative if you have any questions. We will provide additional updates about this impending change in subsequent release notes.
List Endpoint Semantics Update [#list-endpoint-semantics-update]
As indicated in prior release notes ("Changes to Paged List Fetch Semantics"), Socotra is moving to a convention in which list results are not simply an array of items but an object containing the results array and an indicator `listCompleted` property to facilitate results pagination.
The new response format is documented for individual list endpoints (e.g. ), and is obtained by setting the optional `extended` query parameter to `true`. Soon, all such endpoints will behave as though `extended` is `true` by default, and we will remove that query parameter and access to the original list response style.
We recommend that client code be updated to use `extended=true` in all list fetches so that response consumption is brought in line with the new standard. In upcoming release notes, we will provide a reminder and a date on which the `extended=true` response style will become the default.
January 15, 2025 [#january-15-2025]
Underwriting Event Payload Updates [#underwriting-event-payload-updates]
The following underwriting event payloads will no longer include arrays of underwriting flags:
*
*
*
*
Underwriting flags on quotes and transactions can be fetched through the API, where they are exposed in and , respectively.
Other Changes [#other-changes-1]
* `timezone` has been added to .
* There is now a dedicated SAML identity provider creation endpoint and corresponding .
January 8, 2025 [#january-8-2025]
New Feature: Availability [#new-feature-availability]
The availability feature facilitates the introduction and retirement of products, data extensions, policy elements, and coverage terms, supporting a variety of use cases. See the [Availability Guide](/configuration/general-topics/availability) for details.
New Feature: Contact Management [#new-feature-contact-management]
Contact management brings the ability to define contacts and manage them in association with system entities. See the [Contact Management Feature Guide](/features/contacts) for details.
New Static Data Endpoints [#new-static-data-endpoints]
The following endpoints allow for fetching static data on quotes and policies, including historical values:
*
*
*
*
Underwriting Update [#underwriting-update]
* and
now have a `tag` property.
December 18, 2024 [#december-18-2024]
User Management API Update [#user-management-api-update]
An optional `email` property has been added to , , and .
This is the final 2024 release. There will be no release on 2024-Dec-25, and no release the following week (2025-Jan-01). The next release will be available Wednesday, 2025-Jan-08.
December 11, 2024 [#december-11-2024]
Migration API update [#migration-api-update]
{/* KERN-4359 */}
The [Migration API](/api/migration) now allows you to specify Aux Data for importation with .
Identity Providers API update [#identity-providers-api-update]
{/* KERN-4414 */}
now includes a `callbackUrl`
property.
December 4, 2024 [#december-4-2024]
New Feature: Data Lake (Beta) [#new-feature-data-lake-beta]
Data Lake provides a relational view of your book of business in Socotra, enabling a wide range of reporting applications. See the [Data Lake Guide](/features/reporting/datalake) for details.
New Feature: Value-Based Coverage Terms [#new-feature-value-based-coverage-terms]
Until now, values to be associated with a [coverage term](/features/policy-management/coverage-terms) had to be defined as a finite set of `options` in the configuration. To support use cases requiring variable values -- such as a computed quantity based on various factors -- a coverage term may now be configured to take a `value` described as a , instead of `options`. See the [Coverage Terms Guide](/features/policy-management/coverage-terms) for details.
Other Changes [#other-changes-2]
{/* KERN-4319, KERN-4362 */}
* Use of the precommit plugin for delinquency events (method signature `PreCommitDelinquencyEventsResponse preCommit(PreCommitPlugin.DelinquencyEventsRequest request)`) is now deprecated.
* Both "startsWith" and "fuzzy" searches are case-insensitive.
Bug Fixes [#bug-fixes-39]
{/* KERN-4274, KERN-4074, KERN-3909 */}
* Pascal casing for account names is now enforced.
* `graceEndAt` now accounts for `gracePeriodDays` if that value is set in the precommit plugin for delinquency, with `graceEndAt` taking precedence if it is also set in the plugin.
* [Deployments API](/api/configuration-and-development/deployments): and responses include a `content-type: application/zip` header.
November 20, 2024 [#november-20-2024]
New Feature: Early Invoicing [#new-feature-early-invoicing]
* Early invoicing allows invoices to be created and sent before the generate time of the installments that they are based on.
* See the [Early Invoicing Feature Guide](/features/billing/early-invoicing) for details.
There will be no release on 2024-Nov-27. The next release will be on 2024-Dec-04.
November 13, 2024 [#november-13-2024]
New Feature: Delinquency Events [#new-feature-delinquency-events]
* Delinquency events are a new feature that supports extending delinquency processes with additional extensions.
* For interacting with events directly, the and endpoints are added, along with responses and
* The endpoint and response types and have been added for job information.
* See the [Delinquency Events Feature Guide](/features/billing/delinquency-events) for details.
November 6, 2024 [#november-6-2024]
Constraint Tables [#constraint-tables]
* There is now an option to use any column (not just the first column) of a constraint table as a list of distinct values for [constraints evaluation](/configuration/data-extensions/data-extension-constraints). Use of the first column is implicit if there is no `where` clause. To enable other columns, set the `makeDistinct` property in the column definition to `true`.
* For consistency with other validation checks on configuration deployment, validation of constraint column names is now case sensitive as well. Column names in the constraints definition have to match case with column name in the associated constraint table definition.
Quote Events [#quote-events]
* Events have been added to signal changes to static data for quotes.
* The new event types are `policy.quote.staticdata.add`, `policy.quote.staticdata.replace`, and `policy.quote.staticdata.update`, each of which emit a object.
Optional Properties [#optional-properties]
The following properties are now marked as optional:
* : `tag`
* and : `data`
* : `headers`
October 30, 2024 [#october-30-2024]
Constraints with Custom Data Types [#constraints-with-custom-data-types]
Data extension constraints have been extended to include nested custom data objects. Constraining arrays of custom data objects is not yet supported.
Additional Changes to Paged List Fetch Semantics [#additional-changes-to-paged-list-fetch-semantics]
The following endpoints have been updated to align with list endpoint semantics as described in recent release notes:
* returns
* returns
* returns
* returns
Deployments [#deployments]
To better accommodate common zip file creation patterns on various systems, configuration deployment will no longer fail if the configuration archive contains an extra top-level directory.
October 23, 2024 [#october-23-2024]
Data Access Controls [#data-access-controls]
* Security features are now available to restrict users' access to system data based on specific Products or Regions, or designated extension data.
* See the [Data Access Controls feature guide](/configuration/general-topics/data-access-controls) and [Data Access Controls API guide](/api/configuration-and-development/data-access-controls) for details.
Webhooks Security Features [#webhooks-security-features]
* Webhooks are now security enabled: The entities , , and have added properties `secret`, `tag`, `secureSsl`, and `hmacEnabled`.
* See the [Security Features section of the Webhooks configuration guide](/configuration/general-topics/webhooks#webhooksSecurity) for implementation details.
Yet More Changes to Paged List Fetch Semantics [#yet-more-changes-to-paged-list-fetch-semantics]
Similar to the endpoints that were enhanced last week, when fetching entities with any of the following endpoints, a new query parameter is available called `extended`. Setting `extended` to `true` means that the return object will not be a bare array of entities, but rather a List Contents object that includes an indicator that the list is complete. The following endpoints have been changed:
* returns
(and, `UserBasicResponse` has been
renamed to )
* returns
* ,
,
,
and
return
* ,
,
return
* returns
* and
return
* returns
* and
return
* , getDelinquenciesForQuote,
and
return
* and
return
* returns
* returns
* returns
* returns
* returns
* ,
return
* returns
* returns
The [Open API descriptor file](/other-resources/open-api-specification) and documentation for endpoints expresses these responses as if the `extended` property were set to `true`.
Later, the `extended` property will be deprecated, and then removed and the default behavior will be as if it were `true`. Until then, the default value for this flag is `false`.
Other Changes [#other-changes-3]
* There is a new [Feature Guide for Dynamic Documents](/features/documents/dynamic-documents)!
* There is a new block of example code provided for the [Document Data Snapshot Plugin](/configuration/plugins/document-data-snapshot#documentDataSnapshotExample) configuration guide.
* The entity has new property `invoiceItemLocators`.
* The entity has new optional properties `policyLocator`, `quoteLocator`, `chargeCategory`, `chargeType`, and `transactionLocators`.
October 16, 2024 [#october-16-2024]
Entity Numbering [#entity-numbering]
* Several system entities, including accounts, policies, quotes, policy terms, invoices, and disbursements can now have automatically generated numbers, for use on printed documents, portal and app screens, etc.
* This provides a much easier, human-readable identifier compared to locators.
* Numbers are ideal for use in customer service and similar situations.
* See the [Entity Numbering Feature Guide](/configuration/general-topics/entity-numbering) for details.
More Changes to Paged List Fetch Semantics [#more-changes-to-paged-list-fetch-semantics]
When fetching entities with any of the following endpoints, a new query parameter is available called `extended`. Setting `extended` to `true` means that the return object will not be a bare array of entities, but rather a List Contents object that includes an indicator that the list is complete. The following endpoints have been changed:
* returns
* ,
, and
return
* ,
, and
return
* returns
.
* returns
.
* returns
* returns
Other Changes [#other-changes-4]
* The entity has added fields `policyLocator`, `quoteLocator`, `chargeCategory`, `chargeType`, and `transactionLocators` properties.
* The entity has new property `transactionLocators`.
* The entity's `pluginVersionStatus` has type changed from `map<string,string>` to `map<string,map<string,string>>`.
October 9, 2024 [#october-9-2024]
New Feature Guides [#new-feature-guides-1]
* [Delinquency Feature Guide](/features/billing/delinquency)
* [Billing Holds Feature Guide](/features/billing/billing-holds)
Other Changes [#other-changes-5]
* Added new endpoint.
* Added new property `clearedAt` to .
October 2, 2024 [#october-2-2024]
* Added the property `category` to , to indicate in which of the main categories the element is. This can be `product`, `policyLine`, `exposureGroup`, `exposure`, or `coverage`.
* Added the endpoint to convert a configuration's property casing to match requirements.
* Added the `resetToDraft` query parameter for the endpoint. If `true`, then the transaction will revert to draft state and the generated segment data, including elements and data, will be discarded. If `false` (the default), then the transaction will revert to `initialized` state and the segment data will be retained. This is useful to preserve the locator data for generated elements.
September 25, 2024 [#september-25-2024]
New Getting Started Guide! [#new-getting-started-guide]
* See the new [Getting Started Guide](/getting-started/introduction-to-socotra) for a step-by-step introduction to configuring and using Socotra.
New Migration Feature Guide [#new-migration-feature-guide]
* See the new [Migration Feature Guide](/features/migration) for more details about data migration projects.
Invoice Documents [#invoice-documents]
* Documents can now be configured to renender when invoices are generated, similarly to how policy documents are created.
* See the [Invoice Rendering](/features/billing/invoicing#invoiceRendering) topic for details.
Other Changes [#other-changes-6]
* Enabled support for [reinstatement with a gap](/features/policy-management/reinstatements#reinstatementWithGap).
* Added a new feature guide for [automatic handling of excess credits](/features/billing/excess-credits).
* Extended the [Quick Quotes Feature Guide](/features/policy-quotation/quick-quotes) with additional details.
* Clarified in the [Rounding Service Feature Guide](/features/financials/rounding-service) that the configuration for rounding mode is limited to data extensions.
* Marked the following properties as optional:
* : `elementLocator`
* : `clearedFlags`
September 18, 2024 [#september-18-2024]
External Documents [#external-documents]
You can now attach documents created from outside Socotra to quotes, policies, terms, segments, and transactions. See the [Document Management Feature Guide](/features/documents/document-management) and [Documents API Guide](/api/documents) for details.
Other Changes [#other-changes-7]
* On , the `latestSegmentLocator` has been added to indicated the last segment on the policy based on issued transactions.
* The entity has added property `termNumber`.
* The endpoint's request type has been changed to ElementResponse\[].
* On , the `defaultRegion` property has been deprecated and marked as optional.
* For these configuration entities, the `displayName` is now marked as optional.
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
Older Changes [#older-changes]
See the [release notes archive](/other-resources/release-notes-archive) for older release notes.