Accounts API

Endpoint Index

Action	Endpoint
Fetch an Account	GET /policy/{tenantLocator}/accounts/{locator}
Fetch Multiple Accounts	GET /policy/{tenantLocator}/accounts/list
Create an Account	POST /policy/{tenantLocator}/accounts
Update Account	PATCH /policy/{tenantLocator}/accounts/{locator}
Update Account and Replace Data	PUT /policy/{tenantLocator}/accounts/{locator}
Validate an Account	PATCH /policy/{tenantLocator}/accounts/{locator}/validate
Add contact	POST /policy/{tenantLocator}/accounts/{accountLocator}/contacts
Delete contact	DELETE /policy/{tenantLocator}/accounts/{accountLocator}/contacts/{contactLocator}
Update contact	PATCH /policy/{tenantLocator}/accounts/{accountLocator}/contacts/{contactLocator}
Fetch contacts	GET /policy/{tenantLocator}/accounts/{accountLocator}/contacts
Fetch Policies for an Account	GET /policy/{tenantLocator}/accounts/{locator}/policies/list
Fetch Quotes for an Account	GET /policy/{tenantLocator}/accounts/{locator}/quotes/list
Fetch Policy Snapshots for an Account	GET /policy/{tenantLocator}/accounts/{locator}/policies/snapshot/list
Update Billing Level for an Account	PATCH /policy/{tenantLocator}/accounts/{locator}/billingLevel
Fetch Accounts with Number	GET /policy/{tenantLocator}/accounts/numbers/{accountNumber}
Set Account Number	POST /policy/{tenantLocator}/accounts/{locator}/number/set

Fetch

Fetch an Account

¶

fetchAccount

GET /policy/{tenantLocator}/accounts/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:AccountResponse

Security Group:accounts Permission:read

AccountResponse

¶

required
locator string
accountState Enum draft | validated | discarded
accountNumber string
billingLevel Enum account | inherit | policy
type string
One of the configured Account Types
data map<string,object>
contacts ContactRoles[]
state Enum draft | validated | discarded (deprecated)

optional
region string?
autoRenewalPlanName string?
delinquencyPlanName string?
excessCreditPlanName string?
invoicingPlanName string?
paymentExecutionRetryPlanName string?
shortfallTolerancePlanName string?
timezone string?
anonymizedAt datetime?
invoiceDocument string?
preferences PreferencesResponse?
validationResult ValidationResult?

Fetch Multiple Accounts

¶

fetchMultipleAccounts

GET /policy/{tenantLocator}/accounts/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:AccountListResponse

Security Group:accounts Permissions:read,list

AccountListResponse

¶

required
listCompleted boolean
items AccountResponse[]

Account Creation

Create an Account

¶

createAccount

POST /policy/{tenantLocator}/accounts

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:AccountCreateRequest

Response:AccountResponse

Security Group:accounts Permission:write

AccountCreateRequest

¶

required
type string
One of the configured Account Types

optional
region string?
autoRenewalPlanName string?
delinquencyPlanName string?
excessCreditPlanName string?
invoicingPlanName string?
paymentExecutionRetryPlanName string?
shortfallTolerancePlanName string?
timezone string?
autoValidate boolean?
billingLevel Enum? account | inherit | policy
invoiceDocument string?
preferences PreferencesResponse?
data map<string,object>?
contacts ContactRoles[]?

ContactRoles

¶

required
contactLocator string
roles string[]

Updating

Update Account

¶

updateAccount

Updates the account and individual data extensions.

PATCH /policy/{tenantLocator}/accounts/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:AccountUpdateRequest

Response:AccountResponse

Security Group:accounts Permission:write

AccountUpdateRequest

¶

required
autoRenewalPlanName string
delinquencyPlanName string
excessCreditPlanName string
invoicingPlanName string
paymentExecutionRetryPlanName string
shortfallTolerancePlanName string
timezone string
autoValidate boolean
billingLevel Enum account | inherit | policy
invoiceDocument string
preferences PreferencesResponse
type string
One of the configured Account Types
removeData map<string,object>
setData map<string,object>

Update Account and Replace Data

¶

updateAccountReplaceData

Updates the account and replaces all existing data extensions with the new data.

PUT /policy/{tenantLocator}/accounts/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:AccountUpdateReplaceDataRequest

Response:AccountResponse

Security Group:accounts Permission:write

Note

This version of updateAccount replaces all extension data for the account, rather than just updating individual properties.

AccountUpdateReplaceDataRequest

¶

required
type string
One of the configured Account Types

optional
region string?
autoRenewalPlanName string?
delinquencyPlanName string?
excessCreditPlanName string?
invoicingPlanName string?
paymentExecutionRetryPlanName string?
shortfallTolerancePlanName string?
timezone string?
autoValidate boolean?
billingLevel Enum? account | inherit | policy
invoiceDocument string?
preferences PreferencesResponse?
data map<string,object>?
contacts ContactRoles[]?

Validation

Validate an Account

¶

validateAccount

PATCH /policy/{tenantLocator}/accounts/{locator}/validate

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:AccountResponse

Security Group:accounts Permission:write

ValidationResult

¶

required
success boolean

optional
validationItems ValidationItemResponse[]?

ValidationItemResponse

¶

required
locator string
elementType string
errors string[]

