Policies API

Endpoint Index

ActionEndpoint
Fetch a PolicyGET /policy/{tenantLocator}/policies/{locator}
Add Static Data to a PolicyPOST /policy/{tenantLocator}/policies/{locator}/static
Update Static Data on a PolicyPATCH /policy/{tenantLocator}/policies/{locator}/static
Replace All Static Data on a PolicyPUT /policy/{tenantLocator}/policies/{locator}/static
Fetch a Policy SnapshotGET /policy/{tenantLocator}/policies/{locator}/snapshot
Fetch Multiple SnapshotsGET /policy/{tenantLocator}/policies/snapshot/list
Update Policy Billing TriggerPATCH /policy/{tenantLocator}/policies/{locator}/billingTrigger
Update Billing Level for a PolicyPATCH /policy/{tenantLocator}/policies/{locator}/billingLevel

Fetch

Fetch a Policy
fetchPolicy
GET /policy/{tenantLocator}/policies/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:PolicyResponse
    Security Group:policies   Permission:read
PolicyResponse
required
locator locator
accountLocator locator
issuedTransactionLocator locator
The locator of the latest issued transaction for the policy.
latestSegmentLocator locator
The last segment on the policy, based on issued transactions only
latestTermLocator locator
productName string
startTime datetime
The start time, based on issued transactions only
endTime datetime
The end time based on issued transactions only.
currency string
durationBasis Enum years | months | weeks | days | hours
timezone string
billingLevel Enum account | inherit | policy
static map<string,object>
createdAt datetime
createdBy uuid
billingTrigger Enum accept | issue (deprecated)

optional
region string?
autoRenewalPlanName string?
delinquencyPlanName string?
policyNumber string?
validationResult ValidationResult?
branchHeadTransactionLocators locator[]?
The locators of all the top-level transactions on the policy, one per branch
Fetch all Policies for an Account
fetchPoliciesForAccount
GET /policy/{tenantLocator}/accounts/{locator}/policies/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    includeStaticDataqueryboolean?optional
    extendedqueryboolean?optional
    Response:PolicyListResponse
    Security Group:accounts   Permissions:read,list
PolicyListResponse
required
listCompleted boolean
items PolicyResponse[]

Static Data

Add Static Data to a Policy
addStaticDataForPolicy
Set the static extension data on a policy
POST /policy/{tenantLocator}/policies/{locator}/static
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Request:map<string,object>
    Response:PolicyResponse
    Security Group:policies   Permission:write
Update Static Data on a Policy
updateStaticDataForPolicy
Updates some of the static data on a policy
PATCH /policy/{tenantLocator}/policies/{locator}/static
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Request:StaticDataUpdateRequest
    Response:PolicyResponse
    Security Group:policies   Permission:write
StaticDataUpdateRequest
required
removeData map<string,object>
setData map<string,object>
Replace All Static Data on a Policy
replaceAllStaticDataForPolicy
Replaces all of the static data on a policy
PUT /policy/{tenantLocator}/policies/{locator}/static
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Request:map<string,object>
    Response:PolicyResponse
    Security Group:policies   Permission:write

Snapshots

Fetch a Policy Snapshot
fetchPolicySnapshot
GET /policy/{tenantLocator}/policies/{locator}/snapshot
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    datequerydatetimerequired
    byIssuedTimequeryboolean?optional
    Response:PolicySnapshotResponse
    Security Group:policies   Permission:read
Fetch Multiple Snapshots
Deprecated
fetchMultipleSnapshots
This endpoint will be removed in a future release.
GET /policy/{tenantLocator}/policies/snapshot/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    offsetqueryint?optional
    countqueryint?optional
    Response:PolicySnapshotResponse[]
    Security Group:policies   Permissions:read,list
PolicySnapshotListResponse
required
listCompleted boolean
items PolicySnapshotResponse[]
PolicySnapshotResponse
required
locator locator
accountLocator locator
region string
productName string
currency string
timezone string
transaction TransactionSnapshotResponse
static map<string,object>

optional
delinquencyPlanName string?
TransactionSnapshotResponse
required
locator locator
effectiveTime datetime
issuedTime datetime
preferences PreferencesResponse
segment SegmentResponse
transactionCategory Enum issuance | change | renewal | cancellation | reinstatement | reversal | aggregate
transactionType string

Billing Triggers

Update Policy Billing Trigger
Deprecated
updatePolicyBillingTrigger
This endpoint will be removed in a future release.
PATCH /policy/{tenantLocator}/policies/{locator}/billingTrigger
BillingTriggerUpdateRequest
Deprecated
This entity will be removed in a future release.
required
billingTrigger Enum accept | issue

Billing

Update Billing Level for a Policy
updateBillingLevelForAPolicy
PATCH /policy/{tenantLocator}/policies/{locator}/billingLevel
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Request:UpdateBillingLevelRequest
    Response:PolicyResponse
    Security Group:policies   Permission:write
UpdateBillingLevelRequest
required
billingLevel Enum account | inherit | policy
Update the Delinquency Plan Assigned to a Policy
updatePolicyDelinquencyPlan
PATCH /policy/{tenantLocator}/policies/{locator}/delinquencyPlan