Release Notes Archive

September 11, 2024

• On PolicyTransactionResponse, the property acceptedTime has been added, the properties aggregatedTransactions and changeInstructions have now marked as optional.
• On QuoteResponse, the deprecated property boundTime has been removed in favor of the new property acceptedTime.
• On TransactionPriceResponse, the property aggregatedTransactions is now marked as optional.

September 4, 2024

Optional Properties

The following properties are now marked as optional:

• AccountResponse: autoRenewalPlanName, delinquencyPlanName, excessCreditPlanName, shortfallTolerancePlanName, invoiceDocument, preferences, region
• QuoteCreateRequest: durationBasis, billingLevel, billingTrigger, region
• ElementRef: coverageTerms, data
• ElementResponse: coverageTerms, data
• TenantResponse: description
• QuoteResponse: static
• AccountCreateRequest: region
• AccountUpdateReplaceDataRequest: region

Billing Triggers

The "Billing Trigger" setting is being removed, and the following entities now have the property billingTrigger deprecated.

• PolicyResponse
• PolicyTransactionResponse
• QuoteCreateRequest
• QuoteUpdateRequest
• QuoteResponse
• BillingPlanRef

In addition:

• On ConfigurationRef and ProductRef, defaultBillingTrigger is deprecated.
• The endpoint updatePolicyBillingTrigger is deprecated.
• The entity BillingTriggerUpdateRequest is deprecated.

Other Change

• On DocumentSummary, the property documentInstanceState has been added, and the equivalent property state has been deprecated.

August 28, 2024

• The following state properties have been changed, from state:

  • AccountResponse: accountState
  • QuickQuoteResponse: quickQuoteState
  • QuickQuotePriceResponse: quickQuoteState
  • InvoiceResponse: invoiceState
  • DocumentInstanceResponse: documentInstanceState

• The endpoints Preview Invoices For Quote and Preview Invoices For Transaction have had the property includeZeroAmountInvoices added, and excludeOtherPolicies has been removed.

• The endpoint Fetch Transaction Segments has been deprecated in favor of Fetch Transaction Segment because transactions can have a maximum of a single segment.

• The entity DocumentInstanceResponse has new properties category and external.

August 21, 2024

Diaries

Diaries are a new feature that enables a running narrative to be attached to individual entities. The following endpoints have been added:

• Create Diary
• Fetch Latest Diary Entries By Reference
• Fetch Latest Diary Entry By Locator
• Fetch All Diary Entries By Locator
• Update Diary
• Discard Diary

The following entities are used in the above endpoints:

• DiaryEntryCreateRequest
• DiaryEntryResponse
• DiaryEntryUpdateRequest

For now, diaries are enabled for quotes, policies, and policy transactions. Other entities will be enabled in the future.

See the Diaries Feature Guide for more information.

Regions

Regions are now supported. The new region property has been added to:

• AccountCreateRequest
• AccountResponse
• PolicyResponse
• PolicySnapshotResponse
• QuoteResponse
• AccountUpdateReplaceDataRequest

Also, defaultRegion has been added to ConfigurationRef.

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:

• Fetch Multiple Accounts returns AccountListResponse.
• Fetch Quotes For Account, Fetch All Quotes In Group, and Fetch Quotes In A Tenant return QuoteListResponse.
• Fetch Multiple Quick Quotes and fetchQuickQuotesForAGroup return QuickQuoteListResponse.
• Fetch Policies For Account returns PolicyListResponse.
• Fetch Policy Snapshots For An Account returns PolicySnapshotListResponse.
• Fetch Issued Transactions returns PolicyTransactionListResponse.
• Fetch Multiple Terms returns TermListResponse.

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 Issue Transaction endpoint.

Other Changes

The following entity properties have been marked as optional:

• AuthTokenResponse: permissions and tenants
• ElementResponse: coveragesTerms and elements
• PolicyResponse: branchHeadTransactionLocators

July 31, 2024

Quick Quotes

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:

• Fetch Quick Quote
• Fetch Multiple Quick Quotes
• Create Quick Quote
• Validate Quick Quote
• Update Quick Quote
• Create Quote From Quick Quote
• Copy Quick Quote
• Reset Quick Quote
• Discard Quick Quote
• Price A Quick Quote
• Fetch Pricing For Quick Quote
• Add Elements To Quick Quote
• Delete Elements From Quick Quote
• Fetch Dependency Map For Quick Quote
• Evaluate Constraints For Quick Quote
• assignQuickQuoteToGroup
• fetchQuickQuotesForAGroup

