SOsocotra

GET /policy/{tenantLocator}/policies/numbers/{policyNumber}

Request

Path parameters

tenantLocatorstring uuid required
policyNumberstring required

Response

OK

locatorstring ulid required
accountLocatorstring ulid required
branchHeadTransactionLocatorsstring[]

The locators of all the top-level transactions on the policy, one per branch

issuedTransactionLocatorstring ulid required

The locator of the latest issued transaction for the policy.

productNamestring required
timezonestring required
currencystring required
durationBasis'years' | 'months' | 'weeks' | 'days' | 'hours' required
createdAtstring date-time required
createdBystring uuid required
delinquencyPlanNamestring
autoRenewalPlanNamestring
startTimestring date-time required

The start time, based on issued transactions only

endTimestring date-time required

The end time based on issued transactions only.

latestTermLocatorstring ulid required
billingLevel'account' | 'inherit' | 'policy' required
regionstring
policyNumberstring
latestSegmentLocatorstring ulid required

The last segment on the policy, based on issued transactions only

statusesstring[] required
invoiceFeeAmountnumber
anonymizedAtstring date-time
coverageEndTimestring date-time
moratoriumElectionsobject required
jurisdictionstring
producerCodestring
producerCodeOfRecordstring
proxyPayerLocatorstring ulid
continuedByLocatorstring ulid
continuationOfLocatorstring ulid
staticobject required

Changes

No recorded changes to this operation across all 2 revisions of this API.