com.xero.api.client.PayrollUkApi

public class PayrollUkApi
extends Object

Constructor Summary

Constructors

Constructor Description

PayrollUkApi()

PayrollUkApi(ApiClient apiClient)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details
- PayrollUkApi
  
  public PayrollUkApi()
- PayrollUkApi
  
  public PayrollUkApi(ApiClient apiClient)
Method Details
- getInstance
  
  public static PayrollUkApi getInstance(ApiClient apiClient)
- getApiClient
  
  public ApiClient getApiClient()
- setApiClient
  
  public void setApiClient(ApiClient apiClient)
- setUserAgent
  
  public void setUserAgent(String userAgent)
- getUserAgent
  
  public String getUserAgent()
- approveTimesheet
  
  public TimesheetObject approveTimesheet(String accessToken, String xeroTenantId, UUID timesheetID) throws IOException
  
  approve a timesheet
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  timesheetID - Identifier for the timesheet
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createBenefit
  
  public BenefitObject createBenefit(String accessToken, String xeroTenantId, Benefit benefit) throws IOException
  
  create a new benefit
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  benefit - The benefit parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createDeduction
  
  public DeductionObject createDeduction(String accessToken, String xeroTenantId, Deduction deduction) throws IOException
  
  create a new deduction
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  deduction - The deduction parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createEarningsRate
  
  public EarningsRateObject createEarningsRate(String accessToken, String xeroTenantId, EarningsRate earningsRate) throws IOException
  
  create a new earnings rate
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  earningsRate - The earningsRate parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createEmployee
  
  public EmployeeObject createEmployee(String accessToken, String xeroTenantId, Employee employee) throws IOException
  
  creates employees
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employee - The employee parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createEmployeeEarningsTemplate
  
  public EarningsTemplateObject createEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeId, EarningsTemplate earningsTemplate) throws IOException
  
  creates employee earnings template records
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  earningsTemplate - The earningsTemplate parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createEmployeeLeave
  
  public EmployeeLeaveObject createEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeId, EmployeeLeave employeeLeave) throws IOException
  
  creates employee leave records
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  employeeLeave - The employeeLeave parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createEmployeeLeaveType
  
  public EmployeeLeaveTypeObject createEmployeeLeaveType(String accessToken, String xeroTenantId, UUID employeeId, EmployeeLeaveType employeeLeaveType) throws IOException
  
  creates employee leave type records
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  employeeLeaveType - The employeeLeaveType parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createEmployeeOpeningBalances
  
  public EmployeeOpeningBalancesObject createEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeId, EmployeeOpeningBalances employeeOpeningBalances) throws IOException
  
  creates employee opening balances
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  employeeOpeningBalances - The employeeOpeningBalances parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createEmployeePaymentMethod
  
  public PaymentMethodObject createEmployeePaymentMethod(String accessToken, String xeroTenantId, UUID employeeId, PaymentMethod paymentMethod) throws IOException
  
  creates employee payment method
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  paymentMethod - The paymentMethod parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createEmployeeSalaryAndWage
  
  public SalaryAndWageObject createEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeId, SalaryAndWage salaryAndWage) throws IOException
  
  creates employee salary and wage record
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  salaryAndWage - The salaryAndWage parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createEmployeeStatutorySickLeave
  
  public EmployeeStatutorySickLeaveObject createEmployeeStatutorySickLeave(String accessToken, String xeroTenantId, EmployeeStatutorySickLeave employeeStatutorySickLeave) throws IOException
  
  creates employee statutory sick leave records
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeStatutorySickLeave - The employeeStatutorySickLeave parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createEmployment
  
  public EmploymentObject createEmployment(String accessToken, String xeroTenantId, UUID employeeId, Employment employment) throws IOException
  
  creates employment
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  employment - The employment parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createLeaveType
  
  public LeaveTypeObject createLeaveType(String accessToken, String xeroTenantId, LeaveType leaveType) throws IOException
  
  create a new leave type
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  leaveType - The leaveType parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createMultipleEmployeeEarningsTemplate
  
  public EmployeePayTemplates createMultipleEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeId, List<EarningsTemplate> earningsTemplate) throws IOException
  
  creates multiple employee earnings template records
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  earningsTemplate - The earningsTemplate parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createPayRunCalendar
  
  public PayRunCalendarObject createPayRunCalendar(String accessToken, String xeroTenantId, PayRunCalendar payRunCalendar) throws IOException
  
  create a new payrun calendar
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  payRunCalendar - The payRunCalendar parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createReimbursement
  
  public ReimbursementObject createReimbursement(String accessToken, String xeroTenantId, Reimbursement reimbursement) throws IOException
  
  create a new reimbursement
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  reimbursement - The reimbursement parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createTimesheet
  
  public TimesheetObject createTimesheet(String accessToken, String xeroTenantId, Timesheet timesheet) throws IOException
  
  create a new timesheet
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  timesheet - The timesheet parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- createTimesheetLine
  
  public TimesheetLineObject createTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, TimesheetLine timesheetLine) throws IOException
  
  create a new timesheet line
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  timesheetID - Identifier for the timesheet
  
  timesheetLine - The timesheetLine parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- deleteEmployeeEarningsTemplate
  
  public void deleteEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeId, UUID payTemplateEarningID) throws IOException
  
  deletes an employee earnings template record
  200 - deletion successful
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  payTemplateEarningID - Id for single pay template earnings object
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- deleteEmployeeLeave
  
  public EmployeeLeaveObject deleteEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeId, UUID leaveID) throws IOException
  
  deletes an employee leave record
  200 - successful response
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  leaveID - Leave id for single object
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- deleteEmployeeSalaryAndWage
  
  public void deleteEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeId, UUID salaryAndWagesID) throws IOException
  
  deletes an employee salary and wages record
  200 - deletion successful
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  salaryAndWagesID - Id for single salary and wages object
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- deleteTimesheet
  
  public TimesheetLine deleteTimesheet(String accessToken, String xeroTenantId, UUID timesheetID) throws IOException
  
  delete a timesheet
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  timesheetID - Identifier for the timesheet
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- deleteTimesheetLine
  
  public TimesheetLine deleteTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID) throws IOException
  
  delete a timesheet line
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  timesheetID - Identifier for the timesheet
  
  timesheetLineID - Identifier for the timesheet line
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getBenefit
  
  public BenefitObject getBenefit(String accessToken, String xeroTenantId, UUID id) throws IOException
  
  retrieve a single benefit by id
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  id - Identifier for the benefit
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getBenefits
  
  public Benefits getBenefits(String accessToken, String xeroTenantId, Integer page) throws IOException
  
  searches benefits
  200 - search results matching criteria
  
  Parameters:
  
  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.
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getDeduction
  
  public DeductionObject getDeduction(String accessToken, String xeroTenantId, UUID deductionId) throws IOException
  
  retrieve a single deduction by id
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  deductionId - Identifier for the deduction
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getDeductions
  
  public Deductions getDeductions(String accessToken, String xeroTenantId, Integer page) throws IOException
  
  searches deductions
  200 - search results matching criteria
  
  Parameters:
  
  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.
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEarningsOrder
  
  public EarningsOrderObject getEarningsOrder(String accessToken, String xeroTenantId, UUID id) throws IOException
  
  retrieve a single deduction by id
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  id - Identifier for the deduction
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEarningsOrders
  
  public EarningsOrders getEarningsOrders(String accessToken, String xeroTenantId, Integer page) throws IOException
  
  searches earnings orders
  200 - search results matching criteria
  
  Parameters:
  
  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.
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEarningsRate
  
  public EarningsRateObject getEarningsRate(String accessToken, String xeroTenantId, UUID earningsRateID) throws IOException
  
  retrieve a single earnings rates by id
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  earningsRateID - Identifier for the earnings rate
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEarningsRates
  
  public EarningsRates getEarningsRates(String accessToken, String xeroTenantId, Integer page) throws IOException
  
  searches earnings rates
  200 - search results matching criteria
  
  Parameters:
  
  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.
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployee
  
  public EmployeeObject getEmployee(String accessToken, String xeroTenantId, UUID employeeId) throws IOException
  
  searches employees
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployeeLeave
  
  public EmployeeLeaveObject getEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeId, UUID leaveID) throws IOException
  
  retrieve a single employee leave record
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  leaveID - Leave id for single object
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployeeLeaveBalances
  
  public EmployeeLeaveBalances getEmployeeLeaveBalances(String accessToken, String xeroTenantId, UUID employeeId) throws IOException
  
  search employee leave balances
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployeeLeavePeriods
  
  public LeavePeriods getEmployeeLeavePeriods(String accessToken, String xeroTenantId, UUID employeeId, org.threeten.bp.LocalDate startDate, org.threeten.bp.LocalDate endDate) throws IOException
  
  searches employee leave periods
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  startDate - Filter by start date
  
  endDate - Filter by end date
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployeeLeaveTypes
  
  public EmployeeLeaveTypes getEmployeeLeaveTypes(String accessToken, String xeroTenantId, UUID employeeId) throws IOException
  
  searches employee leave types
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployeeLeaves
  
  public EmployeeLeaves getEmployeeLeaves(String accessToken, String xeroTenantId, UUID employeeId) throws IOException
  
  search employee leave records
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployeeOpeningBalances
  
  public EmployeeOpeningBalancesObject getEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeId) throws IOException
  
  retrieve employee openingbalances
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployeePayTemplate
  
  public EmployeePayTemplateObject getEmployeePayTemplate(String accessToken, String xeroTenantId, UUID employeeId) throws IOException
  
  searches employee pay templates
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployeePaymentMethod
  
  public PaymentMethodObject getEmployeePaymentMethod(String accessToken, String xeroTenantId, UUID employeeId) throws IOException
  
  retrieves an employee's payment method
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployeeSalaryAndWage
  
  public SalaryAndWages getEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeId, UUID salaryAndWagesID) throws IOException
  
  get employee salary and wages record by id
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  salaryAndWagesID - Id for single pay template earnings object
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployeeSalaryAndWages
  
  public SalaryAndWages getEmployeeSalaryAndWages(String accessToken, String xeroTenantId, UUID employeeId, Integer page) throws IOException
  
  retrieves an employee's salary and wages
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  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.
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployeeStatutoryLeaveBalances
  
  public EmployeeStatutoryLeaveBalanceObject getEmployeeStatutoryLeaveBalances(String accessToken, String xeroTenantId, UUID employeeId, String leaveType, org.threeten.bp.LocalDate asOfDate) throws IOException
  
  search employee leave balances
  200 - search results matching criteria
  
  Parameters:
  
  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.
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployeeStatutorySickLeave
  
  public EmployeeStatutorySickLeaveObject getEmployeeStatutorySickLeave(String accessToken, String xeroTenantId, UUID statutorySickLeaveID) throws IOException
  
  retrieve a statutory sick leave for an employee
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  statutorySickLeaveID - Statutory sick leave id for single object
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployeeTax
  
  public EmployeeTaxObject getEmployeeTax(String accessToken, String xeroTenantId, UUID employeeId) throws IOException
  
  searches tax records for an employee
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getEmployees
  
  public Employees getEmployees(String accessToken, String xeroTenantId, String firstName, String lastName, Integer page) throws IOException
  
  searches employees
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  firstName - Filter by first name
  
  lastName - Filter by last name
  
  page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
  
  accessToken - Authorization token for user set in header of each request
  
  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 firstName, String lastName, Integer page) throws IOException
  
  Throws:
  
  IOException
