Update Fund Details
POST {{baseUrl}}/sf/funds/:fundId
Using a FundId an API Consumer can add or update Fund Details.
API Scopes
The following API scopes can access this resouce
- smsf_partner
Request
| Key | Type | Mandatory | Description/Constraints |
|---|---|---|---|
| badgeId | Number | No | Must be a valid badge id for the firm |
| name | String | No | The Name of the SMSF |
| fundCode | String | No | If not supplied the field will be auto-created by Simple Fund 360 |
| abn | number | No | If supplied, the number must be valid ABN |
| tfn | number | No | If supplied must be valid TFN |
| esa | String | No | Electronic Service Address |
| dateFormed | date | No | Must in format yyyy-MM-dd |
| windUpDate | date | No | Must in format yyyy-MM-dd |
| financialYearFrom | date | No | If not supplied, system will default to dateFormed. Cannot be before dateFormed. Must in format yyyy-MM-dd |
| financialYearEnd | date | No | If not supplied, system will default to next 30 June date after dateFormed. Cannot be before dateFormed. Must in format yyyy-MM-dd |
| systemStartDate | date | No | Must be present if enteringOpeningBalance = Yes. Cannot be before dateFormed. Must in format yyyy-MM-dd |
| enteringOpeningBalance | Boolean | No | True or False |
| gstregistered | Boolean | No | True or False |
| taxEffectAccount | Boolean | No | True or False |
| postalAddress | Array | No | see Address Array below |
| physicalAddress | Array | No | see Address Array below |
| trustDeedSource | String | No | |
| trustDeedLastModifiedDate | date | No | Must in format yyyy-MM-dd |
| trustDeedRuleClauseDeathBenefit | String | No |
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/ISO3166-1alpha-2 |
Request Body
{"name"=>"{{name}}", "fundCode"=>"{{fundCode}}", "abn"=>"{{abn}}", "tfn"=>"{{tfn}}", "esa"=>"{{esa}}", "dateFormed"=>"{{dateFormed}}", "windUpDate"=>"{{windUpDate}}", "financialYearFrom"=>"{{financialYearFrom}}", "financialYearEnd"=>"{{financialYearEnd}}", "systemStartDate"=>"{{systemStartDate}}", "enteringOpeningBalance"=>"False", "gstregistered"=>"false", "taxEffectAccount"=>"false", "postalAddress"=>{"streetLine1"=>"{{streetLine1}}", "streetLine2"=>"{{streetLine2}}", "city"=>"{{city}}", "state"=>"{{state}}", "country"=>"{{country}}", "postCode"=>"{{postCode}}"}, "physicalAddress"=>{"streetLine1"=>"{{streetLine1}}", "streetLine2"=>"{{streetLine2}}", "city"=>"{{city}}", "state"=>"{{state}}", "country"=>"{{country}}", "postCode"=>"{{postCode}}"}, "trustDeedSource"=>"{{trustDeedSource}}", "trustDeedLastModifiedDate"=>"{{trustDeedLastModifiedDate}}", "trustDeedRuleClauseDeathBenefit"=>"{{trustDeedRuleClauseDeathBenefit}}"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | ||
Content-Type | string |
RESPONSES
status: Created
{"id":"8a348bec68712b24016874142344444","name":"The Sample Super Fund ","fundCode":"SAM001","abn":null,"tfn":null,"esa":null,"dateFormed":"2018-12-18","windUpDate":null,"financialYearFrom":"2018-12-18","financialYearEnd":"2019-06-30","systemStartDate":null,"enteringOpeningBalance":"No","gstregistered":false,"taxEffectAccount":false,"postalAddress":{"streetLine1":"606 Hawthorn Rd","streetLine2":"","city":"Brighton East","state":"VICTORIA","country":"AU","postCode":"3187"},"physicalAddress":{"streetLine1":"606 Hawthorn Rd","streetLine2":"","city":"Brighton East","state":"VICTORIA","country":"AU","postCode":"3187"},"trustDeedSource":null,"trustDeedLastModifiedDate":null,"trustDeedRuleClauseDeathBenefit":null,"createTime":"2015-07-23T23:32:16Z"}