canonical: https://jentic.com/apis/xero.com/xero-payroll-au-api

# Xero Payroll AU API

This is the Xero Payroll API for orgs in Australia region. The API exposes 32 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically creates a payroll employee, searches payroll employees. Covers 32 operations with oauth2 authentication.

## Scope

Does not handle payments, communications, or crm - use for hr and recruiting only.

## Capabilities

- Creates a payroll employee
- Searches payroll employees
- Updates an employee's detail
- Retrieves an employee's detail by unique employee id
- Monitor Xero Payroll AU API operational status and events

## Use cases

### HR and Recruiting Operations

Use the Xero Payroll AU API to perform hr recruiting operations programmatically. The API provides 32 endpoints covering core functionality including creates a payroll employee, searches payroll employees, updates an employee's detail.

Example prompt: Call POST /Employees to creates a payroll employee

### Automated PayrollAu Management

Automate payrollau operations by combining multiple Xero Payroll AU API endpoints. Agents can searches payroll employees and then updates an employee's detail in a single workflow.

Example prompt: Call GET /Employees to searches payroll employees, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Xero Payroll AU API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle oauth2 tokens manually.

Example prompt: Search Jentic for 'creates a payroll employee', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /Employees | Creates a payroll employee |
| GET | /Employees | Searches payroll employees |
| POST | /Employees/{EmployeeID} | Updates an employee's detail |
| GET | /Employees/{EmployeeID} | Retrieves an employee's detail by unique employee id |
| POST | /LeaveApplications | Creates a leave application |
| GET | /LeaveApplications | Retrieves leave applications |
| GET | /LeaveApplications/v2 | Retrieves leave applications including leave requests |
| POST | /LeaveApplications/{LeaveApplicationID} | Updates a specific leave application |

## Key resources

- **PayrollAu** — Operations available to regular developers

## Why Jentic

- **Setup:** Wiring the Xero Payroll AU API by hand means implementing its OAuth2 flow, sending the tenant header on every request, and managing employees and leave across 32 operations yourself. Through Jentic you install once, import the Xero Payroll AU API from the API Directory, store the OAuth2 credential once, and your agent calls it.
- **Permission scoping:** The Xero Payroll AU API puts the employee id in the URL path (/Employees/{EmployeeID}), so a rule can pin your agent to one employee. You choose the operations it may call, so writes like creating employees or leave applications are not included unless you add them.
- **Credential handling:** Your Xero Payroll AU API OAuth2 credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a payroll employee' or 'list leave applications', and Jentic returns the matching Xero Payroll AU API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Greenhouse** — Alternative hr recruiting API
- **Lever** — Alternative hr recruiting API
- **Workday** — Complementary hr recruiting API

## FAQ

### What authentication does the Xero Payroll AU API use?

The Xero Payroll AU API uses OAuth 2.0 for authorization. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I creates a payroll employee with the Xero Payroll AU API?

Yes. Use the POST /Employees endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Xero Payroll AU API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I creates a payroll employee through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'creates a payroll employee'. Jentic returns the matching Xero Payroll AU API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Xero Payroll AU API have?

The Xero Payroll AU API exposes 32 endpoints covering payrollau operations.

### Can I limit what my agent is allowed to do with the Xero Payroll AU API?

Yes. Because you run Jentic One yourself, your own rules decide which Xero Payroll AU API operations and credentials the agent may use. You can allow only read calls such as GET /Employees and GET /LeaveApplications while withholding writes like POST /Employees or POST /LeaveApplications, so the agent cannot create employees or leave applications unless you add those operations. Since the employee id sits in the URL path (/Employees/{EmployeeID}), a rule can also pin the agent to a single employee.