Xero: Retrieves payroll calendar by using a unique payroll calendar ID

← Payroll au operations · Get started

Operation xero.payroll_au_getpayrollcalendar

Provider route: GET /payroll.xro/1.0/PayrollCalendars/{PayrollCalendarID}. 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"]["getPayrollCalendar"]>[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.getPayrollCalendar(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_payroll_calendar(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.PayrollCalendarID	string	Required within parent	Format: uuid
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 Creates a Payroll Calendar — response body

Referenced models: Creates a Payroll Calendar — response body

Schemas

Creates a Payroll Calendar — response body

Field	Type	Presence	Description and constraints
$	object	Root
PayrollCalendars	array	Optional
PayrollCalendars[]	Model	Each item	Expand Creates a Payroll Calendar — response body — Payroll Calendars item

Referenced models: Creates a Payroll Calendar — response body — Payroll Calendars item

Creates a Payroll Calendar — response body — Payroll Calendars item

Field	Type	Presence	Description and constraints
$	object	Root
CalendarType	string	Optional	Known values: WEEKLY, FORTNIGHTLY, FOURWEEKLY, MONTHLY, TWICEMONTHLY, QUARTERLY
Name	string	Optional	Name of the Payroll Calendar
PaymentDate	string	Optional	The date on which employees will be paid for the upcoming pay period (YYYY-MM-DD)
PayrollCalendarID	string	Optional	Xero identifier Format: uuid
ReferenceDate	string	Optional	Reference Date (YYYY-MM-DD)
StartDate	string	Optional	The start date of the upcoming pay period. The end date will be calculated based upon this date, and the calendar type selected (YYYY-MM-DD)
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_getpayrollcalendar. Catalog operation: payroll_au.getPayrollCalendar. 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