List of Contacts (Firm)
GET {{baseUrl}}/sf/contacts?offset={{offset}}&limit={{limit}}
Returns the list of all contacts for a firm
API Scopes
The following API scopes can access this resouce
- smsf_partner
Query Parameters
| Form Parameter | type | Mandatory | Description |
|---|
| offset | number | Required | Example = 0 |
| limit | number | Required | Example = 500 |
Response Body
| Key | Datatype | Comments/Constraints |
|---|
| abn | string | |
| acn | number | Only returned if contactType='Company' |
| address | object | Address object will be received with the address details |
| birthCountry | string | Only returned if contactType is ‘People’. ISO 3166 country code/name https://en.wikipedia.org/wiki/ISO_3166 |
| birthPlace | string | Only returned if contactType is ‘People’. One of ‘ACT’/‘NSW’/‘VIC’/‘QLD’/‘SA’/‘WA’/‘TAS’/‘NT’/‘Foreign’ |
| birthday | date | format yyyy/MM/dd. Only allowed if contactType is ‘People’ |
| contactId | string | Contact Identifier |
| contactType | string | one of ‘People’/‘Company’/OtherEntity’/’Trust’ |
| dateOfDeath | date | |
| din | string | Director ID |
| email | string | |
| entityRelationships | array | See below |
| establishmentDate | date | - format is yyyy/MM/dd. Only returned if the contactType is ‘Trust’ |
| firstName | string | Returned if the contactType is ‘People’ |
| lastName | string | Returned if the contactType is ‘People’ |
| memberAccountNumber | string | |
| mobile | string | |
| name | string | Returned if the contactType is ‘Company’/‘Other Entity’/'Trust' |
| otherName | string | Returned where contactType is ‘People’ |
| professionalBody | string | |
| professionalBodyNumber | string | |
| sex | string | List from ‘Male’/‘Female’ |
| smsfAuditorNumber | string | |
| solePurposeSMSFCorpTrustee | boolean | Only returned if contactType='Company'. |
| spin | string | Returned if the contactType is ‘Other Entity’ |
| telephone | string | |
| tfn | string | will return 'Provided' or 'Not Provided' |
| title | string | |
| usi | string | |
Address Array
| Key | Type | Mandatory | Constraints/Comments |
|---|
| streetLine1 | String | Yes | Mandatory if any other address fields are not empty |
| streetLine2 | String | No | |
| city | String | Yes | Mandatory if any other address fields are not empty |
| state | String | Yes | Mandatory if any other address fields are not empty. Must be one of (ACT’/‘NSW’/‘VIC’/‘QLD’/‘SA’/‘WA’/‘TAS’/‘NT) |
| postCode | String | Yes | Mandatory if any other address fields are not empty |
| country | String | Yes | Mandatory 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 |
## EntityRelationships object
| 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 |
Request Params
| Key | Datatype | Required | Description |
|---|
offset | string | | Example = 0 |
limit | string | | Example = 500. Maximum amount between offset and limit must be 500 |
| Key | Datatype | Required | Description |
|---|
Authorization | string | | |
RESPONSES
status: OK
{"contacts":[{"abn":"99159300464","acn":null,"address":{"addressId":2260063,"city":"Brighton East","country":"AU","postCode":"3178","state":"VICTORIA","streetLine1":"Suite 2, 606 Hawthorn Rd","streetLine2":null},"birthCountry":"AU","birthPlace":null,"birthState":null,"birthday":"1947-08-02","contactId":"2c918082685ea3b801686d82e99b0107","contactType":"People","dateOfDeath":null,"email":"test@test.com.au","entityRelationships":[{"entityContactChildId":"2c918082685ea3b801686d82e99b0107","entityContactChildType":"People","entityContactParentId":"8ad08a29686d750701686d8182ef0002","entityContactParentType":"SMSF","entityContactPosition":"Trustee","entityRelationshipId":161826},{"entityContactChildId":"2c918082685ea3b801686d82e99b0107","entityContactChildType":"People","entityContactParentId":"8ad08a29686d750701686d8182ef0002","entityContactParentType":"SMSF","entityContactPosition":"Member","entityRelationshipId":161828},{"entityContactChildId":"2c918082685ea3b801686d82e99b0107","entityContactChildType":"People","entityContactParentId":"8ad08ad568742d950168744aa0380022","entityContactParentType":"SMSF","entityContactPosition":"Member","entityRelationshipId":169054}],"establishmentDate":null,"firstName":"John","lastName":"Jones","memberAccountNumber":null,"mobile":"61426277777","name":null,"otherName":null,"preferredName":null,"professionalBody":null,"professionalBodyNumber":null,"sex":"MALE","smsfAuditorNumber":null,"solePurposeSMSFCorpTrustee":null,"spin":null,"telephone":"1300111111","tfn":"Not Provided","title":"Mr","usi":null},{"abn":null,"acn":null,"address":{"addressId":2103348,"city":"Brighton East","country":"AU","postCode":"5475","state":"VICTORIA","streetLine1":"Suite 2, 606-608 Hawthorn Rd","streetLine2":""},"birthCountry":"AU","birthPlace":null,"birthState":null,"birthday":"1947-08-02","contactId":"2c918082685ea3b801686d82e9bb0109","contactType":"People","dateOfDeath":null,"email":"sandy4812@hand.com","entityRelationships":[{"entityContactChildId":"2c918082685ea3b801686d82e9bb0109","entityContactChildType":"People","entityContactParentId":"8ad08a29686d750701686d8182ef0002","entityContactParentType":"SMSF","entityContactPosition":"Member","entityRelationshipId":161827}],"establishmentDate":null,"firstName":"Mary","lastName":"Jones","memberAccountNumber":null,"mobile":null,"name":null,"otherName":null,"preferredName":null,"professionalBody":null,"professionalBodyNumber":null,"sex":"FEMALE","smsfAuditorNumber":null,"solePurposeSMSFCorpTrustee":null,"spin":null,"telephone":"01-76970987","tfn":"Provided","title":null,"usi":null}],"limit":2,"offset":0,"total":83}