Integrated Application Eligible Benefits (POST)
Returns available benefits along with eligibility evaluation outcomes.
- Resource
-
1/connect/integrated-application/eligible-benefits - Available version
- 68.0
- HTTP methods
- POST
- Request body for POST
-
- JSON example
-
1{ 2 "sourceRecordId": "1LaSG000005I1Fh0AK", 3 "contextInfo": { 4 "inputData": { 5 "BenefitEnrollment": [ 6 { 7 "id": "13XAAC000006H6D2BU", 8 "businessObjectType": "ApplicationForm", 9 "PrimaryBeneficiaryId": "001AAC0001RPvpRYBT", 10 "UsageType": "Other", 11 "Applicants": [ 12 { 13 "id": "13YAAC0000006v42BA", 14 "businessObjectType": "Applicant", 15 "Role": "Mother", 16 "FirstName": "Mary", 17 "ParentReference": "13XAAC000006H6D2BU", 18 "IsPreparingFoodTogether": false, 19 "IsLivingTogether": false, 20 "LastName": "Lucas", 21 "Expenses": [ 22 { 23 "id": "139AAC00002QAQoYBO", 24 "businessObjectType": "PartyExpense", 25 "Status": "Active", 26 "Frequency": "Monthly", 27 "Type": "Garnishments", 28 "StartDateTime": "2022-06-27T00:00:00.000Z", 29 "ParentReference": "13YAAC0000006v42BA", 30 "Amount": 3600.0 31 } 32 ], 33 "Incomes": [ 34 { 35 "id": "2m3AAC00005XoxnYBC", 36 "businessObjectType": "PartyIncome", 37 "StartDate": "2021-06-01", 38 "Status": "Active", 39 "ParentReference": "13YAAC0000006v42BA", 40 "EmployerAddress": "789 Mission St, San Francisco, CA 94103", 41 "Amount": 36900.0, 42 "Type": "Fees", 43 "Frequency": "Monthly", 44 "EmployerName": "Lucas Designs" 45 } 46 ] 47 }, 48 { 49 "id": "13YAAC0000006v32BA", 50 "businessObjectType": "Applicant", 51 "Role": "Father", 52 "FirstName": "George", 53 "ParentReference": "13XAAC000006H6D2BU", 54 "IsPreparingFoodTogether": false, 55 "IsLivingTogether": false, 56 "LastName": "Lucas", 57 "Expenses": [ 58 { 59 "id": "139AAC00002QAQnYBO", 60 "businessObjectType": "PartyExpense", 61 "Status": "Active", 62 "Frequency": "Monthly", 63 "Type": "Garnishments", 64 "StartDateTime": "2006-09-12T00:00:00.000Z", 65 "ParentReference": "13YAAC0000006v32BA", 66 "Amount": 36200.0 67 } 68 ], 69 "Assets": [ 70 { 71 "id": "12MAAC000003zTZ2BY", 72 "businessObjectType": "PartyFinancialAsset", 73 "Status": "Active", 74 "Type": "Other", 75 "OwnershipStartDateTime": "2024-03-13T00:00:00.000Z", 76 "ParentReference": "13YAAC0000006v32BA", 77 "ValuationAmount": 36510.0 78 } 79 ], 80 "Profile": [ 81 { 82 "id": "0xUAAC000005HOP2B2", 83 "businessObjectType": "PartyProfile", 84 "BirthDate": "2019-06-01", 85 "Phone": "1212121212", 86 "FirstName": "George", 87 "IsDisabled": false, 88 "Email": "george.lucas@gmail.com", 89 "Name": "George Lucas", 90 "ParentReference": "13YAAC0000006v32BA", 91 "PreferredCommunicationMethod": "Phone", 92 "LastName": "Lucas" 93 } 94 ], 95 "Incomes": [ 96 { 97 "id": "2m3AAC00005XoxmYBC", 98 "businessObjectType": "PartyIncome", 99 "StartDate": "2022-01-01", 100 "Status": "Active", 101 "ParentReference": "13YAAC0000006v32BA", 102 "EmployerAddress": "123 Market St, San Francisco, CA 94105", 103 "Amount": 36500.0, 104 "Type": "Salary", 105 "Frequency": "Monthly", 106 "EmployerName": "Acme Corporation" 107 } 108 ] 109 } 110 ] 111 } 112 ] 113 }, 114 "contextDefinitionApiName": "BenefitEnrollmentContext__stdctx" 115 } 116} - Properties
-
Name Type Description Required or Optional Available Version contextInfo Object Context information used to add details to the context. Optional 68.0 parameters Object Input parameters to the expression sets. 68.0 sourceRecordId String ID of the source record that invoked the API. Required 68.0
- Response body for POST
- Integrated Application Benefits
- Request parameters for POST
-
Parameter Name Type Description Required or Optional Available Version integratedApplicationBenefitsInputRepresentation Object 68.0