Package com.xero.api.client

Class PayrollUkApi

java.lang.Object

com.xero.api.client.PayrollUkApi

public class PayrollUkApi
extends Object

PayrollUkApi has methods for interacting with all endpoints in the API set

Constructor Summary

Constructors

Constructor	Description
PayrollUkApi()	PayrollUkApi
PayrollUkApi(ApiClient apiClient)	PayrollUkApi

Method Summary

Modifier and Type	Method	Description
TimesheetObject	approveTimesheet(String accessToken, String xeroTenantId, UUID timesheetID, String idempotencyKey)	Approves a specific timesheet
com.google.api.client.http.HttpResponse	approveTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, String idempotencyKey)	Approves a specific timesheet
ByteArrayInputStream	convertInputToByteArray(InputStream is)	convert intput to byte array
BenefitObject	createBenefit(String accessToken, String xeroTenantId, Benefit benefit, String idempotencyKey)	Creates a new employee benefit
com.google.api.client.http.HttpResponse	createBenefitForHttpResponse(String accessToken, String xeroTenantId, Benefit benefit, String idempotencyKey)	Creates a new employee benefit
DeductionObject	createDeduction(String accessToken, String xeroTenantId, Deduction deduction, String idempotencyKey)	Creates a new deduction
com.google.api.client.http.HttpResponse	createDeductionForHttpResponse(String accessToken, String xeroTenantId, Deduction deduction, String idempotencyKey)	Creates a new deduction
EarningsRateObject	createEarningsRate(String accessToken, String xeroTenantId, EarningsRate earningsRate, String idempotencyKey)	Creates a new earnings rate
com.google.api.client.http.HttpResponse	createEarningsRateForHttpResponse(String accessToken, String xeroTenantId, EarningsRate earningsRate, String idempotencyKey)	Creates a new earnings rate
EmployeeObject	createEmployee(String accessToken, String xeroTenantId, Employee employee, String idempotencyKey)	Creates employees
EarningsTemplateObject	createEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeID, EarningsTemplate earningsTemplate, String idempotencyKey)	Creates an earnings template records for a specific employee
com.google.api.client.http.HttpResponse	createEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EarningsTemplate earningsTemplate, String idempotencyKey)	Creates an earnings template records for a specific employee
com.google.api.client.http.HttpResponse	createEmployeeForHttpResponse(String accessToken, String xeroTenantId, Employee employee, String idempotencyKey)	Creates employees
EmployeeLeaveObject	createEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeID, EmployeeLeave employeeLeave, String idempotencyKey)	Creates leave records for a specific employee
com.google.api.client.http.HttpResponse	createEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EmployeeLeave employeeLeave, String idempotencyKey)	Creates leave records for a specific employee
EmployeeLeaveTypeObject	createEmployeeLeaveType(String accessToken, String xeroTenantId, UUID employeeID, EmployeeLeaveType employeeLeaveType, String idempotencyKey)	Creates employee leave type records
com.google.api.client.http.HttpResponse	createEmployeeLeaveTypeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EmployeeLeaveType employeeLeaveType, String idempotencyKey)	Creates employee leave type records
EmployeeOpeningBalancesObject	createEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeID, EmployeeOpeningBalances employeeOpeningBalances, String idempotencyKey)	Creates an opening balance for a specific employee
com.google.api.client.http.HttpResponse	createEmployeeOpeningBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EmployeeOpeningBalances employeeOpeningBalances, String idempotencyKey)	Creates an opening balance for a specific employee
PaymentMethodObject	createEmployeePaymentMethod(String accessToken, String xeroTenantId, UUID employeeID, PaymentMethod paymentMethod, String idempotencyKey)	Creates an employee payment method
com.google.api.client.http.HttpResponse	createEmployeePaymentMethodForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, PaymentMethod paymentMethod, String idempotencyKey)	Creates an employee payment method
SalaryAndWageObject	createEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeID, SalaryAndWage salaryAndWage, String idempotencyKey)	Creates a salary and wage record for a specific employee
com.google.api.client.http.HttpResponse	createEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, SalaryAndWage salaryAndWage, String idempotencyKey)	Creates a salary and wage record for a specific employee
EmployeeStatutorySickLeaveObject	createEmployeeStatutorySickLeave(String accessToken, String xeroTenantId, EmployeeStatutorySickLeave employeeStatutorySickLeave, String idempotencyKey)	Creates statutory sick leave records
com.google.api.client.http.HttpResponse	createEmployeeStatutorySickLeaveForHttpResponse(String accessToken, String xeroTenantId, EmployeeStatutorySickLeave employeeStatutorySickLeave, String idempotencyKey)	Creates statutory sick leave records
EmploymentObject	createEmployment(String accessToken, String xeroTenantId, UUID employeeID, Employment employment, String idempotencyKey)	Creates employment detail for a specific employee using a unique employee ID
com.google.api.client.http.HttpResponse	createEmploymentForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, Employment employment, String idempotencyKey)	Creates employment detail for a specific employee using a unique employee ID
LeaveTypeObject	createLeaveType(String accessToken, String xeroTenantId, LeaveType leaveType, String idempotencyKey)	Creates a new leave type
com.google.api.client.http.HttpResponse	createLeaveTypeForHttpResponse(String accessToken, String xeroTenantId, LeaveType leaveType, String idempotencyKey)	Creates a new leave type
EmployeePayTemplates	createMultipleEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeID, List<EarningsTemplate> earningsTemplate, String idempotencyKey)	Creates multiple earnings template records for a specific employee using a unique employee ID
com.google.api.client.http.HttpResponse	createMultipleEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, List<EarningsTemplate> earningsTemplate, String idempotencyKey)	Creates multiple earnings template records for a specific employee using a unique employee ID
PayRunCalendarObject	createPayRunCalendar(String accessToken, String xeroTenantId, PayRunCalendar payRunCalendar, String idempotencyKey)	Creates a new payrun calendar
com.google.api.client.http.HttpResponse	createPayRunCalendarForHttpResponse(String accessToken, String xeroTenantId, PayRunCalendar payRunCalendar, String idempotencyKey)	Creates a new payrun calendar
ReimbursementObject	createReimbursement(String accessToken, String xeroTenantId, Reimbursement reimbursement, String idempotencyKey)	Creates a new reimbursement
com.google.api.client.http.HttpResponse	createReimbursementForHttpResponse(String accessToken, String xeroTenantId, Reimbursement reimbursement, String idempotencyKey)	Creates a new reimbursement
TimesheetObject	createTimesheet(String accessToken, String xeroTenantId, Timesheet timesheet, String idempotencyKey)	Creates a new timesheet
com.google.api.client.http.HttpResponse	createTimesheetForHttpResponse(String accessToken, String xeroTenantId, Timesheet timesheet, String idempotencyKey)	Creates a new timesheet
TimesheetLineObject	createTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, TimesheetLine timesheetLine, String idempotencyKey)	Creates a new timesheet line for a specific timesheet using a unique timesheet ID
com.google.api.client.http.HttpResponse	createTimesheetLineForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, TimesheetLine timesheetLine, String idempotencyKey)	Creates a new timesheet line for a specific timesheet using a unique timesheet ID
void	deleteEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeID, UUID payTemplateEarningID)	Deletes a specific employee's earnings template record
com.google.api.client.http.HttpResponse	deleteEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID payTemplateEarningID)	Deletes a specific employee's earnings template record
EmployeeLeaveObject	deleteEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID)	Deletes a specific employee's leave record
com.google.api.client.http.HttpResponse	deleteEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID)	Deletes a specific employee's leave record
void	deleteEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID)	Deletes a salary and wages record for a specific employee
com.google.api.client.http.HttpResponse	deleteEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID)	Deletes a salary and wages record for a specific employee
TimesheetLine	deleteTimesheet(String accessToken, String xeroTenantId, UUID timesheetID)	Deletes a specific timesheet
com.google.api.client.http.HttpResponse	deleteTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)	Deletes a specific timesheet
TimesheetLine	deleteTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID)	Deletes a specific timesheet line
com.google.api.client.http.HttpResponse	deleteTimesheetLineForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID)	Deletes a specific timesheet line
ApiClient	getApiClient()	get ApiClient
BenefitObject	getBenefit(String accessToken, String xeroTenantId, UUID id)	Retrieves a specific benefit by using a unique benefit ID
com.google.api.client.http.HttpResponse	getBenefitForHttpResponse(String accessToken, String xeroTenantId, UUID id)	Retrieves a specific benefit by using a unique benefit ID
Benefits	getBenefits(String accessToken, String xeroTenantId, Integer page)	Retrieves employee benefits
com.google.api.client.http.HttpResponse	getBenefitsForHttpResponse(String accessToken, String xeroTenantId, Integer page)	Retrieves employee benefits
DeductionObject	getDeduction(String accessToken, String xeroTenantId, UUID deductionId)	Retrieves a specific deduction by using a unique deduction ID
com.google.api.client.http.HttpResponse	getDeductionForHttpResponse(String accessToken, String xeroTenantId, UUID deductionId)	Retrieves a specific deduction by using a unique deduction ID
Deductions	getDeductions(String accessToken, String xeroTenantId, Integer page)	Retrieves deductions
com.google.api.client.http.HttpResponse	getDeductionsForHttpResponse(String accessToken, String xeroTenantId, Integer page)	Retrieves deductions
EarningsOrderObject	getEarningsOrder(String accessToken, String xeroTenantId, UUID id)	Retrieves a specific earnings orders by using a unique earnings orders id
com.google.api.client.http.HttpResponse	getEarningsOrderForHttpResponse(String accessToken, String xeroTenantId, UUID id)	Retrieves a specific earnings orders by using a unique earnings orders id
EarningsOrders	getEarningsOrders(String accessToken, String xeroTenantId, Integer page)	Retrieves earnings orders
com.google.api.client.http.HttpResponse	getEarningsOrdersForHttpResponse(String accessToken, String xeroTenantId, Integer page)	Retrieves earnings orders
EarningsRateObject	getEarningsRate(String accessToken, String xeroTenantId, UUID earningsRateID)	Retrieves a specific earnings rates by using a unique earnings rate id
com.google.api.client.http.HttpResponse	getEarningsRateForHttpResponse(String accessToken, String xeroTenantId, UUID earningsRateID)	Retrieves a specific earnings rates by using a unique earnings rate id
EarningsRates	getEarningsRates(String accessToken, String xeroTenantId, Integer page)	Retrieves earnings rates
com.google.api.client.http.HttpResponse	getEarningsRatesForHttpResponse(String accessToken, String xeroTenantId, Integer page)	Retrieves earnings rates
EmployeeObject	getEmployee(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves specific employees by using a unique employee ID
com.google.api.client.http.HttpResponse	getEmployeeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves specific employees by using a unique employee ID
EmployeeLeaveObject	getEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID)	Retrieves a specific employee's leave record using a unique employee ID
EmployeeLeaveBalances	getEmployeeLeaveBalances(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves a specific employee's leave balances using a unique employee ID
com.google.api.client.http.HttpResponse	getEmployeeLeaveBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves a specific employee's leave balances using a unique employee ID
com.google.api.client.http.HttpResponse	getEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID)	Retrieves a specific employee's leave record using a unique employee ID
LeavePeriods	getEmployeeLeavePeriods(String accessToken, String xeroTenantId, UUID employeeID, org.threeten.bp.LocalDate startDate, org.threeten.bp.LocalDate endDate)	Retrieves a specific employee's leave periods using a unique employee ID
com.google.api.client.http.HttpResponse	getEmployeeLeavePeriodsForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, org.threeten.bp.LocalDate startDate, org.threeten.bp.LocalDate endDate)	Retrieves a specific employee's leave periods using a unique employee ID
EmployeeLeaves	getEmployeeLeaves(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves a specific employee's leave records using a unique employee ID
com.google.api.client.http.HttpResponse	getEmployeeLeavesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves a specific employee's leave records using a unique employee ID
EmployeeLeaveTypes	getEmployeeLeaveTypes(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves a specific employee's leave types using a unique employee ID
com.google.api.client.http.HttpResponse	getEmployeeLeaveTypesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves a specific employee's leave types using a unique employee ID
EmployeeOpeningBalancesObject	getEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves a specific employee's openingbalances using a unique employee ID
com.google.api.client.http.HttpResponse	getEmployeeOpeningBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves a specific employee's openingbalances using a unique employee ID
PaymentMethodObject	getEmployeePaymentMethod(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves a specific employee's payment method using a unique employee ID
com.google.api.client.http.HttpResponse	getEmployeePaymentMethodForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves a specific employee's payment method using a unique employee ID
EmployeePayTemplateObject	getEmployeePayTemplate(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves a specific employee pay templates using a unique employee ID
com.google.api.client.http.HttpResponse	getEmployeePayTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves a specific employee pay templates using a unique employee ID
Employees	getEmployees(String accessToken, String xeroTenantId, String filter, Integer page)	Retrieves employees
SalaryAndWages	getEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID)	Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id
com.google.api.client.http.HttpResponse	getEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID)	Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id
SalaryAndWages	getEmployeeSalaryAndWages(String accessToken, String xeroTenantId, UUID employeeID, Integer page)	Retrieves a specific employee's salary and wages by using a unique employee ID
com.google.api.client.http.HttpResponse	getEmployeeSalaryAndWagesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, Integer page)	Retrieves a specific employee's salary and wages by using a unique employee ID
com.google.api.client.http.HttpResponse	getEmployeesForHttpResponse(String accessToken, String xeroTenantId, String filter, Integer page)	Retrieves employees
EmployeeStatutoryLeaveBalanceObject	getEmployeeStatutoryLeaveBalances(String accessToken, String xeroTenantId, UUID employeeID, String leaveType, org.threeten.bp.LocalDate asOfDate)	Retrieves a specific employee's leave balances using a unique employee ID
com.google.api.client.http.HttpResponse	getEmployeeStatutoryLeaveBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, String leaveType, org.threeten.bp.LocalDate asOfDate)	Retrieves a specific employee's leave balances using a unique employee ID
EmployeeStatutorySickLeaveObject	getEmployeeStatutorySickLeave(String accessToken, String xeroTenantId, UUID statutorySickLeaveID)	Retrieves a statutory sick leave for an employee
com.google.api.client.http.HttpResponse	getEmployeeStatutorySickLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID statutorySickLeaveID)	Retrieves a statutory sick leave for an employee
EmployeeTaxObject	getEmployeeTax(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves tax records for a specific employee using a unique employee ID
com.google.api.client.http.HttpResponse	getEmployeeTaxForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves tax records for a specific employee using a unique employee ID
static PayrollUkApi	getInstance(ApiClient apiClient)	PayrollUkApi getInstance
LeaveTypeObject	getLeaveType(String accessToken, String xeroTenantId, UUID leaveTypeID)	Retrieves a specific leave type by using a unique leave type ID
com.google.api.client.http.HttpResponse	getLeaveTypeForHttpResponse(String accessToken, String xeroTenantId, UUID leaveTypeID)	Retrieves a specific leave type by using a unique leave type ID
LeaveTypes	getLeaveTypes(String accessToken, String xeroTenantId, Integer page, Boolean activeOnly)	Retrieves leave types
com.google.api.client.http.HttpResponse	getLeaveTypesForHttpResponse(String accessToken, String xeroTenantId, Integer page, Boolean activeOnly)	Retrieves leave types
PayRunObject	getPayRun(String accessToken, String xeroTenantId, UUID payRunID)	Retrieves a specific pay run by using a unique pay run ID
PayRunCalendarObject	getPayRunCalendar(String accessToken, String xeroTenantId, UUID payRunCalendarID)	Retrieves a specific payrun calendar by using a unique payrun calendar ID
com.google.api.client.http.HttpResponse	getPayRunCalendarForHttpResponse(String accessToken, String xeroTenantId, UUID payRunCalendarID)	Retrieves a specific payrun calendar by using a unique payrun calendar ID
PayRunCalendars	getPayRunCalendars(String accessToken, String xeroTenantId, Integer page)	Retrieves payrun calendars
com.google.api.client.http.HttpResponse	getPayRunCalendarsForHttpResponse(String accessToken, String xeroTenantId, Integer page)	Retrieves payrun calendars
com.google.api.client.http.HttpResponse	getPayRunForHttpResponse(String accessToken, String xeroTenantId, UUID payRunID)	Retrieves a specific pay run by using a unique pay run ID
PayRuns	getPayRuns(String accessToken, String xeroTenantId, Integer page, String status)	Retrieves pay runs
com.google.api.client.http.HttpResponse	getPayRunsForHttpResponse(String accessToken, String xeroTenantId, Integer page, String status)	Retrieves pay runs
PayslipObject	getPaySlip(String accessToken, String xeroTenantId, UUID payslipID)	Retrieves a specific payslip by using a unique payslip ID
com.google.api.client.http.HttpResponse	getPaySlipForHttpResponse(String accessToken, String xeroTenantId, UUID payslipID)	Retrieves a specific payslip by using a unique payslip ID
Payslips	getPaySlips(String accessToken, String xeroTenantId, UUID payRunID, Integer page)	Retrieves payslips
com.google.api.client.http.HttpResponse	getPaySlipsForHttpResponse(String accessToken, String xeroTenantId, UUID payRunID, Integer page)	Retrieves payslips
ReimbursementObject	getReimbursement(String accessToken, String xeroTenantId, UUID reimbursementID)	Retrieves a specific reimbursement by using a unique reimbursement id
com.google.api.client.http.HttpResponse	getReimbursementForHttpResponse(String accessToken, String xeroTenantId, UUID reimbursementID)	Retrieves a specific reimbursement by using a unique reimbursement id
Reimbursements	getReimbursements(String accessToken, String xeroTenantId, Integer page)	Retrieves reimbursements
com.google.api.client.http.HttpResponse	getReimbursementsForHttpResponse(String accessToken, String xeroTenantId, Integer page)	Retrieves reimbursements
Settings	getSettings(String accessToken, String xeroTenantId)	Retrieves payroll settings
com.google.api.client.http.HttpResponse	getSettingsForHttpResponse(String accessToken, String xeroTenantId)	Retrieves payroll settings
EmployeeStatutoryLeavesSummaries	getStatutoryLeaveSummary(String accessToken, String xeroTenantId, UUID employeeID, Boolean activeOnly)	Retrieves a specific employee's summary of statutory leaves using a unique employee ID
com.google.api.client.http.HttpResponse	getStatutoryLeaveSummaryForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, Boolean activeOnly)	Retrieves a specific employee's summary of statutory leaves using a unique employee ID
TimesheetObject	getTimesheet(String accessToken, String xeroTenantId, UUID timesheetID)	Retrieve a specific timesheet by using a unique timesheet ID
com.google.api.client.http.HttpResponse	getTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)	Retrieve a specific timesheet by using a unique timesheet ID
Timesheets	getTimesheets(String accessToken, String xeroTenantId, Integer page, String filter, String status, String startDate, String endDate, String sort)	Retrieves timesheets
com.google.api.client.http.HttpResponse	getTimesheetsForHttpResponse(String accessToken, String xeroTenantId, Integer page, String filter, String status, String startDate, String endDate, String sort)	Retrieves timesheets
TrackingCategories	getTrackingCategories(String accessToken, String xeroTenantId)	Retrieves tracking categories
com.google.api.client.http.HttpResponse	getTrackingCategoriesForHttpResponse(String accessToken, String xeroTenantId)	Retrieves tracking categories
String	getUserAgent()	get user agent
TimesheetObject	revertTimesheet(String accessToken, String xeroTenantId, UUID timesheetID, String idempotencyKey)	Reverts a specific timesheet to draft
com.google.api.client.http.HttpResponse	revertTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, String idempotencyKey)	Reverts a specific timesheet to draft
void	setApiClient(ApiClient apiClient)	set ApiClient
void	setUserAgent(String userAgent)	set user agent
EmployeeObject	updateEmployee(String accessToken, String xeroTenantId, UUID employeeID, Employee employee, String idempotencyKey)	Updates a specific employee's detail
EarningsTemplateObject	updateEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeID, UUID payTemplateEarningID, EarningsTemplate earningsTemplate, String idempotencyKey)	Updates a specific employee's earnings template records
com.google.api.client.http.HttpResponse	updateEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID payTemplateEarningID, EarningsTemplate earningsTemplate, String idempotencyKey)	Updates a specific employee's earnings template records
com.google.api.client.http.HttpResponse	updateEmployeeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, Employee employee, String idempotencyKey)	Updates a specific employee's detail
EmployeeLeaveObject	updateEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID, EmployeeLeave employeeLeave, String idempotencyKey)	Updates a specific employee's leave records
com.google.api.client.http.HttpResponse	updateEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID, EmployeeLeave employeeLeave, String idempotencyKey)	Updates a specific employee's leave records
EmployeeOpeningBalancesObject	updateEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeID, EmployeeOpeningBalances employeeOpeningBalances, String idempotencyKey)	Updates a specific employee's opening balances
com.google.api.client.http.HttpResponse	updateEmployeeOpeningBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EmployeeOpeningBalances employeeOpeningBalances, String idempotencyKey)	Updates a specific employee's opening balances
SalaryAndWageObject	updateEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID, SalaryAndWage salaryAndWage, String idempotencyKey)	Updates salary and wages record for a specific employee
com.google.api.client.http.HttpResponse	updateEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID, SalaryAndWage salaryAndWage, String idempotencyKey)	Updates salary and wages record for a specific employee
PayRunObject	updatePayRun(String accessToken, String xeroTenantId, UUID payRunID, PayRun payRun, String idempotencyKey)	Updates a specific pay run
com.google.api.client.http.HttpResponse	updatePayRunForHttpResponse(String accessToken, String xeroTenantId, UUID payRunID, PayRun payRun, String idempotencyKey)	Updates a specific pay run
TimesheetLineObject	updateTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID, TimesheetLine timesheetLine, String idempotencyKey)	Updates a specific timesheet line for a specific timesheet
com.google.api.client.http.HttpResponse	updateTimesheetLineForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID, TimesheetLine timesheetLine, String idempotencyKey)	Updates a specific timesheet line for a specific timesheet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PayrollUkApi

