Release Notes
Note
The structure and use of the API does not change when names of entities or endpoint operation IDs change. These changes are typically made for clarity and consistency.
All changes to the API listed here are also reflected in our Open API definition file.
December 4, 2024
New Feature: Data Lake (Beta)
Data Lake provides a relational view of your book of business in Socotra, enabling a wide range of reporting applications. See the Data Lake Guide for details.
New Feature: Value-Based Coverage Terms
Until now, values to be associated with a coverage term had to be defined as a finite set of options
in the configuration. To support use cases requiring variable values – such as a computed quantity based on various factors – a coverage term may now be configured to take a value
described as a PropertyRef, instead of options
. See the Coverage Terms Guide for details.
Other Changes
Use of the pre-commit plugin for delinquency events (method signature
PreCommitDelinquencyEventsResponse preCommit(PreCommitPlugin.DelinquencyEventsRequest request)
) is now deprecated.Both “startsWith” and “fuzzy” searches are case-insensitive.
Bug Fixes
Pascal casing for account names is now enforced.
graceEndAt
now accounts forgracePeriodDays
if that value is set in the pre-commit plugin for delinquency, withgraceEndAt
taking precedence if it is also set in the plugin.Deployments API: Validate Config and Format Config responses include a
content-type: application/zip
header.
November 20, 2024
New Feature: Early Invoicing
Early invoicing allows invoices to be created and sent before the generate time of the installments that they are based on.
See the Early Invoicing Feature Guide for details.
Note
There will be no release on 2024-Nov-27. The next release will be on 2024-Dec-04.
November 13, 2024
New Feature: Delinquency Events
Delinquency events are a new feature that supports extending delinquency processes with additional extensions.
For interacting with events directly, the Fetch Delinquency Events and Update Delinquency Event endpoints are added, along with responses DelinquencyEventsResponse and DelinquencyEventResponse
The endpoint Fetch Delinquency Event Jobs and response types DelinquencyEventJobDataListResponse and DelinquencyEventJobData have been added for job information.
See the Delinquency Events Feature Guide for details.
November 6, 2024
Constraint Tables
There is now an option to use any column (not just the first column) of a constraint table as a list of distinct values for constraints evaluation. Use of the first column is implicit if there is no
where
clause. To enable other columns, set themakeDistinct
property in the column definition totrue
.For consistency with other validation checks on configuration deployment, validation of constraint column names is now case sensitive as well. Column names in the constraints definition have to match case with column name in the associated constraint table definition.
Quote Events
Events have been added to signal changes to static data for quotes.
The new event types are
policy.quote.staticdata.add
,policy.quote.staticdata.replace
, andpolicy.quote.staticdata.update
, each of which emit a QuoteEventData object.
Optional Properties
The following properties are now marked as optional:
PaymentRef and PaymentResponse:
data
CreateEndpointRequest:
headers
October 30, 2024
Constraints with Custom Data Types
Data extension constraints have been extended to include nested custom data objects. Constraining arrays of custom data objects is not yet supported.
Additional Changes to Paged List Fetch Semantics
The following endpoints have been updated to align with list endpoint semantics as described in recent release notes:
Deployments
To better accommodate common zip file creation patterns on various systems, configuration deployment will no longer fail if the configuration archive contains an extra top-level directory.
October 23, 2024
Data Access Controls
Security features are now available to restrict users’ access to system data based on specific Products or Regions, or designated extension data.
See the Data Access Controls feature guide and Data Access Controls API guide for details.
Webhooks Security Features
Webhooks are now security enabled: The entities CreateEndpointRequest, UpdateEndpointRequest, and EndpointResponse have added properties
secret
,tag
,secureSsl
, andhmacEnabled
.See the Security Features section of the Webhooks configuration guide for implementation details.
Yet More Changes to Paged List Fetch Semantics
Similar to the endpoints that were enhanced last week, when fetching entities with any of the following endpoints, a new query parameter is available called extended
. Setting extended
to true
means that the return object will not be a bare array of entities, but rather a List Contents object that includes an indicator that the list is complete. The following endpoints have been changed:
Fetch Multiple Basic Users returns BasicUserListResponse (and,
UserBasicResponse
has been renamed to BasicUserResponse)Fetch Tenants returns TenantListResponse
Fetch Invoices for Policy, Fetch Invoices for Account, Fetch Invoices for Quote, Fetch Invoices Targeted By a Credit Distribution and Fetch Invoices Targeted By a Payment return InvoiceListResponse
Fetch Installments for Policy, Fetch Installments for Policy Transaction, Fetch Installments for Quote return InstallmentListResponse
Fetch Installment Lattices By Policy Locator returns InstallmentLatticeListResponse
Fetch Multiple Payments and Fetch Payments for an Invoice return PaymentListResponse
Fetch Multiple Disbursements returns DisbursementListResponse
Fetch Multiple Credit Distributions and Fetch Credit Distributions for an Invoice return CreditDistributionListResponse
Get Delinquencies for Account, Get Delinquencies for Quote, Get Delinquencies for Policy and Get Delinquencies for Invoice return DelinquencyListResponse
Fetch Credits and Fetch Credits for an Invoice return CreditListResponse
Fetch Multiple Shortfall Credits returns ShortfallCreditListResponse
List Financial Instruments returns FinancialInstrumentListResponse
Fetch Multiple Ledger Cash Accounts returns LedgerAccountListResponse
Fetch Installments Job Data for Transactions, Fetch Installments Job Data for Quotes return InstallmentJobDataListResponse
Fetch Delinquency Grace Job returns GraceJobDataListResponse
Fetch Create Delinquencies Job Data for Invoice returns DelinquencyCreateJobDataListResponse
The Open API descriptor file and documentation for endpoints expresses these responses as if the extended
property were set to true
.
Note
Later, the extended
property will be deprecated, and then removed and the default behavior will be as if it were true
. Until then, the default value for this flag is false
.
Other Changes
There is a new Feature Guide for Dynamic Documents!
There is a new block of example code provided for the Document Data Snapshot Plugin configuration guide.
The InvoiceItemResponse entity has new property
invoiceItemLocators
.The InvoiceItemPreview entity has new optional properties
policyLocator
,quoteLocator
,chargeCategory
,chargeType
, andtransactionLocators
.
October 16, 2024
Entity Numbering
Several system entities, including accounts, policies, quotes, policy terms, invoices, and disbursements can now have automatically generated numbers, for use on printed documents, portal and app screens, etc.
This provides a much easier, human-readable identifier compared to locators.
Numbers are ideal for use in customer service and similar situations.
See the Entity Numbering Feature Guide for details.
More Changes to Paged List Fetch Semantics
When fetching entities with any of the following endpoints, a new query parameter is available called extended
. Setting extended
to true
means that the return object will not be a bare array of entities, but rather a List Contents object that includes an indicator that the list is complete. The following endpoints have been changed:
Fetch My Tenants returns TenantListResponse
Fetch Documents for Transaction, Fetch Documents for Segment, and Fetch Documents for Quote return DocumentListResponse
Fetch Multiple Documents Jobs for Transaction, Fetch Multiple Documents Jobs for Segment, and Fetch Multiple Documents Jobs for Quote return DocumentJobListResponse
Fetch Multiple Users returns UserListResponse.
Fetch Multiple Roles returns RoleListResponse.
Other Changes
The InvoiceItemPreview entity has added fields
policyLocator
,quoteLocator
,chargeCategory
,chargeType
, andtransactionLocators
properties.The InvoiceItemResponse entity has new property
transactionLocators
.The DeployedConfigMetadata entity’s
pluginVersionStatus
has type changed frommap<string,string>
tomap<string,map<string,string>>
.
October 9, 2024
New Feature Guides
Other Changes
Added new Fetch Tenant Level Cash Balance endpoint.
Added new property
clearedAt
to UnderwritingFlag.
October 2, 2024
Added the property
category
to ElementResponse, to indicate in which of the main categories the element is. This can beproduct
,policyLine
,exposureGroup
,exposure
, orcoverage
.Added the Format Config endpoint to convert a configuration’s property casing to match requrements.
Added the
resetToDraft
query parameter for the Reset Transaction endpoint. Iftrue
, then the transaction will revert to draft state and the generated segment data, including elements and data, will be discarded. Iffalse
(the default), then the transaction will revert toinitialized
state and the segment data will be retained. This is useful to preserve the locator data for generated elements.
September 25, 2024
New Getting Started Guide!
See the new Getting Started Guide for a step-by-step introduction to configuring and using Socotra.
New Migration Feature Guide
See the new Migration Feature Guide for more details about data migration projects.
Invoice Documents
Documents can now be configured to renender when invoices are generated, similarly to how policy documents are created.
See the Invoice Rendering topic for details.
Other Changes
Enabled support for reinstatement with a gap.
Added a new feature guide for automatic handling of excess credits.
Extended the Quick Quotes Feature Guide with additional details.
Clarified in the Rounding Service Feature Guide that the configuration for rounding mode is limited to data extensions.
Marked the following properties as optional:
UnderwritingFlagResponse:
elementLocator
QuoteUnderwritingFlagsResponse:
clearedFlags
September 18, 2024
External Documents
You can now attach documents created from outside Socotra to quotes, policies, terms, segments, and transactions. See the Document Management Feature Guide and Documents API Guide for details.
Other Changes
On PolicyResponse, the
latestSegmentLocator
has been added to indicated the last segment on the policy based on issued transactions.The TermResponse entity has added property
termNumber
.The Add Elements To Policy with Transaction endpoint’s request type has been changed to ElementResponse[].
On ConfigurationRef, the
defaultRegion
property has been deprecated and marked as optional.For these configuration entities, the
displayName
is now marked as optional.
September 11, 2024
On PolicyTransactionResponse, the property
acceptedTime
has been added, the propertiesaggregatedTransactions
andchangeInstructions
have now marked as optional.On QuoteResponse, the deprecated property
boundTime
has been removed in favor of the new propertyacceptedTime
.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.
In addition:
On ConfigurationRef and ProductRef,
defaultBillingTrigger
is deprecated.The endpoint Update Policy Billing Trigger is deprecated.
The entity BillingTriggerUpdateRequest is deprecated.
Other Change
On DocumentSummary, the property
documentInstanceState
has been added, and the equivalent propertystate
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, andexcludeOtherPolicies
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
andexternal
.
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:
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 for more information.
Regions
Regions are now supported. The new region
property has been added to:
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 Quotes for Account, Fetch All Quotes In Group, and Fetch Quotes In a Tenant return QuoteListResponse.
Fetch Multiple Quick Quotes and Fetch Quick Quotes for a Group return QuickQuoteListResponse.
Fetch Policy Snapshots for an Account returns PolicySnapshotListResponse.
Fetch Issued Transactions returns PolicyTransactionListResponse.
Fetch Multiple Terms returns TermListResponse.
Note
Later, the extended
property will be removed and the default behavior will be as if it were true
.
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 settng the autoRebase
query paramter to false
when using the Issue Transaction endpoint.
Other Changes
The following entity properties have been marked as optional:
AuthTokenResponse:
permissions
andtenants
ElementResponse:
coveragesTerms
andelements
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:
In support of the above endpoints, the following new entities are used:
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 UpdateBillingLevelRequest entity.
In addition, the following entities have added a billingLevel
property:
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
Added the property
delinquencyLevel
, and removed propertiesbaseLapseOn
andlapseConflictHandling
from DelinquencyPlanRefAdded the property
defaultBackdatedInstallmentsBilling
to ConfigurationRef.Deprecated the
billingPlans
anddefaultBillingPlan
properties on ConfigurationRef, anddefaultBillingPlan
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 toinstallmentItemLocators
, and has added propertiesinvoiceLocator
andtransactionLocator
. Also, thereversalOfLocator
property has been removed.Added a
timezone
property to InvoiceResponseAdded the
preemptingLapseTransactionLocator
property to DelinquencyReference.Added properties
realizedAt
,reversalReason
, andreversedAt
to CreditResponse.Added the boolean property
reversalLattice
to InstallmentLatticeResponse, and made thesettingsLocator
property optional.On QuoteResponse and QuoteGroupAssignmentRequest, renamed the
quoteGroupLocator
property togroupLocator
.On PolicyResponse, added the properties
latestTermLocator
andbillingLevel
.On AccountResponse, AccountCreateRequest, AccountUpdateRequest, and AccountUpdateReplaceDataRequest, added the properties
billingLevel
andinvoiceDocument
.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:
Other endpoints will also be updated with a stateless
parameter in upcoming releases.
Invoices and Installments
On InvoiceItemResponse, added new properties
invoiceLocator
andtransactionLocator
, and changed theinstallmentItemsLocators
property to be calledinstallmentItemLocators
, and made theelementStaticLocator
property required.On InvoiceResponse, made the
startTime
andendtime
properties required, and changed the type of thecurrency
property tostring
.On InstallmentItemResponse, removed the property
reversalOfLocator
.On InstallmentLatticeResponse, added the property
reversalLattice
, and made thesettingsLocator
property required.
Other Changes
Added a new Fetch Invoice Details endpoint for retreiving 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 DelinquencySettingsOn DelinquencyPlanRef, added the property
delinquencyLevel
and removed the propertiesbaseLapseOn
andlapseConflictHandling
.On PolicyResponse, added the property
latestTermLocator
and made thestartTime
andendTime
properties required.On QuoteGroupAssignmentRequest, changed the name of the
quoteGroupLocator
property togroupLocator
.
June 10, 2024
Policies
Added the properties
startTime
andendTime
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
, andrefused
properties have been removed from InstallmentResponseThe
reversedByInstallmentItemLocator
andtenantLocator
properties have been removed from InstallmentItemResponseThe
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:
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 Fetch a Ledger Cash Account 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
andlapseTransactionEffectiveDate
properties have been added to DelinquencyResponseThe
references
property is now optional on DelinquencyResponseOn DelinquencyPlanRef the properties
advanceLapseTo
andlapseTransactionType
are now optional.The properties
executedAt
andreversedAt
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:
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
andtenantLocator
from ElementResponse.Added the property
updatedAt
to TenantResponse.On ProductRef the properties
defaultAutoRenewalPlan
,defaultDelinquencyPlan
, anddefaultShortfallTolerancePlan
are now optional.
May 23, 2024
Users
Added the Fetch Multiple Basic Users endpoint to return a streamlined user response, which allows for a larger page size. This endpoint returns an array of BasicUserResponse entities.
Renamed the
fetchUsersByBusinessAccount
endpoint to Fetch Multiple Users.
Excess Credits
The Excess Credits feature is forthcoming to handle excess customer credits held in a credit balance.
Added the
excessCreditPlans
anddefaultExcessCreditPlan
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 erronously called externalDocuments
rather than its proper name externalDocs
. This has been corrected. (This property is not currenly 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 markedreferences
as optional.Renamed the
listByTransactionLocator
endpoint to Fetch Installments for Policy TransactionThe DocumentInstanceResponse entity has the following properties marked as optional:
policyLocator
,referenceDocumentLocator
,segmentLocator
,termLocator
,transactionLocator
,name
,staticName
,documentFormat
,processingErrors
,readyAt
, andcreatedBy
.
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 replacebillingModeChange
The
preferences
andnewPolicyEndTime
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
anddate
parameter to the Fetch Resource and Fetch Secret endpoints for finer control of resource retreival.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 totermNumber
.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 isfalse
.On UnderwritingFlag, removed properties
createdBy
,createdTime
,clearedBy
clearedTime
.On TransactionPriceResponse, changed the
pricingItems
property to now becharges
.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.
Important
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 may now be managed and retreived by the entity they are attached to with these endpoints:
Fetch Documents for Quote (previously named
fetchDocumentsByQuote
)Fetch Documents Job for Quote (previously named
fetchQuoteDocumentsJob
)Fetch Multiple Documents Jobs for Quote (previously named
getQuoteDocumentsJobs
)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
Note
Policy documents are attatched to either policy segments or transactions, depending on scope rules
April 28, 2024
Feature Guides
New feature guides have been added for these topics:
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 and Update Password Policy 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:
Other Changes
Added property
validationResult
to PolicyResponse and AccountResponseAdded configuration for
staticData
to ProductRefDeprecated 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:
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:
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
andcount
parameters to Fetch Search Results endpointAdded properties
offset
,count
, andsearchToken
to SearchServiceResponse, and removedpage
Renamed the
locator
property on SearchResultResponse tosearchEntityLocator
Invoicing
Added property
installmentsItemsLocator
to InvoiceResponse, and removedinvoiceLocator
andinstallmentItems
Added properties
originationType
, andrefused
, andinvalidated
to InstallmentResponseAdded property
autoRenewalLocator
to TermResponse
Other Changes
Added a Reinstatements Feature Guide
Added the Fetch Multiple Snapshots endpoint
Renamed the
TransactionSnapshot
entity to TransactionSnapshotResponseAdded parameter
accountLocator
to Fetch Multiple Payments, Fetch Multiple Disbursements and Fetch Multiple Credit Distributions endpointsAdded property
preferences
to AccountCreateRequest, AccountUpdateRequest, AccountUpdateReplaceDataRequest, and AccountResponse
Older Changes
See the release notes archive for older release notes.