- getLeaveType
  
  public LeaveTypeObject getLeaveType(String accessToken, String xeroTenantId, UUID leaveTypeID) throws IOException
  
  retrieve a single leave type by id
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  leaveTypeID - Identifier for the leave type
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getLeaveTypes
  
  public LeaveTypes getLeaveTypes(String accessToken, String xeroTenantId, Integer page, Boolean activeOnly) throws IOException
  
  searches leave types
  200 - search results matching criteria
  
  Parameters:
  
  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.
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getPayRun
  
  public PayRunObject getPayRun(String accessToken, String xeroTenantId, UUID payRunID) throws IOException
  
  retrieve a single pay run by id
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  payRunID - Identifier for the pay run
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getPayRunCalendar
  
  public PayRunCalendarObject getPayRunCalendar(String accessToken, String xeroTenantId, UUID payRunCalendarID) throws IOException
  
  retrieve a single payrun calendar by id
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  payRunCalendarID - Identifier for the payrun calendars
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getPayRunCalendars
  
  public PayRunCalendars getPayRunCalendars(String accessToken, String xeroTenantId, Integer page) throws IOException
  
  searches payrun calendars
  200 - search results matching criteria
  
  Parameters:
  
  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.
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getPayRuns
  
  public PayRuns getPayRuns(String accessToken, String xeroTenantId, Integer page, String status) throws IOException
  
  searches pay runs
  200 - search results matching criteria
  
  Parameters:
  
  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.
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getPaySlip
  
  public PayslipObject getPaySlip(String accessToken, String xeroTenantId, UUID payslipID) throws IOException
  
  retrieve a single payslip by id
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  payslipID - Identifier for the payslip
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getPaySlips
  
  public Payslips getPaySlips(String accessToken, String xeroTenantId, UUID payRunID, Integer page) throws IOException
  
  searches payslips
  200 - search results matching criteria
  
  Parameters:
  
  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.
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getReimbursement
  
  public ReimbursementObject getReimbursement(String accessToken, String xeroTenantId, UUID reimbursementID) throws IOException
  
  retrieve a single reimbursement by id
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  reimbursementID - Identifier for the reimbursement
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getReimbursements
  
  public Reimbursements getReimbursements(String accessToken, String xeroTenantId, Integer page) throws IOException
  
  searches reimbursements
  200 - search results matching criteria
  
  Parameters:
  
  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.
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getSettings
  
  public Settings getSettings(String accessToken, String xeroTenantId) throws IOException
  
  searches settings
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getStatutoryLeaveSummary
  
  public EmployeeStatutoryLeavesSummaries getStatutoryLeaveSummary(String accessToken, String xeroTenantId, UUID employeeId, Boolean activeOnly) throws IOException
  
  retrieve a summary of statutory leaves for an employee
  200 - search results matching criteria
  
  Parameters:
  
  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
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getTimesheet
  
  public TimesheetObject getTimesheet(String accessToken, String xeroTenantId, UUID timesheetID) throws IOException
  
  retrieve a single timesheet by id
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  timesheetID - Identifier for the timesheet
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- getTimesheets
  
  public Timesheets getTimesheets(String accessToken, String xeroTenantId, Integer page, UUID employeeId, UUID payrollCalendarId) throws IOException
  
  searches timesheets
  200 - search results matching criteria
  
  Parameters:
  
  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.
  
  employeeId - By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeId} to get only the timesheets of a particular employee.
  
  payrollCalendarId - By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id
  
  accessToken - Authorization token for user set in header of each request
  
  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, UUID employeeId, UUID payrollCalendarId) throws IOException
  
  Throws:
  
  IOException