public PayrollUkApi()

PayrollUkApi

PayrollUkApi

public PayrollUkApi(ApiClient apiClient)

PayrollUkApi

Parameters:

apiClient - ApiClient pass into the new instance of this class

Method Details

getInstance

public static PayrollUkApi getInstance(ApiClient apiClient)

PayrollUkApi getInstance

Parameters:

apiClient - ApiClient pass into the new instance of this class

Returns:

instance of this class

getApiClient

public ApiClient getApiClient()

get ApiClient

Returns:

apiClient the current ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

set ApiClient

Parameters:

apiClient - ApiClient pass into the new instance of this class

setUserAgent

public void setUserAgent(String userAgent)

set user agent

Parameters:

userAgent - string to override the user agent

getUserAgent

public String getUserAgent()

get user agent

Returns:

String of user agent

approveTimesheet

public TimesheetObject approveTimesheet(String accessToken,
 String xeroTenantId,
 UUID timesheetID,
 String idempotencyKey)
                                 throws IOException

Approves a specific timesheet

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheetID - Identifier for the timesheet

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

Returns:

TimesheetObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

approveTimesheetForHttpResponse

public com.google.api.client.http.HttpResponse approveTimesheetForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID timesheetID,
 String idempotencyKey)
                                                                        throws IOException

