java.lang.Object
- com.xero.api.client.PayrollNzApi

```
public class PayrollNzApi
extends Object
```
PayrollNzApi has methods for interacting with all endpoints in the API set

Constructor Summary

Constructors
Constructor Description

PayrollNzApi()
PayrollNzApi

PayrollNzApi(ApiClient apiClient)
PayrollNzApi

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TimesheetObject`	`approveTimesheet(String accessToken, String xeroTenantId, UUID timesheetID)`	Approves a timesheet
`com.google.api.client.http.HttpResponse`	`approveTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)`	Approves a timesheet
`ByteArrayInputStream`	`convertInputToByteArray(InputStream is)`	convert intput to byte array
`DeductionObject`	`createDeduction(String accessToken, String xeroTenantId, Deduction deduction)`	Creates a new deduction for a specific employee
`com.google.api.client.http.HttpResponse`	`createDeductionForHttpResponse(String accessToken, String xeroTenantId, Deduction deduction)`	Creates a new deduction for a specific employee
`EarningsRateObject`	`createEarningsRate(String accessToken, String xeroTenantId, EarningsRate earningsRate)`	Creates a new earnings rate
`com.google.api.client.http.HttpResponse`	`createEarningsRateForHttpResponse(String accessToken, String xeroTenantId, EarningsRate earningsRate)`	Creates a new earnings rate
`EmployeeObject`	`createEmployee(String accessToken, String xeroTenantId, Employee employee)`	Creates an employees
`EarningsTemplateObject`	`createEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeID, EarningsTemplate earningsTemplate)`	Creates earnings template records for an employee
`com.google.api.client.http.HttpResponse`	`createEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EarningsTemplate earningsTemplate)`	Creates earnings template records for an employee
`com.google.api.client.http.HttpResponse`	`createEmployeeForHttpResponse(String accessToken, String xeroTenantId, Employee employee)`	Creates an employees
`EmployeeLeaveObject`	`createEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeID, EmployeeLeave employeeLeave)`	Creates leave records for a specific employee
`com.google.api.client.http.HttpResponse`	`createEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EmployeeLeave employeeLeave)`	Creates leave records for a specific employee
`EmployeeLeaveSetupObject`	`createEmployeeLeaveSetup(String accessToken, String xeroTenantId, UUID employeeID, EmployeeLeaveSetup employeeLeaveSetup)`	Creates a leave set-up for a specific employee.
`com.google.api.client.http.HttpResponse`	`createEmployeeLeaveSetupForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EmployeeLeaveSetup employeeLeaveSetup)`	Creates a leave set-up for a specific employee.
`EmployeeLeaveTypeObject`	`createEmployeeLeaveType(String accessToken, String xeroTenantId, UUID employeeID, EmployeeLeaveType employeeLeaveType)`	Creates leave type records for a specific employee
`com.google.api.client.http.HttpResponse`	`createEmployeeLeaveTypeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EmployeeLeaveType employeeLeaveType)`	Creates leave type records for a specific employee
`EmployeeOpeningBalancesObject`	`createEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeID, List<EmployeeOpeningBalance> employeeOpeningBalance)`	Creates opening balances for a specific employee
`com.google.api.client.http.HttpResponse`	`createEmployeeOpeningBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, List<EmployeeOpeningBalance> employeeOpeningBalance)`	Creates opening balances for a specific employee
`PaymentMethodObject`	`createEmployeePaymentMethod(String accessToken, String xeroTenantId, UUID employeeID, PaymentMethod paymentMethod)`	Creates a payment method for an employee
`com.google.api.client.http.HttpResponse`	`createEmployeePaymentMethodForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, PaymentMethod paymentMethod)`	Creates a payment method for an employee
`SalaryAndWageObject`	`createEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeID, SalaryAndWage salaryAndWage)`	Creates an employee salary and wage record
`com.google.api.client.http.HttpResponse`	`createEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, SalaryAndWage salaryAndWage)`	Creates an employee salary and wage record
`EmploymentObject`	`createEmployment(String accessToken, String xeroTenantId, UUID employeeID, Employment employment)`	Creates an employment detail for a specific employee
`com.google.api.client.http.HttpResponse`	`createEmploymentForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, Employment employment)`	Creates an employment detail for a specific employee
`LeaveTypeObject`	`createLeaveType(String accessToken, String xeroTenantId, LeaveType leaveType)`	Creates a new leave type
`com.google.api.client.http.HttpResponse`	`createLeaveTypeForHttpResponse(String accessToken, String xeroTenantId, LeaveType leaveType)`	Creates a new leave type
`EmployeeEarningsTemplates`	`createMultipleEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeID, List<EarningsTemplate> earningsTemplate)`	Creates multiple employee earnings template records for a specific employee
`com.google.api.client.http.HttpResponse`	`createMultipleEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, List<EarningsTemplate> earningsTemplate)`	Creates multiple employee earnings template records for a specific employee
`PayRunObject`	`createPayRun(String accessToken, String xeroTenantId, PayRun payRun)`	Creates a pay run
`PayRunCalendarObject`	`createPayRunCalendar(String accessToken, String xeroTenantId, PayRunCalendar payRunCalendar)`	Creates a new payrun calendar
`com.google.api.client.http.HttpResponse`	`createPayRunCalendarForHttpResponse(String accessToken, String xeroTenantId, PayRunCalendar payRunCalendar)`	Creates a new payrun calendar
`com.google.api.client.http.HttpResponse`	`createPayRunForHttpResponse(String accessToken, String xeroTenantId, PayRun payRun)`	Creates a pay run
`ReimbursementObject`	`createReimbursement(String accessToken, String xeroTenantId, Reimbursement reimbursement)`	Creates a new reimbursement
`com.google.api.client.http.HttpResponse`	`createReimbursementForHttpResponse(String accessToken, String xeroTenantId, Reimbursement reimbursement)`	Creates a new reimbursement
`SuperannuationObject`	`createSuperannuation(String accessToken, String xeroTenantId, Benefit benefit)`	Creates a new superannuation
`com.google.api.client.http.HttpResponse`	`createSuperannuationForHttpResponse(String accessToken, String xeroTenantId, Benefit benefit)`	Creates a new superannuation
`TimesheetObject`	`createTimesheet(String accessToken, String xeroTenantId, Timesheet timesheet)`	Creates a new timesheet
`com.google.api.client.http.HttpResponse`	`createTimesheetForHttpResponse(String accessToken, String xeroTenantId, Timesheet timesheet)`	Creates a new timesheet
`TimesheetLineObject`	`createTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, TimesheetLine timesheetLine)`	Create a new timesheet line for a specific time sheet
`com.google.api.client.http.HttpResponse`	`createTimesheetLineForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, TimesheetLine timesheetLine)`	Create a new timesheet line for a specific time sheet
`EarningsTemplateObject`	`deleteEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeID, UUID payTemplateEarningID)`	Deletes an employee's earnings template record
`com.google.api.client.http.HttpResponse`	`deleteEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID payTemplateEarningID)`	Deletes an employee's earnings template record
`EmployeeLeaveObject`	`deleteEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID)`	Deletes a leave record for a specific employee
`com.google.api.client.http.HttpResponse`	`deleteEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID)`	Deletes a leave record for a specific employee
`SalaryAndWageObject`	`deleteEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID)`	Deletes an employee's salary and wages record
`com.google.api.client.http.HttpResponse`	`deleteEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID)`	Deletes an employee's salary and wages record
`TimesheetLine`	`deleteTimesheet(String accessToken, String xeroTenantId, UUID timesheetID)`	Deletes a timesheet
`com.google.api.client.http.HttpResponse`	`deleteTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)`	Deletes a timesheet
`TimesheetLine`	`deleteTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID)`	Deletes a timesheet line for a specific timesheet
`com.google.api.client.http.HttpResponse`	`deleteTimesheetLineForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID)`	Deletes a timesheet line for a specific timesheet
`ApiClient`	`getApiClient()`	get ApiClient
`DeductionObject`	`getDeduction(String accessToken, String xeroTenantId, UUID deductionId)`	Retrieves a single deduction by using a unique deduction ID
`com.google.api.client.http.HttpResponse`	`getDeductionForHttpResponse(String accessToken, String xeroTenantId, UUID deductionId)`	Retrieves a single deduction by using a unique deduction ID
`Deductions`	`getDeductions(String accessToken, String xeroTenantId, Integer page)`	Retrieves deductions for a specific employee
`com.google.api.client.http.HttpResponse`	`getDeductionsForHttpResponse(String accessToken, String xeroTenantId, Integer page)`	Retrieves deductions for a specific employee
`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 an employees using a unique employee ID
`com.google.api.client.http.HttpResponse`	`getEmployeeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves an employees using a unique employee ID
`EmployeeLeaveBalances`	`getEmployeeLeaveBalances(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves leave balances for a specific employee
`com.google.api.client.http.HttpResponse`	`getEmployeeLeaveBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves leave balances for a specific employee
`LeavePeriods`	`getEmployeeLeavePeriods(String accessToken, String xeroTenantId, UUID employeeID, org.threeten.bp.LocalDate startDate, org.threeten.bp.LocalDate endDate)`	Retrieves leave periods for a specific employee
`com.google.api.client.http.HttpResponse`	`getEmployeeLeavePeriodsForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, org.threeten.bp.LocalDate startDate, org.threeten.bp.LocalDate endDate)`	Retrieves leave periods for a specific employee
`EmployeeLeaves`	`getEmployeeLeaves(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves leave records for a specific employee
`com.google.api.client.http.HttpResponse`	`getEmployeeLeavesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves leave records for a specific employee
`EmployeeLeaveTypes`	`getEmployeeLeaveTypes(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves leave types for a specific employee
`com.google.api.client.http.HttpResponse`	`getEmployeeLeaveTypesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves leave types for a specific employee
`EmployeeOpeningBalancesObject`	`getEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves the opening balance for a specific employee
`com.google.api.client.http.HttpResponse`	`getEmployeeOpeningBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves the opening balance for a specific employee
`PaymentMethodObject`	`getEmployeePaymentMethod(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves available payment methods for a specific employee
`com.google.api.client.http.HttpResponse`	`getEmployeePaymentMethodForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves available payment methods for a specific employee
`EmployeePayTemplates`	`getEmployeePayTemplates(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves pay templates for a specific employee
`com.google.api.client.http.HttpResponse`	`getEmployeePayTemplatesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves pay templates for a specific employee
`Employees`	`getEmployees(String accessToken, String xeroTenantId, String firstName, String lastName, Integer page)`	Retrieves employees
`SalaryAndWages`	`getEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID)`	Retrieves an employee's salary and wages record by using a unique salary and wage ID
`com.google.api.client.http.HttpResponse`	`getEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID)`	Retrieves an employee's salary and wages record by using a unique salary and wage ID
`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)`	Retrieves an employee's salary and wages
`com.google.api.client.http.HttpResponse`	`getEmployeesForHttpResponse(String accessToken, String xeroTenantId, String firstName, String lastName, Integer page)`	Retrieves employees
`EmployeeTaxObject`	`getEmployeeTax(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves tax records for a specific employee
`com.google.api.client.http.HttpResponse`	`getEmployeeTaxForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves tax records for a specific employee
`static PayrollNzApi`	`getInstance(ApiClient apiClient)`	PayrollNzApi 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 payrollCalendarID)`	Retrieves a specific payrun calendar by using a unique payroll calendar ID
`com.google.api.client.http.HttpResponse`	`getPayRunCalendarForHttpResponse(String accessToken, String xeroTenantId, UUID payrollCalendarID)`	Retrieves a specific payrun calendar by using a unique payroll 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 a unique pay slip ID
`com.google.api.client.http.HttpResponse`	`getPaySlipForHttpResponse(String accessToken, String xeroTenantId, UUID paySlipID)`	Retrieves a specific payslip by a unique pay slip 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 settings
`com.google.api.client.http.HttpResponse`	`getSettingsForHttpResponse(String accessToken, String xeroTenantId)`	Retrieves settings
`StatutoryDeductionObject`	`getStatutoryDeduction(String accessToken, String xeroTenantId, UUID id)`	Retrieves a specific statutory deduction by using a unique statutory deductions id
`com.google.api.client.http.HttpResponse`	`getStatutoryDeductionForHttpResponse(String accessToken, String xeroTenantId, UUID id)`	Retrieves a specific statutory deduction by using a unique statutory deductions id
`StatutoryDeductions`	`getStatutoryDeductions(String accessToken, String xeroTenantId, Integer page)`	Retrieves statutory deductions
`com.google.api.client.http.HttpResponse`	`getStatutoryDeductionsForHttpResponse(String accessToken, String xeroTenantId, Integer page)`	Retrieves statutory deductions
`SuperannuationObject`	`getSuperannuation(String accessToken, String xeroTenantId, UUID superannuationID)`	Retrieves a specific superannuation using a unique superannuation ID
`com.google.api.client.http.HttpResponse`	`getSuperannuationForHttpResponse(String accessToken, String xeroTenantId, UUID superannuationID)`	Retrieves a specific superannuation using a unique superannuation ID
`Superannuations`	`getSuperannuations(String accessToken, String xeroTenantId, Integer page)`	Retrieves superannuations
`com.google.api.client.http.HttpResponse`	`getSuperannuationsForHttpResponse(String accessToken, String xeroTenantId, Integer page)`	Retrieves superannuations
`TimesheetObject`	`getTimesheet(String accessToken, String xeroTenantId, UUID timesheetID)`	Retrieves a specific timesheet by using a unique timesheet ID
`com.google.api.client.http.HttpResponse`	`getTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)`	Retrieves a specific timesheet by using a unique timesheet ID
`Timesheets`	`getTimesheets(String accessToken, String xeroTenantId, Integer page, UUID employeeId, UUID payrollCalendarId)`	Retrieves timesheets
`com.google.api.client.http.HttpResponse`	`getTimesheetsForHttpResponse(String accessToken, String xeroTenantId, Integer page, UUID employeeId, UUID payrollCalendarId)`	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)`	Reverts a timesheet to draft
`com.google.api.client.http.HttpResponse`	`revertTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)`	Reverts a 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)`	Updates an existing employee
`EarningsTemplateObject`	`updateEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeID, UUID payTemplateEarningID, EarningsTemplate earningsTemplate)`	Updates an earnings template records for an employee
`com.google.api.client.http.HttpResponse`	`updateEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID payTemplateEarningID, EarningsTemplate earningsTemplate)`	Updates an earnings template records for an employee
`com.google.api.client.http.HttpResponse`	`updateEmployeeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, Employee employee)`	Updates an existing employee
`EmployeeLeaveObject`	`updateEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID, EmployeeLeave employeeLeave)`	Updates leave records for a specific employee
`com.google.api.client.http.HttpResponse`	`updateEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID, EmployeeLeave employeeLeave)`	Updates leave records for a specific employee
`SalaryAndWageObject`	`updateEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID, SalaryAndWage salaryAndWage)`	Updates an employee's salary and wages record
`com.google.api.client.http.HttpResponse`	`updateEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID, SalaryAndWage salaryAndWage)`	Updates an employee's salary and wages record
`EmployeeTaxObject`	`updateEmployeeTax(String accessToken, String xeroTenantId, UUID employeeID, EmployeeTax employeeTax)`	Updates the tax records for a specific employee
`com.google.api.client.http.HttpResponse`	`updateEmployeeTaxForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EmployeeTax employeeTax)`	Updates the tax records for a specific employee
`PayRunObject`	`updatePayRun(String accessToken, String xeroTenantId, UUID payRunID, PayRun payRun)`	Updates a pay run
`com.google.api.client.http.HttpResponse`	`updatePayRunForHttpResponse(String accessToken, String xeroTenantId, UUID payRunID, PayRun payRun)`	Updates a pay run
`PaySlipObject`	`updatePaySlipLineItems(String accessToken, String xeroTenantId, UUID paySlipID, PaySlip paySlip)`	Creates an employee pay slip
`com.google.api.client.http.HttpResponse`	`updatePaySlipLineItemsForHttpResponse(String accessToken, String xeroTenantId, UUID paySlipID, PaySlip paySlip)`	Creates an employee pay slip
`TimesheetLineObject`	`updateTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID, TimesheetLine timesheetLine)`	Updates a timesheet line for a specific timesheet
`com.google.api.client.http.HttpResponse`	`updateTimesheetLineForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID, TimesheetLine timesheetLine)`	Updates a 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 Detail
- PayrollNzApi
```
public PayrollNzApi()
```
  PayrollNzApi