Contact Management

Add contact

¶

addAccountContact

POST /policy/{tenantLocator}/accounts/{accountLocator}/contacts

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountLocator	path	string	required

Request:ContactRoles

Response:AccountResponse

Security Group:accounts Permission:write

Delete contact

¶

deleteAccountContact

DELETE /policy/{tenantLocator}/accounts/{accountLocator}/contacts/{contactLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountLocator	path	string	required
contactLocator	path	string	required

Response:AccountResponse

Security Group:accounts Permission:write

Update contact

¶

updateAccountContact

PATCH /policy/{tenantLocator}/accounts/{accountLocator}/contacts/{contactLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountLocator	path	string	required
contactLocator	path	string	required

Request:ContactAssociationUpdateRequest

Response:AccountResponse

Security Group:accounts Permission:write

ContactAssociationUpdateRequest

¶

required
addRoles string[]
removeRoles string[]

Fetch contacts

¶

fetchAccountContacts

GET /policy/{tenantLocator}/accounts/{accountLocator}/contacts

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountLocator	path	string	required

Response:ContactRoles[]

Security Group:accounts Permission:write

Quotes and Policies

Fetch Policies for an Account

¶

fetchPoliciesForAccount

GET /policy/{tenantLocator}/accounts/{locator}/policies/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional
includeStaticData	query	boolean?	optional
extended	query	boolean?	optional

Response:PolicyListResponse

Security Group:accounts Permissions:read,list

PolicyResponse

¶

required
locator string
accountLocator string
issuedTransactionLocator string
The locator of the latest issued transaction for the policy.
latestSegmentLocator string
The last segment on the policy, based on issued transactions only
latestTermLocator string
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
contacts ContactRoles[]
moratoriumElections map<string,string>
statuses Enum[] cancelled | cancelPending | delinquent | doNotRenew | expired | inGap | onRisk | pending
billingTrigger Enum accept | issue (deprecated)

optional
region string?
autoRenewalPlanName string?
delinquencyPlanName string?
anonymizedAt datetime?
coverageEndTime datetime?
invoiceFeeAmount number?
policyNumber string?
validationResult ValidationResult?
branchHeadTransactionLocators string[]?
The locators of all the top-level transactions on the policy, one per branch

Fetch Quotes for an Account

¶

fetchQuotesForAccount

GET /policy/{tenantLocator}/accounts/{locator}/quotes/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional
includeStaticData	query	boolean?	optional
extended	query	boolean?	optional

Response:QuoteListResponse

Security Group:accounts Permissions:read,list

QuoteResponse

¶

required
locator string
accountLocator string
groupLocator string
productName string
quoteState Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded
billingLevel Enum account | inherit | policy
element ElementResponse
The root element in the hierarchy
contacts ContactRoles[]

optional
policyLocator string?
quickQuoteLocator string?
region string?
autoRenewalPlanName string?
delinquencyPlanName string?
issuedTime datetime?
startTime datetime?
endTime datetime?
acceptedTime datetime?
currency string?
duration number?
The duration of the prospective policy in units of durationBasis
durationBasis Enum? years | months | weeks | days | hours
timezone string?
anonymizedAt datetime?
expirationTime datetime?
invoiceFeeAmount number?
policyNumber string?
preferences PreferencesResponse?
Plan selections and setting overrides
quoteNumber string?
underwritingStatus string?
validationResult ValidationResult?
static map<string,object>?
createdAt datetime?
createdBy uuid?
billingTrigger Enum? accept | issue (deprecated)

Fetch Policy Snapshots for an Account

¶

fetchPolicySnapshotsForAnAccount

GET /policy/{tenantLocator}/accounts/{locator}/policies/snapshot/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:PolicySnapshotListResponse

Security Group:accounts Permissions:read,list

PolicySnapshotResponse

¶

required
locator string
accountLocator string
region string
productName string
currency string
timezone string
transaction TransactionSnapshotResponse
static map<string,object>

optional
delinquencyPlanName string?

Holds

Fetch All Holds for an Account

¶

fetchAllHoldsForAnAccount

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountLocator	path	string	required
state	query	Enum? draft \| validated \| active \| discarded \| released	optional
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:HoldListResponse

Security Group:holds Permissions:read,list

HoldResponse

¶

required
locator string
accountLocator string
holdState Enum draft | validated | active | discarded | released
targetType Enum invoicing | delinquency
updatedAt datetime
createdAt datetime

optional
validationResult ValidationResult?

Billing

Update Billing Level for an Account

¶

updateBillingLevelForAnAccount

PATCH /policy/{tenantLocator}/accounts/{locator}/billingLevel

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:UpdateBillingLevelRequest

Response:AccountResponse

Security Group:accounts Permission:write

UpdateBillingLevelRequest

¶

required
billingLevel Enum account | inherit | policy

Numbering

Fetch Accounts with Number

¶

fetchAccountsWithNumber

GET /policy/{tenantLocator}/accounts/numbers/{accountNumber}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountNumber	path	string	required

Response:AccountResponse[]

Security Group:accounts Permissions:read,list

Set Account Number

¶

setAccountNumber

POST /policy/{tenantLocator}/accounts/{locator}/number/set

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
accountNumber	query	string	required

Response:AccountResponse

Security Group:accounts Permission:write