Expected Revenue

Output representation of the details of the expected revenue.

JSON Example 

This example shows a sample success response.

1{
2  "policy": {
3    "id": "p111",
4    "amountWithFrequency": {
5      "annually": 1000.3,
6      "monthly": 100.03,
7      "quarterly": 300.09
8    },
9    "coverages": [
10      {
11        "id": "pc111",
12        "amountWithFrequency": {
13          "annually": 1000.3,
14          "monthly": 100.03,
15          "quarterly": 300.09
16        },
17        "ratePlans": [
18          {
19            "id": "rp11",
20            "totalPremiumAmount": 350,
21            "totalFeeAmount": 200,
22            "totalPremiumEqvAmount": 100,
23            "expectedRevenueAmount": 45,
24            "ratePlanCommissions": [
25              {
26                "id": "rpc111",
27                "premiumPercent": 100,
28                "type": "FlatPercentOfPremium"
29              }
30            ]
31          },
32          {
33            "id": "rp12",
34            "totalPremiumAmount": 350,
35            "totalFeeAmount": 200,
36            "totalPremiumEqvAmount": 100,
37            "expectedRevenueAmount": 45,
38            "ratePlanCommissions": [
39              {
40                "id": "rpc111",
41                "premiumPercent": null,
42                "type": "GradedPercent",
43                "amountStartRange": 0,
44                "amountEndRange": 1000
45              },
46              {
47                "id": "rpc112",
48                "premiumPercent": null,
49                "type": "GradedPercent",
50                "amountStartRange": 1001,
51                "amountEndRange": 10000
52              },
53            ]
54          }
55        ]
56      }
57    ]
58  }
59}

This example shows a sample error response.

1{
2    "isSuccess":false,
3    "errors" : [
4        {
5            "code":INVALID_INPUT,
6            "message": "Specify a valid ratePlanId."
7        }
8    ]
9}
Property NameTypeDescriptionFilter Group and VersionAvailable Version
errorsError Response[]List of errors encountered during the processing of the API request.Small, 63.063.0
isSuccessBooleanIndicates whether the API request is successful (true) or not (false).Small, 63.063.0
policyExpected Revenue Policy[]Map of the policy and expected revenue calculation details.Small, 63.063.0