Approves a specific timesheet

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheetID - Identifier for the timesheet

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createBenefit

public BenefitObject createBenefit(String accessToken,
 String xeroTenantId,
 Benefit benefit,
 String idempotencyKey)
                            throws IOException

Creates a new employee benefit

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

benefit - The benefit parameter

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

Returns:

BenefitObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createBenefitForHttpResponse

public com.google.api.client.http.HttpResponse createBenefitForHttpResponse(String accessToken,
 String xeroTenantId,
 Benefit benefit,
 String idempotencyKey)
                                                                     throws IOException

Creates a new employee benefit

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

benefit - The benefit parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createDeduction

public DeductionObject createDeduction(String accessToken,
 String xeroTenantId,
 Deduction deduction,
 String idempotencyKey)
                                throws IOException

Creates a new deduction

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

deduction - The deduction parameter

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

Returns:

DeductionObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createDeductionForHttpResponse

public com.google.api.client.http.HttpResponse createDeductionForHttpResponse(String accessToken,
 String xeroTenantId,
 Deduction deduction,
 String idempotencyKey)
                                                                       throws IOException

Creates a new deduction

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

deduction - The deduction parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createEarningsRate

public EarningsRateObject createEarningsRate(String accessToken,
 String xeroTenantId,
 EarningsRate earningsRate,
 String idempotencyKey)
                                      throws IOException

