Xero Payroll AU API

PayrollAu

approveLeaveApplication

Approve a requested leave application by a unique leave application id


/LeaveApplications/{LeaveApplicationID}/approve

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const leaveApplicationID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
const idempotencyKey = 'KEY_VALUE';

try {
  const response = await xero.accountingApi.approveLeaveApplication(xeroTenantId, leaveApplicationID, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.employees Grant read-write access to payroll employees

Parameters

Path parameters
Name Description
LeaveApplicationID*
UUID (uuid)

Leave Application id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

createEmployee

Creates a payroll employee


/Employees

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const idempotencyKey = 'KEY_VALUE';
const dateOfBirth = '2000-10-28'

const homeAddress: HomeAddress = { 
  addressLine1: "123 Test st",
  region: "VIC",
  postalCode: 3000,
  city: "Melbourne"
}; 

const employee: Employee = { 
  firstName: "Adam",
  lastName: "Adamson",
  dateOfBirth: dateOfBirth,
  homeAddress: homeAddress
}; 

try {
  const response = await xero.accountingApi.createEmployee(xeroTenantId, employee, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.employees Grant read-write access to payroll employees

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
employee *
array[Employee]
Required

createLeaveApplication

Creates a leave application


/LeaveApplications

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const idempotencyKey = 'KEY_VALUE';
const startDate = '2020-10-28'
const endDate = '2020-10-30'

const leaveApplication: LeaveApplication = { 
  employeeId: "00000000-0000-0000-0000-000000000000",
  leaveTypeId: "00000000-0000-0000-0000-000000000000",
  title: "Annual Leave",
  startDate: startDate,
  endDate: endDate
}; 

try {
  const response = await xero.accountingApi.createLeaveApplication(xeroTenantId, leaveApplication, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.employees Grant read-write access to payroll employees

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
leaveApplication *
array[LeaveApplication]
Required

createPayItem

Creates a pay item


/PayItems

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const idempotencyKey = 'KEY_VALUE';

const earningsRate: EarningsRate = { 
  name: "Ordinary Hours 123",
  accountCode: "477",
  typeOfUnits: "Hours",
  isExemptFromTax: true,
  isExemptFromSuper: true,
  earningsType: EarningsType.OVERTIMEEARNINGS
}; 

const deductionType: DeductionType = { 
  name: "Union Fees",
  accountCode: "826",
  reducesTax: true,
  reducesSuper: true
}; 

const leaveType: LeaveType = { 
  name: "Annual Leave",
  typeOfUnits: "Hours",
  isPaidLeave: true,
  showOnPayslip: true
}; 

const reimbursementType: ReimbursementType = { 
  name: "Annual Leave",
  accountCode: "850"
};   
const earningsRates = [];
earningsRates.push(earningsRate,  
const deductionTypes = [];  
const leaveTypes = [];
leaveTypes.push(leaveType)  
const reimbursementTypes = [];
reimbursementTypes.push(reimbursementType)

const payItem: PayItem = { 
  earningsRates: earningsRates,
  deductionTypes: deductionTypes,
  leaveTypes: leaveTypes,
  reimbursementTypes: reimbursementTypes
}; 

try {
  const response = await xero.accountingApi.createPayItem(xeroTenantId, payItem, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.settings Grant read-write access to payroll settings

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
payItem *
PayItem
Required

createPayRun

Creates a pay run


/PayRuns

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const idempotencyKey = 'KEY_VALUE';

const payRun: PayRun = { 
  payrollCalendarID: "00000000-0000-0000-0000-000000000000"
}; 

try {
  const response = await xero.accountingApi.createPayRun(xeroTenantId, payRun, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.payruns Grant read-write access to payroll payruns

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
payRun *
array[PayRun]
Required

createPayrollCalendar

Creates a Payroll Calendar


/PayrollCalendars

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const idempotencyKey = 'KEY_VALUE';
const startDate = '2000-10-28'
const paymentDate = '2000-10-30'

const payrollCalendar: PayrollCalendar = { 
  name: "Weekly",
  calendarType: CalendarType.WEEKLY,
  startDate: startDate,
  paymentDate: paymentDate
};   
const payrollCalendars = [];
payrollCalendars.push(payrollCalendar)

try {
  const response = await xero.accountingApi.createPayrollCalendar(xeroTenantId, payrollCalendar, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.settings Grant read-write access to payroll settings

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
payrollCalendar *
array[PayrollCalendar]
Required

createSuperfund

Creates a superfund


/Superfunds

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const idempotencyKey = 'KEY_VALUE';

const superFund: SuperFund = { 
  type: SuperFundType.REGULATED,
  USI: "40022701955002"
}; 

try {
  const response = await xero.accountingApi.createSuperfund(xeroTenantId, superFund, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.settings Grant read-write access to payroll settings

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
superFund *
array[SuperFund]
Required

createTimesheet

Creates a timesheet


/Timesheets

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const idempotencyKey = 'KEY_VALUE';
const startDate = '2020-10-23'
const endDate = '2020-10-30'

const timesheet: Timesheet = { 
  employeeID: "00000000-0000-0000-0000-000000000000",
  startDate: startDate,
  endDate: endDate,
  status: TimesheetStatus.DRAFT
}; 

try {
  const response = await xero.accountingApi.createTimesheet(xeroTenantId, timesheet, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.timesheets Grant read-write access to payroll timesheets

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
timesheet *
array[Timesheet]
Required

getEmployee

Retrieves an employee's detail by unique employee id


/Employees/{EmployeeID}

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const employeeID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';

try {
  const response = await xero.accountingApi.getEmployee(xeroTenantId, employeeID);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.employees Grant read-write access to payroll employees
payroll.employees.read Grant read-only access to payroll employees

Parameters

Path parameters
Name Description
EmployeeID*
UUID (uuid)

Employee id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required

getEmployees

Searches payroll employees


/Employees

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const ifModifiedSince: Date = new Date("2020-02-06T12:17:43.202-08:00");
const where = 'Status=="ACTIVE"';
const order = 'EmailAddress%20DESC';
const page = 56;

try {
  const response = await xero.accountingApi.getEmployees(xeroTenantId, ifModifiedSince, where, order, page);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.employees Grant read-write access to payroll employees
payroll.employees.read Grant read-only access to payroll employees

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
page
Integer

e.g. page=1 – Up to 100 employees will be returned in a single API call

getLeaveApplication

Retrieves a leave application by a unique leave application id


/LeaveApplications/{LeaveApplicationID}

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const leaveApplicationID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';

try {
  const response = await xero.accountingApi.getLeaveApplication(xeroTenantId, leaveApplicationID);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.employees Grant read-write access to payroll employees
payroll.employees.read Grant read-only access to payroll employees

Parameters

Path parameters
Name Description
LeaveApplicationID*
UUID (uuid)

Leave Application id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required

getLeaveApplications

Retrieves leave applications


/LeaveApplications

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const ifModifiedSince: Date = new Date("2020-02-06T12:17:43.202-08:00");
const where = 'Status=="ACTIVE"';
const order = 'EmailAddress%20DESC';
const page = 56;

try {
  const response = await xero.accountingApi.getLeaveApplications(xeroTenantId, ifModifiedSince, where, order, page);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.employees Grant read-write access to payroll employees
payroll.employees.read Grant read-only access to payroll employees

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
page
Integer

e.g. page=1 – Up to 100 objects will be returned in a single API call

getLeaveApplicationsV2

Retrieves leave applications including leave requests


/LeaveApplications/v2

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const ifModifiedSince: Date = new Date("2020-02-06T12:17:43.202-08:00");
const where = 'Status=="ACTIVE"';
const order = 'EmailAddress%20DESC';
const page = 56;

try {
  const response = await xero.accountingApi.getLeaveApplicationsV2(xeroTenantId, ifModifiedSince, where, order, page);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.employees Grant read-write access to payroll employees
payroll.employees.read Grant read-only access to payroll employees

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
page
Integer

e.g. page=1 – Up to 100 objects will be returned in a single API call

getPayItems

Retrieves pay items


/PayItems

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const ifModifiedSince: Date = new Date("2020-02-06T12:17:43.202-08:00");
const where = 'Status=="ACTIVE"';
const order = 'EmailAddress%20DESC';
const page = 56;

try {
  const response = await xero.accountingApi.getPayItems(xeroTenantId, ifModifiedSince, where, order, page);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.settings Grant read-write access to payroll settings
payroll.settings.read Grant read-only access to payroll settings

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
page
Integer

e.g. page=1 – Up to 100 objects will be returned in a single API call

getPayRun

Retrieves a pay run by using a unique pay run id


/PayRuns/{PayRunID}

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const payRunID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';

try {
  const response = await xero.accountingApi.getPayRun(xeroTenantId, payRunID);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.payruns Grant read-write access to payroll payruns
payroll.payruns.read Grant read-only access to payroll payruns

Parameters

Path parameters
Name Description
PayRunID*
UUID (uuid)

PayRun id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required

getPayRuns

Retrieves pay runs


/PayRuns

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const ifModifiedSince: Date = new Date("2020-02-06T12:17:43.202-08:00");
const where = 'Status=="ACTIVE"';
const order = 'EmailAddress%20DESC';
const page = 56;

try {
  const response = await xero.accountingApi.getPayRuns(xeroTenantId, ifModifiedSince, where, order, page);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.payruns Grant read-write access to payroll payruns
payroll.payruns.read Grant read-only access to payroll payruns

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
page
Integer

e.g. page=1 – Up to 100 PayRuns will be returned in a single API call

getPayrollCalendar

Retrieves payroll calendar by using a unique payroll calendar ID


/PayrollCalendars/{PayrollCalendarID}

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const payrollCalendarID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';

try {
  const response = await xero.accountingApi.getPayrollCalendar(xeroTenantId, payrollCalendarID);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.settings Grant read-write access to payroll settings
payroll.settings.read Grant read-only access to payroll settings

Parameters

Path parameters
Name Description
PayrollCalendarID*
UUID (uuid)

Payroll Calendar id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required

getPayrollCalendars

Retrieves payroll calendars


/PayrollCalendars

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const ifModifiedSince: Date = new Date("2020-02-06T12:17:43.202-08:00");
const where = 'Status=="ACTIVE"';
const order = 'EmailAddress%20DESC';
const page = 56;

try {
  const response = await xero.accountingApi.getPayrollCalendars(xeroTenantId, ifModifiedSince, where, order, page);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.settings Grant read-write access to payroll settings
payroll.settings.read Grant read-only access to payroll settings

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
page
Integer

e.g. page=1 – Up to 100 objects will be returned in a single API call

getPayslip

Retrieves for a payslip by a unique payslip id


/Payslip/{PayslipID}

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const payslipID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';

try {
  const response = await xero.accountingApi.getPayslip(xeroTenantId, payslipID);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.payslip Grant read-write access to payroll payslips
payroll.payslip.read Grant read-only access to payroll payslips

Parameters

Path parameters
Name Description
PayslipID*
UUID (uuid)

Payslip id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required

getSettings

Retrieves payroll settings


/Settings

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';

try {
  const response = await xero.accountingApi.getSettings(xeroTenantId);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.settings Grant read-write access to payroll settings
payroll.settings.read Grant read-only access to payroll settings

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required

getSuperfund

Retrieves a superfund by using a unique superfund ID


/Superfunds/{SuperFundID}

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const superFundID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';

try {
  const response = await xero.accountingApi.getSuperfund(xeroTenantId, superFundID);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.settings Grant read-write access to payroll settings
payroll.settings.read Grant read-only access to payroll settings

Parameters

Path parameters
Name Description
SuperFundID*
UUID (uuid)

Superfund id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required

getSuperfundProducts

Retrieves superfund products


/SuperfundProducts

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const aBN = '40022701955';
const uSI = 'OSF0001AU';

try {
  const response = await xero.accountingApi.getSuperfundProducts(xeroTenantId,  aBN, uSI);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.settings Grant read-write access to payroll settings
payroll.settings.read Grant read-only access to payroll settings

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
ABN
String

The ABN of the Regulated SuperFund
USI
String

The USI of the Regulated SuperFund

getSuperfunds

Retrieves superfunds


/Superfunds

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const ifModifiedSince: Date = new Date("2020-02-06T12:17:43.202-08:00");
const where = 'Status=="ACTIVE"';
const order = 'EmailAddress%20DESC';
const page = 56;

try {
  const response = await xero.accountingApi.getSuperfunds(xeroTenantId, ifModifiedSince, where, order, page);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.settings Grant read-write access to payroll settings
payroll.settings.read Grant read-only access to payroll settings

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
page
Integer

e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call

getTimesheet

Retrieves a timesheet by using a unique timesheet id


/Timesheets/{TimesheetID}

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const timesheetID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';

try {
  const response = await xero.accountingApi.getTimesheet(xeroTenantId, timesheetID);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.timesheets Grant read-write access to payroll timesheets
payroll.timesheets.read Grant read-only access to payroll timesheets

Parameters

Path parameters
Name Description
TimesheetID*
UUID (uuid)

Timesheet id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required

getTimesheets

Retrieves timesheets


/Timesheets

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const ifModifiedSince: Date = new Date("2020-02-06T12:17:43.202-08:00");
const where = 'Status=="ACTIVE"';
const order = 'EmailAddress%20DESC';
const page = 56;

try {
  const response = await xero.accountingApi.getTimesheets(xeroTenantId, ifModifiedSince, where, order, page);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.timesheets Grant read-write access to payroll timesheets
payroll.timesheets.read Grant read-only access to payroll timesheets

Parameters

Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
page
Integer

e.g. page=1 – Up to 100 timesheets will be returned in a single API call

rejectLeaveApplication

Reject a leave application by a unique leave application id


/LeaveApplications/{LeaveApplicationID}/reject

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const leaveApplicationID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
const idempotencyKey = 'KEY_VALUE';

try {
  const response = await xero.accountingApi.rejectLeaveApplication(xeroTenantId, leaveApplicationID, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.employees Grant read-write access to payroll employees

Parameters

Path parameters
Name Description
LeaveApplicationID*
UUID (uuid)

Leave Application id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

updateEmployee

Updates an employee's detail

Update properties on a single employee


/Employees/{EmployeeID}

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const employeeID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
const idempotencyKey = 'KEY_VALUE';
const dateOfBirth = '2000-10-28'

const homeAddress: HomeAddress = { 
  addressLine1: "123 Test st",
  region: "VIC",
  postalCode: 3000,
  city: "Melbourne"
}; 

const employee: Employee = { 
  firstName: "Adam",
  lastName: "Adamson",
  dateOfBirth: dateOfBirth,
  homeAddress: homeAddress
}; 

try {
  const response = await xero.accountingApi.updateEmployee(xeroTenantId, employeeID, employee, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.employees Grant read-write access to payroll employees

Parameters

Path parameters
Name Description
EmployeeID*
UUID (uuid)

Employee id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
employee *
array[Employee]
Required

updateLeaveApplication

Updates a specific leave application


/LeaveApplications/{LeaveApplicationID}

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const leaveApplicationID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
const idempotencyKey = 'KEY_VALUE';
const startDate = '2020-10-28'
const endDate = '2020-10-30'

const leaveApplication: LeaveApplication = { 
  employeeId: "00000000-0000-0000-0000-000000000000",
  leaveTypeId: "00000000-0000-0000-0000-000000000000",
  title: "Annual Leave",
  startDate: startDate,
  endDate: endDate
}; 

try {
  const response = await xero.accountingApi.updateLeaveApplication(xeroTenantId, leaveApplicationID, leaveApplication, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.employees Grant read-write access to payroll employees

Parameters

Path parameters
Name Description
LeaveApplicationID*
UUID (uuid)

Leave Application id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
leaveApplication *
array[LeaveApplication]
Required

updatePayRun

Updates a pay run

Update properties on a single PayRun


/PayRuns/{PayRunID}

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const payRunID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
const idempotencyKey = 'KEY_VALUE';

const payRun: PayRun = { 
  payrollCalendarID: "00000000-0000-0000-0000-000000000000"
}; 

try {
  const response = await xero.accountingApi.updatePayRun(xeroTenantId, payRunID, payRun, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.payruns Grant read-write access to payroll payruns

Parameters

Path parameters
Name Description
PayRunID*
UUID (uuid)

PayRun id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
payRun *
array[PayRun]
Required

updatePayslip

Updates a payslip

Update lines on a single payslips


/Payslip/{PayslipID}

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const payslipID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
const idempotencyKey = 'KEY_VALUE';

const earningsLine: EarningsLine = { 
  earningsRateID: "00000000-0000-0000-0000-000000000000",
  ratePerUnit: 20,
  numberOfUnits: 1
};   
const earningsLines = [];
earningsLines.push(earningsLine)

const payslipLine: PayslipLines = { 
  earningsLines: earningsLines
};   
const payslipLines = [];
payslipLines.push(payslipLine)

try {
  const response = await xero.accountingApi.updatePayslip(xeroTenantId, payslipID, payslipLines, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.payslip Grant read-write access to payroll payslips

Parameters

Path parameters
Name Description
PayslipID*
UUID (uuid)

Payslip id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
payslipLines *
array[PayslipLines]
Required

updateSuperfund

Updates a superfund

Update properties on a single Superfund


/Superfunds/{SuperFundID}

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const superFundID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
const idempotencyKey = 'KEY_VALUE';

const superFund: SuperFund = { 
  type: SuperFundType.REGULATED,
  USI: "40022701955002"
}; 

try {
  const response = await xero.accountingApi.updateSuperfund(xeroTenantId, superFundID, superFund, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.settings Grant read-write access to payroll settings

Parameters

Path parameters
Name Description
SuperFundID*
UUID (uuid)

Superfund id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
superFund *
array[SuperFund]
Required

updateTimesheet

Updates a timesheet

Update properties on a single timesheet


/Timesheets/{TimesheetID}

Usage and SDK Samples

await xero.setTokenSet(tokenSet);

const xeroTenantId = 'xeroTenantId_example';
const timesheetID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
const idempotencyKey = 'KEY_VALUE';
const startDate = '2020-10-23'
const endDate = '2020-10-30'

const timesheet: Timesheet = { 
  employeeID: "00000000-0000-0000-0000-000000000000",
  startDate: startDate,
  endDate: endDate,
  status: TimesheetStatus.DRAFT
}; 

try {
  const response = await xero.accountingApi.updateTimesheet(xeroTenantId, timesheetID, timesheet, idempotencyKey);
  console.log(response.body || response.response.statusCode)
} catch (err) {
  const error = JSON.stringify(err.response.body, null, 2)
  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
}

Scopes

payroll.timesheets Grant read-write access to payroll timesheets

Parameters

Path parameters
Name Description
TimesheetID*
UUID (uuid)

Timesheet id for single object

Required
Header parameters
Name Description
Xero-Tenant-Id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
timesheet *
array[Timesheet]
Required