Policy Terms API

Fetch

Fetch a Term
fetchTerm
GET /policy/{tenantLocator}/terms/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:TermResponse
    Security Group:terms   Permission:read
TermResponse
required
locator locator
staticLocator locator
policyLocator locator
startTime datetime
endTime datetime
number int

optional
autoRenewalLocator locator?
previousTermLocator locator?
supersedesTermLocator locator?
termNumber string?
Fetch Multiple Terms
fetchMultipleTerms
GET /policy/{tenantLocator}/policies/{locator}/terms/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:policies   Permissions:read,list
TermListResponse
required
listCompleted boolean
items TermResponse[]
Fetch Payable Amounts for a Policy Term
fetchTermPayableAmounts
GET /policy/{tenantLocator}/terms/{locator}/payable
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:terms   Permission:read
TermPayableResponse
required
locator locator
staticLocator locator
policyLocator locator
startTime datetime
endTime datetime
amount number
number int

Term Summaries

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.

Fetch Term Summary By Term Locator
fetchTermSummaryByTermLocator
GET /policy/{tenantLocator}/terms/{locator}/summary
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:TermSummary
    Security Group:terms   Permission:read
Fetch Term Summary By Term Number
fetchTermSummaryByTermNumber
GET /policy/{tenantLocator}/policies/{locator}/summary
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    termNumberqueryint?optional
    Response:TermSummary
    Security Group:policies   Permission:read

Note

If the term has been created by a renewal transaction that is not yet issued, the TermSummary will not contain any segments.

TermSummary
required
locator locator
staticLocator locator
policyLocator locator
startTime datetime
endTime datetime
duration number
durationBasis Enum years | months | weeks | days | hours
termNumber int
subsegments SubsegmentSummary[]
SubsegmentSummary
required
locator locator
startTime datetime
endTime datetime
duration number
basedOn locator
type Enum coverage | gap
documentSummary DocumentSummary[]
elements ElementSummary[]
ElementSummary
required
locator locator
staticLocator locator
type string
data map<string,object>
chargeSummaries map<string,number>
DocumentSummary
required
locator locator
staticName string
name string
documentInstanceState Enum draft | dataReady | ready | dataError | renderError | conversionError
referenceType Enum quote | policy | invoice | transaction | segment | term
state Enum draft | dataReady | ready | dataError | renderError | conversionError (deprecated)

Numbering

Fetch Terms with Number
fetchTermsWithNumber
GET /policy/{tenantLocator}/terms/numbers/{termNumber}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    termNumberpathstringrequired
    Response:TermResponse[]
    Security Group:terms   Permissions:read,list