Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Claims Management
Insurance Group Benefits
Insurance Group Benefits Business APIs
Resources
Create Quote From Insurance Contract (POST)
Deep Clone Group Census (POST)
Endorse Contract (POST)
Map Group Census Fields (POST)
Member Overrides (POST, DELETE)
Group Renewal (POST)
Group Census Price Comparisons (POST)
Group Census Members With Plans (POST, PATCH)
Generate Insurance Contract Transactions (POST)
Generate Group Census From Insurance Contract (POST)
Update Group Census (PATCH)
Generate or Update Group Census Members (POST)
Group Enrollment (POST)
Individual Enrollment (POST)
Insurance Person Accounts and Users (POST)
Insurance Contacts and Users (POST)
Insurance Member Rating (POST)
Insurance Bulk Census Management (POST)
Insurance Group Census Members (POST, PATCH, DELETE)
Insurance Group Census Members Delete (POST)
Insurance Group Rating (POST)
Insurance Census Summary Sync (POST)
Insurance Member Plans (POST, PATCH)
Insurance Member Plans Delete (POST)
Insurance Member Eligible Plans (GET)
Insurance Plans Eligibility Check (POST, PATCH)
Issue Contract From Quote Asynchronous (POST)
Issue Contract From Quote (POST)
Member Policies Adjustment (POST)
Member Plans Adjustment (POST)
Renew Contract (POST)
Requests
Responses
Insurance Group Benefits Apex Reference
Insurance Group Benefits Standard Invocable Actions
Insurance Group Benefits Metadata API Types
Insurance Policy Administration
Insurance Product Administration
Insurance Quoting
Insurance Apex Reference
Error Codes and Responses
PDF

Group Census Price Comparisons (POST)

Compare the previous and the current prices for a group census so that you can show the price impact of an enrollment or a mid-term adjustment before it's finalized. Scope the comparison to a product category or to specific members, and optionally return the plan and coverage attributes along with the amounts.
Resource
1/connect/insurance/group-censuses/censusId/price-comparisons
Resource example
1https://yourInstance.salesforce.com/services/data/v68.0/connect/insurance/group-censuses/0rfxx000000001aEAA/price-comparisons
Available version
68.0
HTTP methods
POST
Path parameter for POST
Parameter Name Type Description Required or Optional Available Version
censusId String ID of the group census to compare the prices for. Required 68.0
Request body for POST
JSON example
1{
2  "category": "vision",
3  "fetchAttributes": true,
4  "memberIds": [
5    "0rgxx000000001aEAA",
6    "0rgxx000000002bEAA"
7  ]
8}
Properties
Name Type Description Required or Optional Available Version
category String Product category to filter the comparison by, such as dental or vision. If not specified, the API returns only the overall summary and the list of available categories. Optional 68.0
fetchAttributes Boolean Indicates whether to return the attributes of the root products and coverages, such as copay and coinsurance, along with the prices (true) or not (false). The default value is false. Optional 68.0
memberIds String[] List of group census member IDs to compare prices for. If not specified, the API returns the summary view of the census instead of member-level comparisons. Optional 68.0
Response body for POST
Price Comparison Response