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

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

Constructor Summary

Constructors
Constructor Description

PayrollAuApi()
PayrollAuApi

PayrollAuApi(ApiClient apiClient)
PayrollAuApi

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ByteArrayInputStream`	`convertInputToByteArray(InputStream is)`	convert intput to byte array
`Employees`	`createEmployee(String accessToken, String xeroTenantId, List<Employee> employee)`	Creates a payroll employee
`com.google.api.client.http.HttpResponse`	`createEmployeeForHttpResponse(String accessToken, String xeroTenantId, List<Employee> employee)`	Creates a payroll employee
`LeaveApplications`	`createLeaveApplication(String accessToken, String xeroTenantId, List<LeaveApplication> leaveApplication)`	Creates a leave application
`com.google.api.client.http.HttpResponse`	`createLeaveApplicationForHttpResponse(String accessToken, String xeroTenantId, List<LeaveApplication> leaveApplication)`	Creates a leave application
`PayItems`	`createPayItem(String accessToken, String xeroTenantId, PayItem payItem)`	Creates a pay item
`com.google.api.client.http.HttpResponse`	`createPayItemForHttpResponse(String accessToken, String xeroTenantId, PayItem payItem)`	Creates a pay item
`PayrollCalendars`	`createPayrollCalendar(String accessToken, String xeroTenantId, List<PayrollCalendar> payrollCalendar)`	Creates a Payroll Calendar
`com.google.api.client.http.HttpResponse`	`createPayrollCalendarForHttpResponse(String accessToken, String xeroTenantId, List<PayrollCalendar> payrollCalendar)`	Creates a Payroll Calendar
`PayRuns`	`createPayRun(String accessToken, String xeroTenantId, List<PayRun> payRun)`	Creates a pay run
`com.google.api.client.http.HttpResponse`	`createPayRunForHttpResponse(String accessToken, String xeroTenantId, List<PayRun> payRun)`	Creates a pay run
`SuperFunds`	`createSuperfund(String accessToken, String xeroTenantId, List<SuperFund> superFund)`	Creates a superfund
`com.google.api.client.http.HttpResponse`	`createSuperfundForHttpResponse(String accessToken, String xeroTenantId, List<SuperFund> superFund)`	Creates a superfund
`Timesheets`	`createTimesheet(String accessToken, String xeroTenantId, List<Timesheet> timesheet)`	Creates a timesheet
`com.google.api.client.http.HttpResponse`	`createTimesheetForHttpResponse(String accessToken, String xeroTenantId, List<Timesheet> timesheet)`	Creates a timesheet
`ApiClient`	`getApiClient()`	get ApiClient
`Employees`	`getEmployee(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves an employee's detail by unique employee id
`com.google.api.client.http.HttpResponse`	`getEmployeeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)`	Retrieves an employee's detail by unique employee id
`Employees`	`getEmployees(String accessToken, String xeroTenantId, String ifModifiedSince, String where, String order, Integer page)`	Searches payroll employees
`com.google.api.client.http.HttpResponse`	`getEmployeesForHttpResponse(String accessToken, String xeroTenantId, String ifModifiedSince, String where, String order, Integer page)`	Searches payroll employees
`static PayrollAuApi`	`getInstance(ApiClient apiClient)`	PayrollAuApi getInstance
`LeaveApplications`	`getLeaveApplication(String accessToken, String xeroTenantId, UUID leaveApplicationID)`	Retrieves a leave application by a unique leave application id
`com.google.api.client.http.HttpResponse`	`getLeaveApplicationForHttpResponse(String accessToken, String xeroTenantId, UUID leaveApplicationID)`	Retrieves a leave application by a unique leave application id
`LeaveApplications`	`getLeaveApplications(String accessToken, String xeroTenantId, String ifModifiedSince, String where, String order, Integer page)`	Retrieves leave applications
`com.google.api.client.http.HttpResponse`	`getLeaveApplicationsForHttpResponse(String accessToken, String xeroTenantId, String ifModifiedSince, String where, String order, Integer page)`	Retrieves leave applications
`PayItems`	`getPayItems(String accessToken, String xeroTenantId, String ifModifiedSince, String where, String order, Integer page)`	Retrieves pay items
`com.google.api.client.http.HttpResponse`	`getPayItemsForHttpResponse(String accessToken, String xeroTenantId, String ifModifiedSince, String where, String order, Integer page)`	Retrieves pay items
`PayrollCalendars`	`getPayrollCalendar(String accessToken, String xeroTenantId, UUID payrollCalendarID)`	Retrieves payroll calendar by using a unique payroll calendar ID
`com.google.api.client.http.HttpResponse`	`getPayrollCalendarForHttpResponse(String accessToken, String xeroTenantId, UUID payrollCalendarID)`	Retrieves payroll calendar by using a unique payroll calendar ID
`PayrollCalendars`	`getPayrollCalendars(String accessToken, String xeroTenantId, String ifModifiedSince, String where, String order, Integer page)`	Retrieves payroll calendars
`com.google.api.client.http.HttpResponse`	`getPayrollCalendarsForHttpResponse(String accessToken, String xeroTenantId, String ifModifiedSince, String where, String order, Integer page)`	Retrieves payroll calendars
`PayRuns`	`getPayRun(String accessToken, String xeroTenantId, UUID payRunID)`	Retrieves a pay run by using a unique pay run id
`com.google.api.client.http.HttpResponse`	`getPayRunForHttpResponse(String accessToken, String xeroTenantId, UUID payRunID)`	Retrieves a pay run by using a unique pay run id
`PayRuns`	`getPayRuns(String accessToken, String xeroTenantId, String ifModifiedSince, String where, String order, Integer page)`	Retrieves pay runs
`com.google.api.client.http.HttpResponse`	`getPayRunsForHttpResponse(String accessToken, String xeroTenantId, String ifModifiedSince, String where, String order, Integer page)`	Retrieves pay runs
`PayslipObject`	`getPayslip(String accessToken, String xeroTenantId, UUID payslipID)`	Retrieves for a payslip by a unique payslip id
`com.google.api.client.http.HttpResponse`	`getPayslipForHttpResponse(String accessToken, String xeroTenantId, UUID payslipID)`	Retrieves for a payslip by a unique payslip id
`SettingsObject`	`getSettings(String accessToken, String xeroTenantId)`	Retrieves payroll settings
`com.google.api.client.http.HttpResponse`	`getSettingsForHttpResponse(String accessToken, String xeroTenantId)`	Retrieves payroll settings
`SuperFunds`	`getSuperfund(String accessToken, String xeroTenantId, UUID superFundID)`	Retrieves a superfund by using a unique superfund ID
`com.google.api.client.http.HttpResponse`	`getSuperfundForHttpResponse(String accessToken, String xeroTenantId, UUID superFundID)`	Retrieves a superfund by using a unique superfund ID
`SuperFundProducts`	`getSuperfundProducts(String accessToken, String xeroTenantId, String ABN, String USI)`	Retrieves superfund products
`com.google.api.client.http.HttpResponse`	`getSuperfundProductsForHttpResponse(String accessToken, String xeroTenantId, String ABN, String USI)`	Retrieves superfund products
`SuperFunds`	`getSuperfunds(String accessToken, String xeroTenantId, String ifModifiedSince, String where, String order, Integer page)`	Retrieves superfunds
`com.google.api.client.http.HttpResponse`	`getSuperfundsForHttpResponse(String accessToken, String xeroTenantId, String ifModifiedSince, String where, String order, Integer page)`	Retrieves superfunds
`TimesheetObject`	`getTimesheet(String accessToken, String xeroTenantId, UUID timesheetID)`	Retrieves a timesheet by using a unique timesheet id
`com.google.api.client.http.HttpResponse`	`getTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID)`	Retrieves a timesheet by using a unique timesheet id
`Timesheets`	`getTimesheets(String accessToken, String xeroTenantId, String ifModifiedSince, String where, String order, Integer page)`	Retrieves timesheets
`com.google.api.client.http.HttpResponse`	`getTimesheetsForHttpResponse(String accessToken, String xeroTenantId, String ifModifiedSince, String where, String order, Integer page)`	Retrieves timesheets
`String`	`getUserAgent()`	get user agent
`void`	`setApiClient(ApiClient apiClient)`	set ApiClient
`void`	`setUserAgent(String userAgent)`	set user agent
`Employees`	`updateEmployee(String accessToken, String xeroTenantId, UUID employeeID, List<Employee> employee)`	Updates an employee's detail Update properties on a single employee
`com.google.api.client.http.HttpResponse`	`updateEmployeeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID, List<Employee> employee)`	Updates an employee's detail Update properties on a single employee
`LeaveApplications`	`updateLeaveApplication(String accessToken, String xeroTenantId, UUID leaveApplicationID, List<LeaveApplication> leaveApplication)`	Updates a specific leave application
`com.google.api.client.http.HttpResponse`	`updateLeaveApplicationForHttpResponse(String accessToken, String xeroTenantId, UUID leaveApplicationID, List<LeaveApplication> leaveApplication)`	Updates a specific leave application
`PayRuns`	`updatePayRun(String accessToken, String xeroTenantId, UUID payRunID, List<PayRun> payRun)`	Updates a pay run Update properties on a single PayRun
`com.google.api.client.http.HttpResponse`	`updatePayRunForHttpResponse(String accessToken, String xeroTenantId, UUID payRunID, List<PayRun> payRun)`	Updates a pay run Update properties on a single PayRun
`Payslips`	`updatePayslip(String accessToken, String xeroTenantId, UUID payslipID, List<PayslipLines> payslipLines)`	Updates a payslip Update lines on a single payslips
`com.google.api.client.http.HttpResponse`	`updatePayslipForHttpResponse(String accessToken, String xeroTenantId, UUID payslipID, List<PayslipLines> payslipLines)`	Updates a payslip Update lines on a single payslips
`SuperFunds`	`updateSuperfund(String accessToken, String xeroTenantId, UUID superFundID, List<SuperFund> superFund)`	Updates a superfund Update properties on a single Superfund
`com.google.api.client.http.HttpResponse`	`updateSuperfundForHttpResponse(String accessToken, String xeroTenantId, UUID superFundID, List<SuperFund> superFund)`	Updates a superfund Update properties on a single Superfund
`Timesheets`	`updateTimesheet(String accessToken, String xeroTenantId, UUID timesheetID, List<Timesheet> timesheet)`	Updates a timesheet Update properties on a single timesheet
`com.google.api.client.http.HttpResponse`	`updateTimesheetForHttpResponse(String accessToken, String xeroTenantId, UUID timesheetID, List<Timesheet> timesheet)`	Updates a timesheet Update properties on a single timesheet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PayrollAuApi
```
public PayrollAuApi()
```
  PayrollAuApi
- PayrollAuApi
```
public PayrollAuApi(ApiClient apiClient)
```
  PayrollAuApi
  
  Parameters:
  
  apiClient - ApiClient pass into the new instance of this class

Method Detail

getInstance
```
public static PayrollAuApi getInstance(ApiClient apiClient)
```
PayrollAuApi 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

createEmployee
```
public Employees createEmployee(String accessToken,
                                String xeroTenantId,
                                List<Employee> employee)
                         throws IOException
```
Creates a payroll employee
200 - A successful request
400 - invalid input, object invalid - TODO

Parameters:

xeroTenantId - Xero identifier for Tenant

employee - The employee parameter

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 *

createEmployeeForHttpResponse

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

Creates a payroll employee

200 - A successful request

400 - invalid input, object invalid - TODO

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

createLeaveApplication

public LeaveApplications createLeaveApplication(String accessToken,
                                                String xeroTenantId,
                                                List<LeaveApplication> leaveApplication)
                                         throws IOException

Creates a leave application

200 - A successful request

400 - invalid input, object invalid - TODO

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

createLeaveApplicationForHttpResponse

public com.google.api.client.http.HttpResponse createLeaveApplicationForHttpResponse(String accessToken,
                                                                                     String xeroTenantId,
                                                                                     List<LeaveApplication> leaveApplication)
                                                                              throws IOException

Creates a leave application

200 - A successful request

400 - invalid input, object invalid - TODO

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

createPayItem
```
public PayItems createPayItem(String accessToken,
                              String xeroTenantId,
                              PayItem payItem)
                       throws IOException
```
Creates a pay item
200 - A successful request - currently returns empty array for JSON
400 - invalid input, object invalid - TODO

Parameters:

xeroTenantId - Xero identifier for Tenant

payItem - The payItem parameter

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

Returns:

PayItems

Throws:

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

createPayItemForHttpResponse

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

Creates a pay item

200 - A successful request - currently returns empty array for JSON

400 - invalid input, object invalid - TODO

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

createPayRun
```
public PayRuns createPayRun(String accessToken,
                            String xeroTenantId,
                            List<PayRun> payRun)
                     throws IOException
```
Creates a pay run
200 - A successful request
400 - invalid input, object invalid - TODO

Parameters:

xeroTenantId - Xero identifier for Tenant

payRun - The payRun parameter

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 *

createPayRunForHttpResponse

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

Creates a pay run

200 - A successful request

400 - invalid input, object invalid - TODO

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

createPayrollCalendar

public PayrollCalendars createPayrollCalendar(String accessToken,
                                              String xeroTenantId,
                                              List<PayrollCalendar> payrollCalendar)
                                       throws IOException

Creates a Payroll Calendar

200 - A successful request

400 - invalid input, object invalid - TODO

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

createPayrollCalendarForHttpResponse

public com.google.api.client.http.HttpResponse createPayrollCalendarForHttpResponse(String accessToken,
                                                                                    String xeroTenantId,
                                                                                    List<PayrollCalendar> payrollCalendar)
                                                                             throws IOException

Creates a Payroll Calendar

200 - A successful request

400 - invalid input, object invalid - TODO

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

createSuperfund
```
public SuperFunds createSuperfund(String accessToken,
                                  String xeroTenantId,
                                  List<SuperFund> superFund)
                           throws IOException
```
Creates a superfund
200 - A successful request
400 - invalid input, object invalid - TODO

Parameters:

xeroTenantId - Xero identifier for Tenant

superFund - The superFund parameter

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

Returns:

SuperFunds

Throws:

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

createSuperfundForHttpResponse

public com.google.api.client.http.HttpResponse createSuperfundForHttpResponse(String accessToken,
                                                                              String xeroTenantId,
                                                                              List<SuperFund> superFund)
                                                                       throws IOException

Creates a superfund

200 - A successful request

400 - invalid input, object invalid - TODO

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

createTimesheet
```
public Timesheets createTimesheet(String accessToken,
                                  String xeroTenantId,
                                  List<Timesheet> timesheet)
                           throws IOException
```
Creates a timesheet
200 - A successful request
400 - invalid input, object invalid - TODO

Parameters:

xeroTenantId - Xero identifier for Tenant

timesheet - The timesheet parameter

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

Returns:

Timesheets

Throws:

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

createTimesheetForHttpResponse

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

Creates a timesheet

200 - A successful request

400 - invalid input, object invalid - TODO

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

getEmployee
```
public Employees getEmployee(String accessToken,
                             String xeroTenantId,
                             UUID employeeID)
                      throws IOException
```
Retrieves an employee's detail by unique employee id
200 - search results matching criteria

Parameters:

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

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

Returns:

Employees

Throws:

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

getEmployeeForHttpResponse

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

Retrieves an employee's detail by unique employee id

200 - search results matching criteria

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

getEmployees
```
public Employees getEmployees(String accessToken,
                              String xeroTenantId,
                              String ifModifiedSince,
                              String where,
                              String order,
                              Integer page)
                       throws IOException
```
Searches payroll employees
200 - search results matching criteria
400 - validation error for a bad request

Parameters:

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - e.g. page=1 – Up to 100 employees will be returned in a single API call

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 ifModifiedSince,
                                                                           String where,
                                                                           String order,
                                                                           Integer page)
                                                                    throws IOException

