Newer Version Available

This content describes an older version of this product. View Latest

Financial Goal Create Input

Input for creating a single financial goal with goal members and funding.
JSON example

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

1{
2  "financialGoal": {
3    "actualAmount": "$1000.00",
4    "completionDate": "2024-05-01",
5    "initialAmount": "$500.00",
6    "description": "Car for commuting",
7    "priority": "P1",
8    "startDate": "2023-05-01",
9    "status": "InProgress",
10    "targetAmount": "$50000.00",
11    "targetDate": "2024-05-01",
12    "name": "Goal1",
13    "type": "Auto",
14    "customFields": {
15      "carType": "New luxury car"
16    }
17  },
18  "financialGoalParties": [
19    {
20      "accountId": "001xx000003GYyJAAW",
21      "customFields": {
22        "role": "Auto purchaser"
23      }
24    },
25    {
26      "accountId": "001xx000005dJCxYAM",
27      "customFields": {
28        "role": "Auto purchaser partner"
29      }
30    }
31  ],
32  "financialGoalFundings": [
33    {
34      "amount": 1000,
35      "currencyIsoCode": "USD",
36      "customFields": {
37        "FSC9__FinancialAccount__c": "a0HSG0000000AfJ2AU"
38      }
39    },
40    {
41      "amount": 2000,
42      "currencyIsoCode": "USD",
43      "customFields": {
44        "FSC9__FinancialAccount__c": "a0HSG0000000AfJ2AV"
45      }
46    }
47  ]
48}
Properties
Name Type Description Required or Optional Available Version
financialGoal Financial Goal Input Financial Goal data. At least one required 59.0
financial​GoalFundings Financial Goal Funding Input[] Financial Accounts that fund the Financial Goal. Optional 60.0
financial​GoalParties Financial Goal Party Input[] Goal members to be included in the Financial Goal. At least one per goal required 59.0