# Release Notes Archive This is a continuation of older release notes from the [main release notes page](/other-resources/release-notes). September 11, 2024 [#september-11-2024] * On , the property `acceptedTime` has been added, the properties `aggregatedTransactions` and `changeInstructions` have now marked as optional. * On , the deprecated property `boundTime` has been removed in favor of the new property `acceptedTime`. * On , the property `aggregatedTransactions` is now marked as optional. September 4, 2024 [#september-4-2024] Optional Properties [#optional-properties] The following properties are now marked as optional: * : `autoRenewalPlanName`, `delinquencyPlanName`, `excessCreditPlanName`, `shortfallTolerancePlanName`, `invoiceDocument`, `preferences`, `region` * : `durationBasis`, `billingLevel`, `billingTrigger`, `region` * : `coverageTerms`, `data` * : `coverageTerms`, `data` * : `description` * : `static` * : `region` * : `region` Billing Triggers [#billing-triggers] The "Billing Trigger" setting is being removed, and the following entities now have the property `billingTrigger` deprecated. * * * * * * In addition: * On and , `defaultBillingTrigger` is deprecated. * The endpoint `updatePolicyBillingTrigger` is deprecated. * The entity `BillingTriggerUpdateRequest` is deprecated. Other Change [#other-change] * On , the property `documentInstanceState` has been added, and the equivalent property `state` has been deprecated. August 28, 2024 [#august-28-2024] * The following state properties have been changed, from `state`: * : `accountState` * : `quickQuoteState` * : `quickQuoteState` * : `invoiceState` * : `documentInstanceState` * The endpoints and have had the property `includeZeroAmountInvoices` added, and `excludeOtherPolicies` has been removed. * The endpoint has been deprecated in favor of because transactions can have a maximum of a single segment. * The entity has new properties `category` and `external`. August 21, 2024 [#august-21-2024] Diaries [#diaries] [Diaries](/api/aux-data/diary) are a new feature that enables a running narrative to be attached to individual entities. The following endpoints have been added: * * * * * * The following entities are used in the above endpoints: * * * For now, diaries are enabled for quotes, policies, and policy transactions. Other entities will be enabled in the future. See the [Diaries Feature Guide](/features/work-management/diaries) for more information. Regions [#regions] Regions are now supported. The new `region` property has been added to: * * * * * * Also, `defaultRegion` has been added to . Changes to Paged List Fetch Semantics [#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 `fetchQuickQuotesForAGroup` return . * returns . * returns . * returns . * returns . Later, the `extended` property will be removed and the default behavior will be as if it were `true`. Auto Transaction Rebasing [#auto-transaction-rebasing] Before, transactions were always invalidated when a transaction on another branch became issued. Now, these transactions are automatically rebased on to the new, latest issued transaction. This behavior can be bypassed by setting the `autoRebase` query parameter to `false` when using the endpoint. Other Changes [#other-changes] The following entity properties have been marked as optional: * : `permissions` and `tenants` * : `coveragesTerms` and `elements` * : `branchHeadTransactionLocators` July 31, 2024 [#july-31-2024] Quick Quotes [#quick-quotes] [Quick Quotes](/api/quick-quotes) are a lightweight mechanism for quotation without full underwriting support or document generation. Element extension data for quick quotes can be a subset of that used on a full quote. The following endpoints have been added: * * * * * * * * * * * * * * * * `assignQuickQuoteToGroup` * `fetchQuickQuotesForAGroup` In support of the above endpoints, the following new entities are used: * * * * Account Level Billing [#account-level-billing] Account level billing is activated by setting the `billingLevel` of the account, policy, or quote to `account`. If a policy or quote uses `inherit` for the `billingLevel`, it will defer to the account for the setting. The following endpoints have been added to modify the billing level: * * * Each of these endpoints takes a entity. In addition, the following entities have added a `billingLevel` property: * * * * * * * * Policy Transaction Branching [#policy-transaction-branching] Policy transaction branching is done by setting the `baseLocator` of the transaction to a transaction other than the most recently created transaction. The following endpoints that create policy transactions now have a `baseLocator` parameter: * * * * * And the following entity has a `baseLocator` property: * Configuration Changes [#configuration-changes] * Added the property `delinquencyLevel`, and removed properties `baseLapseOn` and `lapseConflictHandling` from * Added the property `defaultBackdatedInstallmentsBilling` to . * Deprecated the `billingPlans` and `defaultBillingPlan` properties on , and `defaultBillingPlan` on . These will be removed in an upcoming release. Other Changes [#other-changes-1] * Endpoints which return a streaming response now show the type of object in the stream. So now is shown as `StreamingResponseBody<string>`, `StreamingResponseBody<ZipFile>`, etc. * The 's `installmentItemsLocators` property has been renamed to `installmentItemLocators`, and has added properties `invoiceLocator` and `transactionLocator`. Also, the `reversalOfLocator` property has been removed. * Added a `timezone` property to * Added the `preemptingLapseTransactionLocator` property to . * Added properties `realizedAt`, `reversalReason`, and `reversedAt` to . * Added the boolean property `reversalLattice` to , and made the `settingsLocator` property optional. * On and , renamed the `quoteGroupLocator` property to `groupLocator`. * On , added the properties `latestTermLocator` and `billingLevel`. * On , , , and , added the properties `billingLevel` and `invoiceDocument`. * Added the endpoint. July 24, 2024 [#july-24-2024] *Internal changes only for this release.* July 1, 2024 [#july-1-2024] Stateless Operations [#stateless-operations] Stateless operations are a way to determine the validatability, pricing, and underwriting for a quote or policy transaction without changing its state. The following endpoints now have a `stateless` parameter added to generate the results of the call without a state change: * * Other endpoints will also be updated with a `stateless` parameter in upcoming releases. Invoices and Installments [#invoices-and-installments] * On , added new properties `invoiceLocator` and `transactionLocator`, and changed the `installmentItemsLocators` property to be called `installmentItemLocators`, and made the `elementStaticLocator` property required. * On , made the `startTime` and `endtime` properties required, and changed the type of the `currency` property to `string`. * On , removed the property `reversalOfLocator`. * On , added the property `reversalLattice`, and made the `settingsLocator` property required. Other Changes [#other-changes-2] * Added a new endpoint for retrieving granular information about the contents of invoices. The response includes the new entities , `PolicyInvoiceSummary`, `InvoiceItemSummary`, and `InstallmentItemSummary`. * Added the endpoint, with and entities. * Added the endpoint. * Added the property `preemptingLapseTransactionLocator` to , which indicates that some other delinquency's lapse transaction has taken precedence over this delinquency's lapse transaction. * Added the property `delinquencylevel` to * On , added the property `delinquencyLevel` and removed the properties `baseLapseOn` and `lapseConflictHandling`. * On , added the property `latestTermLocator` and made the `startTime` and `endTime` properties required. * On , changed the name of the `quoteGroupLocator` property to `groupLocator`. June 10, 2024 [#june-10-2024] Policies [#policies] * Added the properties `startTime` and `endTime` to . These indicate the start and end of the policy based on issued transactions only. Invoices and Payments [#invoices-and-payments] * Added endpoint * Added endpoint * Added the property `unsettledTime` to , to indicate when a settled invoice became unsettled due to a payment reversal. * The property `elementStaticLocator` has been added to the entity. Installments [#installments] * The `reversalOfTransactionLocator`, `tenantLocator`, `invalidated`, `originationType`, and `refused` properties have been removed from * The `reversedByInstallmentItemLocator` and `tenantLocator` properties have been removed from * The `tenantLocator` property has been removed from Stateless Operations [#stateless-operations-1] These endpoints now have a boolean `stateless` property to allow calculation of pricing or underwriting data without changing the state of the associated quote or policy: * * * * Underwriting [#underwriting] The responses for quote and policy transaction underwriting have been changed: * now returns a * now returns a Accounting [#accounting] * The "Cash" T-Accounts that represent cash inflows and outflows from the system are now managed at the customer account level. * These are accessed through the new `fetchALedgerCashAccount` and endpoints. * The tenant-wide cash account has been removed and so the `GET /billing/{tenantLocator}/accounting/ledgerAccounts/cash` endpoint has been removed as well. Delinquency [#delinquency] * The properties `graceEndAt` and `lapseTransactionEffectiveDate` properties have been added to * The `references` property is now optional on * On the properties `advanceLapseTo` and `lapseTransactionType` are now optional. * The properties `executedAt` and `reversedAt` have been added to and Aux Data [#aux-data] * On the property `auxDataSettingsName` is now optional. * On the `auxDataSettingsName` property is now optional. Data Extension Constraints [#data-extension-constraints] These [Data Extension Constraints](/configuration/data-extensions/data-extension-constraints) endpoints are now accessed with POST API calls: * * Other Changes [#other-changes-3] * Added the parameter `includeReversed` to the , , and endpoints to include those response items that have been previously reversed. * Added the property `preferences` to . * Added the property `searchSummary` to . * Removed the property `transactionLocator` from . * Removed the properties `rootLocator` and `tenantLocator` from . * Added the property `updatedAt` to . * On the properties `defaultAutoRenewalPlan`, `defaultDelinquencyPlan`, and `defaultShortfallTolerancePlan` are now optional. May 23, 2024 [#may-23-2024] Users [#users] * Added the endpoint to return streamlined user responses, which allows for a larger page size. This endpoint returns an array of entities. Excess Credits [#excess-credits] The *Excess Credits* feature is forthcoming to handle excess customer credits held in a credit balance. * Added the `excessCreditPlans` and `defaultExcessCreditPlan` properties to , and added with the entity. * Added the `excessCreditPlanName` property to , , , and . Open API Definitions [#open-api-definitions] A top level property in the [Open API definition file](/openapi/socotra-openapi.json) was erroneously called `externalDocuments` rather than its proper name `externalDocs`. This has been corrected. (This property is not currently used as so contains an empty array.) Other Changes [#other-changes-4] * Clarified that the `references` property of will only be populated when fetching a single delinquency entity. Accordingly marked `references` as optional. * Renamed the `listByTransactionLocator` endpoint to * The entity has the following properties marked as optional: `policyLocator`, `referenceDocumentLocator`, `segmentLocator`, `termLocator`, `transactionLocator`, `name`, `staticName`, `documentFormat`, `processingErrors`, `readyAt`, and `createdBy`. May 20, 2024 [#may-20-2024] Event Stream Data Definition [#event-stream-data-definition] * Information about the data contained within each payload is now on the [Event Definitions Page](/configuration/general-topics/event-definitions). May 17, 2024 [#may-17-2024] Deprecations [#deprecations] The following entity properties are now `deprecated` and will be removed in a future release: * : `defaultAnchorMode`, `defaultBillingLevel`, `defaultDueLeadDays`, `defaultLapseType`, `regions` * : `displayName` * : `pluralType` * : `pluralType` * : `inheritSettings`, `billingModeChange` * : `inheritSettings`, `billingModeChange` Static Data [#static-data] * Added the parameter `includeStaticData` to the and endpoints. Other Changes [#other-changes-5] * On and : * The `triggerBillingChange` property has been added, to replace `billingModeChange` * The `preferences` and `newPolicyEndTime` properties are now optional. May 15, 2024 [#may-15-2024] Renewal Management and Auto-Renewal [#renewal-management-and-auto-renewal] * There is a new [Renewal Management API](/api/policy-management/renewal-management) which supports the upcoming renewal management feature, including automatic renewal functionality. * A feature guide for renewal management is forthcoming. Resources [#resources] * Added the `byStaticName` and `date` parameter to the and endpoints for finer control of resource retrieval. * The endpoint now returns a streaming response rather than a `string`. Policy Snapshots [#policy-snapshots] * Added the endpoint. * Added document information with the `documentSummary` property on Credits [#credits] * Added the endpoint to fetch credits across an entire tenant. "List" Endpoints [#list-endpoints] Changed the path to the following endpoints that return multiple endpoints for greater consistency: * : `/billing/{tenantLocator} /invoices/{locator}/payments/list` * : `/billing/{tenantLocator} /invoices/{locator}/credits/list` * `/billing/ {tenantLocator}/invoices/{locator}/creditDistributions/list` Other Changes [#other-changes-6] * now has an `originalEffectiveTime` property which shows when that element was first added to the policy. * On the endpoint, changed the `number` parameter to `termNumber`. * Added a `description` parameter to the endpoint. * On the and endpoints, added the `includeZeroAmountInvoices` parameter for filtering. The default is `false`. * On , removed properties `createdBy`, `createdTime`, `clearedBy` `clearedTime`. * On , changed the `pricingItems` property to now be `charges`. * On , the `maxInstallmentsPerTerm` property is now optional. May 1, 2024 [#may-1-2024] Charges [#charges] On the week of May 6, 2024, there will be a change that requires configuration for which charges can be attached to elements. Each element definition must declare the charges that apply. and now have a `charges` property, which is an array of the charge types. All the applicable charges *must* be returned by the rating plugin, and *only* those charges can be applied; otherwise, the rating call will fail and the policy transaction or quote will fail to reach the `priced` state. Documents [#documents] * Documents may now be managed and retrieved by the entity they are attached to with these endpoints: * * * (previously named `fetchDocumentsByQuote`) * * * (previously named `fetchQuoteDocumentsJob`) * * * (previously named `getQuoteDocumentsJobs`) * * * (previously named `triggerTimedOutQuoteJob`) * The property has a new `policyLocator` property. * The `fetchSource` endpoint has been renamed to Policy documents are attatched to either policy segments or transactions, depending on [scope rules](/configuration/resources/documents#document_scope) April 28, 2024 [#april-28-2024] Feature Guides [#feature-guides] New feature guides have been added for these topics: * [InstallmentSettings](/features/billing/installment-settings) * [Invoicing](/features/billing/invoicing) * [Roles and Permissions](/features/security/roles-and-permissions) * [Permissions List](/features/security/permissions-listing) Along with these is an entirely set of configuration guides for plugins, including [rating](/configuration/plugins/rating), [validation](/configuration/plugins/validation), [underwriting](/configuration/plugins/underwriting), [precommit](/configuration/plugins/precommit), and [more](/configuration/plugins/overview). Search [#search] Search now has provisions for opting entity properties into or out of the search index: * The property `defaultSearchable` has been added to , , , , and . * The property `searchable` has been added to . Password Policies [#password-policies] Password policies now have editable settings: * The endpoint can be used to find and update the individual settings. The payloads for these are and , respectively. * Settings include: * Minimum and maximum overall password length * The minimum number of uppercase letters, lowercase letters, numbers, and/or symbols * password expiration after a given number of days * Restrictions on reusing passwords before they are a certain number of days old April 23, 2024 [#april-23-2024] Payments [#payments] * Added endpoint. Write-Offs [#write-offs] Added fetch endpoints: * Fetch a Write-Off * Fetch Multiple Write-Offs Other Changes [#other-changes-7] * Added property `validationResult` to and * Added configuration for `staticData` to * Deprecated endpoints and * Added endpoint and deprecated Feature Guides [#feature-guides-1] Added new feature guides: * [Accounting Example](/features/financials/accounting-example) * [Accounting Primer](/features/financials/accounting-primer) * [Credits From Policy Transactions](/features/billing/credits-from-policy-transactions) * [Backloading Installments](/features/billing/backloading-installments) April 17, 2024 [#april-17-2024] Optional and Required Properties [#optional-and-required-properties] The process for determining whether properties on entities were "required" (i.e. must be set on requests, or will always be set on responses) has moved from a manual to automated process. As a result of this some fields have changed from being indicated as required (with no suffix on their type name), or optional (with a `?` suffix on the type name.) Write-Offs [#write-offs-1] Added endpoints for write-off of invoices: * * Term Summary [#term-summary] Term Summaries are views of the term based on issued transactions, showing in-force coverage only. This essentially flattens the transactions that affect the term into a single series of segments, such that the segments cover the entire term without overlaps or time periods without segments. This is useful to understand the state of the term without constructing it from the transaction stack. The and endpoints fetch the overall term summary, and contains summary objects for segments and elements. Extension data and charge information is included in the element summary. Other Changes [#other-changes-8] The `roundingMode` property on has changed its enumeration values to use camel case: `ceiling`, `down`, `floor`, `halfDown`, `halfEven`, `halfUp-up` April 12, 2024 [#april-12-2024] Search [#search-1] * Added the endpoint * Added `offset` and `count` parameters to endpoint * Added properties `offset`, `count`, and `searchToken` to , and removed `page` * Renamed the `locator` property on to `searchEntityLocator` Invoicing [#invoicing] * Added property `installmentsItemsLocator` to , and removed `invoiceLocator` and `installmentItems` * Added properties `originationType`, and `refused`, and `invalidated` to * Added property `autoRenewalLocator` to Other Changes [#other-changes-9] * Added a [Reinstatements Feature Guide](/features/policy-management/reinstatements) * Added the endpoint * Renamed the `TransactionSnapshot` entity to * Added parameter `accountLocator` to , and endpoints * Added property `preferences` to , , , and April 8, 2024 [#april-8-2024] Extension Data Constraints [#extension-data-constraints] * Added a new [Extension Data Constraints Feature Guide](/configuration/data-extensions/data-extension-constraints) feature guide for understanding configuration and use of the constraints feature in building user interfaces. Shortfall Management [#shortfall-management] Added new endpoints supporting the ability to write-off shortfalls in payments below a configured threshold: * * These endpoints return object(s). Also, added the property `shortfallCreditLocators` to Quote Groups [#quote-groups] Added endpoints supporting Quote Groups: * * Other changes: * Added the ability to assign a quote to a different group when copying, using a * Added the property `quoteGroupLocator` to Term Fetch [#term-fetch] Added an endpoint to fetch all terms in a policy: * Installments [#installments-1] * Added the `basedOnLocator` and `effectiveTime` properties to * Added the property `normalizedWeight` to Policy Transaction Changes [#policy-transaction-changes] Added an endpoint to update the change instructions for a policy transaction based on explicit updates to the new policy segment. This endpoint returns a standard with the `changeInstructions` property updated: * Other Changes [#other-changes-10] * Removed the property `transactionLocator` from * Changed the type of the `outcome` property of from an enumeration to a string * Added the properties `reversalReason` and `shortfallCreditLocators` to April 1, 2024 [#april-1-2024] Search [#search-2] See the new [Search Feature Guide](/features/search) for details about Search including about how to use the [Search API](/api/search). Events [#events] * Added endpoints and * Renamed endpoint `listEvents` to * Added the optional field `transactionLocator` to Elements [#elements] On : * Removed the properties `locator`, `tenantLocator`, and `rootLocator`. * Marked the properties `staticLocator` and `elements` as optional. On : * Marked the properties `staticLocator`, `rootLocator`, and `elements` as optional. Payments, Credit Distributions, and Disbursements [#payments-credit-distributions-and-disbursements] * Added the endpoint. * Added the `reversalReason` and `shortfallCreditLocators` properties to * Added the property `useDefaultFinancialInstrument` to and * Added a request body of to Installments [#installments-2] * Added properties `reversalOfInstallmentLocator` and `reversedByInstallmentLocator` to * Added properties `reversalOfInstallmentItemLocator` and `reversedByInstallmentItemLocator` to Plans and Prferences [#plans-and-prferences] * Added the property `shortfallTolerancePlanName` to , , , and Constraints [#constraints] * Changed the entity to use `staticLocator` instead of `elementLocator` for referencing elements. Resource Groups [#resource-groups] * Marked the `selectionStartTime` property as `Required`. Accounting [#accounting-1] * On Changed the properties `refLocator`, `refType` and `type` to `referenceLocator`, `refType`, and `accountingType`, respectively. * On , changed the properties `transactionLocator`, `transactionNote`, and `transactionTime` to `faTransactionLocator`, `faTransactionNote`, and `faTransactionTime`, respectively. * On , changed the properties `txnLocator`, `txnNote`, `entryType`, and `txnTime` to `faTransactionLocator`, `faTransactionNote`, `accountingType`, and `faTransactionTime` respectively. March 27, 2024 [#march-27-2024] Policy Service [#policy-service] * Updated the operation of policy transactions (policy change, renewal, etc.) to allow manipulation of the actual segment to be created in addition to operating only on the change instructions that describe how to do the transformation. This will better support our upcoming *Constraint Tables* feature, and will allow for more flexibility when working with transactions. Details on usage will follow. * Added endpoints: * * * * * * * Removed `productName` from * Added `initialized` to the allowed values for the `state` property. * On , marked `staticLocator` and `rootLocator` as optional. Billing Service [#billing-service] * Added endpoints: * * `fetchLedgerCashAccount` * On and , changed the property `explicitAnchorDate` to `anchorTime` * On , added properties `anchorTime`, `dayOfWeek`, and `weekOfMonth` * On , changed the properties `transactionLocator`, `transactionNote`, and `transactionTime` to `faTransactionLocator`, `faTransactionNote`, and `faTransactionTime`, respectively. * On , added the properties `reversalOfInstallmentLocator` and `reversedByTransactionLocator` Platform [#platform] * Changed to use method `POST` instead of `GET` * On , the `selectionStartTime` property is now properly marked as `required` * On , added the property `defaultShortfallTolerancePlan` * Changed the name of the `ResourceGroup` entity to Configuration [#configuration] * Added the entities `1PropertyTypeInfo`, , and * On , added the properties `defaultShortfallTolerancePlan`, `shortfallTolerancePlans` and `reversalTypes` The endpoint is part of *Constraint Tables*, an upcoming feature. Details will be provided within the next few days. March 20, 2024 [#march-20-2024] New Endpoints [#new-endpoints] * Path Change [#path-change] The endpoint has changed its path: *from* `/billing/{tenantLocator}/holds/{accountLocator}/list` *to* `/billing/{tenantLocator}/holds/accounts/{accountLocator}/list` Constraint Tables [#constraint-tables] *Constraint Tables* are part of an upcoming feature to facilitate UI development and validation. This feature is not yet ready for use. These endpoints have been added: * * with response * * * Other Changes [#other-changes-11] * Added the properties `dayOfWeek`, `explicitAnchorDate`, and `weekOfMonth` to * Added the property `constraintTables` to * Added the properties `constraint` and `propertyScopes` to * Added the property `graceStartedAt` to , and renamed `state` to `delinquencyState` * Renamed the property `state` on to `disbursementState` * Renamed the property `state` on to `paymentState` * Removed the `POST /billing/{tenantLocator}/invoices/{locator}/delinquencies` endpoint March 13, 2024 [#march-13-2024] Credit Distributions [#credit-distributions] Added these endpoints: * * * * * * * * Added these entities: * * * * * Billing Holds [#billing-holds] Added these endpoints: * * * * * * Added these entities: * * * Billing Triggers [#billing-triggers-1] Billing triggers (either on `accepted` or on `issued`) are moving from billing plans to quotes and policies themselves. * Added the `updatePolicyBillingTrigger` endpoint which uses a `BillingTriggerUpdateRequest`. * Added the `billingTrigger` property to , , , , and . * Removed `billingTrigger` from `BillingSettings` and `BillingPreferences`. Search [#search-3] * Changed the `searchType` on to be called `searchEntityType`. * Removed the `fetchSearchConfiguration` endpoint along with the `EntitySearchConfiguration`, `SearchConfiguration`, and `SearchSummaryResponse` endpoints. * Removed the `searchSummary` response from Other Changes [#other-changes-12] * Changed the type of the `removeSources` and `removeTargets` properties of and from locator\[] to CreditItem\[]. * Removed the properties `webhookLocator` and `tenantLocator` from . March 6, 2024 [#march-6-2024] Static Data [#static-data-1] Added a feature to associate "static" data with Quotes and Policies. This is data that lives outside the existing extension data for these entities, and is managed outside of policy transactions. It currently doesn't require configuration but is otherwise structured like normal extension data. New endpoints: * * * * * * Also added the property `static` to , , , and The `POST` versions of the above endpoints differ from `PUT` in that they will fail if there is already static data on the entity at the time of the request. Search [#search-4] Integrated the new Socotra Insurance Suite search service. New endpoints: * * `fetchSearchConfiguration` New entities: * * * * * `SearchSummaryResponse` * `SearchConfiguration` * `EntitySearchConfiguration` Webhook Failure Handling [#webhook-failure-handling] Functionality to handle failed webhook events has been added. New endpoints: * * * * * New entities: * * * * * * * Other changes: * Added the `failureHandling` property to and * Added `removeFailureHandling` to