List of Entity Relationships
GET {{baseUrl}}/sf/contacts/{{contactId}}/entityRelationships
Returns a list of Entity Relationships for a contact.
API Scopes
The following API scopes can access this resouce
- smsf_partner
Response Body
| Key | Datatype | Comments/Constraints |
|---|---|---|
| entityRelationshipId | string | ID of EntityRelationship |
| entityContactParentId | string | ID of ContactParent. This is contactId where entityToType=”PersonProxy” or “OtherEntity” or “Company” or “Trust”. This is entityId where entityToType=”SMSF” or “BillableTrust” or “BillableCompany”. |
| entityContactParentType | string | From List [Trust, SMSF, PersonProxy, OtherEntity, Company, BillableTrust, BillableCompany] |
| entityContactPosition | string | Position ContactChild has with ContactParent |
| entityContactChildId | string | ID* of ContactChild. This is contactId where entityToType=”PersonProxy” or “OtherEntity” or “Company” or “Trust”. This is entityId where entityToType=”SMSF” or “BillableTrust” or “BillableCompany”. |
| entityContactChildType | string | From List [Trust, SMSF, PersonProxy, OtherEntity, Company, BillableTrust, BillableCompany] |
entityContactPosition List
| Key | Description |
|---|---|
| AccountManager | Account Manager |
| Appointer_Trustee | Appointer |
| Bare_Trust | Bare Trust |
| Beneficiary | Beneficiary |
| Director | Director |
| EX_ComOther | Other |
| EXComOtherAgent | Agent |
| EX_ComOther_Agents_Representative | Agent's Representative |
| EX_ComOther_Alternate | Alternate |
| EX_ComOther_Foreign_Agent | Foreign Agent |
| EX_ComOther_Foreign_Agents_Representative | Foreign Agent’s Representative |
| EX_ComOther_Liquidator | Liquidator |
| EX_ComOther_Members_Representative | Member' Representative |
| EX_ComOther_Natural_Person | Natural Person |
| EX_ComOther_Persons_Representative | Person's Representative |
| EX_ComOther_Public_Officer | Public Officer |
| EX_ComOther_Unitholders_Representative | Unitholder's Representative |
| EX_SMSF_Accountant | Accountant |
| EX_SMSF_Actuary | Actuary |
| EX_SMSF_Administrator | Administrator |
| EX_SMSF_Advisor | Adviser |
| EX_SMSF_Auditor | Auditor |
| EX_SMSF_Authorised_Representative | Authorised Representative |
| EX_SMSF_Bookkeeper | Bookkeeper |
| EX_SMSF_Custodian | Custodian |
| EX_SMSF_Employer_Sponsor | Employer Sponsor |
| EX_SMSF_Expert | SMSF Expert |
| EX_SMSF_External_Administrator | External Administrator |
| EX_SMSF_Firm_Contact | Firm Contact |
| EX_SMSF_Firm_Manager | Firm Manager |
| EX_SMSF_Fund_Contact | Fund Contact |
| EX_SMSF_Investment_Advisor | Investment Advisor |
| EX_SMSF_Lawyer | Lawyer |
| EX_SMSF_Personal_Representative | Personal Representative |
| EX_SMSF_Representative | Representative |
| EX_SMSF_Tax_Agent | Tax Agent |
| Former Member | if all of the person's member accounts for the fund have an end date and all the end dates before the fund’s current financial year start date |
| Financial_Planner | Financial Planner |
| Officer | Officer |
| Partner | Partner |
| Secretary | Secretary |
| Settlor | Settlor |
| Shareholder | Shareholder |
| Trustee | Trustee |
| Trustee | Trustee |
| UnitHolder | Unit Holder |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"contactId":"8ad08a2c74e222f30174e26862330023","entityRelationships":[{"entityContactChildId":"2c91808661d09ca00161e4dcf9d90008","entityContactChildType":"People","entityContactParentId":"8ad08a2c74e222f30174e26862330023","entityContactParentType":"Trust","entityContactPosition":"Trustee","entityRelationshipId":260436},{"entityContactChildId":"8ad08a8b74fb078a0174fb0bf5e30000","entityContactChildType":"People","entityContactParentId":"8ad08a2c74e222f30174e26862330023","entityContactParentType":"Trust","entityContactPosition":"Beneficiary","entityRelationshipId":277447}]}