Creates a new earnings rate

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

earningsRate - The earningsRate parameter

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

Returns:

EarningsRateObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createEarningsRateForHttpResponse

public com.google.api.client.http.HttpResponse createEarningsRateForHttpResponse(String accessToken,
 String xeroTenantId,
 EarningsRate earningsRate,
 String idempotencyKey)
                                                                          throws IOException

Creates a new earnings rate

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

earningsRate - The earningsRate parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createEmployee

public EmployeeObject createEmployee(String accessToken,
 String xeroTenantId,
 Employee employee,
 String idempotencyKey)
                              throws IOException

Creates employees

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employee - The employee parameter

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

Returns:

EmployeeObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createEmployeeForHttpResponse

public com.google.api.client.http.HttpResponse createEmployeeForHttpResponse(String accessToken,
 String xeroTenantId,
 Employee employee,
 String idempotencyKey)
                                                                      throws IOException

Creates employees

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employee - The employee parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createEmployeeEarningsTemplate

public EarningsTemplateObject createEmployeeEarningsTemplate(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 EarningsTemplate earningsTemplate,
 String idempotencyKey)
                                                      throws IOException

Creates an earnings template records for a specific employee

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

earningsTemplate - The earningsTemplate parameter

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

Returns:

EarningsTemplateObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createEmployeeEarningsTemplateForHttpResponse

public com.google.api.client.http.HttpResponse createEmployeeEarningsTemplateForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 EarningsTemplate earningsTemplate,
 String idempotencyKey)
                                                                                      throws IOException

Creates an earnings template records for a specific employee

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

earningsTemplate - The earningsTemplate parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createEmployeeLeave

public EmployeeLeaveObject createEmployeeLeave(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 EmployeeLeave employeeLeave,
 String idempotencyKey)
                                        throws IOException

Creates leave records for a specific employee

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

employeeLeave - The employeeLeave parameter

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

Returns:

EmployeeLeaveObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createEmployeeLeaveForHttpResponse

public com.google.api.client.http.HttpResponse createEmployeeLeaveForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 EmployeeLeave employeeLeave,
 String idempotencyKey)
                                                                           throws IOException

Creates leave records for a specific employee

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

employeeLeave - The employeeLeave parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createEmployeeLeaveType

public EmployeeLeaveTypeObject createEmployeeLeaveType(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 EmployeeLeaveType employeeLeaveType,
 String idempotencyKey)
                                                throws IOException

Creates employee leave type records

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

employeeLeaveType - The employeeLeaveType parameter

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

Returns:

EmployeeLeaveTypeObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createEmployeeLeaveTypeForHttpResponse

public com.google.api.client.http.HttpResponse createEmployeeLeaveTypeForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 EmployeeLeaveType employeeLeaveType,
 String idempotencyKey)
                                                                               throws IOException

Creates employee leave type records

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

employeeLeaveType - The employeeLeaveType parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createEmployeeOpeningBalances

public EmployeeOpeningBalancesObject createEmployeeOpeningBalances(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 EmployeeOpeningBalances employeeOpeningBalances,
 String idempotencyKey)
                                                            throws IOException

Creates an opening balance for a specific employee

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

employeeOpeningBalances - The employeeOpeningBalances parameter

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

Returns:

EmployeeOpeningBalancesObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createEmployeeOpeningBalancesForHttpResponse

public com.google.api.client.http.HttpResponse createEmployeeOpeningBalancesForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 EmployeeOpeningBalances employeeOpeningBalances,
 String idempotencyKey)
                                                                                     throws IOException

Creates an opening balance for a specific employee

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

employeeOpeningBalances - The employeeOpeningBalances parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createEmployeePaymentMethod

public PaymentMethodObject createEmployeePaymentMethod(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 PaymentMethod paymentMethod,
 String idempotencyKey)
                                                throws IOException

Creates an employee payment method

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

paymentMethod - The paymentMethod parameter

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

Returns:

PaymentMethodObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createEmployeePaymentMethodForHttpResponse

public com.google.api.client.http.HttpResponse createEmployeePaymentMethodForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 PaymentMethod paymentMethod,
 String idempotencyKey)
                                                                                   throws IOException

Creates an employee payment method

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

paymentMethod - The paymentMethod parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createEmployeeSalaryAndWage

public SalaryAndWageObject createEmployeeSalaryAndWage(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 SalaryAndWage salaryAndWage,
 String idempotencyKey)
                                                throws IOException

Creates a salary and wage record for a specific employee

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

salaryAndWage - The salaryAndWage parameter

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

Returns:

SalaryAndWageObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createEmployeeSalaryAndWageForHttpResponse

public com.google.api.client.http.HttpResponse createEmployeeSalaryAndWageForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 SalaryAndWage salaryAndWage,
 String idempotencyKey)
                                                                                   throws IOException

Creates a salary and wage record for a specific employee

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

salaryAndWage - The salaryAndWage parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createEmployeeStatutorySickLeave

public EmployeeStatutorySickLeaveObject createEmployeeStatutorySickLeave(String accessToken,
 String xeroTenantId,
 EmployeeStatutorySickLeave employeeStatutorySickLeave,
 String idempotencyKey)
                                                                  throws IOException

Creates statutory sick leave records

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeStatutorySickLeave - The employeeStatutorySickLeave parameter

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

Returns:

EmployeeStatutorySickLeaveObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createEmployeeStatutorySickLeaveForHttpResponse

public com.google.api.client.http.HttpResponse createEmployeeStatutorySickLeaveForHttpResponse(String accessToken,
 String xeroTenantId,
 EmployeeStatutorySickLeave employeeStatutorySickLeave,
 String idempotencyKey)
                                                                                        throws IOException

Creates statutory sick leave records

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeStatutorySickLeave - The employeeStatutorySickLeave parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createEmployment

public EmploymentObject createEmployment(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 Employment employment,
 String idempotencyKey)
                                  throws IOException

Creates employment detail for a specific employee using a unique employee ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

employment - The employment parameter

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

Returns:

EmploymentObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createEmploymentForHttpResponse

public com.google.api.client.http.HttpResponse createEmploymentForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 Employment employment,
 String idempotencyKey)
                                                                        throws IOException

Creates employment detail for a specific employee using a unique employee ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

employment - The employment parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createLeaveType

public LeaveTypeObject createLeaveType(String accessToken,
 String xeroTenantId,
 LeaveType leaveType,
 String idempotencyKey)
                                throws IOException

Creates a new leave type

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

leaveType - The leaveType parameter

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

Returns:

LeaveTypeObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createLeaveTypeForHttpResponse

