Qodex.ai

Create Entity Relationships

POST {{baseUrl}}/sf/contacts/entityRelationships

Create an Entity Relationships for a contact.

API Scopes

The following API scopes can access this resouce

  • smsf_partner

Request Body

KeyDatatypeMandatoryComments/Constraints
entityContactParentIdstringYesID of ContactParent. This is contactId where entityToType=”PersonProxy” or “OtherEntity” or “Company” or “Trust”. This is entityId where entityToType=”SMSF” or “BillableTrust” or “BillableCompany”.
entityContactParentTypestringYesFrom List [Trust, SMSF, PersonProxy, OtherEntity, Company, BillableTrust, BillableCompany]
entityContactPositionstringYesPosition ContactChild has with ContactParent
entityContactChildIdstringYesID* of ContactChild. This is contactId where entityToType=”PersonProxy” or “OtherEntity” or “Company” or “Trust”. This is entityId where entityToType=”SMSF” or “BillableTrust” or “BillableCompany”.
entityContactChildTypestringYesFrom List [Trust, SMSF, PersonProxy, OtherEntity, Company, BillableTrust, BillableCompany]

entityContactPosition List

entityContactPositionDescriptionChild - Contact Type SupportedChild - Entity Type SupportedParent - Contact Type SupportedParent - Entity Type Supported
AccountManagerAccount ManagerPeople, Company, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
Appointer_TrusteeAppointerPeople, Company, Trust, OtherEntityTrustBillableTrust
Bare_TrustBare TrustPeople, Company, Trust, OtherEntitySMSF, BillableTrust, BillableCompany
BeneficiaryBeneficiaryPeople, Company, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrustTrustBillableTrust
DirectorDirectorPeople, Company, Trust, OtherEntityCompany, OtherEntitySMSF, BillableCompany
EX_ComOtherOtherPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_ComOther_AgentAgentPeople, Company, Trust, OtherEntityCompanyBillableCompany
EX_ComOther_Agents_RepresentativeAgent's RepresentativePeople, Company, Trust, OtherEntityCompanyBillableCompany
EX_ComOther_AlternateAlternatePeople, Company, Trust, OtherEntityCompanyBillableCompany
EX_ComOther_Foreign_AgentForeign AgentPeople, Company, Trust, OtherEntityCompanyBillableCompany
EX_ComOther_Foreign_Agents_RepresentativeForeign Agent’s RepresentativePeople, Company, Trust, OtherEntityCompanyBillableCompany
EX_ComOther_LiquidatorLiquidatorPeople, Company, Trust, OtherEntityCompanyBillableCompany
EX_ComOther_Members_RepresentativeMember' RepresentativePeople, Company, Trust, OtherEntityCompanyBillableCompany
EX_ComOther_Natural_PersonNatural PersonPeople, Company, Trust, OtherEntityCompanyBillableCompany
EX_ComOther_Persons_RepresentativePerson's RepresentativePeople, Company, Trust, OtherEntityCompanyBillableCompany
EX_ComOther_Public_OfficerPublic OfficerPeople, Company, Trust, OtherEntityCompanyBillableCompany
EX_ComOther_Unitholders_RepresentativeUnitholder's RepresentativePeople, Company, Trust, OtherEntityCompanyBillableCompany
EX_SMSF_AccountantAccountantPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_SMSF_ActuaryActuaryPeople, Company, Trust, OtherEntityOtherEntitySMSF
EX_SMSF_AdministratorAdministratorPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_SMSF_AdvisorAdviserPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_SMSF_AuditorAuditorPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_SMSF_Authorised_RepresentativeAuthorised RepresentativePeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_SMSF_BookkeeperBookkeeperPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_SMSF_CustodianCustodianPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_SMSF_Employer_SponsorEmployer SponsorPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_SMSF_ExpertSMSF ExpertPeople, Company, Trust, OtherEntityOtherEntitySMSF
EX_SMSF_External_AdministratorExternal AdministratorPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_SMSF_Firm_ContactFirm ContactPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableCompany, BillableTrust
EX_SMSF_Firm_ManagerFirm ManagerPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableCompany, BillableTrust
EX_SMSF_Fund_ContactFund ContactPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_SMSF_Investment_AdvisorInvestment AdvisorPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_SMSF_LawyerLawyerPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_SMSF_Personal_RepresentativePersonal RepresentativePeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_SMSF_RepresentativeRepresentativePeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
EX_SMSF_Tax_AgentTax AgentPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
Financial_PlannerFinancial PlannerPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
OfficerOfficerPeople, Company, Trust, OtherEntityCompanyBillableCompany
PartnerPartnerPeople, Company, Trust, OtherEntityCompany, Trust, OtherEntitySMSF, BillableIndividual, BillableCompany, BillableTrust
SecretarySecretaryPeople, Company, Trust, OtherEntityCompany, OtherEntitySMSF, BillableCompany
SettlorSettlorPeople, Company, Trust, OtherEntityTrustBillableTrust
ShareholderShareholderPeople, Company, Trust, OtherEntityCompanyBillableCompany
TrusteeTrusteePeople, CompanyBillableCompanyTrustBillableTrust
TrusteeTrusteePeople, Company, Trust, OtherEntityCompany, OtherEntitySMSF, BillableCompany
UnitHolderUnit HolderPeople, Company, Trust, OtherEntityTrustBillableTrust

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"entityRelationshipId":277447}