Searches payroll employees

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; ifModifiedSince - Only records created or modified since this timestamp will be returned; where - Filter by an any element; order - Order by an any element; page - e.g. page=1 – Up to 100 employees will be returned in a single API call; 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

getLeaveApplication
```
public LeaveApplications getLeaveApplication(String accessToken,
                                             String xeroTenantId,
                                             UUID leaveApplicationID)
                                      throws IOException
```
Retrieves a leave application by a unique leave application id
200 - search results matching criteria

Parameters:

xeroTenantId - Xero identifier for Tenant

leaveApplicationID - Leave Application id for single object

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

Returns:

LeaveApplications

Throws:

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

getLeaveApplicationForHttpResponse

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

Retrieves a leave application by a unique leave application id

200 - search results matching criteria

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

getLeaveApplications

public LeaveApplications getLeaveApplications(String accessToken,
                                              String xeroTenantId,
                                              String ifModifiedSince,
                                              String where,
                                              String order,
                                              Integer page)
                                       throws IOException

Retrieves leave applications

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; ifModifiedSince - Only records created or modified since this timestamp will be returned; where - Filter by an any element; order - Order by an any element; page - e.g. page=1 – Up to 100 objects will be returned in a single API call; accessToken - Authorization token for user set in header of each request
Returns:: LeaveApplications
Throws:: IOException - if an error occurs while attempting to invoke the API *

