Confirm Household API Using the Installed Aggregation Definitions
Create a Household API using the installed aggregation definitions.
Required Editions
| Available in: Lightning Experience |
| Available in: Professional, Enterprise, and Unlimited Editions |
| User Permissions Needed | |
|---|---|
| To configure Household API Setup: | Financial Services Cloud Extensions |
| To generate a Data Processing Engine definition for record aggregation: | Record Aggregation Access |
Household API Setup aggregates records using the installed API Retrieval Summary Definition that retrieves household details using four record aggregation definitions and fields for each object:
- Household Members
- Household Financial Accounts
- Household Assets
- Household Liabilities
- In Setup, in the quick find box, enter Household API Setup, then click Household API Setup.
- On HouseholdAPIForWealthManagement, click the Action menu and select Edit.
-
Confirm that the Account or Party Relationship Group object is
selected.
To use the installed API Retrieval Summary Definition that retrieves household details. select either the Account or the Party Relationship Group object. The data rolls up to this object. For example, select the Account object to roll up details related to the household, such as members, financial accounts, assets, and liabilities.
- Confirm that the object fields show in the API.
- Confirm the rollup definition. This is the data that rolls up to the object.
-
To use the four installed record aggregation definitions, select All assets and
liabilities of a household, All financial accounts of a
household, All financial holdings of a household, and
All members of a household.
The object is populated with the name of the object in the rollup definition.
- Confirm that the object fields show in the API.
- Save your changes.
Did this article solve your issue?
Let us know so we can improve!
