Qodex.ai

Create Contacts

POST {{baseUrl}}/sf/funds/contacts

API Scopes

The following API scopes can access this resouce - smsf_partner

Request Body

KeyTypeMandatoryConstraints/Comments
contactTypeStringYesMust be one of ‘People’/‘Company’/OtherEntity’/’Trust’
dinstringNoDirector ID
titleStringNoOnly allowed if contactType is ‘People’. must be one of (Mr, Ms, Mrs, Mstr, Dr, Miss)
firstNameStringYes*Only mandatory if the contactType is ‘People’
lastNameStringYes*Only mandatory if the contactType is ‘People’
otherNameStringNoOnly allowed if contactType is ‘People’
preferredNameStringNoOnly allowed if contactType is ‘People’.
nameStringYes*Only mandatory if the contactType is ‘Company’/‘Other Entity’/'Trust'. Only allowed if the contactType is ‘Company’/‘Other Entity’/'Trust'
sexStringNoOnly allowed if contactType is ‘People’. Must be one of ‘Male’/‘Female’
birthdaydateYes*Only allowed if contactType is ‘People’. Must be informat yyyy-MM-dd. Must be added if person is Member or Trustee (
birthPlaceStringNoOnly allowed if contactType is ‘People’
birthStateStringNoOnly allowed if contactType is ‘People’.. Must be one of (‘ACT’/‘NSW’/‘VIC’/‘QLD’/‘SA’/‘WA’/‘TAS’/‘NT’/‘Foreign’)
birthCountryStringNoOnly allowed if contactType is ‘People’. Must be ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166
dateOfDeathdateNoOnly allowed if contactType is ‘People’. Must in format yyyy-MM-dd
tfnNumberNoNo
abnNumberNoAllowed for all ContactTypes
acnNumberYesOnly mandatory if contactType is ‘Company'. Only allowed if contactType is ‘Company'.
emailStringNoNo
telephoneStringNoOnly allowed if contactType is ‘People’/'Company'.
mobileStringNoOnly allowed if contactType is ‘People’.
smsfAuditorNumberNumberNoOnly allowed if contactType is ‘People’
professionalBodyStringNoOnly allowed if contactType is ‘People’
professionalBodyNumberStringNoOnly allowed if contactType is ‘People’
usiStringNoOnly allowed if the contactType is ‘Other Entity’
memberAccountNumberStringNoOnly allowed if the contactType is ‘Other Entity’. Used for RBS forms when transfeering from SMSF to another fund.
spinStringNoOnly allowed if the contactType is ‘Other Entity’
establishmentDateDateNomust be format yyyy/MM/dd. Only allowed if the contactType is ‘Trust’
addressObjectNo(see Address Array below)
representativeIdsArrayYesSee RepresentativeIds Array Below. Only allowed if the contactType is 'People'/‘Other Entity’/'Trust'
fundIdStringYesRequired to attach entityRelationships
entityRelationshipsArrayNoArray of strings. See List Below

Address Object

KeyTypeMandatoryConstraints/Comments
streetLine1StringYesMandatory if any other address fields are not empty
streetLine2StringNo
cityStringYesMandatory if any other address fields are not empty
stateStringYesMandatory if any other address fields are not empty. Must be one of (ACT’/‘NSW’/‘VIC’/‘QLD’/‘SA’/‘WA’/‘TAS’/‘NT)
postCodeStringYesMandatory if any other address fields are not empty
countryStringYesMandatory if any other address fields are not empty. Must be a country code as defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

RepresentativeIds Array

KeyTypeMandatoryConstraints/Comments
contactIdStringYes if representativeType is not empty
representativeTypeStringYes if contactId is not empty

entityRelationships List

  • Actuary
  • Accountant
  • Account Manager
  • Administrator
  • Adviser
  • Auditor
  • Authorised Representative
  • Bookkeeper
  • Custodian
  • Director
  • External Administrator
  • Financial Planner
  • SMSF Expert
  • Firm Manager
  • Fund Contact
  • Investment Adviser
  • Lawyer
  • Partner
  • Personal Representative
  • Representative
  • Secretary
  • Tax Agent
  • Trustee
  • Other

Request Body

{"contactType"=>"{{contactType}}", "fundId"=>"{{fundId}}", "firstName"=>"{{firstName}}", "lastName"=>"{{lastName}}", "address"=>{"streetLine1"=>"{{streetLine1}}", "suburb"=>"{{suburb}}", "state"=>"{{state}}", "postCode"=>"{{postCode}}", "country"=>"{{country}}"}, "title"=>"{{title}}", "sex"=>"{{sex}}", "email"=>"{{email}}", "mobile"=>"{{mobile}}", "phone1"=>"{{phone1}}", "birthday"=>"{{birthday}}", "birthPlace"=>"{{birthPlace}}", "birthState"=>"{{birthState}}", "birthCountry"=>"birthCountry", "entityRelationships"=>["{{entityRelationships}}"]}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring

RESPONSES

status: Created

{"abn":null,"acn":null,"address":{"addressId":2154828,"city":null,"country":"AU","postCode":"3000","state":"VIC","streetLine1":"78 Test Road","streetLine2":null},"birthCountry":"AU","birthPlace":"Macdeon","birthState":"VIC","birthday":"1977-12-25","contactId":"8ad08a3e6c829e03016c82ff6728000c","dateOfDeath":null,"email":"johndoe@mail.com","entityRelationships":["Trustee"],"establishmentDate":null,"firstName":"John","lastName":"Doe","memberAccountNumber":null,"mobile":"61417000999","name":null,"otherName":null,"phone":"98581111","preferredName":null,"professionalBody":null,"professionalBodyNumber":null,"representativeIds":[],"sex":"Male","smsfAuditorNumber":null,"spin":null,"tfn":null,"title":"Mr","usi":null}