public com.google.api.client.http.HttpResponse createLeaveTypeForHttpResponse(String accessToken,
 String xeroTenantId,
 LeaveType leaveType,
 String idempotencyKey)
                                                                       throws IOException

Creates a new leave type

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

leaveType - The leaveType parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createMultipleEmployeeEarningsTemplate

public EmployeePayTemplates createMultipleEmployeeEarningsTemplate(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 List<EarningsTemplate> earningsTemplate,
 String idempotencyKey)
                                                            throws IOException

Creates multiple earnings template records for a specific employee using a unique employee ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

earningsTemplate - The earningsTemplate parameter

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

Returns:

EmployeePayTemplates

Throws:

IOException - if an error occurs while attempting to invoke the API *

createMultipleEmployeeEarningsTemplateForHttpResponse

public com.google.api.client.http.HttpResponse createMultipleEmployeeEarningsTemplateForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 List<EarningsTemplate> earningsTemplate,
 String idempotencyKey)
                                                                                              throws IOException

Creates multiple earnings template records for a specific employee using a unique employee ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

earningsTemplate - The earningsTemplate parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createPayRunCalendar

public PayRunCalendarObject createPayRunCalendar(String accessToken,
 String xeroTenantId,
 PayRunCalendar payRunCalendar,
 String idempotencyKey)
                                          throws IOException

Creates a new payrun calendar

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payRunCalendar - The payRunCalendar parameter

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

Returns:

PayRunCalendarObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createPayRunCalendarForHttpResponse

public com.google.api.client.http.HttpResponse createPayRunCalendarForHttpResponse(String accessToken,
 String xeroTenantId,
 PayRunCalendar payRunCalendar,
 String idempotencyKey)
                                                                            throws IOException

Creates a new payrun calendar

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payRunCalendar - The payRunCalendar parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createReimbursement

public ReimbursementObject createReimbursement(String accessToken,
 String xeroTenantId,
 Reimbursement reimbursement,
 String idempotencyKey)
                                        throws IOException

Creates a new reimbursement

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

reimbursement - The reimbursement parameter

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

Returns:

ReimbursementObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createReimbursementForHttpResponse

public com.google.api.client.http.HttpResponse createReimbursementForHttpResponse(String accessToken,
 String xeroTenantId,
 Reimbursement reimbursement,
 String idempotencyKey)
                                                                           throws IOException

Creates a new reimbursement

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

reimbursement - The reimbursement parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createTimesheet

public TimesheetObject createTimesheet(String accessToken,
 String xeroTenantId,
 Timesheet timesheet,
 String idempotencyKey)
                                throws IOException

Creates a new timesheet

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheet - The timesheet parameter

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

Returns:

TimesheetObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createTimesheetForHttpResponse

public com.google.api.client.http.HttpResponse createTimesheetForHttpResponse(String accessToken,
 String xeroTenantId,
 Timesheet timesheet,
 String idempotencyKey)
                                                                       throws IOException

Creates a new timesheet

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheet - The timesheet parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createTimesheetLine

public TimesheetLineObject createTimesheetLine(String accessToken,
 String xeroTenantId,
 UUID timesheetID,
 TimesheetLine timesheetLine,
 String idempotencyKey)
                                        throws IOException

Creates a new timesheet line for a specific timesheet using a unique timesheet ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheetID - Identifier for the timesheet

timesheetLine - The timesheetLine parameter

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

Returns:

TimesheetLineObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

createTimesheetLineForHttpResponse

public com.google.api.client.http.HttpResponse createTimesheetLineForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID timesheetID,
 TimesheetLine timesheetLine,
 String idempotencyKey)
                                                                           throws IOException

Creates a new timesheet line for a specific timesheet using a unique timesheet ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheetID - Identifier for the timesheet

timesheetLine - The timesheetLine parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteEmployeeEarningsTemplate

public void deleteEmployeeEarningsTemplate(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID payTemplateEarningID)
                                    throws IOException

Deletes a specific employee's earnings template record

200 - deletion successful

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

payTemplateEarningID - Id for single pay template earnings object

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteEmployeeEarningsTemplateForHttpResponse

public com.google.api.client.http.HttpResponse deleteEmployeeEarningsTemplateForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID payTemplateEarningID)
                                                                                      throws IOException

Deletes a specific employee's earnings template record

200 - deletion successful

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

payTemplateEarningID - Id for single pay template earnings object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteEmployeeLeave

public EmployeeLeaveObject deleteEmployeeLeave(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID leaveID)
                                        throws IOException

Deletes a specific employee's leave record

200 - successful response

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

leaveID - Leave id for single object

Returns:

EmployeeLeaveObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteEmployeeLeaveForHttpResponse

public com.google.api.client.http.HttpResponse deleteEmployeeLeaveForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID leaveID)
                                                                           throws IOException

Deletes a specific employee's leave record

200 - successful response

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

leaveID - Leave id for single object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteEmployeeSalaryAndWage

public void deleteEmployeeSalaryAndWage(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID salaryAndWagesID)
                                 throws IOException

Deletes a salary and wages record for a specific employee

200 - deletion successful

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

salaryAndWagesID - Id for single salary and wages object

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteEmployeeSalaryAndWageForHttpResponse

public com.google.api.client.http.HttpResponse deleteEmployeeSalaryAndWageForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID salaryAndWagesID)
                                                                                   throws IOException

Deletes a salary and wages record for a specific employee

200 - deletion successful

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

salaryAndWagesID - Id for single salary and wages object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteTimesheet

public TimesheetLine deleteTimesheet(String accessToken,
 String xeroTenantId,
 UUID timesheetID)
                              throws IOException

Deletes a specific timesheet

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheetID - Identifier for the timesheet

Returns:

TimesheetLine

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteTimesheetForHttpResponse

public com.google.api.client.http.HttpResponse deleteTimesheetForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID timesheetID)
                                                                       throws IOException

Deletes a specific timesheet

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheetID - Identifier for the timesheet

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteTimesheetLine

public TimesheetLine deleteTimesheetLine(String accessToken,
 String xeroTenantId,
 UUID timesheetID,
 UUID timesheetLineID)
                                  throws IOException

Deletes a specific timesheet line

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheetID - Identifier for the timesheet

timesheetLineID - Identifier for the timesheet line

Returns:

TimesheetLine

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteTimesheetLineForHttpResponse

public com.google.api.client.http.HttpResponse deleteTimesheetLineForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID timesheetID,
 UUID timesheetLineID)
                                                                           throws IOException

Deletes a specific timesheet line

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheetID - Identifier for the timesheet

timesheetLineID - Identifier for the timesheet line

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBenefit

public BenefitObject getBenefit(String accessToken,
 String xeroTenantId,
 UUID id)
                         throws IOException

Retrieves a specific benefit by using a unique benefit ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

id - Identifier for the benefit

Returns:

BenefitObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBenefitForHttpResponse

public com.google.api.client.http.HttpResponse getBenefitForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID id)
                                                                  throws IOException

Retrieves a specific benefit by using a unique benefit ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

id - Identifier for the benefit

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBenefits

public Benefits getBenefits(String accessToken,
 String xeroTenantId,
 Integer page)
                     throws IOException

Retrieves employee benefits

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

Benefits

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBenefitsForHttpResponse

public com.google.api.client.http.HttpResponse getBenefitsForHttpResponse(String accessToken,
 String xeroTenantId,
 Integer page)
                                                                   throws IOException

Retrieves employee benefits

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getDeduction

public DeductionObject getDeduction(String accessToken,
 String xeroTenantId,
 UUID deductionId)
                             throws IOException

Retrieves a specific deduction by using a unique deduction ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

deductionId - Identifier for the deduction

Returns:

DeductionObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getDeductionForHttpResponse

public com.google.api.client.http.HttpResponse getDeductionForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID deductionId)
                                                                    throws IOException

Retrieves a specific deduction by using a unique deduction ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