- PayrollNzApi
```
public PayrollNzApi(ApiClient apiClient)
```
  PayrollNzApi
  
  Parameters:
  
  apiClient - ApiClient pass into the new instance of this class

Method Detail

getInstance
```
public static PayrollNzApi getInstance(ApiClient apiClient)
```
PayrollNzApi 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)
                                 throws IOException
```
Approves 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

Approves 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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

createDeduction
```
public DeductionObject createDeduction(String accessToken,
                                       String xeroTenantId,
                                       Deduction deduction)
                                throws IOException
```
Creates a new deduction for a specific employee
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

Creates a new deduction for a specific employee

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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

createEarningsRate
```
public EarningsRateObject createEarningsRate(String accessToken,
                                             String xeroTenantId,
                                             EarningsRate earningsRate)
                                      throws IOException
```
Creates 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

Creates 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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

createEmployee
```
public EmployeeObject createEmployee(String accessToken,
                                     String xeroTenantId,
                                     Employee employee)
                              throws IOException
```
Creates an 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

Creates an 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:: 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)
                                                      throws IOException

Creates earnings template records for an employee

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

Creates earnings template records for an employee

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:: 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)
                                        throws IOException

Creates leave records for a specific employee

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

Creates leave records for a specific employee

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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

createEmployeeLeaveSetup

public EmployeeLeaveSetupObject createEmployeeLeaveSetup(String accessToken,
                                                         String xeroTenantId,
                                                         UUID employeeID,
                                                         EmployeeLeaveSetup employeeLeaveSetup)
                                                  throws IOException

Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; employeeID - Employee id for single object; employeeLeaveSetup - The employeeLeaveSetup parameter; accessToken - Authorization token for user set in header of each request
Returns:: EmployeeLeaveSetupObject
Throws:: IOException - if an error occurs while attempting to invoke the API *

createEmployeeLeaveSetupForHttpResponse

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

Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; employeeID - Employee id for single object; employeeLeaveSetup - The employeeLeaveSetup parameter; accessToken - Authorization token for user set in header of each request
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)
                                                throws IOException

Creates leave type records for a specific employee

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

Creates leave type records for a specific employee

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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

createEmployeeOpeningBalances

public EmployeeOpeningBalancesObject createEmployeeOpeningBalances(String accessToken,
                                                                   String xeroTenantId,
                                                                   UUID employeeID,
                                                                   List<EmployeeOpeningBalance> employeeOpeningBalance)
                                                            throws IOException

Creates opening balances for a specific employee

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; employeeID - Employee id for single object; employeeOpeningBalance - The employeeOpeningBalance 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,
                                                                                            List<EmployeeOpeningBalance> employeeOpeningBalance)
                                                                                     throws IOException

Creates opening balances for a specific employee

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; employeeID - Employee id for single object; employeeOpeningBalance - The employeeOpeningBalance parameter; accessToken - Authorization token for user set in header of each request
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)
                                                throws IOException

Creates a payment method for an employee

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

Creates a payment method for an employee

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:: 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)
                                                throws IOException

Creates an 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

Creates an 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:: 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)
                                  throws IOException

Creates an employment detail for a specific employee

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

Creates an employment detail for a specific employee

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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

createLeaveType
```
public LeaveTypeObject createLeaveType(String accessToken,
                                       String xeroTenantId,
                                       LeaveType leaveType)
                                throws IOException
