Set Up API Record Aggregation Using Household API for Wealth Management Unmanaged Package
Assign the Record Aggregation Access permission to users. Install and deploy the Household API for Wealth Management Unmanaged Package.
Required Editions
| Available in: Lightning Experience |
| Available in: Professional, Enterprise, and Unlimited Editions |
The Household API for Wealth Management Unmanaged Package installs the household API Retrieval Summary Definition that retrieves details about a household. These aggregation definitions retrieve all members where the household is their primary household, including their financial accounts, assets, financial holdings, and liabilities associated with the household. The aggregation definitions reference the standard and custom fields on these objects: Account, AccountContactRelation, FinServ_FinancialAccount__c, FinServ_AssetsAndLiabilities__c objects, and FinServ__FinancialHolding__c.
In Household API Setup, HouseholdAPIForWealthManagement API configures the financial details and members of a household. Four Rollup Definitions are available to configure:
- Financial holdings for members of a household
- Financial accounts for members of a household
- Assets and liabilities for members of a household
- Members of a household
- Assign Household API Permissions
Confirm that Record Aggregation Access permission is assigned to users. - Install and Deploy the Household API for Wealth Management Unmanaged Package
Install the Household API for Wealth Management unmanaged package to access the Household API Retrieval Summary Definition that retrieves details about a household. - Generate the Data Processing Engine Definition for Record Aggregation Using Household API for Wealth Management Unmanaged Package
Make a REST API request to generate the Data Processing Engine definition that aggregates the records. - Add the Installed Record Rollup Definitions to the Data Processing Engine
Add the installed record rollup definitions to a schedule-triggered flow. The Data Processing Engine uses with active record rollup definitions to get the aggregated records. To ensure that any recent updates are accounted for, add the installed record rollup definitions to the schedule-triggered flows and run the active record rollup definitions periodically. - Confirm Household API Using the Installed Aggregation Definitions
Create a Household API using the installed aggregation definitions. - Retrieve Aggregated Results for HouseholdAPIForWealthManagement Retrieval Summary Definition
Make a GET REST API request to retrieve aggregate records.