In support of the above endpoints, the following new entities are used:

• QuickQuoteResponse
• QuickQuotePriceResponse
• QuickQuoteCreateRequest
• QuickQuoteUpdateRequest

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:

• Update Billing Level For An Account
• Update Billing Level For A Policy
• Update Billing Level For A Quote

Each of these endpoints takes a UpdateBillingLevelRequest entity.

In addition, the following entities have added a billingLevel property:

• AccountResponse
• AccountCreateRequest
• AccountUpdateRequest
• AccountUpdateReplaceDataRequest
• PolicyResponse
• QuoteResponse
• QuoteCreateRequest
• QuoteUpdateRequest

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:

• Create Policy Transaction
• Change Policy
• Renew Policy
• Reinstate Policy
• Cancel Policy

And the following entity has a baseLocator property:

• PolicyTransactionReversalRequest

Configuration Changes

• Added the property delinquencyLevel, and removed properties baseLapseOn and lapseConflictHandling from DelinquencyPlanRef
• Added the property defaultBackdatedInstallmentsBilling to ConfigurationRef.
• Deprecated the billingPlans and defaultBillingPlan properties on ConfigurationRef, and defaultBillingPlan on ProductRef. These will be removed in an upcoming release.

Other Changes

• Endpoints which return a streaming response now show the type of object in the stream. So StreamingResponseBody now is shown as StreamingResponseBody<string>, StreamingResponseBody<ZipFile>, etc.
• The InvoiceItemResponse'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 InvoiceResponse
• Added the preemptingLapseTransactionLocator property to DelinquencyReference.
• Added properties realizedAt, reversalReason, and reversedAt to CreditResponse.
• Added the boolean property reversalLattice to InstallmentLatticeResponse, and made the settingsLocator property optional.
• On QuoteResponse and QuoteGroupAssignmentRequest, renamed the quoteGroupLocator property to groupLocator.
• On PolicyResponse, added the properties latestTermLocator and billingLevel.
• On AccountResponse, AccountCreateRequest, AccountUpdateRequest, and AccountUpdateReplaceDataRequest, added the properties billingLevel and invoiceDocument.
• Added the Fetch Invoices For Account endpoint.

July 24, 2024

Internal changes only for this release.

July 1, 2024

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:

• Validate Transaction
• Validate Quote

Other endpoints will also be updated with a stateless parameter in upcoming releases.

Invoices and Installments

• On InvoiceItemResponse, added new properties invoiceLocator and transactionLocator, and changed the installmentItemsLocators property to be called installmentItemLocators, and made the elementStaticLocator property required.
• On InvoiceResponse, made the startTime and endtime properties required, and changed the type of the currency property to string.
• On InstallmentItem, removed the property reversalOfLocator.
• On InstallmentLatticeResponse, added the property reversalLattice, and made the settingsLocator property required.

Other Changes

• Added a new Fetch Invoice Details endpoint for retrieving granular information about the contents of invoices. The response includes the new entities InvoiceDetailsResponse, PolicyInvoiceSummary, InvoiceItemSummary, and InstallmentItemSummary.
• Added the Preview Invoices For Quote endpoint, with InvoicePreviewResponse and InvoiceItemPreview entities.
• Added the Fetch Preferences For A Transaction endpoint.
• Added the property preemptingLapseTransactionLocator to DelinquencyReference, which indicates that some other delinquency's lapse transaction has taken precedence over this delinquency's lapse transaction.
• Added the property delinquencylevel to DelinquencySettings
• On DelinquencyPlanRef, added the property delinquencyLevel and removed the properties baseLapseOn and lapseConflictHandling.
• On PolicyResponse, added the property latestTermLocator and made the startTime and endTime properties required.
• On QuoteGroupAssignmentRequest, changed the name of the quoteGroupLocator property to groupLocator.

June 10, 2024

Policies

• Added the properties startTime and endTime to PolicyResponse. These indicate the start and end of the policy based on issued transactions only.

Invoices and Payments

• Added endpoint Fetch Invoices Targeted By A Payment
• Added endpoint Fetch Invoices Targeted By A Credit Distribution
• Added the property unsettledTime to InvoiceResponse, to indicate when a settled invoice became unsettled due to a payment reversal.
• The property elementStaticLocator has been added to the InvoiceItemResponse entity.

