Integrated Application Benefit Amount Calculations (POST)

Returns benefit amounts computed by the expression set for the selected benefits.
Resource
1/connect/integrated-application/benefit-amount-calculations
Available version
68.0
HTTP methods
POST
Request body for POST
JSON example
1{
2  "sourceRecordId": "1LaSG000005I1Fh0AK",
3  "selectedBenefitIds": [
4    "0jiSG0000005lMTYAY",
5    "0jiSG0000005mqPYAQ"
6  ],
7  "contextInfo": {
8    "contextDefinitionApiName": "BenefitEnrollmentContext__stdctx",
9    "inputData": {
10      "BenefitEnrollment": {
11        "PrimaryBeneficiaryId": "001SG00000XyZ12YAF",
12        "UsageType": "BenefitApplication",
13        "AppliedBenefits": [
14          { "Name": "SNAP", "BenefitId": "0jiSG0000005lMTYAY" },
15          { "Name": "LIHEAP", "BenefitId": "0jiSG0000005mqPYAQ" }
16        ],
17        "Applicants": [
18          {
19            "Role": "Primary Applicant",
20            "FirstName": "John",
21            "LastName": "Smith",
22            "BirthDate": "2011-02-01",
23            "IsDisabled": true,
24            "IsLivingTogether": true,
25            "IsPreparingFoodTogether": true,
26            "Profile": {
27              "FirstName": "John",
28              "LastName": "Smith",
29              "BirthDate": "2011-02-01",
30              "Gender": "Male",
31              "IsDisabled": true
32            },
33            "Incomes": [
34              {
35                "Type": "Salary",
36                "Status": "Active",
37                "Amount": 500,
38                "Frequency": "Monthly",
39                "StartDate": "2026-02-01",
40                "EndDate": "2026-02-28",
41                "EmployerName": "Acme Corp"
42              }
43            ],
44            "Expenses": [
45              {
46                "Type": "Child Care",
47                "Status": "Active",
48                "Amount": 200,
49                "Frequency": "Monthly",
50                "StartDateTime": "2026-02-01T06:30:00.000Z"
51              }
52            ]
53          },
54          {
55            "Role": "Household Member",
56            "FirstName": "Radhika",
57            "LastName": "Madan",
58            "BirthDate": "1997-02-01",
59            "IsDisabled": false,
60            "IsLivingTogether": true,
61            "IsPreparingFoodTogether": true,
62            "Profile": {
63              "FirstName": "Radhika",
64              "LastName": "Madan",
65              "BirthDate": "1997-02-01",
66              "Gender": "Female",
67              "IsDisabled": false
68            },
69            "Incomes": [
70              {
71                "Type": "Salary",
72                "Status": "Active",
73                "Amount": 200,
74                "Frequency": "Monthly",
75                "StartDate": "2026-02-01"
76              }
77            ]
78          }
79        ]
80      }
81    }
82  }
83}
Properties
Name Type Description Required or Optional Available Version
contextInfo Context Info Input Context information used to add details to the context. Optional 68.0
parameters Object Input parameters to the expression sets. Optional 68.0
selectedBenefitIds String[] List of Salesforce IDs for the benefits the applicant selected for the amount calculation. If not provided, the API returns an empty benefits array. Required 68.0
sourceRecordId String ID of the source record that invoked the API. Required 68.0
Response body for POST
Integrated Application Benefit Amounts
Request parameters for POST
Parameter Name Type Description Required or Optional Available Version
integratedApplicationBenefitAmountsInputRepresentation Object 68.0