Query financial goals, goal members, and goal funding using the parent Person Account,
Household, or Party Relationship Group record.
Resource
/connect/financialplanning/financialgoals/query/parentRecordId
Available Version
59.0
Requires Chatter
No
HTTP Methods
POST
Request Body for POST
JSON Example
{
"financialGoalFields": [
"Name",
"Description",
"ActualAmount",
"CompletionDate"
],
"financialGoalPartyFields": [
"AccountId",
"Account.Name"
],
"filterCriteria": [
{
"fieldName": "FinancialGoal.Type",
"operator": "equals",
"value": "Retirement"
}
],
"offset": 1,
"limit": 10,
"sortBy": "DESC",
"orderBy": "FinancialGoal.Name"
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| filterCriteria | Filter Criteria[] | Filter criteria for the results. | Optional | 59.0 |
| financialGoalFields | String[] | List of developer names of the fields from the FinancialGoal object to be retrieved. | Required for 59.0, Optional for 60.0 | 59.0 |
| financialGoalFundingFields | String[] | List of field developer names from the FinancialAccount object to be retrieved. | Optional | 60.0 |
| financialGoalPartyFields | String[] | List of field developer names from the FinancialGoalParty object to be retrieved. | Optional | 59.0 |
| limit | Integer | Maximum number of financial goals returned in each response. | Optional | 59.0 |
| offset | Integer | Offset for paging through returned financial goals. | Optional | 59.0 |
| orderBy | String | Fully qualified developer name of the field used to sort the results. | Optional | 59.0 |
| sortBy | String | Sort the results by Asc or Desc order. | Optional | 59.0 |