deductionId - Identifier for the deduction

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getDeductions

public Deductions getDeductions(String accessToken,
 String xeroTenantId,
 Integer page)
                         throws IOException

Retrieves deductions

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

Deductions

Throws:

IOException - if an error occurs while attempting to invoke the API *

getDeductionsForHttpResponse

public com.google.api.client.http.HttpResponse getDeductionsForHttpResponse(String accessToken,
 String xeroTenantId,
 Integer page)
                                                                     throws IOException

Retrieves deductions

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEarningsOrder

public EarningsOrderObject getEarningsOrder(String accessToken,
 String xeroTenantId,
 UUID id)
                                     throws IOException

Retrieves a specific earnings orders by using a unique earnings orders id

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

id - Identifier for the deduction

Returns:

EarningsOrderObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEarningsOrderForHttpResponse

public com.google.api.client.http.HttpResponse getEarningsOrderForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID id)
                                                                        throws IOException

Retrieves a specific earnings orders by using a unique earnings orders id

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

id - Identifier for the deduction

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEarningsOrders

public EarningsOrders getEarningsOrders(String accessToken,
 String xeroTenantId,
 Integer page)
                                 throws IOException

Retrieves earnings orders

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

EarningsOrders

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEarningsOrdersForHttpResponse

public com.google.api.client.http.HttpResponse getEarningsOrdersForHttpResponse(String accessToken,
 String xeroTenantId,
 Integer page)
                                                                         throws IOException

Retrieves earnings orders

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEarningsRate

public EarningsRateObject getEarningsRate(String accessToken,
 String xeroTenantId,
 UUID earningsRateID)
                                   throws IOException

Retrieves a specific earnings rates by using a unique earnings rate id

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

earningsRateID - Identifier for the earnings rate

Returns:

EarningsRateObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEarningsRateForHttpResponse

public com.google.api.client.http.HttpResponse getEarningsRateForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID earningsRateID)
                                                                       throws IOException

Retrieves a specific earnings rates by using a unique earnings rate id

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

earningsRateID - Identifier for the earnings rate

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEarningsRates

public EarningsRates getEarningsRates(String accessToken,
 String xeroTenantId,
 Integer page)
                               throws IOException

Retrieves earnings rates

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

EarningsRates

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEarningsRatesForHttpResponse

public com.google.api.client.http.HttpResponse getEarningsRatesForHttpResponse(String accessToken,
 String xeroTenantId,
 Integer page)
                                                                        throws IOException

Retrieves earnings rates

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployee

public EmployeeObject getEmployee(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                           throws IOException

Retrieves specific employees by using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

EmployeeObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeeForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeeForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                                                   throws IOException

Retrieves specific employees by using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployeeLeave

public EmployeeLeaveObject getEmployeeLeave(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID leaveID)
                                     throws IOException

Retrieves a specific employee's leave record using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

leaveID - Leave id for single object

Returns:

EmployeeLeaveObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeeLeaveForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeeLeaveForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID leaveID)
                                                                        throws IOException

Retrieves a specific employee's leave record using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

leaveID - Leave id for single object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployeeLeaveBalances

public EmployeeLeaveBalances getEmployeeLeaveBalances(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                               throws IOException

Retrieves a specific employee's leave balances using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

EmployeeLeaveBalances

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeeLeaveBalancesForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeeLeaveBalancesForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                                                                throws IOException

Retrieves a specific employee's leave balances using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployeeLeavePeriods

public LeavePeriods getEmployeeLeavePeriods(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 org.threeten.bp.LocalDate startDate,
 org.threeten.bp.LocalDate endDate)
                                     throws IOException

Retrieves a specific employee's leave periods using a unique employee ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

startDate - Filter by start date

endDate - Filter by end date

Returns:

LeavePeriods

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeeLeavePeriodsForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeeLeavePeriodsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 org.threeten.bp.LocalDate startDate,
 org.threeten.bp.LocalDate endDate)
                                                                               throws IOException

Retrieves a specific employee's leave periods using a unique employee ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

startDate - Filter by start date

endDate - Filter by end date

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployeeLeaveTypes

public EmployeeLeaveTypes getEmployeeLeaveTypes(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                         throws IOException

Retrieves a specific employee's leave types using a unique employee ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

EmployeeLeaveTypes

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeeLeaveTypesForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeeLeaveTypesForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                                                             throws IOException

Retrieves a specific employee's leave types using a unique employee ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployeeLeaves

public EmployeeLeaves getEmployeeLeaves(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                 throws IOException

Retrieves a specific employee's leave records using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

EmployeeLeaves

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeeLeavesForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeeLeavesForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                                                         throws IOException

Retrieves a specific employee's leave records using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployeeOpeningBalances

public EmployeeOpeningBalancesObject getEmployeeOpeningBalances(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                                         throws IOException

Retrieves a specific employee's openingbalances using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

EmployeeOpeningBalancesObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeeOpeningBalancesForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeeOpeningBalancesForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                                                                  throws IOException

Retrieves a specific employee's openingbalances using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployeePayTemplate

public EmployeePayTemplateObject getEmployeePayTemplate(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                                 throws IOException

Retrieves a specific employee pay templates using a unique employee ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

EmployeePayTemplateObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeePayTemplateForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeePayTemplateForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                                                              throws IOException

Retrieves a specific employee pay templates using a unique employee ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployeePaymentMethod

public PaymentMethodObject getEmployeePaymentMethod(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                             throws IOException

Retrieves a specific employee's payment method using a unique employee ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

PaymentMethodObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeePaymentMethodForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeePaymentMethodForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                                                                throws IOException

Retrieves a specific employee's payment method using a unique employee ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployeeSalaryAndWage

public SalaryAndWages getEmployeeSalaryAndWage(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID salaryAndWagesID)
                                        throws IOException

Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

salaryAndWagesID - Id for single pay template earnings object

Returns:

SalaryAndWages

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeeSalaryAndWageForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeeSalaryAndWageForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID salaryAndWagesID)
                                                                                throws IOException

Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

salaryAndWagesID - Id for single pay template earnings object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployeeSalaryAndWages

public SalaryAndWages getEmployeeSalaryAndWages(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 Integer page)
                                         throws IOException

Retrieves a specific employee's salary and wages by using a unique employee ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

SalaryAndWages

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeeSalaryAndWagesForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeeSalaryAndWagesForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 Integer page)
                                                                                 throws IOException

Retrieves a specific employee's salary and wages by using a unique employee ID

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployeeStatutoryLeaveBalances

public EmployeeStatutoryLeaveBalanceObject getEmployeeStatutoryLeaveBalances(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 String leaveType,
 org.threeten.bp.LocalDate asOfDate)
                                                                      throws IOException

Retrieves a specific employee's leave balances using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

leaveType - Filter by the type of statutory leave

asOfDate - The date from which to calculate balance remaining. If not specified, current date UTC is used.

Returns:

EmployeeStatutoryLeaveBalanceObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeeStatutoryLeaveBalancesForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeeStatutoryLeaveBalancesForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 String leaveType,
 org.threeten.bp.LocalDate asOfDate)
                                                                                         throws IOException

Retrieves a specific employee's leave balances using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

leaveType - Filter by the type of statutory leave

asOfDate - The date from which to calculate balance remaining. If not specified, current date UTC is used.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployeeStatutorySickLeave

public EmployeeStatutorySickLeaveObject getEmployeeStatutorySickLeave(String accessToken,
 String xeroTenantId,
 UUID statutorySickLeaveID)
                                                               throws IOException

Retrieves a statutory sick leave for an employee

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

statutorySickLeaveID - Statutory sick leave id for single object

Returns:

EmployeeStatutorySickLeaveObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeeStatutorySickLeaveForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeeStatutorySickLeaveForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID statutorySickLeaveID)
                                                                                     throws IOException

Retrieves a statutory sick leave for an employee

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

statutorySickLeaveID - Statutory sick leave id for single object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployeeTax

public EmployeeTaxObject getEmployeeTax(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                 throws IOException

Retrieves tax records for a specific employee using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

EmployeeTaxObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeeTaxForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeeTaxForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                                                      throws IOException

Retrieves tax records for a specific employee using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployees

public Employees getEmployees(String accessToken,
 String xeroTenantId,
 String filter,
 Integer page)
                       throws IOException

Retrieves employees

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

filter - Filter by first name, lastname, and/or whether they are an off-payroll worker

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

Employees

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeesForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeesForHttpResponse(String accessToken,
 String xeroTenantId,
 String filter,
 Integer page)
                                                                    throws IOException

Retrieves employees

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

filter - Filter by first name, lastname, and/or whether they are an off-payroll worker

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getLeaveType

public LeaveTypeObject getLeaveType(String accessToken,
 String xeroTenantId,
 UUID leaveTypeID)
                             throws IOException

Retrieves a specific leave type by using a unique leave type ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

leaveTypeID - Identifier for the leave type

Returns:

LeaveTypeObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getLeaveTypeForHttpResponse

public com.google.api.client.http.HttpResponse getLeaveTypeForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID leaveTypeID)
                                                                    throws IOException

Retrieves a specific leave type by using a unique leave type ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

leaveTypeID - Identifier for the leave type

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getLeaveTypes

public LeaveTypes getLeaveTypes(String accessToken,
 String xeroTenantId,
 Integer page,
 Boolean activeOnly)
                         throws IOException

Retrieves leave types

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

activeOnly - Filters leave types by active status. By default the API returns all leave types.

Returns:

LeaveTypes

Throws:

IOException - if an error occurs while attempting to invoke the API *

getLeaveTypesForHttpResponse

public com.google.api.client.http.HttpResponse getLeaveTypesForHttpResponse(String accessToken,
 String xeroTenantId,
 Integer page,
 Boolean activeOnly)
                                                                     throws IOException

Retrieves leave types

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

activeOnly - Filters leave types by active status. By default the API returns all leave types.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPayRun

public PayRunObject getPayRun(String accessToken,
 String xeroTenantId,
 UUID payRunID)
                       throws IOException

Retrieves a specific pay run by using a unique pay run ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payRunID - Identifier for the pay run

Returns:

PayRunObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPayRunForHttpResponse

public com.google.api.client.http.HttpResponse getPayRunForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID payRunID)
                                                                 throws IOException

