Xero: Retrieves payroll settings

← Payroll au operations · Get started

Operation xero.payroll_au_getsettings

Provider route: GET /payroll.xro/1.0/Settings. 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"]["getSettings"]>[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.getSettings(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.get_settings(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
headers	object	Required within parent	Additional keys: not allowed
headers.xero-tenant-id	string	Required within parent

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 Retrieves payroll settings — response body

Referenced models: Retrieves payroll settings — response body

Schemas

Retrieves payroll settings — response body

Field	Type	Presence	Description and constraints
$	object	Root
Settings	Model	Optional	Expand Retrieves payroll settings — response body — Settings

Referenced models: Retrieves payroll settings — response body — Settings

Retrieves payroll settings — response body — Settings

Field	Type	Presence	Description and constraints
$	object	Root
Accounts	array	Optional	Payroll Account details for SuperExpense, SuperLiabilty, WagesExpense, PAYGLiability & WagesPayable.
Accounts[]	Model	Each item	Expand Retrieves payroll settings — response body — Settings Accounts item
DaysInPayrollYear	JSON	Optional
DaysInPayrollYear (anyOf 1)	integer	Alternative	Number of days in the Payroll year Format: int32
DaysInPayrollYear (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
EmployeesAreSTP2	boolean	Optional	Indicates if the organisation has been enabled for STP Phase 2 editing of employees.
TrackingCategories	Model	Optional	Expand Retrieves payroll settings — response body — Settings Tracking Categories

Referenced models: Retrieves payroll settings — response body — Settings Accounts item, Retrieves payroll settings — response body — Settings Tracking Categories

Retrieves payroll settings — response body — Settings Accounts item

Field	Type	Presence	Description and constraints
$	object	Root
AccountID	string	Optional	Xero identifier for accounts Format: uuid
Code	string	Optional	Customer defined account code
Name	string	Optional	Name of account
Type	string	Optional	See Account Types Known values: BANK, CURRENT, CURRLIAB, DEPRECIATN, DIRECTCOSTS, EQUITY, EXPENSE, FIXED, INVENTORY, LIABILITY, NONCURRENT, OTHERINCOME, OVERHEADS, PREPAYMENT, REVENUE, SALES, TERMLIAB, PAYGLIABILITY, PAYG, SUPERANNUATIONEXPENSE, SUPERANNUATIONLIABILITY, WAGESEXPENSE, WAGESPAYABLELIABILITY

Retrieves payroll settings — response body — Settings Tracking Categories

Field	Type	Presence	Description and constraints
$	object	Root	Tracking categories for Employees and Timesheets
EmployeeGroups	object	Optional	The tracking category used for employees
EmployeeGroups.TrackingCategoryID	string	Optional	The identifier for the tracking category Format: uuid
EmployeeGroups.TrackingCategoryName	string	Optional	Name of the tracking category
TimesheetCategories	object	Optional	The tracking category used for timesheets
TimesheetCategories.TrackingCategoryID	string	Optional	The identifier for the tracking category Format: uuid
TimesheetCategories.TrackingCategoryName	string	Optional	Name of the tracking category

Policy, approvals and errors

SDK function policy ID: xero.payroll_au_getsettings. Catalog operation: payroll_au.getSettings. 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