Financial Goals Query

Query financial goals, goal members, and goal funding using the parent Person Account, Household, or Party Relationship Group record.

Resource

1/connect/financialplanning/financialgoals/query/PARENT_RECORD_ID

Available Version

59.0

Requires Chatter

HTTP Methods

POST

Request Body for POST

JSON Example

1{
2  "financialGoalFields": [
3    "Name",
4    "Description",
5    "ActualAmount",
6    "CompletionDate"
7  ],
8  "financialGoalPartyFields": [
9    "AccountId",
10    "Account.Name"
11  ],
12  "filterCriteria": [
13    {
14      "fieldName": "FinancialGoal.Type",
15      "operator": "equals",
16      "value": "Retirement"
17    }
18  ],
19  "offset": 1,
20  "limit": 10,
21  "sortBy": "DESC",
22  "orderBy": "FinancialGoal.Name"
23}

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

Response Body for POST

Financial Goals List Output