Release Notes Archive

Note

This is a continuation of older release notes from the main release notes page.

April 8, 2024

Extension Data Constraints

• Added a new Extension Data Constraints Feature Guide feature guide for understanding configuration and use of the contraints 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 InstallmentResponse

• Added properties reversalOfInstallmentItemLocator and reversedByInstallmentItemLocator to InstallmentItemResponse

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 InstallmentResponse, 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

Note

The Fetch Dependency Map for Policy Transaction endpoint is part of Constraint Tables, an upcoming feature. Details will be provided within the next few days.

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

Note

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:

• 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 Update Policy Billing Trigger 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

Note

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

Integrated the new Enterprise Core 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:

• DisbursementCreateRequest

• 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 extenstion 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, LedgerAccount, and AccountingTransactionResponse.

• InstallmentResponse 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

• Fetch Invoice Job Data for Quotes

• Fetch Invoice Job Data for Policies

Removed Endpoints

• issueNextInvoiceForAccount

• fetchLedgerAccountLineItems

Added Entities

• InvoiceGenerationJob

Changed Entities

• PaymentResponse has new property currency

• InstallmentItemResponse has property staticElementLocator renamed to staticElementLocator

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

• InstallmentResponse 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