Account Relation Input

Input representation of an account relationship.

JSON Example

1{
2      "relations":[
3         {
4            "type":"Direct",
5            "roleRelationId":"0zlxx000000001dAAA",
6            "relatedAccountId":"001xx000003GYodAAG",
7            "startDate":"2023-06-15T00:00:00.000Z",
8            "endDate":"2023-12-15T00:00:00.000Z",
9            "relatedInverseRecordId":"",
10            "isActive":true,
11            "customFields":{
12               "field1":"field1Value",
13               "field2":"field1Value"
14            }
15         },
16         {
17            "type":"Indirect",
18            "roleRelationId":"0zlxx000000001dGAC",
19            "accountId":"001xx000003GYodACD",
20            "startDate":"2023-02-15T00:00:00.000Z",
21            "endDate":"2023-09-15T00:00:00.000Z",
22            "isActive":true,
23            "customFields":{
24               "field1":"field1Value",
25               "field2":"field1Value"
26            }
27         }
28      ]
29   }

Properties

Name	Type	Description	Required or Optional	Available Version
`aarId`	String	Record ID of the AccountRelationship object.	Optional	58.0
`accountId`	String	Primary account involved in the relationship. If the account relationship type is direct, then Account ID is required.	Optional	58.0
`customFields`	Map<String, Object>	Custom fields associated with the AccountRelationship object.	Optional	58.0
`endDate`	String	Date when the account relationship ends.	Optional	58.0
`hierarchyType`	String	Hierarchy among the accounts that are related. For example, an account is related to another account as a parent, a peer, or a child.	Optional	58.0
`isActive`	Boolean	Indicates whether the account is actively involved with the related account (`true`) or not (`false`).	Optional	58.0
`relatedAccountId`	String	Record ID of the related account. If the account relationship type is direct, then the related account ID is required.	Optional	58.0
`relatedInverseRecordId`	String	Record ID of the related inverse relationship record.	Optional	58.0
`roleRelationId`	String	Record ID of the party role relationship.	Required	58.0
`startDate`	String	Date when the account relationship starts.	Optional	58.0
`type`	String	Type of account relationship, such as a direct or indirect relationship. The default value is `false`. If the `relatedInverseRecordId` property is specified, then the relationship type is indirect.	Optional	58.0