Installments

• The reversalOfTransactionLocator, tenantLocator, invalidated, originationType, and refused properties have been removed from Installment
• The reversedByInstallmentItemLocator and tenantLocator properties have been removed from InstallmentItem
• The tenantLocator property has been removed from InstallmentLatticeResponse

Stateless Operations

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:

• Price Quote
• Underwrite Quote
• Price Transaction
• Underwrite Transaction

Underwriting

The responses for quote and policy transaction underwriting have been changed:

• Underwrite Quote now returns a QuoteUnderwritingResponse
• Underwrite Transaction now returns a TransactionUnderwritingResponse

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 Fetch Multiple Ledger Cash Accounts 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

• The properties graceEndAt and lapseTransactionEffectiveDate properties have been added to DelinquencyResponse
• The references property is now optional on DelinquencyResponse
• On DelinquencyPlanRef the properties advanceLapseTo and lapseTransactionType are now optional.
• The properties executedAt and reversedAt have been added to CreditDistributionResponse and PaymentResponse

Aux Data

• On AuxDataResponse the property auxDataSettingsName is now optional.
• On AuxDataKey the auxDataSettingsName property is now optional.

Data Extension Constraints

These Data Extension Constraints endpoints are now accessed with POST API calls:

• Evaluate Constraints For Quote
• Evaluate Constraints For Policy Transaction

Other Changes

• Added the parameter includeReversed to the Fetch Payments For An Invoice, Fetch Credits For An Invoice, and Fetch Credit Distributions For An Invoice endpoints to include those response items that have been previously reversed.
• Added the property preferences to TransactionSnapshotResponse.
• Added the property searchSummary to SearchResultResponse.
• Removed the property transactionLocator from SegmentResponse.
• Removed the properties rootLocator and tenantLocator from ElementResponse.
• Added the property updatedAt to TenantResponse.
• On ProductRef the properties defaultAutoRenewalPlan, defaultDelinquencyPlan, and defaultShortfallTolerancePlan are now optional.

May 23, 2024

Users

• Added the Fetch Multiple Basic Users endpoint to return streamlined user responses, which allows for a larger page size. This endpoint returns an array of BasicUserResponse entities.

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 ConfigurationRef, and added with the ExcessCreditPlanRef entity.
• Added the excessCreditPlanName property to AccountCreateRequest, AccountResponse, AccountUpdateRequest, and AccountUpdateReplaceDataRequest.

Open API Definitions

A top level property in the Open API definition file 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

• Clarified that the references property of DelinquencyResponse will only be populated when fetching a single delinquency entity. Accordingly marked references as optional.
• Renamed the listByTransactionLocator endpoint to Fetch Installments For Policy Transaction
• The DocumentInstanceResponse entity has the following properties marked as optional: policyLocator, referenceDocumentLocator, segmentLocator, termLocator, transactionLocator, name, staticName, documentFormat, processingErrors, readyAt, and createdBy.

May 20, 2024

Event Stream Data Definition

• Information about the data contained within each payload is now on the Event Definitions Page.

May 17, 2024

Deprecations

The following entity properties are now deprecated and will be removed in a future release:

• ConfigurationRef: defaultAnchorMode, defaultBillingLevel, defaultDueLeadDays, defaultLapseType, regions
• ChargeRef: displayName
• ElementRef: pluralType
• ProductRef: pluralType
• ParamsChangeInstructionCreateRequest: inheritSettings, billingModeChange
• ParamsChangeInstructionResponse: inheritSettings, billingModeChange

Static Data

• Added the parameter includeStaticData to the Fetch Quotes For Account and Fetch Policies For Account endpoints.

Other Changes

• On ParamsChangeInstructionCreateRequest and ParamsChangeInstructionResponse:
  • The triggerBillingChange property has been added, to replace billingModeChange
  • The preferences and newPolicyEndTime properties are now optional.

May 15, 2024

Renewal Management and Auto-Renewal

• There is a new Renewal Management API which supports the upcoming renewal management feature, including automatic renewal functionality.
• A feature guide for renewal management is forthcoming.

Resources

• Added the byStaticName and date parameter to the Fetch Resource and Fetch Secret endpoints for finer control of resource retrieval.
• The Fetch Document Template endpoint now returns a streaming response rather than a string.

Policy Snapshots

• Added the Fetch Policy Snapshots For An Account endpoint.
• Added document information with the documentSummary property on SubsegmentSummary