```
Creates 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

Creates 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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

createMultipleEmployeeEarningsTemplate

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

Creates multiple employee earnings template records for a specific employee

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:: EmployeeEarningsTemplates
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

Creates multiple employee earnings template records for a specific employee

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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

createPayRun
```
public PayRunObject createPayRun(String accessToken,
                                 String xeroTenantId,
                                 PayRun payRun)
                          throws IOException
```
Creates a pay run
200 - created payrun results
400 - validation error for a bad request

Parameters:

xeroTenantId - Xero identifier for Tenant

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 *

createPayRunForHttpResponse

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

Creates a pay run

200 - created payrun results

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; payRun - The payRun parameter; accessToken - Authorization token for user set in header of each request
Returns:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

createPayRunCalendar

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

Creates 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

Creates 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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

createReimbursement
```
public ReimbursementObject createReimbursement(String accessToken,
                                               String xeroTenantId,
                                               Reimbursement reimbursement)
                                        throws IOException
```
Creates 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

Creates 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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

createSuperannuation

public SuperannuationObject createSuperannuation(String accessToken,
                                                 String xeroTenantId,
                                                 Benefit benefit)
                                          throws IOException

Creates a new superannuation

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:: SuperannuationObject
Throws:: IOException - if an error occurs while attempting to invoke the API *

createSuperannuationForHttpResponse

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

Creates a new superannuation

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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

createTimesheet
```
public TimesheetObject createTimesheet(String accessToken,
                                       String xeroTenantId,
                                       Timesheet timesheet)
                                throws IOException
