Policy Terms API

Action	Endpoint
Fetch a Term	GET/policy/{tenantLocator}/terms/{locator}
Fetch Multiple Terms	GET/policy/{tenantLocator}/policies/{locator}/terms/list
Fetch Payable Amounts for a Policy Term	GET/policy/{tenantLocator}/terms/{locator}/payable
Fetch Term Charges	GET/policy/{tenantLocator}/terms/{locator}/charges
Fetch Term Summary By Term Locator	GET/policy/{tenantLocator}/terms/{locator}/summary
Fetch Term Summary By Term Number	GET/policy/{tenantLocator}/policies/{locator}/summary
Fetch Terms With Number	GET/policy/{tenantLocator}/terms/numbers/{termNumber}
Set Term Number	POST/policy/{tenantLocator}/terms/{locator}/number/set
Generate Term Number	POST/policy/{tenantLocator}/terms/{locator}/number/generate

Fetch

Fetch a Term

Fetch a TermfetchTerm

GET/policy/{tenantLocator}/terms/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:TermResponse

Security Group:terms

Permission:

read

TermResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`staticLocator`	`ulid`
`policyLocator`	`ulid`
`startTime`	`datetime`
`endTime`	`datetime`
`number`	`integer`

Optional properties

Property	Type	Description
`autoRenewalLocator`	`ulid?`
`previousTermLocator`	`ulid?`
`supersedesTermLocator`	`ulid?`
`termNumber`	`string?`

Fetch Multiple Terms

Fetch Multiple TermsfetchMultipleTerms

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.

Response:TermListResponse

Security Group:policies

Permissions:

read,list

TermListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`TermResponse[]`

Fetch Payable Amounts for a Policy Term

Fetch Payable Amounts for a Policy TermfetchTermPayableAmounts

GET/policy/{tenantLocator}/terms/{locator}/payable

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:TermPayableResponse

Security Group:terms

Permission:

read

TermPayableResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`staticLocator`	`ulid`
`policyLocator`	`ulid`
`startTime`	`datetime`
`endTime`	`datetime`
`amount`	`number`
`number`	`integer`

Fetch Term Charges

Fetch Term ChargesfetchTermCharges

GET/policy/{tenantLocator}/terms/{locator}/charges

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:map<string, PolicyChargeResponse[]>

Security Group:terms

Permission:

read

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

Fetch Term Summary By Term LocatorfetchTermSummaryByTermLocator

GET/policy/{tenantLocator}/terms/{locator}/summary

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:TermSummary

Security Group:terms

Permission:

read

Fetch Term Summary By Term Number

Fetch Term Summary By Term NumberfetchTermSummaryByTermNumber

GET/policy/{tenantLocator}/policies/{locator}/summary

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`termNumber`	query	`integer?`	No

Response:TermSummary

Security Group:policies

Permission:

read

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

TermSummary

Required properties

Property	Type	Description
`locator`	`ulid`
`staticLocator`	`ulid`
`policyLocator`	`ulid`
`startTime`	`datetime`
`endTime`	`datetime`
`duration`	`number`
`durationBasis`	`Enum years \| months \| weeks \| days \| hours`
`termNumber`	`integer`
`subsegments`	`SubsegmentSummary[]`

SubsegmentSummary

Required properties

Property	Type	Description
`locator`	`ulid`
`startTime`	`datetime`
`endTime`	`datetime`
`duration`	`number`
`basedOn`	`ulid`
`type`	`Enum coverage \| gap`
`documentSummary`	`DocumentSummary[]`
`elements`	`ElementSummary[]`

Optional properties

Property	Type	Description
`producerInfo`	`ProducerInfo?`

ElementSummary

Required properties

Property	Type	Description
`locator`	`ulid`
`staticLocator`	`ulid`
`type`	`string`
`data`	`map<string, object>`
`chargeSummaries`	`map<string, number>`

DocumentSummary

Required properties

Property	Type	Description
`locator`	`ulid`
`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

Optional properties

Property	Type	Description
`staticName`	`string?`
`name`	`string?`

Numbering

Fetch Terms With Number

Fetch Terms With NumberfetchTermsWithNumber

GET/policy/{tenantLocator}/terms/numbers/{termNumber}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`termNumber`	path	`string`	Yes

Response:TermResponse[]

Security Group:terms

Permissions:

read,list

Set Term Number

Set Term NumbersetTermNumber

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`termNumber`	query	`string`	Yes

Response:TermResponse

Security Group:terms

Permission:

write

Generate Term Number

Generate Term NumbergenerateTermNumber

POST/policy/{tenantLocator}/terms/{locator}/number/generate

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:TermResponse

Security Group:terms

Permission:

write

Policy Terms API

On this page