- getTrackingCategories
  
  public TrackingCategories getTrackingCategories(String accessToken, String xeroTenantId) throws IOException
  
  searches tracking categories
  200 - search results matching criteria
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  accessToken - Authorization token for user set in header of each request
  
  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
  
  Throws:
  
  IOException
- revertTimesheet
  
  public TimesheetObject revertTimesheet(String accessToken, String xeroTenantId, UUID timesheetID) throws IOException
  
  revert a timesheet to draft
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  timesheetID - Identifier for the timesheet
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- updateEmployee
  
  public EmployeeObject updateEmployee(String accessToken, String xeroTenantId, UUID employeeId, Employee employee) throws IOException
  
  updates employee
  200 - successful response
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  employee - The employee parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- updateEmployeeEarningsTemplate
  
  public EarningsTemplateObject updateEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeId, UUID payTemplateEarningID, EarningsTemplate earningsTemplate) throws IOException
  
  updates employee earnings template records
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  payTemplateEarningID - Id for single pay template earnings object
  
  earningsTemplate - The earningsTemplate parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- updateEmployeeLeave
  
  public EmployeeLeaveObject updateEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeId, UUID leaveID, EmployeeLeave employeeLeave) throws IOException
  
  updates employee leave records
  200 - successful response
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  leaveID - Leave id for single object
  
  employeeLeave - The employeeLeave parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- updateEmployeeOpeningBalances
  
  public EmployeeOpeningBalancesObject updateEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeId, EmployeeOpeningBalances employeeOpeningBalances) throws IOException
  
  updates employee opening balances
  200 - successful response
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  employeeOpeningBalances - The employeeOpeningBalances parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- updateEmployeeSalaryAndWage
  
  public SalaryAndWageObject updateEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeId, UUID salaryAndWagesID, SalaryAndWage salaryAndWage) throws IOException
  
  updates employee salary and wages record
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  employeeId - Employee id for single object
  
  salaryAndWagesID - Id for single pay template earnings object
  
  salaryAndWage - The salaryAndWage parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- updatePayRun
  
  public PayRunObject updatePayRun(String accessToken, String xeroTenantId, UUID payRunID, PayRun payRun) throws IOException
  
  update a pay run
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  payRunID - Identifier for the pay run
  
  payRun - The payRun parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- updateTimesheetLine
  
  public TimesheetLineObject updateTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID, TimesheetLine timesheetLine) throws IOException
  
  update a timesheet line
  200 - search results matching criteria
  400 - validation error for a bad request
  
  Parameters:
  
  xeroTenantId - Xero identifier for Tenant
  
  timesheetID - Identifier for the timesheet
  
  timesheetLineID - Identifier for the timesheet line
  
  timesheetLine - The timesheetLine parameter
  
  accessToken - Authorization token for user set in header of each request
  
  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) throws IOException
  
  Throws:
  
  IOException