getLeaveApplicationsForHttpResponse

public com.google.api.client.http.HttpResponse getLeaveApplicationsForHttpResponse(String accessToken,
                                                                                   String xeroTenantId,
                                                                                   String ifModifiedSince,
                                                                                   String where,
                                                                                   String order,
                                                                                   Integer page)
                                                                            throws IOException

Retrieves leave applications

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; ifModifiedSince - Only records created or modified since this timestamp will be returned; where - Filter by an any element; order - Order by an any element; page - e.g. page=1 – Up to 100 objects will be returned in a single API call; 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

getPayItems
```
public PayItems getPayItems(String accessToken,
                            String xeroTenantId,
                            String ifModifiedSince,
                            String where,
                            String order,
                            Integer page)
                     throws IOException
```
Retrieves pay items
200 - search results matching criteria
400 - validation error for a bad request

Parameters:

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - e.g. page=1 – Up to 100 objects will be returned in a single API call

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

Returns:

PayItems

Throws:

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

getPayItemsForHttpResponse

public com.google.api.client.http.HttpResponse getPayItemsForHttpResponse(String accessToken,
                                                                          String xeroTenantId,
                                                                          String ifModifiedSince,
                                                                          String where,
                                                                          String order,
                                                                          Integer page)
                                                                   throws IOException

