SuperFunds


Overview

URL https://api.xero.com/payroll.xro/1.0/SuperFunds
Methods Supported POST, GET
Description Allows you to retrieve, add and update Payroll Super Funds in a Xero organisation

Elements for adding a regulated Super Fund

Type REGULATED see Super Fund Types
ABN The ABN of the Regulated SuperFund
USI The USI of the Regulated SuperFund

Elements for adding a self managed Super Fund

Type SMSF see Super Fund Types
Name Name of the super fund (max length = 76) e.g Clive Monk Superannuation Fund
ABN ABN of the self managed super fund. (max length = 11) e.g 839182848805
BSB BSB of the self managed super fund. (max length = 6) e.g 123123
AccountNumber The account number for the self managed super fund. (max length = 9) e.g 234324324
AccountName The account name for the self managed super fund (max length = 32) e.g Clive Monk Superannuation Fund

Other elements for SuperFund

SuperFundID Xero identifier e.g c56b19ef-75bf-45e8-98a4-e699a96609f7
EmployeeNumber Some funds assign a unique number to each employer (max length = 20)
SPIN (deprecated) 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

POST SuperFunds

Use this method to create or update one or more Super Funds in payroll

Create example

<SuperFunds>
  <SuperFund>  
    <ABN>40022701955</ABN>  
    <USI>40022701955001</USI>
    <Type>REGULATED</Type>  
  </SuperFund>
  <SuperFund>  
    <ABN>11001032511</ABN>  
    <AccountName>Test</AccountName>  
    <AccountNumber>111222333</AccountNumber>  
    <BSB>159357</BSB>  
    <EmployerNumber>999555666</EmployerNumber>  
    <Name>Clive Monk Superannuation Fund</Name>  
    <Type>SMSF</Type>  
  </SuperFund> 
</SuperFunds>

Update Example

 <SuperFunds>  
  <SuperFund>
    <SuperFundID>b1eabc65-251c-4dd1-9d20-63e5ba263f8f</SuperFundID>
    <Type>REGULATED</Type>
    <EmployerNumber>999555666</EmployerNumber>
  </SuperFund>   
  <SuperFund>  
    <ABN>11001032511</ABN>  
    <AccountName>Test</AccountName>  
    <AccountNumber>111222333</AccountNumber>  
    <BSB>159357</BSB>  
    <EmployerNumber>999555666</EmployerNumber>  
    <Name>Clive Monk Superannuation Fund</Name>  
    <SuperFundID>9cb36648-0ff3-4df6-8ec2-858d2fe19f6d</SuperFundID>  
    <Type>SMSF</Type>  
  </SuperFund>  
</SuperFunds>  

GET SuperFunds

Example response for GET SuperFunds

 <SuperFunds>    
  <SuperFund>
    <SuperFundID>b1eabc65-251c-4dd1-9d20-63e5ba263f8f</SuperFundID>
    <Name>MLC Navigator Retirement Plan - Superannuation Service (including Series 2) (MLC Superannuation Fund)</Name>
    <Type>REGULATED</Type>
    <ABN>40022701955</ABN>
    <USI>40022701955001</USI>
    <UpdatedDateUTC>2014-11-10T23:18:46</UpdatedDateUTC>
  </SuperFund> 
  <SuperFund>  
    <SuperFundID>48d9d081-dc79-4729-8643-8482c3b28ce0</SuperFundID>  
    <Name>what what is</Name>  
    <Type>SMSF</Type>  
    <ABN>32319338078</ABN>  
    <EmployerNumber>324324</EmployerNumber>  
    <BSB>234324</BSB>  
    <AccountNumber>234234234</AccountNumber>  
    <AccountName>33333333</AccountName>  
    <UpdatedDateUTC>2013-03-21T05:40:02</UpdatedDateUTC>  
  </SuperFund>  
</SuperFunds>  

Optional parameters for GET SuperFunds

Record filter You can specify an individual record by appending the value to the endpoint, i.e.
GET https://…/SuperFunds/{identifier}
SuperFundID – The Xero identifier for a super fund e.g. 297c2dc5-cc47-4afd-0000-74990b8761e9
You can get all super funds by not appending super fund Id. e.g. GET https://…/superFunds
Modified After The ModifiedAfter filter is actually an HTTP header: ‘If-Modified-Since‘.
A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only superfunds created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
page By default the number of records returned per call is 100. You can add GET https://…/Superfunds?page=2 to get the next set of records.
Where Filter by an any element (see Filters)
order Order by any element returned (see Order By)

Example response for GET SuperFund/{identifier}

<SuperFunds>  
  <SuperFund>  
    <ABN>11001032511</ABN>  
    <AccountName>Test</AccountName>  
    <AccountNumber>111222333</AccountNumber>  
    <BSB>159357</BSB>  
    <EmployerNumber>999555666</EmployerNumber>  
    <Name>Clive Monk Superannuation Fund</Name>  
    <SuperFundID>9cb36648-0ff3-4df6-8ec2-858d2fe19f6d</SuperFundID>  
    <Type>SMSF</Type>  
  </SuperFund>  
</SuperFunds>