Class PayrollNzApi
public class PayrollNzApi extends Object
-
Constructor Summary
Constructors Constructor Description PayrollNzApi()PayrollNzApi(ApiClient apiClient) -
Method Summary
Modifier and Type Method Description TimesheetObjectapproveTimesheet(String accessToken, String xeroTenantId, UUID timesheetID)approve a timesheetcom.google.api.client.http.HttpResponseapproveTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)ByteArrayInputStreamconvertInputToByteArray(InputStream is)DeductionObjectcreateDeduction(String accessToken, String xeroTenantId, Deduction deduction)create a new deductioncom.google.api.client.http.HttpResponsecreateDeductionForHttpResponse(String accessToken, String xeroTenantId, Deduction deduction)EarningsRateObjectcreateEarningsRate(String accessToken, String xeroTenantId, EarningsRate earningsRate)create a new earnings ratecom.google.api.client.http.HttpResponsecreateEarningsRateForHttpResponse(String accessToken, String xeroTenantId, EarningsRate earningsRate)EmployeeObjectcreateEmployee(String accessToken, String xeroTenantId, Employee employee)creates employeesEarningsTemplateObjectcreateEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeId, EarningsTemplate earningsTemplate)creates employee earnings template recordscom.google.api.client.http.HttpResponsecreateEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, EarningsTemplate earningsTemplate)com.google.api.client.http.HttpResponsecreateEmployeeForHttpResponse(String accessToken, String xeroTenantId, Employee employee)EmployeeLeaveObjectcreateEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeId, EmployeeLeave employeeLeave)creates employee leave recordscom.google.api.client.http.HttpResponsecreateEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, EmployeeLeave employeeLeave)EmployeeLeaveSetupObjectcreateEmployeeLeaveSetup(String accessToken, String xeroTenantId, UUID employeeId, EmployeeLeaveSetup employeeLeaveSetup)Allows you to set-up leave for a specific employee.com.google.api.client.http.HttpResponsecreateEmployeeLeaveSetupForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, EmployeeLeaveSetup employeeLeaveSetup)EmployeeLeaveTypeObjectcreateEmployeeLeaveType(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)EmployeeOpeningBalancesObjectcreateEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeId, List<EmployeeOpeningBalance> employeeOpeningBalance)creates employee opening balancescom.google.api.client.http.HttpResponsecreateEmployeeOpeningBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, List<EmployeeOpeningBalance> employeeOpeningBalance)PaymentMethodObjectcreateEmployeePaymentMethod(String accessToken, String xeroTenantId, UUID employeeId, PaymentMethod paymentMethod)creates employee payment methodcom.google.api.client.http.HttpResponsecreateEmployeePaymentMethodForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, PaymentMethod paymentMethod)SalaryAndWageObjectcreateEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeId, SalaryAndWage salaryAndWage)creates employee salary and wage recordcom.google.api.client.http.HttpResponsecreateEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, SalaryAndWage salaryAndWage)EmploymentObjectcreateEmployment(String accessToken, String xeroTenantId, UUID employeeId, Employment employment)creates employmentcom.google.api.client.http.HttpResponsecreateEmploymentForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, Employment employment)LeaveTypeObjectcreateLeaveType(String accessToken, String xeroTenantId, LeaveType leaveType)create a new leave typecom.google.api.client.http.HttpResponsecreateLeaveTypeForHttpResponse(String accessToken, String xeroTenantId, LeaveType leaveType)EmployeeEarningsTemplatescreateMultipleEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeId, List<EarningsTemplate> earningsTemplate)creates multiple employee earnings template recordscom.google.api.client.http.HttpResponsecreateMultipleEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, List<EarningsTemplate> earningsTemplate)PayRunObjectcreatePayRun(String accessToken, String xeroTenantId, PayRun payRun)create a pay runPayRunCalendarObjectcreatePayRunCalendar(String accessToken, String xeroTenantId, PayRunCalendar payRunCalendar)create a new payrun calendarcom.google.api.client.http.HttpResponsecreatePayRunCalendarForHttpResponse(String accessToken, String xeroTenantId, PayRunCalendar payRunCalendar)com.google.api.client.http.HttpResponsecreatePayRunForHttpResponse(String accessToken, String xeroTenantId, PayRun payRun)ReimbursementObjectcreateReimbursement(String accessToken, String xeroTenantId, Reimbursement reimbursement)create a new reimbursementcom.google.api.client.http.HttpResponsecreateReimbursementForHttpResponse(String accessToken, String xeroTenantId, Reimbursement reimbursement)SuperannuationObjectcreateSuperannuation(String accessToken, String xeroTenantId, Benefit benefit)create a new superannuationcom.google.api.client.http.HttpResponsecreateSuperannuationForHttpResponse(String accessToken, String xeroTenantId, Benefit benefit)TimesheetObjectcreateTimesheet(String accessToken, String xeroTenantId, Timesheet timesheet)create a new timesheetcom.google.api.client.http.HttpResponsecreateTimesheetForHttpResponse(String accessToken, String xeroTenantId, Timesheet timesheet)TimesheetLineObjectcreateTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, TimesheetLine timesheetLine)create a new timesheet linecom.google.api.client.http.HttpResponsecreateTimesheetLineForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, TimesheetLine timesheetLine)EarningsTemplateObjectdeleteEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeId, UUID payTemplateEarningID)deletes an employee earnings template recordcom.google.api.client.http.HttpResponsedeleteEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, UUID payTemplateEarningID)EmployeeLeaveObjectdeleteEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeId, UUID leaveID)deletes an employee leave recordcom.google.api.client.http.HttpResponsedeleteEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, UUID leaveID)SalaryAndWageObjectdeleteEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeId, UUID salaryAndWagesID)deletes an employee salary and wages recordcom.google.api.client.http.HttpResponsedeleteEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, UUID salaryAndWagesID)TimesheetLinedeleteTimesheet(String accessToken, String xeroTenantId, UUID timesheetID)delete a timesheetcom.google.api.client.http.HttpResponsedeleteTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)TimesheetLinedeleteTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID)delete a timesheet linecom.google.api.client.http.HttpResponsedeleteTimesheetLineForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID)ApiClientgetApiClient()DeductionObjectgetDeduction(String accessToken, String xeroTenantId, UUID deductionId)retrieve a single deduction by idcom.google.api.client.http.HttpResponsegetDeductionForHttpResponse(String accessToken, String xeroTenantId, UUID deductionId)DeductionsgetDeductions(String accessToken, String xeroTenantId, Integer page)searches deductionscom.google.api.client.http.HttpResponsegetDeductionsForHttpResponse(String accessToken, String xeroTenantId, Integer page)EarningsRateObjectgetEarningsRate(String accessToken, String xeroTenantId, UUID earningsRateID)retrieve a single earnings rates by idcom.google.api.client.http.HttpResponsegetEarningsRateForHttpResponse(String accessToken, String xeroTenantId, UUID earningsRateID)EarningsRatesgetEarningsRates(String accessToken, String xeroTenantId, Integer page)searches earnings ratescom.google.api.client.http.HttpResponsegetEarningsRatesForHttpResponse(String accessToken, String xeroTenantId, Integer page)EmployeeObjectgetEmployee(String accessToken, String xeroTenantId, UUID employeeId)searches employeescom.google.api.client.http.HttpResponsegetEmployeeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId)EmployeeLeaveBalancesgetEmployeeLeaveBalances(String accessToken, String xeroTenantId, UUID employeeId)search employee leave balancescom.google.api.client.http.HttpResponsegetEmployeeLeaveBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId)LeavePeriodsgetEmployeeLeavePeriods(String accessToken, String xeroTenantId, UUID employeeId, org.threeten.bp.LocalDate startDate, org.threeten.bp.LocalDate endDate)searches employee leave periodscom.google.api.client.http.HttpResponsegetEmployeeLeavePeriodsForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, org.threeten.bp.LocalDate startDate, org.threeten.bp.LocalDate endDate)EmployeeLeavesgetEmployeeLeaves(String accessToken, String xeroTenantId, UUID employeeId)search employee leave recordscom.google.api.client.http.HttpResponsegetEmployeeLeavesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId)EmployeeLeaveTypesgetEmployeeLeaveTypes(String accessToken, String xeroTenantId, UUID employeeId)searches employee leave typescom.google.api.client.http.HttpResponsegetEmployeeLeaveTypesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId)EmployeeOpeningBalancesObjectgetEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeId)retrieve employee openingbalancescom.google.api.client.http.HttpResponsegetEmployeeOpeningBalancesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId)PaymentMethodObjectgetEmployeePaymentMethod(String accessToken, String xeroTenantId, UUID employeeId)retrieves an employee's payment methodcom.google.api.client.http.HttpResponsegetEmployeePaymentMethodForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId)EmployeePayTemplatesgetEmployeePayTemplates(String accessToken, String xeroTenantId, UUID employeeId)searches employee pay templatescom.google.api.client.http.HttpResponsegetEmployeePayTemplatesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId)EmployeesgetEmployees(String accessToken, String xeroTenantId, String firstName, String lastName, Integer page)searches employeesSalaryAndWagesgetEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeId, UUID salaryAndWagesID)get employee salary and wages record by idcom.google.api.client.http.HttpResponsegetEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, UUID salaryAndWagesID)SalaryAndWagesgetEmployeeSalaryAndWages(String accessToken, String xeroTenantId, UUID employeeId, Integer page)retrieves an employee's salary and wagescom.google.api.client.http.HttpResponsegetEmployeeSalaryAndWagesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, Integer page)com.google.api.client.http.HttpResponsegetEmployeesForHttpResponse(String accessToken, String xeroTenantId, String firstName, String lastName, Integer page)EmployeeTaxObjectgetEmployeeTax(String accessToken, String xeroTenantId, UUID employeeId)searches tax records for an employeecom.google.api.client.http.HttpResponsegetEmployeeTaxForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId)static PayrollNzApigetInstance(ApiClient apiClient)LeaveTypeObjectgetLeaveType(String accessToken, String xeroTenantId, UUID leaveTypeID)retrieve a single leave type by idcom.google.api.client.http.HttpResponsegetLeaveTypeForHttpResponse(String accessToken, String xeroTenantId, UUID leaveTypeID)LeaveTypesgetLeaveTypes(String accessToken, String xeroTenantId, Integer page, Boolean activeOnly)searches leave typescom.google.api.client.http.HttpResponsegetLeaveTypesForHttpResponse(String accessToken, String xeroTenantId, Integer page, Boolean activeOnly)PayRunObjectgetPayRun(String accessToken, String xeroTenantId, UUID payRunID)retrieve a single pay run by idPayRunCalendarObjectgetPayRunCalendar(String accessToken, String xeroTenantId, UUID payrollCalendarID)retrieve a single payrun calendar by idcom.google.api.client.http.HttpResponsegetPayRunCalendarForHttpResponse(String accessToken, String xeroTenantId, UUID payrollCalendarID)PayRunCalendarsgetPayRunCalendars(String accessToken, String xeroTenantId, Integer page)searches payrun calendarscom.google.api.client.http.HttpResponsegetPayRunCalendarsForHttpResponse(String accessToken, String xeroTenantId, Integer page)com.google.api.client.http.HttpResponsegetPayRunForHttpResponse(String accessToken, String xeroTenantId, UUID payRunID)PayRunsgetPayRuns(String accessToken, String xeroTenantId, Integer page, String status)searches pay runscom.google.api.client.http.HttpResponsegetPayRunsForHttpResponse(String accessToken, String xeroTenantId, Integer page, String status)PaySlipObjectgetPaySlip(String accessToken, String xeroTenantId, UUID paySlipID)retrieve a single payslip by idcom.google.api.client.http.HttpResponsegetPaySlipForHttpResponse(String accessToken, String xeroTenantId, UUID paySlipID)PaySlipsgetPaySlips(String accessToken, String xeroTenantId, UUID payRunID, Integer page)searches payslipscom.google.api.client.http.HttpResponsegetPaySlipsForHttpResponse(String accessToken, String xeroTenantId, UUID payRunID, Integer page)ReimbursementObjectgetReimbursement(String accessToken, String xeroTenantId, UUID reimbursementID)retrieve a single reimbursement by idcom.google.api.client.http.HttpResponsegetReimbursementForHttpResponse(String accessToken, String xeroTenantId, UUID reimbursementID)ReimbursementsgetReimbursements(String accessToken, String xeroTenantId, Integer page)searches reimbursementscom.google.api.client.http.HttpResponsegetReimbursementsForHttpResponse(String accessToken, String xeroTenantId, Integer page)SettingsgetSettings(String accessToken, String xeroTenantId)searches settingscom.google.api.client.http.HttpResponsegetSettingsForHttpResponse(String accessToken, String xeroTenantId)StatutoryDeductionObjectgetStatutoryDeduction(String accessToken, String xeroTenantId, UUID id)retrieve a single statutory deduction by idcom.google.api.client.http.HttpResponsegetStatutoryDeductionForHttpResponse(String accessToken, String xeroTenantId, UUID id)StatutoryDeductionsgetStatutoryDeductions(String accessToken, String xeroTenantId, Integer page)searches statutory deductionscom.google.api.client.http.HttpResponsegetStatutoryDeductionsForHttpResponse(String accessToken, String xeroTenantId, Integer page)SuperannuationObjectgetSuperannuation(String accessToken, String xeroTenantId, UUID superannuationID)searches for a unique superannuationcom.google.api.client.http.HttpResponsegetSuperannuationForHttpResponse(String accessToken, String xeroTenantId, UUID superannuationID)SuperannuationsgetSuperannuations(String accessToken, String xeroTenantId, Integer page)searches statutory deductionscom.google.api.client.http.HttpResponsegetSuperannuationsForHttpResponse(String accessToken, String xeroTenantId, Integer page)TimesheetObjectgetTimesheet(String accessToken, String xeroTenantId, UUID timesheetID)retrieve a single timesheet by idcom.google.api.client.http.HttpResponsegetTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)TimesheetsgetTimesheets(String accessToken, String xeroTenantId, Integer page, UUID employeeId, UUID payrollCalendarId)searches timesheetscom.google.api.client.http.HttpResponsegetTimesheetsForHttpResponse(String accessToken, String xeroTenantId, Integer page, UUID employeeId, UUID payrollCalendarId)TrackingCategoriesgetTrackingCategories(String accessToken, String xeroTenantId)searches tracking categoriescom.google.api.client.http.HttpResponsegetTrackingCategoriesForHttpResponse(String accessToken, String xeroTenantId)StringgetUserAgent()TimesheetObjectrevertTimesheet(String accessToken, String xeroTenantId, UUID timesheetID)revert a timesheet to draftcom.google.api.client.http.HttpResponserevertTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)voidsetApiClient(ApiClient apiClient)voidsetUserAgent(String userAgent)EmployeeObjectupdateEmployee(String accessToken, String xeroTenantId, UUID employeeId, Employee employee)updates employeeEarningsTemplateObjectupdateEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeId, UUID payTemplateEarningID, EarningsTemplate earningsTemplate)updates employee earnings template recordscom.google.api.client.http.HttpResponseupdateEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, UUID payTemplateEarningID, EarningsTemplate earningsTemplate)com.google.api.client.http.HttpResponseupdateEmployeeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, Employee employee)EmployeeLeaveObjectupdateEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeId, UUID leaveID, EmployeeLeave employeeLeave)updates employee leave recordscom.google.api.client.http.HttpResponseupdateEmployeeLeaveForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, UUID leaveID, EmployeeLeave employeeLeave)SalaryAndWageObjectupdateEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeId, UUID salaryAndWagesID, SalaryAndWage salaryAndWage)updates employee salary and wages recordcom.google.api.client.http.HttpResponseupdateEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, UUID salaryAndWagesID, SalaryAndWage salaryAndWage)EmployeeTaxObjectupdateEmployeeTax(String accessToken, String xeroTenantId, UUID employeeId, EmployeeTax employeeTax)updates the tax records for an employeecom.google.api.client.http.HttpResponseupdateEmployeeTaxForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, EmployeeTax employeeTax)PayRunObjectupdatePayRun(String accessToken, String xeroTenantId, UUID payRunID, PayRun payRun)update a pay runcom.google.api.client.http.HttpResponseupdatePayRunForHttpResponse(String accessToken, String xeroTenantId, UUID payRunID, PayRun payRun)PaySlipObjectupdatePaySlipLineItems(String accessToken, String xeroTenantId, UUID paySlipID, PaySlip paySlip)creates employee pay slipcom.google.api.client.http.HttpResponseupdatePaySlipLineItemsForHttpResponse(String accessToken, String xeroTenantId, UUID paySlipID, PaySlip paySlip)TimesheetLineObjectupdateTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID, TimesheetLine timesheetLine)update a timesheet linecom.google.api.client.http.HttpResponseupdateTimesheetLineForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID, TimesheetLine timesheetLine)
-
Constructor Details
-
PayrollNzApi
public PayrollNzApi() -
PayrollNzApi
-
-
Method Details
-
getInstance
-
getApiClient
-
setApiClient
-
setUserAgent
-
getUserAgent
-
approveTimesheet
public TimesheetObject approveTimesheet(String accessToken, String xeroTenantId, UUID timesheetID) throws IOExceptionapprove a 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- Throws:
IOException
-
createDeduction
public DeductionObject createDeduction(String accessToken, String xeroTenantId, Deduction deduction) throws IOExceptioncreate 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- Throws:
IOException
-
createEarningsRate
public EarningsRateObject createEarningsRate(String accessToken, String xeroTenantId, EarningsRate earningsRate) throws IOExceptioncreate 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- Throws:
IOException
-
createEmployee
public EmployeeObject createEmployee(String accessToken, String xeroTenantId, Employee employee) throws IOExceptioncreates 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- Throws:
IOException
-
createEmployeeEarningsTemplate
public EarningsTemplateObject createEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeId, EarningsTemplate earningsTemplate) throws IOExceptioncreates employee earnings template records200 - 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- Throws:
IOException
-
createEmployeeLeave
public EmployeeLeaveObject createEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeId, EmployeeLeave employeeLeave) throws IOExceptioncreates employee leave records200 - 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- Throws:
IOException
-
createEmployeeLeaveSetup
public EmployeeLeaveSetupObject createEmployeeLeaveSetup(String accessToken, String xeroTenantId, UUID employeeId, EmployeeLeaveSetup employeeLeaveSetup) throws IOExceptionAllows you to set-up leave for a specific employee. This is required before viewing, configuring and requesting leave for an employee200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeId- Employee id for single objectemployeeLeaveSetup- The employeeLeaveSetup parameteraccessToken- Authorization token for user set in header of each request- Returns:
- EmployeeLeaveSetupObject
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
createEmployeeLeaveSetupForHttpResponse
public com.google.api.client.http.HttpResponse createEmployeeLeaveSetupForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, EmployeeLeaveSetup employeeLeaveSetup) throws IOException- Throws:
IOException
-
createEmployeeLeaveType
public EmployeeLeaveTypeObject createEmployeeLeaveType(String accessToken, String xeroTenantId, UUID employeeId, EmployeeLeaveType employeeLeaveType) throws IOExceptioncreates 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- Throws:
IOException
-
createEmployeeOpeningBalances
public EmployeeOpeningBalancesObject createEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeId, List<EmployeeOpeningBalance> employeeOpeningBalance) throws IOExceptioncreates employee opening balances200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeId- Employee id for single objectemployeeOpeningBalance- The employeeOpeningBalance 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, List<EmployeeOpeningBalance> employeeOpeningBalance) throws IOException- Throws:
IOException
-
createEmployeePaymentMethod
public PaymentMethodObject createEmployeePaymentMethod(String accessToken, String xeroTenantId, UUID employeeId, PaymentMethod paymentMethod) throws IOExceptioncreates 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- Throws:
IOException
-
createEmployeeSalaryAndWage
public SalaryAndWageObject createEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeId, SalaryAndWage salaryAndWage) throws IOExceptioncreates employee salary and wage record200 - 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- Throws:
IOException
-
createEmployment
public EmploymentObject createEmployment(String accessToken, String xeroTenantId, UUID employeeId, Employment employment) throws IOExceptioncreates employment200 - 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- Throws:
IOException
-
createLeaveType
public LeaveTypeObject createLeaveType(String accessToken, String xeroTenantId, LeaveType leaveType) throws IOExceptioncreate 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- Throws:
IOException
-
createMultipleEmployeeEarningsTemplate
public EmployeeEarningsTemplates createMultipleEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeId, List<EarningsTemplate> earningsTemplate) throws IOExceptioncreates multiple employee earnings template records200 - 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:
- EmployeeEarningsTemplates
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
createMultipleEmployeeEarningsTemplateForHttpResponse
public com.google.api.client.http.HttpResponse createMultipleEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, List<EarningsTemplate> earningsTemplate) throws IOException- Throws:
IOException
-
createPayRun
public PayRunObject createPayRun(String accessToken, String xeroTenantId, PayRun payRun) throws IOExceptioncreate a pay run200 - created payrun results
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantpayRun- 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
-
createPayRunForHttpResponse
public com.google.api.client.http.HttpResponse createPayRunForHttpResponse(String accessToken, String xeroTenantId, PayRun payRun) throws IOException- Throws:
IOException
-
createPayRunCalendar
public PayRunCalendarObject createPayRunCalendar(String accessToken, String xeroTenantId, PayRunCalendar payRunCalendar) throws IOExceptioncreate 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- Throws:
IOException
-
createReimbursement
public ReimbursementObject createReimbursement(String accessToken, String xeroTenantId, Reimbursement reimbursement) throws IOExceptioncreate 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- Throws:
IOException
-
createSuperannuation
public SuperannuationObject createSuperannuation(String accessToken, String xeroTenantId, Benefit benefit) throws IOExceptioncreate a new superannuation200 - 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:
- SuperannuationObject
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
createSuperannuationForHttpResponse
public com.google.api.client.http.HttpResponse createSuperannuationForHttpResponse(String accessToken, String xeroTenantId, Benefit benefit) throws IOException- Throws:
IOException
-
createTimesheet
public TimesheetObject createTimesheet(String accessToken, String xeroTenantId, Timesheet timesheet) throws IOExceptioncreate 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- Throws:
IOException
-
createTimesheetLine
public TimesheetLineObject createTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, TimesheetLine timesheetLine) throws IOExceptioncreate a new timesheet line200 - 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- Throws:
IOException
-
deleteEmployeeEarningsTemplate
public EarningsTemplateObject deleteEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeId, UUID payTemplateEarningID) throws IOExceptiondeletes an employee 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:
- EarningsTemplateObject
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
deleteEmployeeEarningsTemplateForHttpResponse
public com.google.api.client.http.HttpResponse deleteEmployeeEarningsTemplateForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, UUID payTemplateEarningID) throws IOException- Throws:
IOException
-
deleteEmployeeLeave
public EmployeeLeaveObject deleteEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeId, UUID leaveID) throws IOExceptiondeletes an employee 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- Throws:
IOException
-
deleteEmployeeSalaryAndWage
public SalaryAndWageObject deleteEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeId, UUID salaryAndWagesID) throws IOExceptiondeletes an employee salary and wages record200 - 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:
- SalaryAndWageObject
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
deleteEmployeeSalaryAndWageForHttpResponse
public com.google.api.client.http.HttpResponse deleteEmployeeSalaryAndWageForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, UUID salaryAndWagesID) throws IOException- Throws:
IOException
-
deleteTimesheet
public TimesheetLine deleteTimesheet(String accessToken, String xeroTenantId, UUID timesheetID) throws IOExceptiondelete a 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- Throws:
IOException
-
deleteTimesheetLine
public TimesheetLine deleteTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID) throws IOExceptiondelete a 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- Throws:
IOException
-
getDeduction
public DeductionObject getDeduction(String accessToken, String xeroTenantId, UUID deductionId) throws IOExceptionretrieve a single deduction by 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- Throws:
IOException
-
getDeductions
public Deductions getDeductions(String accessToken, String xeroTenantId, Integer page) throws IOExceptionsearches 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- Throws:
IOException
-
getEarningsRate
public EarningsRateObject getEarningsRate(String accessToken, String xeroTenantId, UUID earningsRateID) throws IOExceptionretrieve a single earnings rates by 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- Throws:
IOException
-
getEarningsRates
public EarningsRates getEarningsRates(String accessToken, String xeroTenantId, Integer page) throws IOExceptionsearches 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- Throws:
IOException
-
getEmployee
public EmployeeObject getEmployee(String accessToken, String xeroTenantId, UUID employeeId) throws IOExceptionsearches employees200 - 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- Throws:
IOException
-
getEmployeeLeaveBalances
public EmployeeLeaveBalances getEmployeeLeaveBalances(String accessToken, String xeroTenantId, UUID employeeId) throws IOExceptionsearch employee leave balances200 - 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- Throws:
IOException
-
getEmployeeLeavePeriods
public LeavePeriods getEmployeeLeavePeriods(String accessToken, String xeroTenantId, UUID employeeId, org.threeten.bp.LocalDate startDate, org.threeten.bp.LocalDate endDate) throws IOExceptionsearches employee leave periods200 - 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- Throws:
IOException
-
getEmployeeLeaveTypes
public EmployeeLeaveTypes getEmployeeLeaveTypes(String accessToken, String xeroTenantId, UUID employeeId) throws IOExceptionsearches employee leave types200 - 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- Throws:
IOException
-
getEmployeeLeaves
public EmployeeLeaves getEmployeeLeaves(String accessToken, String xeroTenantId, UUID employeeId) throws IOExceptionsearch employee leave records200 - 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- Throws:
IOException
-
getEmployeeOpeningBalances
public EmployeeOpeningBalancesObject getEmployeeOpeningBalances(String accessToken, String xeroTenantId, UUID employeeId) throws IOExceptionretrieve employee openingbalances200 - 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- Throws:
IOException
-
getEmployeePayTemplates
public EmployeePayTemplates getEmployeePayTemplates(String accessToken, String xeroTenantId, UUID employeeId) throws IOExceptionsearches employee pay templates200 - 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:
- EmployeePayTemplates
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getEmployeePayTemplatesForHttpResponse
public com.google.api.client.http.HttpResponse getEmployeePayTemplatesForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId) throws IOException- Throws:
IOException
-
getEmployeePaymentMethod
public PaymentMethodObject getEmployeePaymentMethod(String accessToken, String xeroTenantId, UUID employeeId) throws IOExceptionretrieves an employee's payment method200 - 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- Throws:
IOException
-
getEmployeeSalaryAndWage
public SalaryAndWages getEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeId, UUID salaryAndWagesID) throws IOExceptionget employee salary and wages record by 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- Throws:
IOException
-
getEmployeeSalaryAndWages
public SalaryAndWages getEmployeeSalaryAndWages(String accessToken, String xeroTenantId, UUID employeeId, Integer page) throws IOExceptionretrieves an employee's salary and wages200 - 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- Throws:
IOException
-
getEmployeeTax
public EmployeeTaxObject getEmployeeTax(String accessToken, String xeroTenantId, UUID employeeId) throws IOExceptionsearches tax records for an employee200 - 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- Throws:
IOException
-
getEmployees
public Employees getEmployees(String accessToken, String xeroTenantId, String firstName, String lastName, Integer page) throws IOExceptionsearches employees200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantfirstName- Filter by first namelastName- Filter by last namepage- Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.accessToken- Authorization token for user set in header of each request- Returns:
- Employees
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getEmployeesForHttpResponse
public com.google.api.client.http.HttpResponse getEmployeesForHttpResponse(String accessToken, String xeroTenantId, String firstName, String lastName, Integer page) throws IOException- Throws:
IOException
-
getLeaveType
public LeaveTypeObject getLeaveType(String accessToken, String xeroTenantId, UUID leaveTypeID) throws IOExceptionretrieve a single leave type by 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- Throws:
IOException
-
getLeaveTypes
public LeaveTypes getLeaveTypes(String accessToken, String xeroTenantId, Integer page, Boolean activeOnly) throws IOExceptionsearches 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- Throws:
IOException
-
getPayRun
public PayRunObject getPayRun(String accessToken, String xeroTenantId, UUID payRunID) throws IOExceptionretrieve a single pay run by 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- Throws:
IOException
-
getPayRunCalendar
public PayRunCalendarObject getPayRunCalendar(String accessToken, String xeroTenantId, UUID payrollCalendarID) throws IOExceptionretrieve a single payrun calendar by id200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantpayrollCalendarID- 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 payrollCalendarID) throws IOException- Throws:
IOException
-
getPayRunCalendars
public PayRunCalendars getPayRunCalendars(String accessToken, String xeroTenantId, Integer page) throws IOExceptionsearches 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- Throws:
IOException
-
getPayRuns
public PayRuns getPayRuns(String accessToken, String xeroTenantId, Integer page, String status) throws IOExceptionsearches 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- Throws:
IOException
-
getPaySlip
public PaySlipObject getPaySlip(String accessToken, String xeroTenantId, UUID paySlipID) throws IOExceptionretrieve a single payslip by 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- Throws:
IOException
-
getPaySlips
public PaySlips getPaySlips(String accessToken, String xeroTenantId, UUID payRunID, Integer page) throws IOExceptionsearches 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- Throws:
IOException
-
getReimbursement
public ReimbursementObject getReimbursement(String accessToken, String xeroTenantId, UUID reimbursementID) throws IOExceptionretrieve a single reimbursement by 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- Throws:
IOException
-
getReimbursements
public Reimbursements getReimbursements(String accessToken, String xeroTenantId, Integer page) throws IOExceptionsearches 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- Throws:
IOException
-
getSettings
searches 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- Throws:
IOException
-
getStatutoryDeduction
public StatutoryDeductionObject getStatutoryDeduction(String accessToken, String xeroTenantId, UUID id) throws IOExceptionretrieve a single statutory deduction by id200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for Tenantid- Identifier for the statutory deductionaccessToken- Authorization token for user set in header of each request- Returns:
- StatutoryDeductionObject
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getStatutoryDeductionForHttpResponse
public com.google.api.client.http.HttpResponse getStatutoryDeductionForHttpResponse(String accessToken, String xeroTenantId, UUID id) throws IOException- Throws:
IOException
-
getStatutoryDeductions
public StatutoryDeductions getStatutoryDeductions(String accessToken, String xeroTenantId, Integer page) throws IOExceptionsearches statutory 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:
- StatutoryDeductions
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getStatutoryDeductionsForHttpResponse
public com.google.api.client.http.HttpResponse getStatutoryDeductionsForHttpResponse(String accessToken, String xeroTenantId, Integer page) throws IOException- Throws:
IOException
-
getSuperannuation
public SuperannuationObject getSuperannuation(String accessToken, String xeroTenantId, UUID superannuationID) throws IOExceptionsearches for a unique superannuation200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantsuperannuationID- Identifier for the superannuationaccessToken- Authorization token for user set in header of each request- Returns:
- SuperannuationObject
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getSuperannuationForHttpResponse
public com.google.api.client.http.HttpResponse getSuperannuationForHttpResponse(String accessToken, String xeroTenantId, UUID superannuationID) throws IOException- Throws:
IOException
-
getSuperannuations
public Superannuations getSuperannuations(String accessToken, String xeroTenantId, Integer page) throws IOExceptionsearches statutory 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:
- Superannuations
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getSuperannuationsForHttpResponse
public com.google.api.client.http.HttpResponse getSuperannuationsForHttpResponse(String accessToken, String xeroTenantId, Integer page) throws IOException- Throws:
IOException
-
getTimesheet
public TimesheetObject getTimesheet(String accessToken, String xeroTenantId, UUID timesheetID) throws IOExceptionretrieve a single timesheet by 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- Throws:
IOException
-
getTimesheets
public Timesheets getTimesheets(String accessToken, String xeroTenantId, Integer page, UUID employeeId, UUID payrollCalendarId) throws IOExceptionsearches 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.employeeId- By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeId} to get only the timesheets of a particular employee.payrollCalendarId- By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar idaccessToken- Authorization token for user set in header of each request- Returns:
- Timesheets
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getTimesheetsForHttpResponse
public com.google.api.client.http.HttpResponse getTimesheetsForHttpResponse(String accessToken, String xeroTenantId, Integer page, UUID employeeId, UUID payrollCalendarId) throws IOException- Throws:
IOException
-
getTrackingCategories
public TrackingCategories getTrackingCategories(String accessToken, String xeroTenantId) throws IOExceptionsearches 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- Throws:
IOException
-
revertTimesheet
public TimesheetObject revertTimesheet(String accessToken, String xeroTenantId, UUID timesheetID) throws IOExceptionrevert a 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- Throws:
IOException
-
updateEmployee
public EmployeeObject updateEmployee(String accessToken, String xeroTenantId, UUID employeeId, Employee employee) throws IOExceptionupdates employee200 - 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- Throws:
IOException
-
updateEmployeeEarningsTemplate
public EarningsTemplateObject updateEmployeeEarningsTemplate(String accessToken, String xeroTenantId, UUID employeeId, UUID payTemplateEarningID, EarningsTemplate earningsTemplate) throws IOExceptionupdates employee 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- Throws:
IOException
-
updateEmployeeLeave
public EmployeeLeaveObject updateEmployeeLeave(String accessToken, String xeroTenantId, UUID employeeId, UUID leaveID, EmployeeLeave employeeLeave) throws IOExceptionupdates employee 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- Throws:
IOException
-
updateEmployeeSalaryAndWage
public SalaryAndWageObject updateEmployeeSalaryAndWage(String accessToken, String xeroTenantId, UUID employeeId, UUID salaryAndWagesID, SalaryAndWage salaryAndWage) throws IOExceptionupdates employee salary and wages record200 - 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- Throws:
IOException
-
updateEmployeeTax
public EmployeeTaxObject updateEmployeeTax(String accessToken, String xeroTenantId, UUID employeeId, EmployeeTax employeeTax) throws IOExceptionupdates the tax records for an employee200 - search results matching criteria
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeId- Employee id for single objectemployeeTax- The employeeTax parameteraccessToken- Authorization token for user set in header of each request- Returns:
- EmployeeTaxObject
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
updateEmployeeTaxForHttpResponse
public com.google.api.client.http.HttpResponse updateEmployeeTaxForHttpResponse(String accessToken, String xeroTenantId, UUID employeeId, EmployeeTax employeeTax) throws IOException- Throws:
IOException
-
updatePayRun
public PayRunObject updatePayRun(String accessToken, String xeroTenantId, UUID payRunID, PayRun payRun) throws IOExceptionupdate a 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- Throws:
IOException
-
updatePaySlipLineItems
public PaySlipObject updatePaySlipLineItems(String accessToken, String xeroTenantId, UUID paySlipID, PaySlip paySlip) throws IOExceptioncreates employee pay slip200 - search results matching criteria
400 - validation error for a bad request
- Parameters:
xeroTenantId- Xero identifier for TenantpaySlipID- Identifier for the payslippaySlip- The paySlip parameteraccessToken- Authorization token for user set in header of each request- Returns:
- PaySlipObject
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
updatePaySlipLineItemsForHttpResponse
public com.google.api.client.http.HttpResponse updatePaySlipLineItemsForHttpResponse(String accessToken, String xeroTenantId, UUID paySlipID, PaySlip paySlip) throws IOException- Throws:
IOException
-
updateTimesheetLine
public TimesheetLineObject updateTimesheetLine(String accessToken, String xeroTenantId, UUID timesheetID, UUID timesheetLineID, TimesheetLine timesheetLine) throws IOExceptionupdate a 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 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- Throws:
IOException
-
convertInputToByteArray
- Throws:
IOException
-