Retrieves pay items

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; ifModifiedSince - Only records created or modified since this timestamp will be returned; where - Filter by an any element; order - Order by an any element; page - e.g. page=1 – Up to 100 objects will be returned in a single API call; 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 PayRuns getPayRun(String accessToken,
                         String xeroTenantId,
                         UUID payRunID)
                  throws IOException
```
Retrieves a pay run by using a unique pay run id
200 - search results matching criteria

Parameters:

xeroTenantId - Xero identifier for Tenant

payRunID - PayRun id for single object

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 *

getPayRunForHttpResponse

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

Retrieves a pay run by using a unique pay run id

200 - search results matching criteria

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

getPayRuns
```
public PayRuns getPayRuns(String accessToken,
                          String xeroTenantId,
                          String ifModifiedSince,
                          String where,
                          String order,
                          Integer page)
                   throws IOException
```
Retrieves pay runs
200 - search results matching criteria
400 - validation error for a bad request

Parameters:

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - e.g. page=1 – Up to 100 PayRuns will be returned in a single API call

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,
                                                                         String ifModifiedSince,
                                                                         String where,
                                                                         String order,
                                                                         Integer page)
                                                                  throws IOException

Retrieves pay runs

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; ifModifiedSince - Only records created or modified since this timestamp will be returned; where - Filter by an any element; order - Order by an any element; page - e.g. page=1 – Up to 100 PayRuns will be returned in a single API call; 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

getPayrollCalendar
```
public PayrollCalendars getPayrollCalendar(String accessToken,
                                           String xeroTenantId,
                                           UUID payrollCalendarID)
                                    throws IOException
