---
schema_version: "1"
id: 65230fc781de1e7718b4ba669edf0f35d58aa5770853f830e01256200567ed73
title: Financial Goal Input
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/financial_services_cloud_object_reference/connect_requests_financial_goal_input.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/connect_requests_financial_goal_input.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 908a74bbba351676f9b6d30d79c258ee4b40b362ece50300c4eca7122962b178
description: Input for creating or updating a financial goal.
---
# Financial Goal Input

Input for creating or updating a financial goal.

## JSON Example

In this example, carType is a custom field.

{
  "actualAmount": "$1000.00",
  "completionDate": "2024-05-01",
  "initialAmount": "$500.00",
  "description": "Car for commuting",
  "priority": "P1",
  "startDate": "2023-05-01",
  "status": "InProgress",
  "targetAmount": "$50000.00",
  "targetDate": "2024-05-01",
  "name": "Goal1",
  "type": "Auto",
  "customFields": {
    "carType": "New luxury car"
  }
}

## Properties

<table class="featureTable sort_table" summary="">





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d106607e56">Name</th>

              <th class="featureTableHeader vertical-align-top " id="d106607e59">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d106607e62">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d106607e65">Required or Optional</th>

              <th class="featureTableHeader vertical-align-top " id="d106607e68">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">actualAmount</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">The amount currently in the account associated with this goal.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Required for create, optional for update</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">category</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">The category of the goal.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">completionDate</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">The date at which this goal reaches the <samp class="codeph nolang">targetAmount</samp>.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Required for create, optional for update</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">currencyIsoCode</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description"> Currency ISO code for the currency fields.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">customFields</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">Map&lt;String, Object&gt;</td>

              <td class="entry" headers="d106607e62" data-title="Description">Any custom fields added for a particular banking institution.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">description</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">A description of this goal.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Required for create, optional for update</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">estimatedSuccessPercent</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">The success percentage estimated for the financial goal.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">financialPlanId</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">The ID of the associated financial plan.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">frequency</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">The frequency at which the money is withdrawn. Values are:<ul class="ul bulletList">
                  <li class="li">Monthly</li>

                  <li class="li">Weekly</li>

                  <li class="li">Annually</li>

                </ul>
              </td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">initialAmount</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">The starting amount in the account associated with this goal.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Required for create, not editable for update</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">name</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">A name for the goal.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Required for create, optional for update</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">priority</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">The priority of this goal.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Required for create, optional for update</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">startDate</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">The creation date of this goal.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Required for create, not editable for update</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">status</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">The status of this goal's progress.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Required for create, optional for update</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">targetAmount</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">The amount this goal is intended to raise.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Required for create, optional for update</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">targetDate</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">The date at which this goal is intended to reach the <samp class="codeph nolang">targetAmount</samp>.</td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Required for create, optional for update</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d106607e56" data-title="Name"><samp class="codeph nolang">type</samp></td>

              <td class="entry" headers="d106607e59" data-title="Type">String</td>

              <td class="entry" headers="d106607e62" data-title="Description">The goal type, for example <samp class="codeph nolang">Auto</samp> or
                <samp class="codeph nolang">Retirement</samp>.
              </td>

              <td class="entry" headers="d106607e65" data-title="Required or Optional">Required for create, optional for update</td>

              <td class="entry" headers="d106607e68" data-title="Available Version">59.0</td>

            </tr>

          </tbody>

        </table>