Policy Terms API
Fetch
GET /policy/{tenantLocator}/terms/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:TermResponse
Security Group:terms  Permission:read
TermResponse
¶requiredlocator locatorstaticLocator locatorpolicyLocator locatorstartTime datetimeendTime datetimenumber intoptionalautoRenewalLocator locator?previousTermLocator locator?supersedesTermLocator locator?termNumber string?
GET /policy/{tenantLocator}/policies/{locator}/terms/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:TermListResponse
Security Group:policies  Permissions:read,list
TermListResponse
¶requiredlistCompleted booleanitems TermResponse[]
GET /policy/{tenantLocator}/terms/{locator}/payable
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:TermPayableResponse
Security Group:terms  Permission:read
TermPayableResponse
¶requiredlocator locatorstaticLocator locatorpolicyLocator locatorstartTime datetimeendTime datetimeamount numbernumber 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.
GET /policy/{tenantLocator}/terms/{locator}/summary
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:TermSummary
Security Group:terms  Permission:read
GET /policy/{tenantLocator}/policies/{locator}/summary
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
termNumber | query | int? | 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
¶requiredlocator locatorstaticLocator locatorpolicyLocator locatorstartTime datetimeendTime datetimeduration numberdurationBasis Enum years | months | weeks | days | hourstermNumber intsubsegments SubsegmentSummary[]
SubsegmentSummary
¶requiredlocator locatorstartTime datetimeendTime datetimeduration numberbasedOn locatortype Enum coverage | gapdocumentSummary DocumentSummary[]elements ElementSummary[]
ElementSummary
¶requiredlocator locatorstaticLocator locatortype stringdata map<string,object>chargeSummaries map<string,number>
DocumentSummary
¶requiredlocator locatorstaticName stringname stringdocumentInstanceState Enum draft | dataReady | ready | dataError | renderError | conversionErrorreferenceType Enum quote | policy | invoice | transaction | segment | termstate Enum draft | dataReady | ready | dataError | renderError | conversionError (deprecated)
Numbering
GET /policy/{tenantLocator}/terms/numbers/{termNumber}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
termNumber | path | string | required |
Response:TermResponse[]
Security Group:terms  Permissions:read,list