```
Retrieves payroll calendar by using a unique payroll calendar ID
200 - search results matching criteria
400 - validation error for a bad request

Parameters:

xeroTenantId - Xero identifier for Tenant

payrollCalendarID - Payroll Calendar id for single object

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

Returns:

PayrollCalendars

Throws:

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

getPayrollCalendarForHttpResponse

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

Retrieves payroll calendar by using a unique payroll calendar ID

200 - search results matching criteria

400 - validation error for a bad request

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

getPayrollCalendars

public PayrollCalendars getPayrollCalendars(String accessToken,
                                            String xeroTenantId,
                                            String ifModifiedSince,
                                            String where,
                                            String order,
                                            Integer page)
                                     throws IOException

Retrieves payroll calendars

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; ifModifiedSince - Only records created or modified since this timestamp will be returned; where - Filter by an any element; order - Order by an any element; page - e.g. page=1 – Up to 100 objects will be returned in a single API call; accessToken - Authorization token for user set in header of each request
Returns:: PayrollCalendars
Throws:: IOException - if an error occurs while attempting to invoke the API *

getPayrollCalendarsForHttpResponse

public com.google.api.client.http.HttpResponse getPayrollCalendarsForHttpResponse(String accessToken,
                                                                                  String xeroTenantId,
                                                                                  String ifModifiedSince,
                                                                                  String where,
                                                                                  String order,
                                                                                  Integer page)
                                                                           throws IOException

Retrieves payroll calendars

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; ifModifiedSince - Only records created or modified since this timestamp will be returned; where - Filter by an any element; order - Order by an any element; page - e.g. page=1 – Up to 100 objects will be returned in a single API call; 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 for a payslip by a unique payslip id
200 - search results matching criteria

Parameters:

xeroTenantId - Xero identifier for Tenant

payslipID - Payslip id for single object

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

Returns:

PayslipObject

Throws:

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

getPayslipForHttpResponse

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

Retrieves for a payslip by a unique payslip id

200 - search results matching criteria

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

getSettings
```
public SettingsObject getSettings(String accessToken,
                                  String xeroTenantId)
                           throws IOException