Credits

• Added the Fetch Credits endpoint to fetch credits across an entire tenant.

"List" Endpoints

Changed the path to the following endpoints that return multiple endpoints for greater consistency:

• Fetch Payments For An Invoice: /billing/{tenantLocator} /invoices/{locator}/payments/list
• Fetch Credits For An Invoice: /billing/{tenantLocator} /invoices/{locator}/credits/list
• Fetch Credit Distributions For An Invoice /billing/ {tenantLocator}/invoices/{locator}/creditDistributions/list

Other Changes

• ElementResponse now has an originalEffectiveTime property which shows when that element was first added to the policy.
• On the Fetch Term Summary By Term Number endpoint, changed the number parameter to termNumber.
• Added a description parameter to the Create Tenant endpoint.
• On the Fetch Invoices For Policy and Fetch Invoices For Quote endpoints, added the includeZeroAmountInvoices parameter for filtering. The default is false.
• On UnderwritingFlagResponse, removed properties createdBy, createdTime, clearedBy clearedTime.
• On TransactionPriceResponse, changed the pricingItems property to now be charges.
• On InstallmentSettings, the maxInstallmentsPerTerm property is now optional.

May 1, 2024

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. ElementRef and ProductRef now have a charges property, which is an array of the charge types.

Documents

• Documents may now be managed and retrieved by the entity they are attached to with these endpoints:

  • Fetch Documents For Segment
  • Fetch Documents For Transaction

  • Fetch Documents For Quote (previously named fetchDocumentsByQuote)

  • Fetch Documents Job For Segment
  • Fetch Documents Job For Transaction

  • Fetch Documents Job For Quote (previously named fetchQuoteDocumentsJob)

  • Fetch Multiple Documents Jobs For Segment
  • Fetch Multiple Documents Jobs For Transaction

  • Fetch Multiple Documents Jobs For Quote (previously named getQuoteDocumentsJobs)

  • Trigger Timed Out Documents Job For Segment
  • Trigger Timed Out Documents Job For Transaction

  • Trigger Timed Out Documents Job For Quote (previously named triggerTimedOutQuoteJob)

• The DocumentInstanceResponse property has a new policyLocator property.

• The fetchSource endpoint has been renamed to Fetch Source For Document

April 28, 2024

Feature Guides

New feature guides have been added for these topics:

• InstallmentSettings
• Invoicing
• Roles and Permissions
• Permissions List

Along with these is an entirely set of configuration guides for plugins, including rating, validation, underwriting, precommit, and more.

Search

Search now has provisions for opting entity properties into or out of the search index:

• The property defaultSearchable has been added to ConfigurationRef, ProductRef, ElementRef, AccountRef, and DataTypeRef.
• The property searchable has been added to PropertyRef.

Password Policies

Password policies now have editable settings:

• The Fetch Password Policy endpoint can be used to find and update the individual settings. The payloads for these are PasswordPolicyResponse and PasswordPolicyUpdateRequest, 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

Payments

• Added Fetch Payments For An Invoice endpoint.

Write-Offs

Added fetch endpoints:

• Fetch a Write-Off
• Fetch Multiple Write-Offs

Other Changes

• Added property validationResult to PolicyResponse and AccountResponse
• Added configuration for staticData to ProductRef
• Deprecated endpoints Fetch Multiple Snapshots and Fetch Quotes In A Tenant
• Added Fetch Policy Segment endpoint and deprecated Fetch Policy Segment Ex

Feature Guides

Added new feature guides:

• Accounting Example
• Accounting Primer
• Credits From Policy Transactions
• Backloading Installments

April 17, 2024

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

Added endpoints for write-off of invoices:

• Write Off Invoice
• Reverse Write Off

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 Fetch Term Summary By Term Locator and Fetch Term Summary By Term Number 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

The roundingMode property on PropertyRef has changed its enumeration values to use camel case: ceiling, down, floor, halfDown, halfEven, halfUp-up

April 12, 2024

Search

• Added the Fetch Additional Search Results By Token endpoint
• Added offset and count parameters to Fetch Search Results endpoint
• Added properties offset, count, and searchToken to SearchServiceResponse, and removed page
• Renamed the locator property on SearchResultResponse to searchEntityLocator

Invoicing

• Added property installmentsItemsLocator to InvoiceResponse, and removed invoiceLocator and installmentItems
• Added properties originationType, and refused, and invalidated to Installment
• Added property autoRenewalLocator to TermResponse