```
Creates 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

Creates 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:: 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)
                                        throws IOException

Create a new timesheet line for a specific time sheet

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

Create a new timesheet line for a specific time sheet

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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

deleteEmployeeEarningsTemplate

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

Deletes an employee's 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
Returns:: EarningsTemplateObject
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 an employee's 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
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 leave record for a specific employee

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

Deletes a leave record for a specific employee

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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

deleteEmployeeSalaryAndWage

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

Deletes an employee's 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
Returns:: SalaryAndWageObject
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 an employee's 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
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 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

Deletes 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:: 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 timesheet line for a specific timesheet
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

Deletes a timesheet line for a specific timesheet

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:: 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 single deduction by using a unique deduction 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

Retrieves a single deduction by using a unique deduction 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:: 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 for a specific employee
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

Retrieves deductions for a specific employee

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:: 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:

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

Retrieves a specific earnings rates by using a unique earnings rate 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:: 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:

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

Retrieves 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:: 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 an employees using a unique employee ID
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

Retrieves an employees using a unique employee ID

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:: 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 leave balances for a specific 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:: 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 leave balances for a specific 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:: 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 leave periods for a specific employee

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

Retrieves leave periods for a specific employee

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:: 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 leave types for a specific employee
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

Retrieves leave types for a specific employee

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:: 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 leave records for a specific 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:

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 leave records for a specific 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:: 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 the opening balance for a specific 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:: 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 the opening balance for a specific 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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

getEmployeePayTemplates
```
public EmployeePayTemplates getEmployeePayTemplates(String accessToken,
                                                    String xeroTenantId,
                                                    UUID employeeID)
                                             throws IOException