```
Retrieves payroll settings
200 - payroll settings

Parameters:

xeroTenantId - Xero identifier for Tenant

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

Returns:

SettingsObject

Throws:

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

getSettingsForHttpResponse

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

Retrieves payroll settings

200 - payroll settings

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

getSuperfund
```
public SuperFunds getSuperfund(String accessToken,
                               String xeroTenantId,
                               UUID superFundID)
                        throws IOException
```
Retrieves a superfund by using a unique superfund ID
200 - search results matching criteria

Parameters:

xeroTenantId - Xero identifier for Tenant

superFundID - Superfund id for single object

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

Returns:

SuperFunds

Throws:

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

getSuperfundForHttpResponse

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

Retrieves a superfund by using a unique superfund ID

200 - search results matching criteria

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

getSuperfundProducts

public SuperFundProducts getSuperfundProducts(String accessToken,
                                              String xeroTenantId,
                                              String ABN,
                                              String USI)
                                       throws IOException

Retrieves superfund products

200 - search results matching criteria

400 - validation error for a bad request

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

getSuperfundProductsForHttpResponse

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

Retrieves superfund products

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; ABN - The ABN of the Regulated SuperFund; USI - The USI of the Regulated SuperFund; 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

getSuperfunds
```
public SuperFunds getSuperfunds(String accessToken,
                                String xeroTenantId,
                                String ifModifiedSince,
                                String where,
                                String order,
                                Integer page)
                         throws IOException
```
Retrieves superfunds
200 - search results matching criteria
400 - validation error for a bad request

Parameters:

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call

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

Returns:

SuperFunds

Throws:

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

getSuperfundsForHttpResponse

public com.google.api.client.http.HttpResponse getSuperfundsForHttpResponse(String accessToken,
                                                                            String xeroTenantId,
                                                                            String ifModifiedSince,
                                                                            String where,
                                                                            String order,
                                                                            Integer page)
                                                                     throws IOException

Retrieves superfunds

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; ifModifiedSince - Only records created or modified since this timestamp will be returned; where - Filter by an any element; order - Order by an any element; page - e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call; accessToken - Authorization token for user set in header of each request
Returns:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

getTimesheet
```
public TimesheetObject getTimesheet(String accessToken,
                                    String xeroTenantId,
                                    UUID timesheetID)
                             throws IOException
