Xero: Updates a superfund

← Payroll au operations · Get started

Operation xero.payroll_au_updatesuperfund

Provider route: POST /payroll.xro/1.0/Superfunds/{SuperFundID}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/xero with npm, or alter-sdk-xero with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { XeroIntegration } from "@alter-ai/xero";

async function execute(input: Parameters<XeroIntegration["payrollAu"]["updateSuperfund"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new XeroIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.payrollAu.updateSuperfund(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_xero import XeroIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = XeroIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.payroll_au.update_superfund(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.SuperFundID	string	Required within parent	Format: uuid
headers	object	Required within parent	Additional keys: not allowed
headers.xero-tenant-id	string	Required within parent
headers.Idempotency-Key	string	Optional
body	array	Required within parent
body[]	Model	Each item	Expand Creates a superfund — request body — body item

Referenced models: Creates a superfund — request body — body item

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Creates a superfund — response body

Referenced models: Creates a superfund — response body

Schemas

Creates a superfund — response body

Field	Type	Presence	Description and constraints
$	object	Root
SuperFunds	array	Optional
SuperFunds[]	Model	Each item	Expand Creates a superfund — response body — Super Funds item

Referenced models: Creates a superfund — response body — Super Funds item

Creates a superfund — request body — body item

Field	Type	Presence	Description and constraints
$	object	Root
ABN	string	Optional	ABN of the self managed super fund
AccountName	string	Optional	The account name for the self managed super fund.
AccountNumber	string	Optional	The account number for the self managed super fund.
BSB	string	Optional	BSB of the self managed super fund
ElectronicServiceAddress	string	Optional	The electronic service address for the self managed super fund.
EmployerNumber	string	Optional	Some funds assign a unique number to each employer
Name	string	Optional	Name of the super fund
SPIN	string	Optional	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.
SuperFundID	string	Optional	Xero identifier for a super fund Format: uuid
Type	string	Required within parent	One of: REGULATED, SMSF
USI	string	Optional	The USI of the Regulated SuperFund
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Retrieves journals — response body — Warnings item

Creates a superfund — response body — Super Funds item

Field	Type	Presence	Description and constraints
$	object	Root
ABN	string	Optional	ABN of the self managed super fund
AccountName	string	Optional	The account name for the self managed super fund.
AccountNumber	string	Optional	The account number for the self managed super fund.
BSB	string	Optional	BSB of the self managed super fund
ElectronicServiceAddress	string	Optional	The electronic service address for the self managed super fund.
EmployerNumber	string	Optional	Some funds assign a unique number to each employer
Name	string	Optional	Name of the super fund
SPIN	string	Optional	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.
SuperFundID	string	Optional	Xero identifier for a super fund Format: uuid
Type	string	Required within parent	Known values: REGULATED, SMSF
USI	string	Optional	The USI of the Regulated SuperFund
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Retrieves journals — response body — Warnings item

Retrieves journals — response body — Warnings item

Field	Type	Presence	Description and constraints
$	object	Root
Message	string	Optional	Validation error message

Policy, approvals and errors

SDK function policy ID: xero.payroll_au_updatesuperfund. Catalog operation: payroll_au.updateSuperfund. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source