Retrieves a specific pay run by using a unique pay run ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payRunID - Identifier for the pay run

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPayRunCalendar

public PayRunCalendarObject getPayRunCalendar(String accessToken,
 String xeroTenantId,
 UUID payRunCalendarID)
                                       throws IOException

Retrieves a specific payrun calendar by using a unique payrun calendar ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payRunCalendarID - Identifier for the payrun calendars

Returns:

PayRunCalendarObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPayRunCalendarForHttpResponse

public com.google.api.client.http.HttpResponse getPayRunCalendarForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID payRunCalendarID)
                                                                         throws IOException

Retrieves a specific payrun calendar by using a unique payrun calendar ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payRunCalendarID - Identifier for the payrun calendars

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPayRunCalendars

public PayRunCalendars getPayRunCalendars(String accessToken,
 String xeroTenantId,
 Integer page)
                                   throws IOException

Retrieves payrun calendars

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

PayRunCalendars

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPayRunCalendarsForHttpResponse

public com.google.api.client.http.HttpResponse getPayRunCalendarsForHttpResponse(String accessToken,
 String xeroTenantId,
 Integer page)
                                                                          throws IOException

Retrieves payrun calendars

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPayRuns

public PayRuns getPayRuns(String accessToken,
 String xeroTenantId,
 Integer page,
 String status)
                   throws IOException

Retrieves pay runs

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

status - By default get payruns will return all the payruns for an organization. You can add GET https://api.xero.com/payroll.xro/2.0/payRuns?statu={PayRunStatus} to filter the payruns by status.

Returns:

PayRuns

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPayRunsForHttpResponse

public com.google.api.client.http.HttpResponse getPayRunsForHttpResponse(String accessToken,
 String xeroTenantId,
 Integer page,
 String status)
                                                                  throws IOException

Retrieves pay runs

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

status - By default get payruns will return all the payruns for an organization. You can add GET https://api.xero.com/payroll.xro/2.0/payRuns?statu={PayRunStatus} to filter the payruns by status.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPaySlip

public PayslipObject getPaySlip(String accessToken,
 String xeroTenantId,
 UUID payslipID)
                         throws IOException

Retrieves a specific payslip by using a unique payslip ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payslipID - Identifier for the payslip

Returns:

PayslipObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPaySlipForHttpResponse

public com.google.api.client.http.HttpResponse getPaySlipForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID payslipID)
                                                                  throws IOException

Retrieves a specific payslip by using a unique payslip ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payslipID - Identifier for the payslip

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPaySlips

public Payslips getPaySlips(String accessToken,
 String xeroTenantId,
 UUID payRunID,
 Integer page)
                     throws IOException

Retrieves payslips

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payRunID - PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun.

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

Payslips

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPaySlipsForHttpResponse

public com.google.api.client.http.HttpResponse getPaySlipsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID payRunID,
 Integer page)
                                                                   throws IOException

Retrieves payslips

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payRunID - PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun.

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReimbursement

public ReimbursementObject getReimbursement(String accessToken,
 String xeroTenantId,
 UUID reimbursementID)
                                     throws IOException

Retrieves a specific reimbursement by using a unique reimbursement id

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

reimbursementID - Identifier for the reimbursement

Returns:

ReimbursementObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReimbursementForHttpResponse

public com.google.api.client.http.HttpResponse getReimbursementForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID reimbursementID)
                                                                        throws IOException

Retrieves a specific reimbursement by using a unique reimbursement id

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

reimbursementID - Identifier for the reimbursement

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReimbursements

public Reimbursements getReimbursements(String accessToken,
 String xeroTenantId,
 Integer page)
                                 throws IOException

Retrieves reimbursements

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

Reimbursements

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReimbursementsForHttpResponse

public com.google.api.client.http.HttpResponse getReimbursementsForHttpResponse(String accessToken,
 String xeroTenantId,
 Integer page)
                                                                         throws IOException

Retrieves reimbursements

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getSettings

public Settings getSettings(String accessToken,
 String xeroTenantId)
                     throws IOException

Retrieves payroll settings

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

Settings

Throws:

IOException - if an error occurs while attempting to invoke the API *

getSettingsForHttpResponse

public com.google.api.client.http.HttpResponse getSettingsForHttpResponse(String accessToken,
 String xeroTenantId)
                                                                   throws IOException

Retrieves payroll settings

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getStatutoryLeaveSummary

public EmployeeStatutoryLeavesSummaries getStatutoryLeaveSummary(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 Boolean activeOnly)
                                                          throws IOException

Retrieves a specific employee's summary of statutory leaves using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

activeOnly - Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future scheduled) are returned

Returns:

EmployeeStatutoryLeavesSummaries

Throws:

IOException - if an error occurs while attempting to invoke the API *

getStatutoryLeaveSummaryForHttpResponse

public com.google.api.client.http.HttpResponse getStatutoryLeaveSummaryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 Boolean activeOnly)
                                                                                throws IOException

Retrieves a specific employee's summary of statutory leaves using a unique employee ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

activeOnly - Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future scheduled) are returned

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getTimesheet

public TimesheetObject getTimesheet(String accessToken,
 String xeroTenantId,
 UUID timesheetID)
                             throws IOException

Retrieve a specific timesheet by using a unique timesheet ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheetID - Identifier for the timesheet

Returns:

TimesheetObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

getTimesheetForHttpResponse

public com.google.api.client.http.HttpResponse getTimesheetForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID timesheetID)
                                                                    throws IOException