Other Changes

• Added a Reinstatements Feature Guide
• Added the Fetch Multiple Snapshots endpoint
• Renamed the TransactionSnapshot entity to TransactionSnapshotResponse
• Added parameter accountLocator to Fetch Multiple Payments, Fetch Multiple Disbursements and Fetch Multiple Credit Distributions endpoints
• Added property preferences to AccountCreateRequest, AccountUpdateRequest, AccountUpdateReplaceDataRequest, and AccountResponse

April 8, 2024

Extension Data Constraints

• Added a new Extension Data Constraints Feature Guide feature guide for understanding configuration and use of the constraints feature in building user interfaces.

Shortfall Management

Added new endpoints supporting the ability to write-off shortfalls in payments below a configured threshold:

• Fetch Shortfall Credit
• Fetch Multiple Shortfall Credits

These endpoints return ShortfallCreditResponse object(s).

Also, added the property shortfallCreditLocators to CreditDistributionResponse

Quote Groups

Added endpoints supporting Quote Groups:

• Assign Quote Group
• Fetch All Quotes In Group

Other changes:

• Added the ability to assign a quote to a different group when copying, using a QuoteGroupAssignmentRequest
• Added the property quoteGroupLocator to QuoteResponse

Term Fetch

Added an endpoint to fetch all terms in a policy:

• Fetch Multiple Terms

Installments

• Added the basedOnLocator and effectiveTime properties to InstallmentLatticeResponse
• Added the property normalizedWeight to InstallmentLatticeFrame

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 PolicyTransactionResponse with the changeInstructions property updated:

• Fetch Policy Transaction With Updated Changes

Other Changes

• Removed the property transactionLocator from EventResponse
• Changed the type of the outcome property of GraceJobData from an enumeration to a string
• Added the properties reversalReason and shortfallCreditLocators to CreditDistributionResponse

April 1, 2024

Search

See the new Search Feature Guide for details about Search including about how to use the Search API.

Events

• Added endpoints Fetch Event and Fetch Events For A Request
• Renamed endpoint listEvents to Fetch Multiple Events
• Added the optional field transactionLocator to EventResponse

Elements

On ElementCreateRequest:

• Removed the properties locator, tenantLocator, and rootLocator.
• Marked the properties staticLocator and elements as optional.

On ElementResponse:

• Marked the properties staticLocator, rootLocator, and elements as optional.

Payments, Credit Distributions, and Disbursements

• Added the Reverse Payment endpoint.
• Added the reversalReason and shortfallCreditLocators properties to PaymentResponse
• Added the property useDefaultFinancialInstrument to PaymentUpdateRequest and DisbursementUpdateRequest
• Added a request body of CreditDistributionReverseRequest to Reverse Credit Distribution

Installments

• Added properties reversalOfInstallmentLocator and reversedByInstallmentLocator to Installment
• Added properties reversalOfInstallmentItemLocator and reversedByInstallmentItemLocator to InstallmentItem

Plans and Prferences

• Added the property shortfallTolerancePlanName to AccountCreateRequest, AccountUpdateRequest, AccountUpdateReplaceDataRequest, and AccountResponse

Constraints

• Changed the ConditionValue entity to use staticLocator instead of elementLocator for referencing elements.

Resource Groups

• Marked the selectionStartTime property as Required.

Accounting

• On AccountLineItem Changed the properties refLocator, refType and type to referenceLocator, refType, and accountingType, respectively.
• On AccountingTransactionResponse, changed the properties transactionLocator, transactionNote, and transactionTime to faTransactionLocator, faTransactionNote, and faTransactionTime, respectively.
• On LedgerAccountLineItem, changed the properties txnLocator, txnNote, entryType, and txnTime to faTransactionLocator, faTransactionNote, accountingType, and faTransactionTime respectively.

March 27, 2024

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:

  • Initialize Transaction
  • Add Elements To Policy With Transaction
  • Update Elements In Policy With Transaction
  • Remove Elements From Policy With Transaction
  • Evaluate Constraints For Policy Transaction
  • Fetch Dependency Map For Policy Transaction

• Removed productName from QuoteUpdateRequest

• Added initialized to the allowed values for the PolicyTransactionResponse state property.

• On ElementResponse, marked staticLocator and rootLocator as optional.

Billing Service

• Added endpoints:

  • Fetch Multiple Credit Distributions
  • fetchLedgerCashAccount

