Xero.Payroll.AU (Xero v1.0.0)

Copy Markdown View Source

Xero Payroll API – Australia. Base URL: https://api.xero.com/payroll.xro/1.0/ Scopes: payroll.employees, payroll.payruns, payroll.payslip, payroll.settings

Summary

Functions

Deletes a leave application.

Deletes a pay item by ID.

Deletes a DRAFT pay run.

Deletes a DRAFT timesheet.

Returns leave balances for an employee.

Returns the leave period for an employee in a specific year.

Returns leave summary for an employee.

Lists leave types for the organisation.

Posts (finalises) a pay run.

Returns superfund products available in Australia.

Updates bank account details for an employee.

Updates opening balances for an employee.

Updates tax declaration for an employee.

Functions

approve_timesheet(t, tid, id)

create_employee(t, tid, attrs)

create_leave_application(t, tid, attrs)

create_pay_item(t, tid, attrs)

create_pay_run(t, tid, attrs)

create_payroll_calendar(t, tid, attrs)

create_timesheet(t, tid, attrs)

delete_leave_application(t, tid, id)

Deletes a leave application.

delete_pay_item(t, tid, id)

Deletes a pay item by ID.

delete_pay_run(t, tid, id)

Deletes a DRAFT pay run.

delete_timesheet(t, tid, id)

Deletes a DRAFT timesheet.

get_employee(t, tid, id)

get_employee_leave_balances(t, tid, employee_id)

Returns leave balances for an employee.

get_employee_leave_periods(t, tid, employee_id, opts \\ [])

Returns the leave period for an employee in a specific year.

get_employee_leave_summary(t, tid, employee_id)

Returns leave summary for an employee.

get_leave_application(t, tid, id)

get_pay_run(t, tid, id)

get_payroll_calendar(t, tid, id)

get_payslip(t, tid, id)

get_superfund(t, tid, id)

get_timesheet(t, tid, id)

list_employees(t, tid, opts \\ [])

list_leave_applications(t, tid, opts \\ [])

list_leave_types(t, tid, opts \\ [])

Lists leave types for the organisation.

list_pay_items(t, tid, opts \\ [])

list_pay_runs(t, tid, opts \\ [])

list_payroll_calendars(t, tid, opts \\ [])

list_timesheets(t, tid, opts \\ [])

post_pay_run(t, tid, id)

Posts (finalises) a pay run.

revert_timesheet(t, tid, id)

settings(t, tid)

superfund_products(t, tid, opts \\ [])

Returns superfund products available in Australia.

superfunds(t, tid, opts \\ [])

update_employee(t, tid, id, attrs)

update_employee_bank_account(t, tid, employee_id, attrs)

Updates bank account details for an employee.

update_employee_opening_balances(t, tid, employee_id, attrs)

Updates opening balances for an employee.

update_employee_tax(t, tid, employee_id, attrs)

Updates tax declaration for an employee.

update_leave_application(t, tid, id, attrs)

update_pay_item(t, tid, attrs)

update_pay_run(t, tid, id, attrs)

update_payroll_calendar(t, tid, id, attrs)

update_payslip(t, tid, id, attrs)

update_timesheet(t, tid, id, attrs)