Retrieve a specific timesheet by using a unique timesheet ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheetID - Identifier for the timesheet

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getTimesheets

public Timesheets getTimesheets(String accessToken,
 String xeroTenantId,
 Integer page,
 String filter,
 String status,
 String startDate,
 String endDate,
 String sort)
                         throws IOException

Retrieves timesheets

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

filter - Filter by employeeId and/or payrollCalendarId

status - filter results by any timesheets with a matching timesheet status

startDate - filter results by any timesheets with a startDate on or after the provided date

endDate - filter results by any timesheets with a endDate on or before the provided date

sort - sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest.

Returns:

Timesheets

Throws:

IOException - if an error occurs while attempting to invoke the API *

getTimesheetsForHttpResponse

public com.google.api.client.http.HttpResponse getTimesheetsForHttpResponse(String accessToken,
 String xeroTenantId,
 Integer page,
 String filter,
 String status,
 String startDate,
 String endDate,
 String sort)
                                                                     throws IOException

Retrieves timesheets

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

filter - Filter by employeeId and/or payrollCalendarId

status - filter results by any timesheets with a matching timesheet status

startDate - filter results by any timesheets with a startDate on or after the provided date

endDate - filter results by any timesheets with a endDate on or before the provided date

sort - sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getTrackingCategories

public TrackingCategories getTrackingCategories(String accessToken,
 String xeroTenantId)
                                         throws IOException

Retrieves tracking categories

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

TrackingCategories

Throws:

IOException - if an error occurs while attempting to invoke the API *

getTrackingCategoriesForHttpResponse

public com.google.api.client.http.HttpResponse getTrackingCategoriesForHttpResponse(String accessToken,
 String xeroTenantId)
                                                                             throws IOException

Retrieves tracking categories

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

revertTimesheet

public TimesheetObject revertTimesheet(String accessToken,
 String xeroTenantId,
 UUID timesheetID,
 String idempotencyKey)
                                throws IOException

Reverts a specific timesheet to draft

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheetID - Identifier for the timesheet

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

Returns:

TimesheetObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

revertTimesheetForHttpResponse

public com.google.api.client.http.HttpResponse revertTimesheetForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID timesheetID,
 String idempotencyKey)
                                                                       throws IOException

Reverts a specific timesheet to draft

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheetID - Identifier for the timesheet

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateEmployee

public EmployeeObject updateEmployee(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 Employee employee,
 String idempotencyKey)
                              throws IOException

Updates a specific employee's detail

200 - successful response

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

employee - The employee parameter

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

Returns:

EmployeeObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateEmployeeForHttpResponse

public com.google.api.client.http.HttpResponse updateEmployeeForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 Employee employee,
 String idempotencyKey)
                                                                      throws IOException

Updates a specific employee's detail

200 - successful response

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

employee - The employee parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateEmployeeEarningsTemplate

public EarningsTemplateObject updateEmployeeEarningsTemplate(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID payTemplateEarningID,
 EarningsTemplate earningsTemplate,
 String idempotencyKey)
                                                      throws IOException

Updates a specific employee's earnings template records

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

payTemplateEarningID - Id for single pay template earnings object

earningsTemplate - The earningsTemplate parameter

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

Returns:

EarningsTemplateObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateEmployeeEarningsTemplateForHttpResponse

public com.google.api.client.http.HttpResponse updateEmployeeEarningsTemplateForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID payTemplateEarningID,
 EarningsTemplate earningsTemplate,
 String idempotencyKey)
                                                                                      throws IOException

Updates a specific employee's earnings template records

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

payTemplateEarningID - Id for single pay template earnings object

earningsTemplate - The earningsTemplate parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateEmployeeLeave

public EmployeeLeaveObject updateEmployeeLeave(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID leaveID,
 EmployeeLeave employeeLeave,
 String idempotencyKey)
                                        throws IOException

Updates a specific employee's leave records

200 - successful response

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

leaveID - Leave id for single object

employeeLeave - The employeeLeave parameter

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

Returns:

EmployeeLeaveObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateEmployeeLeaveForHttpResponse

public com.google.api.client.http.HttpResponse updateEmployeeLeaveForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID leaveID,
 EmployeeLeave employeeLeave,
 String idempotencyKey)
                                                                           throws IOException

Updates a specific employee's leave records

200 - successful response

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

leaveID - Leave id for single object

employeeLeave - The employeeLeave parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateEmployeeOpeningBalances

public EmployeeOpeningBalancesObject updateEmployeeOpeningBalances(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 EmployeeOpeningBalances employeeOpeningBalances,
 String idempotencyKey)
                                                            throws IOException

Updates a specific employee's opening balances

200 - successful response

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

employeeOpeningBalances - The employeeOpeningBalances parameter

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

Returns:

EmployeeOpeningBalancesObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateEmployeeOpeningBalancesForHttpResponse

public com.google.api.client.http.HttpResponse updateEmployeeOpeningBalancesForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 EmployeeOpeningBalances employeeOpeningBalances,
 String idempotencyKey)
                                                                                     throws IOException

Updates a specific employee's opening balances

200 - successful response

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

employeeOpeningBalances - The employeeOpeningBalances parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateEmployeeSalaryAndWage

public SalaryAndWageObject updateEmployeeSalaryAndWage(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID salaryAndWagesID,
 SalaryAndWage salaryAndWage,
 String idempotencyKey)
                                                throws IOException

Updates salary and wages record for a specific employee

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

salaryAndWagesID - Id for single pay template earnings object

salaryAndWage - The salaryAndWage parameter

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

Returns:

SalaryAndWageObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateEmployeeSalaryAndWageForHttpResponse

public com.google.api.client.http.HttpResponse updateEmployeeSalaryAndWageForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID,
 UUID salaryAndWagesID,
 SalaryAndWage salaryAndWage,
 String idempotencyKey)
                                                                                   throws IOException

Updates salary and wages record for a specific employee

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

salaryAndWagesID - Id for single pay template earnings object

salaryAndWage - The salaryAndWage parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updatePayRun

public PayRunObject updatePayRun(String accessToken,
 String xeroTenantId,
 UUID payRunID,
 PayRun payRun,
 String idempotencyKey)
                          throws IOException

Updates a specific pay run

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payRunID - Identifier for the pay run

payRun - The payRun parameter

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

Returns:

PayRunObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

updatePayRunForHttpResponse

public com.google.api.client.http.HttpResponse updatePayRunForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID payRunID,
 PayRun payRun,
 String idempotencyKey)
                                                                    throws IOException

Updates a specific pay run

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payRunID - Identifier for the pay run

payRun - The payRun parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateTimesheetLine

public TimesheetLineObject updateTimesheetLine(String accessToken,
 String xeroTenantId,
 UUID timesheetID,
 UUID timesheetLineID,
 TimesheetLine timesheetLine,
 String idempotencyKey)
                                        throws IOException

Updates a specific timesheet line for a specific timesheet

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheetID - Identifier for the timesheet

timesheetLineID - Identifier for the timesheet line

timesheetLine - The timesheetLine parameter

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

Returns:

TimesheetLineObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateTimesheetLineForHttpResponse

public com.google.api.client.http.HttpResponse updateTimesheetLineForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID timesheetID,
 UUID timesheetLineID,
 TimesheetLine timesheetLine,
 String idempotencyKey)
                                                                           throws IOException

Updates a specific timesheet line for a specific timesheet

200 - search results matching criteria

400 - validation error for a bad request

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

timesheetID - Identifier for the timesheet

timesheetLineID - Identifier for the timesheet line

timesheetLine - The timesheetLine parameter

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

convertInputToByteArray

public ByteArrayInputStream convertInputToByteArray(InputStream is)
                                             throws IOException

convert intput to byte array

Parameters:

is - InputStream the server status code returned

Returns:

byteArrayInputStream a ByteArrayInputStream

Throws:

IOException - for failed or interrupted I/O operations