```
Retrieves a timesheet by using a unique timesheet id
200 - search results matching criteria

Parameters:

xeroTenantId - Xero identifier for Tenant

timesheetID - Timesheet id for single object

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

Returns:

TimesheetObject

Throws:

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

getTimesheetForHttpResponse

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

Retrieves a timesheet by using a unique timesheet id

200 - search results matching criteria

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

getTimesheets
```
public Timesheets getTimesheets(String accessToken,
                                String xeroTenantId,
                                String ifModifiedSince,
                                String where,
                                String order,
                                Integer page)
                         throws IOException
```
Retrieves timesheets
200 - search results matching criteria
400 - validation error for a bad request

Parameters:

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - e.g. page=1 – Up to 100 timesheets will be returned in a single API call

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

Returns:

Timesheets

Throws:

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

getTimesheetsForHttpResponse

public com.google.api.client.http.HttpResponse getTimesheetsForHttpResponse(String accessToken,
                                                                            String xeroTenantId,
                                                                            String ifModifiedSince,
                                                                            String where,
                                                                            String order,
                                                                            Integer page)
                                                                     throws IOException

Retrieves timesheets

200 - search results matching criteria

400 - validation error for a bad request

Parameters:: xeroTenantId - Xero identifier for Tenant; ifModifiedSince - Only records created or modified since this timestamp will be returned; where - Filter by an any element; order - Order by an any element; page - e.g. page=1 – Up to 100 timesheets will be returned in a single API call; accessToken - Authorization token for user set in header of each request
Returns:: HttpResponse
Throws:: IOException - if an error occurs while attempting to invoke the API

updateEmployee
```
public Employees updateEmployee(String accessToken,
                                String xeroTenantId,
                                UUID employeeID,
                                List<Employee> employee)
                         throws IOException
```
Updates an employee's detail Update properties on a single employee
200 - A successful request

Parameters:

xeroTenantId - Xero identifier for Tenant

employeeID - Employee id for single object

employee - The employee parameter

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

Returns:

Employees

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,
                                                                             List<Employee> employee)
                                                                      throws IOException

Updates an employee's detail Update properties on a single employee

200 - A successful request

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

updateLeaveApplication

public LeaveApplications updateLeaveApplication(String accessToken,
                                                String xeroTenantId,
                                                UUID leaveApplicationID,
                                                List<LeaveApplication> leaveApplication)
                                         throws IOException

Updates a specific leave application

200 - A successful request

400 - invalid input, object invalid - TODO

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

updateLeaveApplicationForHttpResponse

public com.google.api.client.http.HttpResponse updateLeaveApplicationForHttpResponse(String accessToken,
                                                                                     String xeroTenantId,
                                                                                     UUID leaveApplicationID,
                                                                                     List<LeaveApplication> leaveApplication)
                                                                              throws IOException

Updates a specific leave application

200 - A successful request

400 - invalid input, object invalid - TODO

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

updatePayRun
```
public PayRuns updatePayRun(String accessToken,
                            String xeroTenantId,
                            UUID payRunID,
                            List<PayRun> payRun)
                     throws IOException
```
Updates a pay run Update properties on a single PayRun
200 - A successful request

Parameters:

xeroTenantId - Xero identifier for Tenant

payRunID - PayRun id for single object

payRun - The payRun parameter

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 *

updatePayRunForHttpResponse

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

Updates a pay run Update properties on a single PayRun

200 - A successful request

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

updatePayslip
```
public Payslips updatePayslip(String accessToken,
                              String xeroTenantId,
                              UUID payslipID,
                              List<PayslipLines> payslipLines)
                       throws IOException
