Premium Preview Result

Output representation of the rolled-up premium amounts or per-node errors for one policy-hierarchy node.

JSON Example

{
  "recordId": "0YTxx000000004rGAA",
  "errors": [],
  "name": "Draft State Premium Dummy Policy -1",
  "amounts": {
    "standardPremium": 2164,
    "standardFee": 25,
    "standardTax": 15,
    "standardCommission": 0,
    "totalStandard": 2204,
    "termPremium": 2164,
    "termFee": 25,
    "termTax": 15,
    "termCommission": 0,
    "totalTerm": 2204
  }
}

Properties

Property Name Type Description Filter Group and Version Available Version
amounts Premium Preview Amounts Rolled-up standard and term premium amounts for this hierarchy node. Shows null when the node fails and errors are returned instead. Small, 68.0 68.0
errors Error Response[] Per-node errors for this reference, such as INVALID_API_INPUT when the record isn’t in the policy hierarchy or INSUFFICIENT_ACCESS. Null when the node computed successfully. A per-node error doesn’t fail the entire request. Small, 68.0 68.0
name String Name of the policy for which the premium amount is calculated. Small, 68.0 68.0
recordId String ID of the policy-hierarchy node these amounts (or errors) belong to. Matches the requested reference, or the policy root whenreferences is omitted. Small, 68.0 68.0