# atom_api.GoalPayload

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of the goal | 
**parentGoalId** | **String** | In the case that a goal is related to a broader goal, the ID of the broader goal | [optional] 
**questionnaireId** | **String** | The ID of the group of questions that are used to customize a goal for a client | [optional] 
**isDecumulation** | **Boolean** | Indicator if the goal is a decumulation goal such as saving for retirement. Default is false, indicating that the goal is an accumulation goal. May be used in conjunction with the Proton API | [optional] [default to false]
**type** | **String** | Type of goal used to identify similar goals. Can be used to differentiate between goal templates and client-specific goals | [optional] 
**category** | **String** | Category of the goal used to group goals together. For example, different large purchase goals could have a type of ‘Major Purchase’ | [optional] 
**clientId** | **String** | If the goal is client-specific (not used by any other client), the ID of the client to which it belongs | [optional] 
**goalAmount** | **Number** | If the goal is client-specific, the target monetary amount to be reached within the goal horizon. May be used in conjunction with the Proton API. If the goal is not client-specific, please store under the account entity | [optional] 
**accumulationHorizon** | **Number** | If the goal is client-specific, the time horizon of the goal during the accumulation phase, in years. May be used in conjunction with the Proton API. If the goal is not client-specific, please store under the account entity | [optional] 
**decumulationHorizon** | **Number** | If the goal is client-specific, the time horizon of the goal during the decumulation phase, in years. If the goal is an accumulation goal, then this can be 0 or omitted entirely. May be used in conjunction with the Proton API. If the goal is not client-specific, please store under the account entity | [optional] 
**isActive** | **Boolean** | Indicates if the goal is active. Defaults to true which indicates it is active | [optional] [default to true]
**metadata** | **Object** | Custom information associated with the goal in the format key:value | [optional] 
**secondaryId** | [**SecondaryId**](SecondaryId.md) |  | [optional]