Nonprofit Cloud Developer Guide

Introduction to Nonprofit Cloud
Nonprofit Cloud Data Model
Fundraising
Program Management
Case Management
Outcome Management Standard Objects
Grantmaking
Volunteer Management Standard Objects
Volunteer Management Fields on Other Objects
Group Memberships and Households in Nonprofit Cloud
Group Membership and Households Standard Objects
Group Membership and Households Business APIs
REST Reference
Resources
Request Bodies
Address Input
Account Input
Account Relation Input
Group Definition Input
Group Input
Group Merge Input
Member Record Input
Relationships Input
Response Bodies
Record Rollup Definitions
NonProfit Cloud Associated Objects
PDF

Note: This release is in preview. Features described here don��t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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
custom​Fields Map<String, Object> Custom fields associated with the AccountRelationship object. Optional 58.0
endDate String Date when the account relationship ends. Optional 58.0
hierarchy​Type 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
related​AccountId String Record ID of the related account. If the account relationship type is direct, then the related account ID is required. Optional 58.0
related​Inverse​RecordId String Record ID of the related inverse relationship record. Optional 58.0
role​Relation​Id 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 related​Inverse​RecordId property is specified, then the relationship type is indirect. Optional 58.0