• On InstallmentSettings and InstallmentPreferences, changed the property explicitAnchorDate to anchorTime

• On InstallmentPreferences, added properties anchorTime, dayOfWeek, and weekOfMonth

• On AccountingTransactionResponse, changed the properties transactionLocator, transactionNote, and transactionTime to faTransactionLocator, faTransactionNote, and faTransactionTime, respectively.

• On Installment, added the properties reversalOfInstallmentLocator and reversedByTransactionLocator

Platform

• Changed Fetch Search Results to use method POST instead of GET
• On ResourceGroupCreateRequest, the selectionStartTime property is now properly marked as required
• On ProductRef, added the property defaultShortfallTolerancePlan
• Changed the name of the ResourceGroup entity to ResourceGroupResponse

Configuration

• Added the entities 1PropertyTypeInfo, ReversalTypeRef, and ShortfallTolerancePlanRef
• On ConfigurationRef, added the properties defaultShortfallTolerancePlan, shortfallTolerancePlans and reversalTypes

March 20, 2024

New Endpoints

• Fetch Credit Distribution

Path Change

The Fetch All Holds For An Account endpoint has changed its path:

from /billing/{tenantLocator}/holds/{accountLocator}/list

to /billing/{tenantLocator}/holds/accounts/{accountLocator}/list

Constraint Tables

These endpoints have been added:

• Fetch Dependency Map For Quote
• Fetch Constraints with ConstraintDependency response
• Create Constraint Table
• Replace Constraint Table
• Zip Constraint Table

Other Changes

• Added the properties dayOfWeek, explicitAnchorDate, and weekOfMonth to InstallmentSettings
• Added the property constraintTables to ConfigurationRef
• Added the properties constraint and propertyScopes to PropertyRef
• Added the property graceStartedAt to DelinquencyResponse, and renamed state to delinquencyState
• Renamed the property state on DisbursementResponse to disbursementState
• Renamed the property state on PaymentResponse to paymentState
• Removed the POST /billing/{tenantLocator}/invoices/{locator}/delinquencies endpoint

March 13, 2024

Credit Distributions

Added these endpoints:

• Create Credit Distribution
• Update Credit Distribution
• Create Or Replace Credit Distribution
• Validate Credit Distribution
• Execute Credit Distribution
• Reverse Credit Distribution
• Reset Credit Distribution
• Discard Credit Distribution

Added these entities:

• CreditDistributionResponse
• CreditDistributionCreateRequest
• CreditDistributionUpdateRequest
• CreditDistributionPutRequest
• CreditDistributionReverseRequest

Billing Holds

Added these endpoints:

• Fetch Hold
• Update Hold
• Validate Hold
• Release Hold
• Activate Hold
• Reset Hold

Added these entities:

• HoldCreateRequest
• HoldResponse
• HoldUpdateRequest

Billing Triggers

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 QuoteCreateRequest, QuoteUpdateRequest, QuoteResponse, PolicyResponse, and PolicyTransactionResponse.
• Removed billingTrigger from BillingSettings and BillingPreferences.

Search

• Changed the searchType on SearchRequest to be called searchEntityType.
• Removed the fetchSearchConfiguration endpoint along with the EntitySearchConfiguration, SearchConfiguration, and SearchSummaryResponse endpoints.
• Removed the searchSummary response from SearchResultResponse

Other Changes

• Changed the type of the removeSources and removeTargets properties of PaymentUpdateRequest and DisbursementUpdateRequest from locator[] to CreditItem[].
• Removed the properties webhookLocator and tenantLocator from DivertedEventResponse.

March 6, 2024

Static Data

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:

• Add Static Data For Quote
• Update Static Data For Quote
• Replace All Static Data For Quote
• Add Static Data For Policy
• Update Static Data For Policy
• Replace All Static Data For Policy

Also added the property static to QuoteResponse, QuoteCreateRequest, PolicyResponse, and PolicySnapshotResponse

Search

Integrated the new Socotra Insurance Suite search service.

New endpoints:

• Fetch Search Results
• fetchSearchConfiguration

New entities:

• SearchRequest
• SearchTermRequest
• SearchServiceResponse
• SearchResultResponse
• SearchSummaryResponse
• SearchConfiguration
• EntitySearchConfiguration

Webhook Failure Handling

Functionality to handle failed webhook events has been added.

New endpoints:

