Financial Goal Update

Update a financial goal and its members and funding.

Resource

1/connect/financialplanning/financialgoals/GOAL_ID

Available Version

59.0

Requires Chatter

HTTP Methods

PATCH

Request Body for PATCH

JSON Example

In this example, carType, role, and FSC9__FinancialAccount__c are custom fields.

1{
2  "financialGoal": {
3    "completionDate": "2024-06-01",
4    "description": "Cars for commuting",
5    "targetAmount": "$55000.00",
6    "targetDate": "2024-06-01",
7    "customFields": {
8      "carType": "New luxury car and used car"
9    }
10  },
11  "addFinancialGoalParties": [
12    {
13      "accountId": "001xx000003GYyJAAV",
14      "customFields": {
15        "role": "Auto purchaser daughter"
16      }
17    }
18  ],
19  "addFinancialGoalFundings": [
20    {
21      "amount": 2000,
22      "currencyIsoCode": "USD",
23      "customFields": {
24        "FSC9__FinancialAccount__c": "a0HSG0000000AfJ2AV"
25      }
26    }
27  ]
28}

Properties

Name	Type	Description	Required or Optional	Available Version
`addFinancialGoalFundings`	Financial Goal Funding Input[]	Financial Accounts to be added to the Financial Goal.	Optional	60.0
`addFinancialGoalParties`	Financial Goal Party Input[]	Goal members to be added to the Financial Goal.	Optional	59.0
`financialGoal`	Financial Goal Input	Financial Goal data.	Required for 59.0, Optional for 60.0	59.0
`removeFinancialGoalFundings`	Financial Goal Funding Input[]	Financial Accounts to be removed from the Financial Goal.	Optional	60.0
`removeFinancialGoalParties`	Financial Goal Party Input[]	Goal members to be removed from the Financial Goal.	Optional	59.0

Response Body for PATCH

Financial Goal Patch Output