- convertInputToByteArray
  
  public ByteArrayInputStream convertInputToByteArray(InputStream is) throws IOException
  
  Throws:
  
  IOException

Constructors
Constructor	Description
`PayrollUkApi()`
`PayrollUkApi(ApiClient apiClient)`

Class PayrollUkApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

PayrollUkApi

PayrollUkApi

Method Details

getInstance

getApiClient

setApiClient

setUserAgent

getUserAgent

approveTimesheet

approveTimesheetForHttpResponse

createBenefit

createBenefitForHttpResponse

createDeduction

createDeductionForHttpResponse

createEarningsRate

createEarningsRateForHttpResponse

createEmployee

createEmployeeForHttpResponse

createEmployeeEarningsTemplate

createEmployeeEarningsTemplateForHttpResponse

createEmployeeLeave

createEmployeeLeaveForHttpResponse

createEmployeeLeaveType

createEmployeeLeaveTypeForHttpResponse

createEmployeeOpeningBalances

createEmployeeOpeningBalancesForHttpResponse

createEmployeePaymentMethod

createEmployeePaymentMethodForHttpResponse

createEmployeeSalaryAndWage

createEmployeeSalaryAndWageForHttpResponse

createEmployeeStatutorySickLeave

createEmployeeStatutorySickLeaveForHttpResponse