```
Updates a payslip Update lines on a single payslips
200 - A successful request - currently returns empty array for JSON

Parameters:

xeroTenantId - Xero identifier for Tenant

payslipID - Payslip id for single object

payslipLines - The payslipLines parameter

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 *

updatePayslipForHttpResponse

public com.google.api.client.http.HttpResponse updatePayslipForHttpResponse(String accessToken,
                                                                            String xeroTenantId,
                                                                            UUID payslipID,
                                                                            List<PayslipLines> payslipLines)
                                                                     throws IOException

Updates a payslip Update lines on a single payslips

200 - A successful request - currently returns empty array for JSON

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

updateSuperfund

public SuperFunds updateSuperfund(String accessToken,
                                  String xeroTenantId,
                                  UUID superFundID,
                                  List<SuperFund> superFund)
                           throws IOException

Updates a superfund Update properties on a single Superfund

200 - A successful request

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

updateSuperfundForHttpResponse

public com.google.api.client.http.HttpResponse updateSuperfundForHttpResponse(String accessToken,
                                                                              String xeroTenantId,
                                                                              UUID superFundID,
                                                                              List<SuperFund> superFund)
                                                                       throws IOException

Updates a superfund Update properties on a single Superfund

200 - A successful request

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

updateTimesheet

public Timesheets updateTimesheet(String accessToken,
                                  String xeroTenantId,
                                  UUID timesheetID,
                                  List<Timesheet> timesheet)
                           throws IOException

Updates a timesheet Update properties on a single timesheet

200 - A successful request

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

updateTimesheetForHttpResponse

public com.google.api.client.http.HttpResponse updateTimesheetForHttpResponse(String accessToken,
                                                                              String xeroTenantId,
                                                                              UUID timesheetID,
                                                                              List<Timesheet> timesheet)
                                                                       throws IOException

Updates a timesheet Update properties on a single timesheet

200 - A successful request

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

convertInputToByteArray
```
public ByteArrayInputStream convertInputToByteArray(InputStream is)
                                             throws IOException
```
convert intput to byte array

Parameters:

is - InputStream the server status code returned

Returns:

byteArrayInputStream a ByteArrayInputStream

Throws:

IOException - for failed or interrupted I/O operations

Constructor	Description
`PayrollAuApi()`	PayrollAuApi
`PayrollAuApi(ApiClient apiClient)`	PayrollAuApi

Class PayrollAuApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PayrollAuApi

PayrollAuApi

Method Detail

getInstance

getApiClient

setApiClient

setUserAgent

getUserAgent

createEmployee

createEmployeeForHttpResponse

createLeaveApplication

createLeaveApplicationForHttpResponse

createPayItem

createPayItemForHttpResponse

createPayRun

createPayRunForHttpResponse

createPayrollCalendar

createPayrollCalendarForHttpResponse

createSuperfund

createSuperfundForHttpResponse

createTimesheet

createTimesheetForHttpResponse

getEmployee

getEmployeeForHttpResponse

getEmployees

getEmployeesForHttpResponse

getLeaveApplication

getLeaveApplicationForHttpResponse

getLeaveApplications

getLeaveApplicationsForHttpResponse

getPayItems

getPayItemsForHttpResponse

getPayRun

getPayRunForHttpResponse

getPayRuns

getPayRunsForHttpResponse

getPayrollCalendar

getPayrollCalendarForHttpResponse

getPayrollCalendars

getPayrollCalendarsForHttpResponse

getPayslip

getPayslipForHttpResponse

getSettings

getSettingsForHttpResponse

getSuperfund

getSuperfundForHttpResponse

getSuperfundProducts

getSuperfundProductsForHttpResponse

getSuperfunds

getSuperfundsForHttpResponse

getTimesheet

getTimesheetForHttpResponse

getTimesheets

getTimesheetsForHttpResponse

updateEmployee

updateEmployeeForHttpResponse

updateLeaveApplication

updateLeaveApplicationForHttpResponse

updatePayRun

updatePayRunForHttpResponse

updatePayslip

updatePayslipForHttpResponse

updateSuperfund

updateSuperfundForHttpResponse

updateTimesheet

updateTimesheetForHttpResponse

convertInputToByteArray