Financial Goal Update

Update a financial goal and its members and funding.
Resource
/connect/financialplanning/financialgoals/goalId
Available version
59.0
Requires Chatter
No
HTTP methods
PATCH
Request body for PATCH
JSON example

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

{
  "financialGoal": {
    "completionDate": "2024-06-01",
    "description": "Cars for commuting",
    "targetAmount": "$55000.00",
    "targetDate": "2024-06-01",
    "customFields": {
      "carType": "New luxury car and used car"
    }
  },
  "addFinancialGoalParties": [
    {
      "accountId": "001xx000003GYyJAAV",
      "customFields": {
        "role": "Auto purchaser daughter"
      }
    }
  ],
  "addFinancialGoalFundings": [
    {
      "amount": 2000,
      "currencyIsoCode": "USD",
      "customFields": {
        "FSC9__FinancialAccount__c": "a0HSG0000000AfJ2AV"
      }
    }
  ]
}
Properties
Name Type Description Required or Optional Available Version
addFinancial​GoalFundings Financial Goal Funding Input[] Financial Accounts to be added to the Financial Goal. Optional 60.0
addFinancial​GoalParties 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
removeFinancial​GoalFundings Financial Goal Funding Input[] Financial Accounts to be removed from the Financial Goal. Optional 60.0
removeFinancial​GoalParties Financial Goal Party Input[] Goal members to be removed from the Financial Goal. Optional 59.0
Response body for PATCH
Financial Goal Patch Output