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:
These endpoints return ShortfallCreditResponse object(s).
Also, added the property shortfallCreditLocators to CreditDistributionResponse
Quote Groups
Added endpoints supporting Quote Groups:
Other changes:
Added the ability to assign a quote to a different group when copying, using a QuoteGroupAssignmentRequest
Added the property
quoteGroupLocatorto QuoteResponse
Term Fetch
Added an endpoint to fetch all terms in a policy:
Installments
Added the
basedOnLocatorandeffectiveTimeproperties to InstallmentLatticeResponseAdded the property
normalizedWeightto 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:
Other Changes
Removed the property
transactionLocatorfrom EventResponseChanged the type of the
outcomeproperty of GraceJobData from an enumeration to a stringAdded the properties
reversalReasonandshortfallCreditLocatorsto 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
listEventsto Fetch Multiple EventsAdded the optional field
transactionLocatorto EventResponse
Elements
Removed the properties
locator,tenantLocator, androotLocator.Marked the properties
staticLocatorandelementsas optional.
On ElementResponse:
Marked the properties
staticLocator,rootLocator, andelementsas optional.
Payments, Credit Distributions, and Disbursements
Added the Reverse Payment endpoint.
Added the
reversalReasonandshortfallCreditLocatorsproperties to PaymentResponseAdded the property
useDefaultFinancialInstrumentto PaymentUpdateRequest and DisbursementUpdateRequestAdded a request body of CreditDistributionReverseRequest to Reverse Credit Distribution
Installments
Added properties
reversalOfInstallmentLocatorandreversedByInstallmentLocatorto InstallmentResponseAdded properties
reversalOfInstallmentItemLocatorandreversedByInstallmentItemLocatorto InstallmentItemResponse
Plans and Prferences
Added the property
shortfallTolerancePlanNameto AccountCreateRequest, AccountUpdateRequest, AccountUpdateReplaceDataRequest, and AccountResponse
Constraints
Changed the ConditionValue entity to use
staticLocatorinstead ofelementLocatorfor referencing elements.
Resource Groups
Marked the
selectionStartTimeproperty asRequired.
Accounting
On AccountLineItem Changed the properties
refLocator,refTypeandtypetoreferenceLocator,refType, andaccountingType, respectively.On AccountingTransactionResponse, changed the properties
transactionLocator,transactionNote, andtransactionTimetofaTransactionLocator,faTransactionNote, andfaTransactionTime, respectively.On LedgerAccountLineItem, changed the properties
txnLocator,txnNote,entryType, andtxnTimetofaTransactionLocator,faTransactionNote,accountingType, andfaTransactionTimerespectively.
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:
Removed
productNamefrom QuoteUpdateRequestAdded
initializedto the allowed values for the PolicyTransactionResponsestateproperty.On ElementResponse, marked
staticLocatorandrootLocatoras optional.
Billing Service
Added endpoints:
fetchLedgerCashAccount
On InstallmentSettings and InstallmentPreferences, changed the property
explicitAnchorDatetoanchorTimeOn InstallmentPreferences, added properties
anchorTime,dayOfWeek, andweekOfMonthOn AccountingTransactionResponse, changed the properties
transactionLocator,transactionNote, andtransactionTimetofaTransactionLocator,faTransactionNote, andfaTransactionTime, respectively.On InstallmentResponse, added the properties
reversalOfInstallmentLocatorandreversedByTransactionLocator
Platform
Changed Fetch Search Results to use method
POSTinstead ofGETOn ResourceGroupCreateRequest, the
selectionStartTimeproperty is now properly marked asrequiredOn ProductRef, added the property
defaultShortfallTolerancePlanChanged the name of the
ResourceGroupentity to ResourceGroupResponse
Configuration
Added the entities
1PropertyTypeInfo, ReversalTypeRef, and ShortfallTolerancePlanRefOn ConfigurationRef, added the properties
defaultShortfallTolerancePlan,shortfallTolerancePlansandreversalTypes
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
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:
Other Changes
Added the properties
dayOfWeek,explicitAnchorDate, andweekOfMonthto InstallmentSettingsAdded the property
constraintTablesto ConfigurationRefAdded the properties
constraintandpropertyScopesto PropertyRefAdded the property
graceStartedAtto DelinquencyResponse, and renamedstatetodelinquencyStateRenamed the property
stateon DisbursementResponse todisbursementStateRenamed the property
stateon PaymentResponse topaymentStateRemoved the
POST /billing/{tenantLocator}/invoices/{locator}/delinquenciesendpoint
March 13, 2024
Credit Distributions
Added these endpoints:
Added these entities:
Billing Holds
Added these endpoints:
Added these entities:
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
billingTriggerproperty to QuoteCreateRequest, QuoteUpdateRequest, QuoteResponse, PolicyResponse, and PolicyTransactionResponse.Removed
billingTriggerfrom BillingSettings and BillingPreferences.
Search
Changed the
searchTypeon SearchRequest to be calledsearchEntityType.Removed the
fetchSearchConfigurationendpoint along with theEntitySearchConfiguration,SearchConfiguration, andSearchSummaryResponseendpoints.Removed the
searchSummaryresponse from SearchResultResponse
Other Changes
Changed the type of the
removeSourcesandremoveTargetsproperties of PaymentUpdateRequest and DisbursementUpdateRequest from locator[] to CreditItem[].Removed the properties
webhookLocatorandtenantLocatorfrom 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:
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:
fetchSearchConfiguration
New entities:
SearchSummaryResponseSearchConfigurationEntitySearchConfiguration
Webhook Failure Handling
Functionality to handle failed webhook events has been added.
New endpoints:
New entities:
Other changes:
Added the
failureHandlingproperty to CreateWebhookRequest and WebhookResponseAdded
removeFailureHandlingto UpdateWebhookRequest
Passwords
Added endpoint Reset User Password
Added the optional
temporaryPasswordproperty 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
transactionLocatorproperty to DelinquencyReferenceChanged the name of the
completedTimeproperty of InstallmentJobData tocompletedAtAdded the properties
referenceDocumentLocator,segmentLocator, andtermLocatorto DocumentInstanceResponse
February 28, 2024
Disbursements
Added a new Disbursements controller, including endpoints:
Added entities:
Added configuration for:
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, andremoveTargets, but has removedtargetLocator,name, andtargetType.Added the Fetch Policy Snapshot endpoint along with PolicySnapshotResponse and TransactionSnapshotResponse entities.
Added the
issuedTimeperoperty to PolicyTransactionResponseAdded the
tagproperty to extenstion data properties in configuration.Changed the
CreditResponseentity to PaymentResponse.Removed the Parameters
date,byStaticName, andkeyfrom the Fetch Lookup Table In Zip Format endpoint.Added
currencyproperties to the entities PaymentCreateRequest, PaymentUpdateRequest, LedgerAccount, and AccountingTransactionResponse.InstallmentResponse now has a
reversalOfTransactionLocatorproperty, butinstallmentStateandamounthave been removed.
February 23, 2024
Marked the
baseLapseOnandlapseConflictHandlingproperties of the configuration item DelinquencyPlanRef asdeprecated. These will be removed in an upcoming release.
February 21, 2024
Changed the name of the
CreditResponseentity to PaymentResponseAdded 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
elementsproperty 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
elementsproperty to ElementCreateRequest[]
February 6, 2024
Added Endpoints
Removed Endpoints
issueNextInvoiceForAccountfetchLedgerAccountLineItems
Added Entities
Changed Entities
PaymentResponse has new property
currencyInstallmentItemResponse has property
staticElementLocatorrenamed tostaticElementLocatorInvoiceItemResponse has the types of properties
chargeCategoryandchargeTypeboth changed tostringInstallmentResponse has these properties renamed:
generateDate=>generateTimedueDate=>dueTimeinstallmentStartDate=>installmentStartTimeinstallmentEndDate=>installmentEndTime
InstallmentLatticeFrame has these properties renamed:
generationDate=>generateTimedueDate=>dueTimeinstallmentStart=>installmentStartTimeinstallmentEnd=>installmentEndTimecoverageStart=>coverageStartTimecoverageEnd=>coverageEndTime
ConfigurationRef has removed property
defaults