```
Retrieves pay templates for a specific employee
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:

EmployeePayTemplates

Throws:

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

getEmployeePayTemplatesForHttpResponse

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

Retrieves pay templates for a specific employee

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:: 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 available payment methods for a specific employee
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

Retrieves available payment methods for a specific employee

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:: 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 an employee's salary and wages record by using a unique salary and wage 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

Retrieves an employee's salary and wages record by using a unique salary and wage 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:: 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 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

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:: 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
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

Retrieves tax records for a specific 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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

getEmployees
```
public Employees getEmployees(String accessToken,
                              String xeroTenantId,
                              String firstName,
                              String lastName,
                              Integer page)
                       throws IOException
```
Retrieves 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

Retrieves 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:: 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:

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

Retrieves a specific leave type by using a unique leave type 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:: 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:

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

Retrieves 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:: 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:

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

Retrieves a specific pay run by using a unique pay run 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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

getPayRunCalendar
```
public PayRunCalendarObject getPayRunCalendar(String accessToken,
                                              String xeroTenantId,
                                              UUID payrollCalendarID)
                                       throws IOException
```
Retrieves a specific payrun calendar by using a unique payroll calendar ID
200 - search results matching criteria

Parameters:

xeroTenantId - Xero identifier for Tenant

payrollCalendarID - 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 payrollCalendarID)
                                                                         throws IOException

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

200 - search results matching criteria

Parameters:: xeroTenantId - Xero identifier for Tenant; payrollCalendarID - Identifier for the payrun calendars; accessToken - Authorization token for user set in header of each request
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:

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

Retrieves 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:: 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:

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

Retrieves 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:: 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 a unique pay slip 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

Retrieves a specific payslip by a unique pay slip 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:: 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:

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

Retrieves 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:: 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:

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

Retrieves a specific reimbursement by using a unique reimbursement 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:: 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:

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

Retrieves 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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

getSettings
```
public Settings getSettings(String accessToken,
                            String xeroTenantId)
                     throws IOException
