Class PayrollUkApi
- java.lang.Object
-
- com.xero.api.client.PayrollUkApi
-
public class PayrollUkApi extends Object
PayrollUkApi has methods for interacting with all endpoints in the API set
-
-
Constructor Summary
Constructors Constructor Description PayrollUkApi()PayrollUkApiPayrollUkApi(ApiClient apiClient)PayrollUkApi
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description TimesheetObjectapproveTimesheet(String accessToken, String xeroTenantId, UUID timesheetID)Approves a specific timesheetcom.google.api.client.http.HttpResponseapproveTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)Approves a specific timesheetByteArrayInputStreamconvertInputToByteArray(InputStream is)convert intput to byte arrayBenefitObjectcreateBenefit(String accessToken, String xeroTenantId, Benefit benefit)Creates a new employee benefitcom.google.api.client.http.HttpResponsecreateBenefitForHttpResponse(String accessToken, String xeroTenantId, Benefit benefit)Creates a new employee benefitDeductionObjectcreateDeduction(String accessToken, String xeroTenantId, Deduction deduction)Creates a new deductioncom.google.api.client.http.HttpResponsecreateDeductionForHttpResponse(String accessToken, String xeroTenantId, Deduction deduction)Creates a new deductionEarningsRateObjectcreateEarningsRate(String accessToken, String xeroTenantId, EarningsRate earningsRate)Creates a new earnings ratecom.google.api.client.http.HttpResponsecreateEarningsRateForHttpResponse(String accessToken, String xeroTenantId, EarningsRate earningsRate)Creates a new earnings rateEmployeeObjectcreateEmployee(String accessToken, String xeroTenantId, Employee employee)Creates employeesEarningsTemplateObjectcreateEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeID, EarningsTemplate earningsTemplate)Creates an earnings template records for a specific employeecom.google.api.client.http.HttpResponsecreateEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EarningsTemplate earningsTemplate)Creates an earnings template records for a specific employeecom.google.api.client.http.HttpResponsecreateEmployeeForHttpResponse(String accessToken, String xeroTenantId, Employee employee)Creates employeesEmployeeLeaveObjectcreateEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeID, EmployeeLeave employeeLeave)Creates leave records for a specific employeecom.google.api.client.http.HttpResponsecreateEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EmployeeLeave employeeLeave)Creates leave records for a specific employeeEmployeeLeaveTypeObjectcreateEmployeeLeaveType(String accessToken, String xeroTenantId, UUID employeeID, EmployeeLeaveType employeeLeaveType)Creates employee leave type recordscom.google.api.client.http.HttpResponsecreateEmployeeLeaveTypeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EmployeeLeaveType employeeLeaveType)Creates employee leave type recordsEmployeeOpeningBalancesObjectcreateEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeID, EmployeeOpeningBalances employeeOpeningBalances)Creates an opening balance for a specific employeecom.google.api.client.http.HttpResponsecreateEmployeeOpeningBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EmployeeOpeningBalances employeeOpeningBalances)Creates an opening balance for a specific employeePaymentMethodObjectcreateEmployeePaymentMethod(String accessToken, String xeroTenantId, UUID employeeID, PaymentMethod paymentMethod)Creates an employee payment methodcom.google.api.client.http.HttpResponsecreateEmployeePaymentMethodForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, PaymentMethod paymentMethod)Creates an employee payment methodSalaryAndWageObjectcreateEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeID, SalaryAndWage salaryAndWage)Creates a salary and wage record for a specific employeecom.google.api.client.http.HttpResponsecreateEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, SalaryAndWage salaryAndWage)Creates a salary and wage record for a specific employeeEmployeeStatutorySickLeaveObjectcreateEmployeeStatutorySickLeave(String accessToken, String xeroTenantId, EmployeeStatutorySickLeave employeeStatutorySickLeave)Creates statutory sick leave recordscom.google.api.client.http.HttpResponsecreateEmployeeStatutorySickLeaveForHttpResponse(String accessToken, String xeroTenantId, EmployeeStatutorySickLeave employeeStatutorySickLeave)Creates statutory sick leave recordsEmploymentObjectcreateEmployment(String accessToken, String xeroTenantId, UUID employeeID, Employment employment)Creates employment detail for a specific employee using a unique employee IDcom.google.api.client.http.HttpResponsecreateEmploymentForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, Employment employment)Creates employment detail for a specific employee using a unique employee IDLeaveTypeObjectcreateLeaveType(String accessToken, String xeroTenantId, LeaveType leaveType)Creates a new leave typecom.google.api.client.http.HttpResponsecreateLeaveTypeForHttpResponse(String accessToken, String xeroTenantId, LeaveType leaveType)Creates a new leave typeEmployeePayTemplatescreateMultipleEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeID, List<EarningsTemplate> earningsTemplate)Creates multiple earnings template records for a specific employee using a unique employee IDcom.google.api.client.http.HttpResponsecreateMultipleEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, List<EarningsTemplate> earningsTemplate)Creates multiple earnings template records for a specific employee using a unique employee IDPayRunCalendarObjectcreatePayRunCalendar(String accessToken, String xeroTenantId, PayRunCalendar payRunCalendar)Creates a new payrun calendarcom.google.api.client.http.HttpResponsecreatePayRunCalendarForHttpResponse(String accessToken, String xeroTenantId, PayRunCalendar payRunCalendar)Creates a new payrun calendarReimbursementObjectcreateReimbursement(String accessToken, String xeroTenantId, Reimbursement reimbursement)Creates a new reimbursementcom.google.api.client.http.HttpResponsecreateReimbursementForHttpResponse(String accessToken, String xeroTenantId, Reimbursement reimbursement)Creates a new reimbursementTimesheetObjectcreateTimesheet(String accessToken, String xeroTenantId, Timesheet timesheet)Creates a new timesheetcom.google.api.client.http.HttpResponsecreateTimesheetForHttpResponse(String accessToken, String xeroTenantId, Timesheet timesheet)Creates a new timesheetTimesheetLineObjectcreateTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, TimesheetLine timesheetLine)Creates a new timesheet line for a specific timesheet using a unique timesheet IDcom.google.api.client.http.HttpResponsecreateTimesheetLineForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, TimesheetLine timesheetLine)Creates a new timesheet line for a specific timesheet using a unique timesheet IDvoiddeleteEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeID, UUID payTemplateEarningID)Deletes a specific employee's earnings template recordcom.google.api.client.http.HttpResponsedeleteEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID payTemplateEarningID)Deletes a specific employee's earnings template recordEmployeeLeaveObjectdeleteEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID)Deletes a specific employee's leave recordcom.google.api.client.http.HttpResponsedeleteEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID)Deletes a specific employee's leave recordvoiddeleteEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID)Deletes a salary and wages record for a specific employeecom.google.api.client.http.HttpResponsedeleteEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID)Deletes a salary and wages record for a specific employeeTimesheetLinedeleteTimesheet(String accessToken, String xeroTenantId, UUID timesheetID)Deletes a specific timesheetcom.google.api.client.http.HttpResponsedeleteTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)Deletes a specific timesheetTimesheetLinedeleteTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID)Deletes a specific timesheet linecom.google.api.client.http.HttpResponsedeleteTimesheetLineForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID)Deletes a specific timesheet lineApiClientgetApiClient()get ApiClientBenefitObjectgetBenefit(String accessToken, String xeroTenantId, UUID id)Retrieves a specific benefit by using a unique benefit IDcom.google.api.client.http.HttpResponsegetBenefitForHttpResponse(String accessToken, String xeroTenantId, UUID id)Retrieves a specific benefit by using a unique benefit IDBenefitsgetBenefits(String accessToken, String xeroTenantId, Integer page)Retrieves employee benefitscom.google.api.client.http.HttpResponsegetBenefitsForHttpResponse(String accessToken, String xeroTenantId, Integer page)Retrieves employee benefitsDeductionObjectgetDeduction(String accessToken, String xeroTenantId, UUID deductionId)Retrieves a specific deduction by using a unique deduction IDcom.google.api.client.http.HttpResponsegetDeductionForHttpResponse(String accessToken, String xeroTenantId, UUID deductionId)Retrieves a specific deduction by using a unique deduction IDDeductionsgetDeductions(String accessToken, String xeroTenantId, Integer page)Retrieves deductionscom.google.api.client.http.HttpResponsegetDeductionsForHttpResponse(String accessToken, String xeroTenantId, Integer page)Retrieves deductionsEarningsOrderObjectgetEarningsOrder(String accessToken, String xeroTenantId, UUID id)Retrieves a specific earnings orders by using a unique earnings orders idcom.google.api.client.http.HttpResponsegetEarningsOrderForHttpResponse(String accessToken, String xeroTenantId, UUID id)Retrieves a specific earnings orders by using a unique earnings orders idEarningsOrdersgetEarningsOrders(String accessToken, String xeroTenantId, Integer page)Retrieves earnings orderscom.google.api.client.http.HttpResponsegetEarningsOrdersForHttpResponse(String accessToken, String xeroTenantId, Integer page)Retrieves earnings ordersEarningsRateObjectgetEarningsRate(String accessToken, String xeroTenantId, UUID earningsRateID)Retrieves a specific earnings rates by using a unique earnings rate idcom.google.api.client.http.HttpResponsegetEarningsRateForHttpResponse(String accessToken, String xeroTenantId, UUID earningsRateID)Retrieves a specific earnings rates by using a unique earnings rate idEarningsRatesgetEarningsRates(String accessToken, String xeroTenantId, Integer page)Retrieves earnings ratescom.google.api.client.http.HttpResponsegetEarningsRatesForHttpResponse(String accessToken, String xeroTenantId, Integer page)Retrieves earnings ratesEmployeeObjectgetEmployee(String accessToken, String xeroTenantId, UUID employeeID)Retrieves specific employees by using a unique employee IDcom.google.api.client.http.HttpResponsegetEmployeeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)Retrieves specific employees by using a unique employee IDEmployeeLeaveObjectgetEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID)Retrieves a specific employee's leave record using a unique employee IDEmployeeLeaveBalancesgetEmployeeLeaveBalances(String accessToken, String xeroTenantId, UUID employeeID)Retrieves a specific employee's leave balances using a unique employee IDcom.google.api.client.http.HttpResponsegetEmployeeLeaveBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)Retrieves a specific employee's leave balances using a unique employee IDcom.google.api.client.http.HttpResponsegetEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID)Retrieves a specific employee's leave record using a unique employee IDLeavePeriodsgetEmployeeLeavePeriods(String accessToken, String xeroTenantId, UUID employeeID, org.threeten.bp.LocalDate startDate, org.threeten.bp.LocalDate endDate)Retrieves a specific employee's leave periods using a unique employee IDcom.google.api.client.http.HttpResponsegetEmployeeLeavePeriodsForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, org.threeten.bp.LocalDate startDate, org.threeten.bp.LocalDate endDate)Retrieves a specific employee's leave periods using a unique employee IDEmployeeLeavesgetEmployeeLeaves(String accessToken, String xeroTenantId, UUID employeeID)Retrieves a specific employee's leave records using a unique employee IDcom.google.api.client.http.HttpResponsegetEmployeeLeavesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)Retrieves a specific employee's leave records using a unique employee IDEmployeeLeaveTypesgetEmployeeLeaveTypes(String accessToken, String xeroTenantId, UUID employeeID)Retrieves a specific employee's leave types using a unique employee IDcom.google.api.client.http.HttpResponsegetEmployeeLeaveTypesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)Retrieves a specific employee's leave types using a unique employee IDEmployeeOpeningBalancesObjectgetEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeID)Retrieves a specific employee's openingbalances using a unique employee IDcom.google.api.client.http.HttpResponsegetEmployeeOpeningBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)Retrieves a specific employee's openingbalances using a unique employee IDPaymentMethodObjectgetEmployeePaymentMethod(String accessToken, String xeroTenantId, UUID employeeID)Retrieves a specific employee's payment method using a unique employee IDcom.google.api.client.http.HttpResponsegetEmployeePaymentMethodForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)Retrieves a specific employee's payment method using a unique employee IDEmployeePayTemplateObjectgetEmployeePayTemplate(String accessToken, String xeroTenantId, UUID employeeID)Retrieves a specific employee pay templates using a unique employee IDcom.google.api.client.http.HttpResponsegetEmployeePayTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)Retrieves a specific employee pay templates using a unique employee IDEmployeesgetEmployees(String accessToken, String xeroTenantId, String filter, Integer page)Retrieves employeesSalaryAndWagesgetEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID)Retrieves a specific salary and wages record for a specific employee using a unique salary and wage idcom.google.api.client.http.HttpResponsegetEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID)Retrieves a specific salary and wages record for a specific employee using a unique salary and wage idSalaryAndWagesgetEmployeeSalaryAndWages(String accessToken, String xeroTenantId, UUID employeeID, Integer page)Retrieves a specific employee's salary and wages by using a unique employee IDcom.google.api.client.http.HttpResponsegetEmployeeSalaryAndWagesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, Integer page)Retrieves a specific employee's salary and wages by using a unique employee IDcom.google.api.client.http.HttpResponsegetEmployeesForHttpResponse(String accessToken, String xeroTenantId, String filter, Integer page)Retrieves employeesEmployeeStatutoryLeaveBalanceObjectgetEmployeeStatutoryLeaveBalances(String accessToken, String xeroTenantId, UUID employeeID, String leaveType, org.threeten.bp.LocalDate asOfDate)Retrieves a specific employee's leave balances using a unique employee IDcom.google.api.client.http.HttpResponsegetEmployeeStatutoryLeaveBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, String leaveType, org.threeten.bp.LocalDate asOfDate)Retrieves a specific employee's leave balances using a unique employee IDEmployeeStatutorySickLeaveObjectgetEmployeeStatutorySickLeave(String accessToken, String xeroTenantId, UUID statutorySickLeaveID)Retrieves a statutory sick leave for an employeecom.google.api.client.http.HttpResponsegetEmployeeStatutorySickLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID statutorySickLeaveID)Retrieves a statutory sick leave for an employeeEmployeeTaxObjectgetEmployeeTax(String accessToken, String xeroTenantId, UUID employeeID)Retrieves tax records for a specific employee using a unique employee IDcom.google.api.client.http.HttpResponsegetEmployeeTaxForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)Retrieves tax records for a specific employee using a unique employee IDstatic PayrollUkApigetInstance(ApiClient apiClient)PayrollUkApi getInstanceLeaveTypeObjectgetLeaveType(String accessToken, String xeroTenantId, UUID leaveTypeID)Retrieves a specific leave type by using a unique leave type IDcom.google.api.client.http.HttpResponsegetLeaveTypeForHttpResponse(String accessToken, String xeroTenantId, UUID leaveTypeID)Retrieves a specific leave type by using a unique leave type IDLeaveTypesgetLeaveTypes(String accessToken, String xeroTenantId, Integer page, Boolean activeOnly)Retrieves leave typescom.google.api.client.http.HttpResponsegetLeaveTypesForHttpResponse(String accessToken, String xeroTenantId, Integer page, Boolean activeOnly)Retrieves leave typesPayRunObjectgetPayRun(String accessToken, String xeroTenantId, UUID payRunID)Retrieves a specific pay run by using a unique pay run IDPayRunCalendarObjectgetPayRunCalendar(String accessToken, String xeroTenantId, UUID payRunCalendarID)Retrieves a specific payrun calendar by using a unique payrun calendar IDcom.google.api.client.http.HttpResponsegetPayRunCalendarForHttpResponse(String accessToken, String xeroTenantId, UUID payRunCalendarID)Retrieves a specific payrun calendar by using a unique payrun calendar IDPayRunCalendarsgetPayRunCalendars(String accessToken, String xeroTenantId, Integer page)Retrieves payrun calendarscom.google.api.client.http.HttpResponsegetPayRunCalendarsForHttpResponse(String accessToken, String xeroTenantId, Integer page)Retrieves payrun calendarscom.google.api.client.http.HttpResponsegetPayRunForHttpResponse(String accessToken, String xeroTenantId, UUID payRunID)Retrieves a specific pay run by using a unique pay run IDPayRunsgetPayRuns(String accessToken, String xeroTenantId, Integer page, String status)Retrieves pay runscom.google.api.client.http.HttpResponsegetPayRunsForHttpResponse(String accessToken, String xeroTenantId, Integer page, String status)Retrieves pay runsPayslipObjectgetPaySlip(String accessToken, String xeroTenantId, UUID payslipID)Retrieves a specific payslip by using a unique payslip IDcom.google.api.client.http.HttpResponsegetPaySlipForHttpResponse(String accessToken, String xeroTenantId, UUID payslipID)Retrieves a specific payslip by using a unique payslip IDPayslipsgetPaySlips(String accessToken, String xeroTenantId, UUID payRunID, Integer page)Retrieves payslipscom.google.api.client.http.HttpResponsegetPaySlipsForHttpResponse(String accessToken, String xeroTenantId, UUID payRunID, Integer page)Retrieves payslipsReimbursementObjectgetReimbursement(String accessToken, String xeroTenantId, UUID reimbursementID)Retrieves a specific reimbursement by using a unique reimbursement idcom.google.api.client.http.HttpResponsegetReimbursementForHttpResponse(String accessToken, String xeroTenantId, UUID reimbursementID)Retrieves a specific reimbursement by using a unique reimbursement idReimbursementsgetReimbursements(String accessToken, String xeroTenantId, Integer page)Retrieves reimbursementscom.google.api.client.http.HttpResponsegetReimbursementsForHttpResponse(String accessToken, String xeroTenantId, Integer page)Retrieves reimbursementsSettingsgetSettings(String accessToken, String xeroTenantId)Retrieves payroll settingscom.google.api.client.http.HttpResponsegetSettingsForHttpResponse(String accessToken, String xeroTenantId)Retrieves payroll settingsEmployeeStatutoryLeavesSummariesgetStatutoryLeaveSummary(String accessToken, String xeroTenantId, UUID employeeID, Boolean activeOnly)Retrieves a specific employee's summary of statutory leaves using a unique employee IDcom.google.api.client.http.HttpResponsegetStatutoryLeaveSummaryForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, Boolean activeOnly)Retrieves a specific employee's summary of statutory leaves using a unique employee IDTimesheetObjectgetTimesheet(String accessToken, String xeroTenantId, UUID timesheetID)Retrieve a specific timesheet by using a unique timesheet IDcom.google.api.client.http.HttpResponsegetTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)Retrieve a specific timesheet by using a unique timesheet IDTimesheetsgetTimesheets(String accessToken, String xeroTenantId, Integer page, String filter)Retrieves timesheetscom.google.api.client.http.HttpResponsegetTimesheetsForHttpResponse(String accessToken, String xeroTenantId, Integer page, String filter)Retrieves timesheetsTrackingCategoriesgetTrackingCategories(String accessToken, String xeroTenantId)Retrieves tracking categoriescom.google.api.client.http.HttpResponsegetTrackingCategoriesForHttpResponse(String accessToken, String xeroTenantId)Retrieves tracking categoriesStringgetUserAgent()get user agentTimesheetObjectrevertTimesheet(String accessToken, String xeroTenantId, UUID timesheetID)Reverts a specific timesheet to draftcom.google.api.client.http.HttpResponserevertTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)Reverts a specific timesheet to draftvoidsetApiClient(ApiClient apiClient)set ApiClientvoidsetUserAgent(String userAgent)set user agentEmployeeObjectupdateEmployee(String accessToken, String xeroTenantId, UUID employeeID, Employee employee)Updates a specific employee's detailEarningsTemplateObjectupdateEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeID, UUID payTemplateEarningID, EarningsTemplate earningsTemplate)Updates a specific employee's earnings template recordscom.google.api.client.http.HttpResponseupdateEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID payTemplateEarningID, EarningsTemplate earningsTemplate)Updates a specific employee's earnings template recordscom.google.api.client.http.HttpResponseupdateEmployeeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, Employee employee)Updates a specific employee's detailEmployeeLeaveObjectupdateEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID, EmployeeLeave employeeLeave)Updates a specific employee's leave recordscom.google.api.client.http.HttpResponseupdateEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID, EmployeeLeave employeeLeave)Updates a specific employee's leave recordsEmployeeOpeningBalancesObjectupdateEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeID, EmployeeOpeningBalances employeeOpeningBalances)Updates a specific employee's opening balancescom.google.api.client.http.HttpResponseupdateEmployeeOpeningBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EmployeeOpeningBalances employeeOpeningBalances)Updates a specific employee's opening balancesSalaryAndWageObjectupdateEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID, SalaryAndWage salaryAndWage)Updates salary and wages record for a specific employeecom.google.api.client.http.HttpResponseupdateEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID, SalaryAndWage salaryAndWage)Updates salary and wages record for a specific employeePayRunObjectupdatePayRun(String accessToken, String xeroTenantId, UUID payRunID, PayRun payRun)Updates a specific pay runcom.google.api.client.http.HttpResponseupdatePayRunForHttpResponse(String accessToken, String xeroTenantId, UUID payRunID, PayRun payRun)Updates a specific pay runTimesheetLineObjectupdateTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID, TimesheetLine timesheetLine)Updates a specific timesheet line for a specific timesheetcom.google.api.client.http.HttpResponseupdateTimesheetLineForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID, TimesheetLine timesheetLine)Updates a specific timesheet line for a specific timesheet
-
-
-
Constructor Detail
-
PayrollUkApi
public PayrollUkApi()
PayrollUkApi
-
PayrollUkApi
public PayrollUkApi(ApiClient apiClient)
PayrollUkApi- Parameters:
apiClient- ApiClient pass into the new instance of this class
-
-
Method Detail
-
getInstance
public static PayrollUkApi getInstance(ApiClient apiClient)
PayrollUkApi getInstance- Parameters:
apiClient- ApiClient pass into the new instance of this class- Returns:
- instance of this class
-
getApiClient
public ApiClient getApiClient()
get ApiClient- Returns:
- apiClient the current ApiClient
-
setApiClient
public void setApiClient(ApiClient apiClient)
set ApiClient- Parameters:
apiClient- ApiClient pass into the new instance of this class
-
setUserAgent
public void setUserAgent(String userAgent)
set user agent- Parameters:
userAgent- string to override the user agent
-
getUserAgent
public String getUserAgent()
get user agent- Returns:
- String of user agent
-
approveTimesheet
public TimesheetObject approveTimesheet(String accessToken, String xeroTenantId, UUID timesheetID) throws IOException
Approves a specific timesheet200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenanttimesheetID- Identifier for the timesheetaccessToken- 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 specific timesheet200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenanttimesheetID- Identifier for the timesheetaccessToken- Authorization token for user set in header of each request- Returns:
- HttpResponse
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
createBenefit
public BenefitObject createBenefit(String accessToken, String xeroTenantId, Benefit benefit) throws IOException
Creates a new employee benefit200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for Tenantbenefit- The benefit parameteraccessToken- Authorization token for user set in header of each request- Returns:
- BenefitObject
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
createBenefitForHttpResponse
public com.google.api.client.http.HttpResponse createBenefitForHttpResponse(String accessToken, String xeroTenantId, Benefit benefit) throws IOException
Creates a new employee benefit200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for Tenantbenefit- The benefit parameteraccessToken- 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 deduction200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for Tenantdeduction- The deduction parameteraccessToken- 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 deduction200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for Tenantdeduction- The deduction parameteraccessToken- 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 rate200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantearningsRate- The earningsRate parameteraccessToken- 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 rate200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantearningsRate- The earningsRate parameteraccessToken- 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 employees200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for Tenantemployee- The employee parameteraccessToken- 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 employees200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for Tenantemployee- The employee parameteraccessToken- 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 an earnings template records for a specific employee200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectearningsTemplate- The earningsTemplate parameteraccessToken- 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 an earnings template records for a specific employee200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectearningsTemplate- The earningsTemplate parameteraccessToken- 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 employee200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectemployeeLeave- The employeeLeave parameteraccessToken- 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 employee200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectemployeeLeave- The employeeLeave parameteraccessToken- 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 employee leave type records200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectemployeeLeaveType- The employeeLeaveType parameteraccessToken- 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 employee leave type records200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectemployeeLeaveType- The employeeLeaveType parameteraccessToken- 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, EmployeeOpeningBalances employeeOpeningBalances) throws IOException
Creates an opening balance for a specific employee200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectemployeeOpeningBalances- The employeeOpeningBalances parameteraccessToken- Authorization token for user set in header of each request- Returns:
- EmployeeOpeningBalancesObject
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
createEmployeeOpeningBalancesForHttpResponse
public com.google.api.client.http.HttpResponse createEmployeeOpeningBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EmployeeOpeningBalances employeeOpeningBalances) throws IOException
Creates an opening balance for a specific employee200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectemployeeOpeningBalances- The employeeOpeningBalances parameteraccessToken- 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 an employee payment method200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectpaymentMethod- The paymentMethod parameteraccessToken- 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 an employee payment method200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectpaymentMethod- The paymentMethod parameteraccessToken- 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 a salary and wage record for a specific employee200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectsalaryAndWage- The salaryAndWage parameteraccessToken- 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 a salary and wage record for a specific employee200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectsalaryAndWage- The salaryAndWage parameteraccessToken- Authorization token for user set in header of each request- Returns:
- HttpResponse
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
createEmployeeStatutorySickLeave
public EmployeeStatutorySickLeaveObject createEmployeeStatutorySickLeave(String accessToken, String xeroTenantId, EmployeeStatutorySickLeave employeeStatutorySickLeave) throws IOException
Creates statutory sick leave records200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeStatutorySickLeave- The employeeStatutorySickLeave parameteraccessToken- Authorization token for user set in header of each request- Returns:
- EmployeeStatutorySickLeaveObject
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
createEmployeeStatutorySickLeaveForHttpResponse
public com.google.api.client.http.HttpResponse createEmployeeStatutorySickLeaveForHttpResponse(String accessToken, String xeroTenantId, EmployeeStatutorySickLeave employeeStatutorySickLeave) throws IOException
Creates statutory sick leave records200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeStatutorySickLeave- The employeeStatutorySickLeave parameteraccessToken- 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 employment detail for a specific employee using a unique employee ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectemployment- The employment parameteraccessToken- 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 employment detail for a specific employee using a unique employee ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectemployment- The employment parameteraccessToken- 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 type200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantleaveType- The leaveType parameteraccessToken- 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 type200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantleaveType- The leaveType parameteraccessToken- 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 EmployeePayTemplates createMultipleEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeID, List<EarningsTemplate> earningsTemplate) throws IOException
Creates multiple earnings template records for a specific employee using a unique employee ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectearningsTemplate- The earningsTemplate parameteraccessToken- Authorization token for user set in header of each request- Returns:
- EmployeePayTemplates
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
createMultipleEmployeeEarningsTemplateForHttpResponse
public com.google.api.client.http.HttpResponse createMultipleEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, List<EarningsTemplate> earningsTemplate) throws IOException
Creates multiple earnings template records for a specific employee using a unique employee ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectearningsTemplate- The earningsTemplate parameteraccessToken- 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 calendar200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantpayRunCalendar- The payRunCalendar parameteraccessToken- 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 calendar200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantpayRunCalendar- The payRunCalendar parameteraccessToken- 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 reimbursement200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for Tenantreimbursement- The reimbursement parameteraccessToken- 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 reimbursement200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for Tenantreimbursement- The reimbursement parameteraccessToken- 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 timesheet200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for Tenanttimesheet- The timesheet parameteraccessToken- 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 timesheet200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for Tenanttimesheet- The timesheet parameteraccessToken- 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
Creates a new timesheet line for a specific timesheet using a unique timesheet ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenanttimesheetID- Identifier for the timesheettimesheetLine- The timesheetLine parameteraccessToken- 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
Creates a new timesheet line for a specific timesheet using a unique timesheet ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenanttimesheetID- Identifier for the timesheettimesheetLine- The timesheetLine parameteraccessToken- 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 void deleteEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeID, UUID payTemplateEarningID) throws IOException
Deletes a specific employee's earnings template record200 - deletion successful
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectpayTemplateEarningID- Id for single pay template earnings objectaccessToken- Authorization token for user set in header of each request- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
deleteEmployeeEarningsTemplateForHttpResponse
public com.google.api.client.http.HttpResponse deleteEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID payTemplateEarningID) throws IOException
Deletes a specific employee's earnings template record200 - deletion successful
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectpayTemplateEarningID- Id for single pay template earnings objectaccessToken- 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 specific employee's leave record200 - successful response
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectleaveID- Leave id for single objectaccessToken- 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 specific employee's leave record200 - successful response
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectleaveID- Leave id for single objectaccessToken- 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 void deleteEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID) throws IOException
Deletes a salary and wages record for a specific employee200 - deletion successful
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectsalaryAndWagesID- Id for single salary and wages objectaccessToken- Authorization token for user set in header of each request- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
deleteEmployeeSalaryAndWageForHttpResponse
public com.google.api.client.http.HttpResponse deleteEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID salaryAndWagesID) throws IOException
Deletes a salary and wages record for a specific employee200 - deletion successful
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectsalaryAndWagesID- Id for single salary and wages objectaccessToken- 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 specific timesheet200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenanttimesheetID- Identifier for the timesheetaccessToken- 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 specific timesheet200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenanttimesheetID- Identifier for the timesheetaccessToken- 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 specific timesheet line200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenanttimesheetID- Identifier for the timesheettimesheetLineID- Identifier for the timesheet lineaccessToken- 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 specific timesheet line200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenanttimesheetID- Identifier for the timesheettimesheetLineID- Identifier for the timesheet lineaccessToken- Authorization token for user set in header of each request- Returns:
- HttpResponse
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getBenefit
public BenefitObject getBenefit(String accessToken, String xeroTenantId, UUID id) throws IOException
Retrieves a specific benefit by using a unique benefit ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantid- Identifier for the benefitaccessToken- Authorization token for user set in header of each request- Returns:
- BenefitObject
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
getBenefitForHttpResponse
public com.google.api.client.http.HttpResponse getBenefitForHttpResponse(String accessToken, String xeroTenantId, UUID id) throws IOException
Retrieves a specific benefit by using a unique benefit ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantid- Identifier for the benefitaccessToken- Authorization token for user set in header of each request- Returns:
- HttpResponse
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getBenefits
public Benefits getBenefits(String accessToken, String xeroTenantId, Integer page) throws IOException
Retrieves employee benefits200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.accessToken- Authorization token for user set in header of each request- Returns:
- Benefits
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
getBenefitsForHttpResponse
public com.google.api.client.http.HttpResponse getBenefitsForHttpResponse(String accessToken, String xeroTenantId, Integer page) throws IOException
Retrieves employee benefits200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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
-
getDeduction
public DeductionObject getDeduction(String accessToken, String xeroTenantId, UUID deductionId) throws IOException
Retrieves a specific deduction by using a unique deduction ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantdeductionId- Identifier for the deductionaccessToken- 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 specific deduction by using a unique deduction ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantdeductionId- Identifier for the deductionaccessToken- 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 deductions200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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 deductions200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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
-
getEarningsOrder
public EarningsOrderObject getEarningsOrder(String accessToken, String xeroTenantId, UUID id) throws IOException
Retrieves a specific earnings orders by using a unique earnings orders id200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantid- Identifier for the deductionaccessToken- Authorization token for user set in header of each request- Returns:
- EarningsOrderObject
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
getEarningsOrderForHttpResponse
public com.google.api.client.http.HttpResponse getEarningsOrderForHttpResponse(String accessToken, String xeroTenantId, UUID id) throws IOException
Retrieves a specific earnings orders by using a unique earnings orders id200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantid- Identifier for the deductionaccessToken- Authorization token for user set in header of each request- Returns:
- HttpResponse
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getEarningsOrders
public EarningsOrders getEarningsOrders(String accessToken, String xeroTenantId, Integer page) throws IOException
Retrieves earnings orders200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.accessToken- Authorization token for user set in header of each request- Returns:
- EarningsOrders
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
getEarningsOrdersForHttpResponse
public com.google.api.client.http.HttpResponse getEarningsOrdersForHttpResponse(String accessToken, String xeroTenantId, Integer page) throws IOException
Retrieves earnings orders200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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 id200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantearningsRateID- Identifier for the earnings rateaccessToken- 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 id200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantearningsRateID- Identifier for the earnings rateaccessToken- 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 rates200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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 rates200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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 specific employees by using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- 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 specific employees by using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- Authorization token for user set in header of each request- Returns:
- HttpResponse
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getEmployeeLeave
public EmployeeLeaveObject getEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID) throws IOException
Retrieves a specific employee's leave record using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectleaveID- Leave id for single objectaccessToken- Authorization token for user set in header of each request- Returns:
- EmployeeLeaveObject
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
getEmployeeLeaveForHttpResponse
public com.google.api.client.http.HttpResponse getEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, UUID leaveID) throws IOException
Retrieves a specific employee's leave record using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectleaveID- Leave id for single objectaccessToken- 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 a specific employee's leave balances using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- 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 a specific employee's leave balances using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- 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 a specific employee's leave periods using a unique employee ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectstartDate- Filter by start dateendDate- Filter by end dateaccessToken- 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 a specific employee's leave periods using a unique employee ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectstartDate- Filter by start dateendDate- Filter by end dateaccessToken- 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 a specific employee's leave types using a unique employee ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- 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 a specific employee's leave types using a unique employee ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- 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 a specific employee's leave records using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- 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 a specific employee's leave records using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- 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 a specific employee's openingbalances using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- 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 a specific employee's openingbalances using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- Authorization token for user set in header of each request- Returns:
- HttpResponse
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getEmployeePayTemplate
public EmployeePayTemplateObject getEmployeePayTemplate(String accessToken, String xeroTenantId, UUID employeeID) throws IOException
Retrieves a specific employee pay templates using a unique employee ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- Authorization token for user set in header of each request- Returns:
- EmployeePayTemplateObject
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
getEmployeePayTemplateForHttpResponse
public com.google.api.client.http.HttpResponse getEmployeePayTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID) throws IOException
Retrieves a specific employee pay templates using a unique employee ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- 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 a specific employee's payment method using a unique employee ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- 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 a specific employee's payment method using a unique employee ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- 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 a specific salary and wages record for a specific employee using a unique salary and wage id200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectsalaryAndWagesID- Id for single pay template earnings objectaccessToken- 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 a specific salary and wages record for a specific employee using a unique salary and wage id200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectsalaryAndWagesID- Id for single pay template earnings objectaccessToken- 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 a specific employee's salary and wages by using a unique employee ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectpage- 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 a specific employee's salary and wages by using a unique employee ID200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectpage- 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
-
getEmployeeStatutoryLeaveBalances
public EmployeeStatutoryLeaveBalanceObject getEmployeeStatutoryLeaveBalances(String accessToken, String xeroTenantId, UUID employeeID, String leaveType, org.threeten.bp.LocalDate asOfDate) throws IOException
Retrieves a specific employee's leave balances using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectleaveType- Filter by the type of statutory leaveasOfDate- The date from which to calculate balance remaining. If not specified, current date UTC is used.accessToken- Authorization token for user set in header of each request- Returns:
- EmployeeStatutoryLeaveBalanceObject
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
getEmployeeStatutoryLeaveBalancesForHttpResponse
public com.google.api.client.http.HttpResponse getEmployeeStatutoryLeaveBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, String leaveType, org.threeten.bp.LocalDate asOfDate) throws IOException
Retrieves a specific employee's leave balances using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectleaveType- Filter by the type of statutory leaveasOfDate- The date from which to calculate balance remaining. If not specified, current date UTC is used.accessToken- Authorization token for user set in header of each request- Returns:
- HttpResponse
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getEmployeeStatutorySickLeave
public EmployeeStatutorySickLeaveObject getEmployeeStatutorySickLeave(String accessToken, String xeroTenantId, UUID statutorySickLeaveID) throws IOException
Retrieves a statutory sick leave for an employee200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantstatutorySickLeaveID- Statutory sick leave id for single objectaccessToken- Authorization token for user set in header of each request- Returns:
- EmployeeStatutorySickLeaveObject
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
getEmployeeStatutorySickLeaveForHttpResponse
public com.google.api.client.http.HttpResponse getEmployeeStatutorySickLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID statutorySickLeaveID) throws IOException
Retrieves a statutory sick leave for an employee200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantstatutorySickLeaveID- Statutory sick leave id for single objectaccessToken- 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 using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- 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 using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectaccessToken- 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 filter, Integer page) throws IOException
Retrieves employees200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for Tenantfilter- Filter by first name and/or lastnamepage- 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 filter, Integer page) throws IOException
Retrieves employees200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for Tenantfilter- Filter by first name and/or lastnamepage- 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 ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantleaveTypeID- Identifier for the leave typeaccessToken- 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 ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantleaveTypeID- Identifier for the leave typeaccessToken- 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 types200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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 types200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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 ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantpayRunID- Identifier for the pay runaccessToken- 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 ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantpayRunID- Identifier for the pay runaccessToken- 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 payRunCalendarID) throws IOException
Retrieves a specific payrun calendar by using a unique payrun calendar ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantpayRunCalendarID- Identifier for the payrun calendarsaccessToken- Authorization token for user set in header of each request- Returns:
- PayRunCalendarObject
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
getPayRunCalendarForHttpResponse
public com.google.api.client.http.HttpResponse getPayRunCalendarForHttpResponse(String accessToken, String xeroTenantId, UUID payRunCalendarID) throws IOException
Retrieves a specific payrun calendar by using a unique payrun calendar ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantpayRunCalendarID- Identifier for the payrun calendarsaccessToken- 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 calendars200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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 calendars200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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 runs200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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 runs200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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 using a unique payslip ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantpayslipID- Identifier for the payslipaccessToken- 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 using a unique payslip ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantpayslipID- Identifier for the payslipaccessToken- 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 payslips200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantpayRunID- 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 payslips200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantpayRunID- 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 id200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantreimbursementID- Identifier for the reimbursementaccessToken- 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 id200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantreimbursementID- Identifier for the reimbursementaccessToken- 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 reimbursements200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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 reimbursements200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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 payroll settings200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantaccessToken- 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 payroll settings200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantaccessToken- Authorization token for user set in header of each request- Returns:
- HttpResponse
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getStatutoryLeaveSummary
public EmployeeStatutoryLeavesSummaries getStatutoryLeaveSummary(String accessToken, String xeroTenantId, UUID employeeID, Boolean activeOnly) throws IOException
Retrieves a specific employee's summary of statutory leaves using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectactiveOnly- Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future scheduled) are returnedaccessToken- Authorization token for user set in header of each request- Returns:
- EmployeeStatutoryLeavesSummaries
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
getStatutoryLeaveSummaryForHttpResponse
public com.google.api.client.http.HttpResponse getStatutoryLeaveSummaryForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, Boolean activeOnly) throws IOException
Retrieves a specific employee's summary of statutory leaves using a unique employee ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectactiveOnly- Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future scheduled) are returnedaccessToken- 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
Retrieve a specific timesheet by using a unique timesheet ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenanttimesheetID- Identifier for the timesheetaccessToken- 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
Retrieve a specific timesheet by using a unique timesheet ID200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenanttimesheetID- Identifier for the timesheetaccessToken- 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, String filter) throws IOException
Retrieves timesheets200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.filter- Filter by first name and/or lastnameaccessToken- 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, String filter) throws IOException
Retrieves timesheets200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.filter- Filter by first name and/or lastnameaccessToken- 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 categories200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantaccessToken- 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 categories200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantaccessToken- 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 specific timesheet to draft200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenanttimesheetID- Identifier for the timesheetaccessToken- 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 specific timesheet to draft200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenanttimesheetID- Identifier for the timesheetaccessToken- 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 a specific employee's detail200 - successful response
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectemployee- The employee parameteraccessToken- 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 a specific employee's detail200 - successful response
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectemployee- The employee parameteraccessToken- 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 a specific employee's earnings template records200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectpayTemplateEarningID- Id for single pay template earnings objectearningsTemplate- The earningsTemplate parameteraccessToken- 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 a specific employee's earnings template records200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectpayTemplateEarningID- Id for single pay template earnings objectearningsTemplate- The earningsTemplate parameteraccessToken- 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 a specific employee's leave records200 - successful response
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectleaveID- Leave id for single objectemployeeLeave- The employeeLeave parameteraccessToken- 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 a specific employee's leave records200 - successful response
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectleaveID- Leave id for single objectemployeeLeave- The employeeLeave parameteraccessToken- Authorization token for user set in header of each request- Returns:
- HttpResponse
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
updateEmployeeOpeningBalances
public EmployeeOpeningBalancesObject updateEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeID, EmployeeOpeningBalances employeeOpeningBalances) throws IOException
Updates a specific employee's opening balances200 - successful response
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectemployeeOpeningBalances- The employeeOpeningBalances parameteraccessToken- Authorization token for user set in header of each request- Returns:
- EmployeeOpeningBalancesObject
- Throws:
IOException- if an error occurs while attempting to invoke the API *
-
updateEmployeeOpeningBalancesForHttpResponse
public com.google.api.client.http.HttpResponse updateEmployeeOpeningBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, EmployeeOpeningBalances employeeOpeningBalances) throws IOException
Updates a specific employee's opening balances200 - successful response
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectemployeeOpeningBalances- The employeeOpeningBalances parameteraccessToken- 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 salary and wages record for a specific employee200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectsalaryAndWagesID- Id for single pay template earnings objectsalaryAndWage- The salaryAndWage parameteraccessToken- 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 salary and wages record for a specific employee200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Employee id for single objectsalaryAndWagesID- Id for single pay template earnings objectsalaryAndWage- The salaryAndWage parameteraccessToken- 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 specific pay run200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantpayRunID- Identifier for the pay runpayRun- The payRun parameteraccessToken- 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 specific pay run200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantpayRunID- Identifier for the pay runpayRun- The payRun parameteraccessToken- 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 specific timesheet line for a specific timesheet200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenanttimesheetID- Identifier for the timesheettimesheetLineID- Identifier for the timesheet linetimesheetLine- The timesheetLine parameteraccessToken- 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 specific timesheet line for a specific timesheet200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenanttimesheetID- Identifier for the timesheettimesheetLineID- Identifier for the timesheet linetimesheetLine- The timesheetLine parameteraccessToken- 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
-
-