Accounts API

Endpoint Index

ActionEndpoint
Fetch an AccountGET /policy/{tenantLocator}/accounts/{locator}
Fetch Multiple AccountsGET /policy/{tenantLocator}/accounts/list
Create an AccountPOST /policy/{tenantLocator}/accounts
Update AccountPATCH /policy/{tenantLocator}/accounts/{locator}
Update Account and Replace DataPUT /policy/{tenantLocator}/accounts/{locator}
Validate an AccountPATCH /policy/{tenantLocator}/accounts/{locator}/validate
Fetch Policies for an AccountGET /policy/{tenantLocator}/accounts/{locator}/policies/list
Fetch Quotes for an AccountGET /policy/{tenantLocator}/accounts/{locator}/quotes/list
Fetch Policy Snapshots for an AccountGET /policy/{tenantLocator}/accounts/{locator}/policies/snapshot/list
Update Billing Level for an AccountPATCH /policy/{tenantLocator}/accounts/{locator}/billingLevel
Fetch Accounts with NumberGET /policy/{tenantLocator}/accounts/numbers/{accountNumber}
Set Account NumberPOST /policy/{tenantLocator}/accounts/{locator}/number/set

Fetch

Fetch an Account
fetchAccount
GET /policy/{tenantLocator}/accounts/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:accounts   Permission:read
AccountResponse
required
locator locator
accountState Enum draft | validated | discarded
accountNumber string
billingLevel Enum account | inherit | policy
type string
One of the configured Account Types
data map<string,object>
state Enum draft | validated | discarded (deprecated)

optional
region string?
autoRenewalPlanName string?
delinquencyPlanName string?
excessCreditPlanName string?
shortfallTolerancePlanName string?
invoiceDocument string?
preferences PreferencesResponse?
validationResult ValidationResult?
Fetch Multiple Accounts
fetchMultipleAccounts
GET /policy/{tenantLocator}/accounts/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:accounts   Permissions:read,list
AccountListResponse
required
listCompleted boolean

Account Creation

Create an Account
createAccount
POST /policy/{tenantLocator}/accounts
AccountCreateRequest
required
type string
One of the configured Account Types

optional
region string?
autoRenewalPlanName string?
delinquencyPlanName string?
excessCreditPlanName string?
shortfallTolerancePlanName string?
autoValidate boolean?
billingLevel Enum? account | inherit | policy
invoiceDocument string?
preferences PreferencesResponse?
data map<string,object>?

Updating

Update Account
updateAccount
Updates the account and individual data extensions.
PATCH /policy/{tenantLocator}/accounts/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:accounts   Permission:write
AccountUpdateRequest
required
autoRenewalPlanName string
delinquencyPlanName string
excessCreditPlanName string
shortfallTolerancePlanName 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}

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?
shortfallTolerancePlanName string?
autoValidate boolean?
billingLevel Enum? account | inherit | policy
invoiceDocument string?
preferences PreferencesResponse?
data map<string,object>?

Validation

Validate an Account
validateAccount
PATCH /policy/{tenantLocator}/accounts/{locator}/validate
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:accounts   Permission:write
ValidationResult
required
success boolean

optional
validationItems ValidationItemResponse[]?
ValidationItemResponse
required
locator locator
elementType string
errors string[]

Quotes and Policies

Fetch 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
    Security Group:accounts   Permissions:read,list
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 Quotes for an Account
fetchQuotesForAccount
GET /policy/{tenantLocator}/accounts/{locator}/quotes/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    includeStaticDataqueryboolean?optional
    extendedqueryboolean?optional
    Security Group:accounts   Permissions:read,list
QuoteResponse
required
locator locator
accountLocator locator
groupLocator locator
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

optional
policyLocator locator?
quickQuoteLocator locator?
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?
expirationTime datetime?
policyNumber string?
preferences PreferencesResponse?
Plan selections and setting overrides
quoteNumber string?
underwritingStatus string?
validationResult ValidationResult?
static map<string,object>?
billingTrigger Enum? accept | issue (deprecated)
Fetch Policy Snapshots for an Account
fetchPolicySnapshotsForAnAccount
GET /policy/{tenantLocator}/accounts/{locator}/policies/snapshot/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:accounts   Permissions:read,list
PolicySnapshotResponse
required
locator locator
accountLocator locator
region string
productName string
currency string
timezone string
static map<string,object>

optional
delinquencyPlanName string?

Holds

Fetch All Holds for an Account
fetchAllHoldsForAnAccount
GET /billing/{tenantLocator}/holds/accounts/{accountLocator}/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    accountLocatorpathlocatorrequired
    statequeryEnum? draft | validated | active | discarded | releasedoptional
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:holds   Permissions:read,list
HoldResponse
required
locator locator
accountLocator locator
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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    accountNumberpathstringrequired
    Response:AccountResponse[]
    Security Group:accounts   Permissions:read,list
Set Account Number
setAccountNumber
POST /policy/{tenantLocator}/accounts/{locator}/number/set
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    accountNumberquerystringrequired
    Security Group:accounts   Permission:write