```
Retrieves 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

Retrieves settings

200 - search results matching criteria

Parameters:: xeroTenantId - Xero identifier for Tenant; accessToken - Authorization token for user set in header of each request
Returns:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

getStatutoryDeduction
```
public StatutoryDeductionObject getStatutoryDeduction(String accessToken,
                                                      String xeroTenantId,
                                                      UUID id)
                                               throws IOException
```
Retrieves a specific statutory deduction by using a unique statutory deductions id
200 - search results matching criteria

Parameters:

xeroTenantId - Xero identifier for Tenant

id - Identifier for the statutory deduction

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

Returns:

StatutoryDeductionObject

Throws:

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

getStatutoryDeductionForHttpResponse

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

Retrieves a specific statutory deduction by using a unique statutory deductions id

200 - search results matching criteria

Parameters:: xeroTenantId - Xero identifier for Tenant; id - Identifier for the statutory deduction; accessToken - Authorization token for user set in header of each request
Returns:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

getStatutoryDeductions
```
public StatutoryDeductions getStatutoryDeductions(String accessToken,
                                                  String xeroTenantId,
                                                  Integer page)
                                           throws IOException
```
Retrieves statutory 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:

StatutoryDeductions

Throws:

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

getStatutoryDeductionsForHttpResponse

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

Retrieves statutory 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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

getSuperannuation
```
public SuperannuationObject getSuperannuation(String accessToken,
                                              String xeroTenantId,
                                              UUID superannuationID)
                                       throws IOException