• Fetch Diverted Event
• Fetch Multiple Diverted Events
• Resend Diverted Event
• Delete Diverted Event
• Unsuspend Webhook

New entities:

• DivertedEventResponse
• RetryStrategyCreateRequest
• RetryStrategyResponse
• RetryStrategyUpdateRequest
• FailureHandlingCreateRequest
• FailureHandlingUpdateRequest
• FailureHandlingResponse

Other changes:

• Added the failureHandling property to CreateWebhookRequest and WebhookResponse
• Added removeFailureHandling to UpdateWebhookRequest

Passwords

• Added endpoint Reset User Password
• Added the optional temporaryPassword property to UserCreateRequest, UserUpdateRequest, and UserResponse

Other Changes

• Added endpoint Fetch Affected Transactions to find which transactions have been affected by a transaction, such as those that were reversed and/or reapplied as a result of an out-of-sequence transaction. Also added AffectedTransaction for the response.
• Added the transactionLocator property to DelinquencyReference
• Changed the name of the completedTime property of InstallmentJobData to completedAt
• Added the properties referenceDocumentLocator, segmentLocator, and termLocator to DocumentInstanceResponse

February 28, 2024

Disbursements

Added a new Disbursements controller, including endpoints:

• Create Disbursement
• Update Disbursement
• Update Disbursement Replace Data
• Fetch Disbursement
• Fetch Multiple Disbursements
• Validate Disbursement
• Approve Disbursement
• Execute Disbursement
• Reject Disbursement
• Reset Disbursement
• Reverse Disbursement
• Discard Disbursement

Added entities:

• DisbursementUpdateReplaceDataRequest
• DisbursementResponse
• DisbursementUpdateReplaceDataRequest

Added configuration for:

• Disbursements
• Payments

Other Changes

• Added a new endpoint to copy a quote: Copy Quote
• Added a new endpoint to fetch the "local stack" of issued transactions for a policy: Fetch Issued Transactions
• The PaymentCreateRequest and PaymentUpdateRequest entities have added properties type, currency, addTargets, and removeTargets, but has removed targetLocator, name, and targetType.
• Added the Fetch Policy Snapshot endpoint along with PolicySnapshotResponse and TransactionSnapshotResponse entities.
• Added the issuedTime peroperty to PolicyTransactionResponse
• Added the tag property to extension data properties in configuration.
• Changed the CreditResponse entity to PaymentResponse.
• Removed the Parameters date, byStaticName, and key from the Fetch Lookup Table In Zip Format endpoint.
• Added currency properties to the entities PaymentCreateRequest, PaymentUpdateRequest, LedgerAccountResponse, and AccountingTransactionResponse.
• Installment now has a reversalOfTransactionLocator property, but installmentState and amount have been removed.

February 23, 2024

• Marked the baseLapseOn and lapseConflictHandling properties of the configuration item DelinquencyPlanRef as deprecated. These will be removed in an upcoming release.

February 21, 2024

• Changed the name of the CreditResponse entity to PaymentResponse
• Added the Fetch Table Record endpoint
• Added the payments and disbursements properties to ConfigurationRef

February 8, 2024

Changed Endpoints

• Add Elements To Quote has changed the type of its elements property to ElementCreateRequest[]
• Update Account Replace Data has changed its request type to AccountUpdateReplaceDataRequest
• Update User has changed its request type to UserUpdateRequest

Changed Entities

• QuoteCreateRequest has changed the type of its elements property to ElementCreateRequest[]

February 6, 2024

Added Endpoints

• fetchInvoiceJobDataForQuotes
• fetchInvoiceJobDataForPolicies

Removed Endpoints

• issueNextInvoiceForAccount
• fetchLedgerAccountLineItems

Added Entities

• InvoiceGenerationJob

Changed Entities

• PaymentResponse has new property currency

• InstallmentItem has property staticElementLocator renamed to staticElementLocator

• InvoiceItemResponse has the types of properties chargeCategory and chargeType both changed to string

• Installment has these properties renamed:

• generateDate => generateTime

• dueDate => dueTime

• installmentStartDate => installmentStartTime

• installmentEndDate => installmentEndTime

• InstallmentLatticeFrame has these properties renamed:

• generationDate => generateTime

• dueDate => dueTime

• installmentStart => installmentStartTime

• installmentEnd => installmentEndTime

• coverageStart => coverageStartTime

• coverageEnd => coverageEndTime

• ConfigurationRef has removed property defaults