Insurance Developer Guide
jGet Census Price Comparison Action
Calculate price comparison impacts for group census members based on their plan
enrollments. This action calculates the financial comparison of changes to a group census by
comparing the previous and current costs across plans, group classes, members, and
coverages, returning a breakdown of total cost, premium, tax, and fees to help evaluate the
comparison of proposed changes.
This action is available in API version 68.0 and later.
Supported REST HTTP Methods
URI: /services/data/v68.0/actions/standard/getCensusPriceComparison
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token
Inputs
| Input | Type | Description |
|---|---|---|
| censusId | string | Required. ID of the group census record to calculate price comparisons for. |
| insurancePriceComparisonInput | Apex-defined | An Apex ConnectApi.InsurancePriceComparisonInputRepresentation record that contains the optional filters, such as member IDs, category, and fetch attribute flag to calculate price comparisons. |
Outputs
| Output | Type | Description |
|---|---|---|
| priceComparisonOutput | Apex-defined | An Apex ConnectApi.RateComparisonOutputRepresentation record that contains the hierarchical price comparison results. |
Example
POST
This sample request is for the Get Census Price Comparison action.
1{
2 "inputs": [
3 {
4 "censusId": "0rfxx000000001aEAA",
5 "insurancePriceComparisonInput": {
6 "category": "vision",
7 "fetchAttributes": true,
8 "memberIds": [
9 "0rgxx000000001aEAA",
10 "0rgxx000000002bEAA"
11 ]
12 }
13 }
14 ]
15}This sample response is for the Get Census Price Comparison action.
1[
2 {
3 "actionName": "getCensusPriceComparison",
4 "errors": null,
5 "invocationId": null,
6 "isSuccess": true,
7 "outcome": null,
8 "outputValues": {
9 "priceComparisonOutput": {
10 "categories": {
11 "dental": "Dental",
12 "vision": "Vision"
13 },
14 "comparisons": [
15 {
16 "category": null,
17 "current": {
18 "attributes": [],
19 "fee": 400,
20 "id": "0rHxx000000001aEAA",
21 "premium": 2000,
22 "tax": 180,
23 "total": 2580
24 },
25 "durationKey": "dur1",
26 "id": "identifier1",
27 "name": null,
28 "node": "summary",
29 "parent": null,
30 "previous": {
31 "attributes": [],
32 "fee": 200,
33 "id": "0rHxx000000002bEAA",
34 "premium": 1800,
35 "tax": 180,
36 "total": 2180
37 }
38 }
39 ],
40 "currencyInfo": {
41 "locale": "en_US",
42 "name": "USD",
43 "symbol": "$"
44 },
45 "durations": [
46 {
47 "effectiveFrom": "2026-01-01",
48 "effectiveTo": "2026-12-31",
49 "key": "dur1"
50 }
51 ],
52 "errors": [],
53 "isSuccess": true,
54 "summary": {
55 "endorse": 10,
56 "enrollment": 0,
57 "hire": 20,
58 "terminate": 10
59 }
60 }
61 },
62 "sortOrder": -1,
63 "version": 1
64 }
65]