```
Retrieves a specific superannuation using a unique superannuation ID
200 - search results matching criteria

Parameters:

xeroTenantId - Xero identifier for Tenant

superannuationID - Identifier for the superannuation

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

Returns:

SuperannuationObject

Throws:

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

getSuperannuationForHttpResponse

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

Retrieves a specific superannuation using a unique superannuation ID

200 - search results matching criteria

Parameters:: xeroTenantId - Xero identifier for Tenant; superannuationID - Identifier for the superannuation; accessToken - Authorization token for user set in header of each request
Returns:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

getSuperannuations
```
public Superannuations getSuperannuations(String accessToken,
                                          String xeroTenantId,
                                          Integer page)
                                   throws IOException
```
Retrieves superannuations
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:

Superannuations

Throws:

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

getSuperannuationsForHttpResponse

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

Retrieves superannuations

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:: 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
```
Retrieves a specific timesheet by using a unique timesheet 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

Retrieves a specific timesheet by using a unique timesheet 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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

getTimesheets
```
public Timesheets getTimesheets(String accessToken,
                                String xeroTenantId,
                                Integer page,
                                UUID employeeId,
                                UUID payrollCalendarId)
                         throws IOException
```
Retrieves 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
```
Retrieves 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:

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:

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

Retrieves 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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

revertTimesheet
```
public TimesheetObject revertTimesheet(String accessToken,
                                       String xeroTenantId,
                                       UUID timesheetID)
                                throws IOException
```
Reverts 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

Reverts 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:: 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)
                              throws IOException

Updates an existing 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

Updates an existing 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:: 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)
                                                      throws IOException

Updates an earnings template records for an employee

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

Updates an earnings template records for an employee

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:: 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)
                                        throws IOException

Updates leave records for a specific employee

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

Updates leave records for a specific employee

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:: 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)
                                                throws IOException

Updates an employee's 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

Updates an employee's 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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

updateEmployeeTax

public EmployeeTaxObject updateEmployeeTax(String accessToken,
                                           String xeroTenantId,
                                           UUID employeeID,
                                           EmployeeTax employeeTax)
                                    throws IOException

Updates the tax records for a specific employee

200 - search results matching criteria

Parameters:: xeroTenantId - Xero identifier for Tenant; employeeID - Employee id for single object; employeeTax - The employeeTax parameter; 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 *

updateEmployeeTaxForHttpResponse

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

Updates the tax records for a specific employee

200 - search results matching criteria

Parameters:: xeroTenantId - Xero identifier for Tenant; employeeID - Employee id for single object; employeeTax - The employeeTax parameter; accessToken - Authorization token for user set in header of each request
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)
                          throws IOException
```
Updates 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

