Funds

Creates a new fund.

post/sites/{site-identifier}/funds

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/funds
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: default, fund_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

Request body

FundCodestring
FundNamestring required
FundExistingboolean required

Indicates whether this is a new fund establishment, or a takeover fund.

FundType'SMSF' | 'SAF' | 'PORTFOLIO' required
InvestmentType'Shared' | 'Segregated'

The investment type of the fund. Must be set to Shared.

CurrentPeriodEndDatestring date required

The end date of the first financial year to be administered on the system.

CorporateActionProcessModelstring

Corporate action processing model.

CorporateActionStartDatestring date
ABNstring
ABNBranchNumberstring
TFNstring
SFNstring
InitialDeedDatestring date
LastDeedDatestring date
StateRegistered'ACT' | 'NSW' | 'QLD' | 'SA' | 'WA' | 'VIC' | 'NT' | 'TAS'
AnnualDeedUpdateboolean
RegisteredForPAYGboolean
RegisteredForGSTboolean
RegisteredForGSTFromDatestring date
GSTRemittanceFrequency'Annually' | 'Monthly' | 'Quarterly' | 'Annually & Quarterly'
InvestorTaxType'Company' | 'Individual' | 'Joint' | 'Trust' | 'Super' | 'Partnership'

Portfolio only. The portfolio tax type.

CountryForTaxstring

Portfolio only. The registered country for tax purposes.

BrandGUIDstring guid
DefaultToAdviserBrandboolean
DomainGUIDstring guid
Statusstring

The fund status value. The value of fund status must meet with description in user type configuration for FUND-STATUS

CGTSellMethodstring
RegisteredForGSTToDatestring date
IASFrequency'Annually' | 'Monthly' | 'Quarterly'
TBARFrequency'Annually' | 'Not-Applicable' | 'Quarterly'
AdministrationStartDatestring date
AdministrationEndDatestring date
WoundUpDatestring date
LodgeActivityStatementsboolean
IncomeAccountEFTCodestring
IntegratedAccountEFTCodestring
ReconciledToDatestring date
ServiceCategorystring
CoContributionsAcceptedboolean
ResidentFundboolean
SISCompliantboolean
ComplyingStatusCode'REGISTERED' | 'COMPLYING' | 'NON-COMPLYING' | 'REGULATION-DETAILS-WITHHELD' | 'REGULATION-DETAILS-REMOVED' | 'PENDING'
OwnerUserGUIDstring guid
Sourcestring

Example request

{
  "DefaultToAdviserBrand": true,
  "Status": "Current Administration, Pending Administration or Wound Up.",
  "CGTSellMethod": "FIFO",
  "CoContributionsAccepted": true,
  "ResidentFund": true,
  "SISCompliant": true,
  "Contact": {
    "Title": "Miss",
    "GivenNames": "Emily",
    "Surname": "Taylor",
    "Salutation": "Dear",
    "EmailAddress1": "emilytaylor@gmail.com"
  },
  "Address": {
    "StreetAddress": {
      "StreetName": "Elizabeth",
      "StreetType": "STREET",
      "Suburb": "BRISBANE CITY",
      "State": "QLD",
      "Country": "Australia"
    },
    "PostalAddress": {
      "Line1": "LOCKED BAG 13101",
      "Suburb": "Archerfield",
      "State": "QLD",
      "Country": "Australia"
    }
  },
  "Trustees": {
    "CorporateTrustee": {
      "Contact": {
        "Title": "Miss",
        "GivenNames": "Emily",
        "Surname": "Taylor",
        "Salutation": "Dear",
        "EmailAddress1": "emilytaylor@gmail.com"
      },
      "Address": {
        "StreetAddress": {
          "StreetName": "Elizabeth",
          "StreetType": "STREET",
          "Suburb": "BRISBANE CITY",
          "State": "QLD",
          "Country": "Australia"
        },
        "PostalAddress": {
          "Line1": "LOCKED BAG 13101",
          "Suburb": "Archerfield",
          "State": "QLD",
          "Country": "Australia"
        }
      },
      "Directors": [
        {
          "Person": {
            "Address": {
              "StreetAddress": {
                "StreetName": "Elizabeth",
                "StreetType": "STREET",
                "Suburb": "BRISBANE CITY",
                "State": "QLD",
                "Country": "Australia"
              },
              "PostalAddress": {
                "Line1": "LOCKED BAG 13101",
                "Suburb": "Archerfield",
                "State": "QLD",
                "Country": "Australia"
              }
            },
            "Contact": {
              "Title": "Miss",
              "GivenNames": "Emily",
              "Surname": "Taylor",
              "Salutation": "Dear",
              "EmailAddress1": "emilytaylor@gmail.com"
            }
          }
        }
      ]
    },
    "IndividualTrustees": [
      {
        "Person": {
          "Address": {
            "StreetAddress": {
              "StreetName": "Elizabeth",
              "StreetType": "STREET",
              "Suburb": "BRISBANE CITY",
              "State": "QLD",
              "Country": "Australia"
            },
            "PostalAddress": {
              "Line1": "LOCKED BAG 13101",
              "Suburb": "Archerfield",
              "State": "QLD",
              "Country": "Australia"
            }
          },
          "Contact": {
            "Title": "Miss",
            "GivenNames": "Emily",
            "Surname": "Taylor",
            "Salutation": "Dear",
            "EmailAddress1": "emilytaylor@gmail.com"
          }
        }
      }
    ]
  },
  "Members": [
    {
      "Person": {
        "Address": {
          "StreetAddress": {
            "StreetName": "Elizabeth",
            "StreetType": "STREET",
            "Suburb": "BRISBANE CITY",
            "State": "QLD",
            "Country": "Australia"
          },
          "PostalAddress": {
            "Line1": "LOCKED BAG 13101",
            "Suburb": "Archerfield",
            "State": "QLD",
            "Country": "Australia"
          }
        },
        "Contact": {
          "Title": "Miss",
          "GivenNames": "Emily",
          "Surname": "Taylor",
          "Salutation": "Dear",
          "EmailAddress1": "emilytaylor@gmail.com"
        }
      },
      "DeathBenefitNomination": [
        {
          "Person": {
            "Address": {
              "StreetAddress": {
                "StreetName": "Elizabeth",
                "StreetType": "STREET",
                "Suburb": "BRISBANE CITY",
                "State": "QLD",
                "Country": "Australia"
              },
              "PostalAddress": {
                "Line1": "LOCKED BAG 13101",
                "Suburb": "Archerfield",
                "State": "QLD",
                "Country": "Australia"
              }
            }
          }
        }
      ]
    }
  ]
}

Response

Created

FundGUIDstring guid
FundCodestring
FundNamestring
FundTypestring
FundValuenumber
ABNstring
CurrentPeriodEndDatestring date
AuditStatus'NOT_READY' | 'READY_FOR_AUDIT' | 'AT_AUDIT' | 'WAITING' | 'INITIAL_AUDIT_COMPLETED' | 'COMPLETED' | 'COMPLETE_QUALIFIED' | 'COMPLETE_NOT_QUALIFIED'
FinancialYearinteger
CurrentFinancialYearinteger
Activeboolean
Statusstring
StatusCodestring
ActivateDateTimestring date-time
DeactivatedDateTimestring date-time
ServiceCategorystring
AdviserGUIDstring guid
ComplyingStatusCode'REGISTERED' | 'COMPLYING' | 'NON-COMPLYING' | 'REGULATION-DETAILS-WITHHELD' | 'REGULATION-DETAILS-REMOVED' | 'PENDING'
Div296ElectionMethod'ADJUST' | 'DO-NOT-ADJUST'

Example response

{
  "FundValue": 230076.43,
  "Status": "Current Administration",
  "StatusCode": "CURRENT",
  "Tags": [
    "Pension"
  ],
  "CustomTags": [
    "Foo"
  ],
  "ServiceCategory": "ANNUAL",
  "AdviserGUID": "9a6ce773-5011-308e-7914-73d18ced3493"
}

Changes

No recorded changes to this operation across all 1 revision of this API.