createEmployment

createEmploymentForHttpResponse

createLeaveType

createLeaveTypeForHttpResponse

createMultipleEmployeeEarningsTemplate

createMultipleEmployeeEarningsTemplateForHttpResponse

createPayRunCalendar

createPayRunCalendarForHttpResponse

createReimbursement

createReimbursementForHttpResponse

createTimesheet

createTimesheetForHttpResponse

createTimesheetLine

createTimesheetLineForHttpResponse

deleteEmployeeEarningsTemplate

deleteEmployeeEarningsTemplateForHttpResponse

deleteEmployeeLeave

deleteEmployeeLeaveForHttpResponse

deleteEmployeeSalaryAndWage

deleteEmployeeSalaryAndWageForHttpResponse

deleteTimesheet

deleteTimesheetForHttpResponse

deleteTimesheetLine

deleteTimesheetLineForHttpResponse

getBenefit

getBenefitForHttpResponse

getBenefits

getBenefitsForHttpResponse

getDeduction

getDeductionForHttpResponse

getDeductions

getDeductionsForHttpResponse

getEarningsOrder

getEarningsOrderForHttpResponse

getEarningsOrders

getEarningsOrdersForHttpResponse

getEarningsRate

getEarningsRateForHttpResponse

getEarningsRates

getEarningsRatesForHttpResponse

getEmployee

getEmployeeForHttpResponse

getEmployeeLeave