Updates 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:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

updatePaySlipLineItems

public PaySlipObject updatePaySlipLineItems(String accessToken,
                                            String xeroTenantId,
                                            UUID paySlipID,
                                            PaySlip paySlip)
                                     throws IOException

Creates an employee pay slip

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; paySlipID - Identifier for the payslip; paySlip - The paySlip parameter; 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 *

updatePaySlipLineItemsForHttpResponse

public com.google.api.client.http.HttpResponse updatePaySlipLineItemsForHttpResponse(String accessToken,
                                                                                     String xeroTenantId,
                                                                                     UUID paySlipID,
                                                                                     PaySlip paySlip)
                                                                              throws IOException

Creates an employee pay slip

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; paySlipID - Identifier for the payslip; paySlip - The paySlip parameter; accessToken - Authorization token for user set in header of each request
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)
                                        throws IOException

Updates a timesheet line for a specific timesheet

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

Updates a timesheet line for a specific timesheet

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:: 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

Constructor	Description
`PayrollNzApi()`	PayrollNzApi
`PayrollNzApi(ApiClient apiClient)`	PayrollNzApi

Class PayrollNzApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PayrollNzApi

PayrollNzApi

Method Detail

getInstance

getApiClient

setApiClient

setUserAgent

getUserAgent

approveTimesheet

approveTimesheetForHttpResponse

createDeduction

createDeductionForHttpResponse

createEarningsRate

createEarningsRateForHttpResponse

createEmployee

createEmployeeForHttpResponse

createEmployeeEarningsTemplate

createEmployeeEarningsTemplateForHttpResponse

createEmployeeLeave

createEmployeeLeaveForHttpResponse

createEmployeeLeaveSetup

createEmployeeLeaveSetupForHttpResponse

createEmployeeLeaveType

createEmployeeLeaveTypeForHttpResponse

createEmployeeOpeningBalances

createEmployeeOpeningBalancesForHttpResponse

createEmployeePaymentMethod

createEmployeePaymentMethodForHttpResponse

createEmployeeSalaryAndWage

createEmployeeSalaryAndWageForHttpResponse

createEmployment

createEmploymentForHttpResponse

createLeaveType

createLeaveTypeForHttpResponse

createMultipleEmployeeEarningsTemplate

createMultipleEmployeeEarningsTemplateForHttpResponse

createPayRun

createPayRunForHttpResponse

createPayRunCalendar

createPayRunCalendarForHttpResponse

createReimbursement

createReimbursementForHttpResponse

createSuperannuation

createSuperannuationForHttpResponse

createTimesheet

createTimesheetForHttpResponse

createTimesheetLine

createTimesheetLineForHttpResponse

deleteEmployeeEarningsTemplate

deleteEmployeeEarningsTemplateForHttpResponse

deleteEmployeeLeave

deleteEmployeeLeaveForHttpResponse

deleteEmployeeSalaryAndWage

deleteEmployeeSalaryAndWageForHttpResponse

deleteTimesheet

deleteTimesheetForHttpResponse

deleteTimesheetLine

deleteTimesheetLineForHttpResponse

getDeduction

getDeductionForHttpResponse

getDeductions

getDeductionsForHttpResponse

getEarningsRate

getEarningsRateForHttpResponse

getEarningsRates

getEarningsRatesForHttpResponse

getEmployee

getEmployeeForHttpResponse

getEmployeeLeaveBalances

getEmployeeLeaveBalancesForHttpResponse

getEmployeeLeavePeriods

getEmployeeLeavePeriodsForHttpResponse

getEmployeeLeaveTypes

getEmployeeLeaveTypesForHttpResponse

getEmployeeLeaves