PayrollAu

Creates a superfund

post/Superfunds

Request

  • Base URL: https://api.xero.com/payroll.xro/1.0
  • URL: https://api.xero.com/payroll.xro/1.0/Superfunds
  • Auth: OAuth 2 (authorization code, authorization URL https://login.xero.com/identity/connect/authorize, token URL https://identity.xero.com/connect/token, scopes: payroll.settings)

Headers

Idempotency-Keystring

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request body

SuperFundIDstring uuid

Xero identifier for a super fund

Type'REGULATED' | 'SMSF' required
Namestring

Name of the super fund

ABNstring

ABN of the self managed super fund

BSBstring

BSB of the self managed super fund

AccountNumberstring

The account number for the self managed super fund.

AccountNamestring

The account name for the self managed super fund.

ElectronicServiceAddressstring

The electronic service address for the self managed super fund.

EmployerNumberstring

Some funds assign a unique number to each employer

SPINstring

The SPIN of the Regulated SuperFund. This field has been deprecated. It will only be present for legacy superfunds. New superfunds will not have a SPIN value. The USI field should be used instead of SPIN.

USIstring

The USI of the Regulated SuperFund

UpdatedDateUTCstring

Last modified timestamp

Example request

[
  {
    "SuperFundID": "bfac31bd-ea62-4fc8-a5e7-7965d9504b15",
    "Name": "MLC Navigator Retirement Plan - Superannuation Service (including Series 2) (MLC Superannuation Fund)",
    "AccountName": "Money account",
    "UpdatedDateUTC": "/Date(1583967733054+0000)/"
  }
]

Response

A successful request

Example response

{
  "SuperFunds": [
    {
      "SuperFundID": "bfac31bd-ea62-4fc8-a5e7-7965d9504b15",
      "Name": "MLC Navigator Retirement Plan - Superannuation Service (including Series 2) (MLC Superannuation Fund)",
      "AccountName": "Money account",
      "UpdatedDateUTC": "/Date(1583967733054+0000)/"
    }
  ]
}

Changes

No recorded changes to this operation across all 56 revisions of this API.