Saves the employee's super fund details.

Request

POST https://api.yourpayroll.com.au/api/v2/ess/{employeeId}/superfunds

Path parameters

Parameter name Value Description Additional
employeeId string Required

Request body

The request body takes a complete SuperFundEditModel resource, containing the following writable properties:

{
    "allocateBalance": "boolean",
    "allocatedPercentage": "double",
    "canBeDeleted": "boolean",
    "fixedAmount": "double",
    "id": "int32",
    "memberNumber": "string",
    "name": "string",
    "superProduct": {
        "abn": "string",
        "accountName": "string",
        "accountNumber": "string",
        "bsb": "string",
        "businessName": "string",
        "electronicServiceAddress": "string",
        "email": "string",
        "externalReferenceId": "string",
        "id": "int32",
        "productCode": "string",
        "productName": "string",
        "productType": "string",
        "source": "string"
    }
}

Properties

Name Type
allocateBalance boolean
allocatedPercentage double
canBeDeleted boolean
fixedAmount double
id int32
memberNumber string
name string
superProduct object
superProduct.abn string
superProduct.accountName string
superProduct.accountNumber string
superProduct.bsb string
superProduct.businessName string
superProduct.electronicServiceAddress string
superProduct.email string
superProduct.externalReferenceId string
superProduct.id int32
superProduct.productCode string
superProduct.productName string
superProduct.productType string
superProduct.source string

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK