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 |
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
GET /policy/{tenantLocator}/accounts/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:AccountResponse
Security Group:accounts  Permission:read
AccountResponse
¶requiredlocator locatoraccountState Enum draft | validated | discardedaccountNumber stringbillingLevel Enum account | inherit | policytype string
One of the configured Account Typesdata map<string,object>state Enum draft | validated | discarded (deprecated)optionalregion string?autoRenewalPlanName string?delinquencyPlanName string?excessCreditPlanName string?shortfallTolerancePlanName string?invoiceDocument string?preferences PreferencesResponse?validationResult ValidationResult?
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
¶requiredlistCompleted booleanitems AccountResponse[]
Account Creation
POST /policy/{tenantLocator}/accounts
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Request:AccountCreateRequest
Response:AccountResponse
Security Group:accounts  Permission:write
AccountCreateRequest
¶requiredtype string
One of the configured Account Typesoptionalregion string?autoRenewalPlanName string?delinquencyPlanName string?excessCreditPlanName string?shortfallTolerancePlanName string?autoValidate boolean?billingLevel Enum? account | inherit | policyinvoiceDocument string?preferences PreferencesResponse?data map<string,object>?
Updating
Updates the account and individual data extensions.
PATCH /policy/{tenantLocator}/accounts/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:AccountUpdateRequest
Response:AccountResponse
Security Group:accounts  Permission:write
AccountUpdateRequest
¶requiredautoRenewalPlanName stringdelinquencyPlanName stringexcessCreditPlanName stringshortfallTolerancePlanName stringautoValidate booleanbillingLevel Enum account | inherit | policyinvoiceDocument stringpreferences PreferencesResponsetype string
One of the configured Account TypesremoveData map<string,object>setData map<string,object>
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 | locator | 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
¶requiredtype string
One of the configured Account Typesoptionalregion string?autoRenewalPlanName string?delinquencyPlanName string?excessCreditPlanName string?shortfallTolerancePlanName string?autoValidate boolean?billingLevel Enum? account | inherit | policyinvoiceDocument string?preferences PreferencesResponse?data map<string,object>?
Validation
PATCH /policy/{tenantLocator}/accounts/{locator}/validate
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:AccountResponse
Security Group:accounts  Permission:write
ValidationResult
¶requiredsuccess booleanoptionalvalidationItems ValidationItemResponse[]?
ValidationItemResponse
¶requiredlocator locatorelementType stringerrors string[]
Quotes and Policies
GET /policy/{tenantLocator}/accounts/{locator}/policies/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | 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
¶requiredlocator locatoraccountLocator locatorissuedTransactionLocator locator
The locator of the latest issued transaction for the policy.latestSegmentLocator locator
The last segment on the policy, based on issued transactions onlylatestTermLocator locatorproductName stringstartTime datetime
The start time, based on issued transactions onlyendTime datetime
The end time based on issued transactions only.currency stringdurationBasis Enum years | months | weeks | days | hourstimezone stringbillingLevel Enum account | inherit | policystatic map<string,object>createdAt datetimecreatedBy uuidbillingTrigger Enum accept | issue (deprecated)optionalregion 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
GET /policy/{tenantLocator}/accounts/{locator}/quotes/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | 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
¶requiredlocator locatoraccountLocator locatorgroupLocator locatorproductName stringquoteState Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discardedbillingLevel Enum account | inherit | policyoptionalpolicyLocator 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 durationBasisdurationBasis Enum? years | months | weeks | days | hourstimezone string?expirationTime datetime?policyNumber string?quoteNumber string?underwritingStatus string?validationResult ValidationResult?static map<string,object>?billingTrigger Enum? accept | issue (deprecated)
GET /policy/{tenantLocator}/accounts/{locator}/policies/snapshot/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:PolicySnapshotListResponse
Security Group:accounts  Permissions:read,list
PolicySnapshotResponse
¶requiredlocator locatoraccountLocator locatorregion stringproductName stringcurrency stringtimezone stringtransaction TransactionSnapshotResponsestatic map<string,object>optionaldelinquencyPlanName string?
Holds
GET /billing/{tenantLocator}/holds/accounts/{accountLocator}/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
accountLocator | path | locator | 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
¶requiredlocator locatoraccountLocator locatorholdState Enum draft | validated | active | discarded | releasedtargetType Enum invoicing | delinquencyupdatedAt datetimecreatedAt datetimeoptionalvalidationResult ValidationResult?
Billing
PATCH /policy/{tenantLocator}/accounts/{locator}/billingLevel
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:UpdateBillingLevelRequest
Response:AccountResponse
Security Group:accounts  Permission:write
UpdateBillingLevelRequest
¶requiredbillingLevel Enum account | inherit | policy
Numbering
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
POST /policy/{tenantLocator}/accounts/{locator}/number/set
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
accountNumber | query | string | required |
Response:AccountResponse
Security Group:accounts  Permission:write