xero-ruby 2.5.0 → 2.5.1

data/docs/payroll_uk/PayRunCalendarObject.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollUk::PayRunCalendarObject
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
-**problem** | [**Problem**](Problem.md) |  | [optional] 
-**pay_run_calendar** | [**PayRunCalendar**](PayRunCalendar.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::PayRunCalendarObject.new(pagination: null,
-                                 problem: null,
-                                 pay_run_calendar: null)
-```
-
-

data/docs/payroll_uk/PayRunCalendars.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollUk::PayRunCalendars
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
-**problem** | [**Problem**](Problem.md) |  | [optional] 
-**pay_run_calendars** | [**Array<PayRunCalendar>**](PayRunCalendar.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::PayRunCalendars.new(pagination: null,
-                                 problem: null,
-                                 pay_run_calendars: null)
-```
-
-

data/docs/payroll_uk/PayRunObject.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollUk::PayRunObject
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
-**problem** | [**Problem**](Problem.md) |  | [optional] 
-**pay_run** | [**PayRun**](PayRun.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::PayRunObject.new(pagination: null,
-                                 problem: null,
-                                 pay_run: null)
-```
-
-

data/docs/payroll_uk/PayRuns.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollUk::PayRuns
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
-**problem** | [**Problem**](Problem.md) |  | [optional] 
-**pay_runs** | [**Array<PayRun>**](PayRun.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::PayRuns.new(pagination: null,
-                                 problem: null,
-                                 pay_runs: null)
-```
-
-

data/docs/payroll_uk/PaymentLine.md

@@ -1,25 +0,0 @@
-# XeroRuby::PayrollUk::PaymentLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payment_line_id** | **String** | Xero identifier for payroll payment line | [optional] 
-**amount** | **Float** | The amount of the payment line | [optional] 
-**account_number** | **String** | The account number | [optional] 
-**sort_code** | **String** | The account sort code | [optional] 
-**account_name** | **String** | The account name | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::PaymentLine.new(payment_line_id: null,
-                                 amount: null,
-                                 account_number: null,
-                                 sort_code: null,
-                                 account_name: null)
-```
-
-

data/docs/payroll_uk/PaymentMethod.md

@@ -1,19 +0,0 @@
-# XeroRuby::PayrollUk::PaymentMethod
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payment_method** | **String** | The payment method code | 
-**bank_accounts** | [**Array<BankAccount>**](BankAccount.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::PaymentMethod.new(payment_method: null,
-                                 bank_accounts: null)
-```
-
-

data/docs/payroll_uk/PaymentMethodObject.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollUk::PaymentMethodObject
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
-**problem** | [**Problem**](Problem.md) |  | [optional] 
-**payment_method** | [**PaymentMethod**](PaymentMethod.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::PaymentMethodObject.new(pagination: null,
-                                 problem: null,
-                                 payment_method: null)
-```
-
-

data/docs/payroll_uk/PayrollUkApi.md

@@ -1,4683 +0,0 @@
-# XeroRuby::PayrollUk::PayrollUkApi
-
-All URIs are relative to *https://api.xero.com/payroll.xro/2.0*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**approve_timesheet**](PayrollUkApi.md#approve_timesheet) | **POST** /Timesheets/{TimesheetID}/Approve | approve a timesheet
-[**create_benefit**](PayrollUkApi.md#create_benefit) | **POST** /Benefits | create a new benefit
-[**create_deduction**](PayrollUkApi.md#create_deduction) | **POST** /Deductions | create a new deduction
-[**create_earnings_rate**](PayrollUkApi.md#create_earnings_rate) | **POST** /EarningsRates | create a new earnings rate
-[**create_employee**](PayrollUkApi.md#create_employee) | **POST** /Employees | creates employees
-[**create_employee_earnings_template**](PayrollUkApi.md#create_employee_earnings_template) | **POST** /Employees/{EmployeeId}/PayTemplates/earnings | creates employee earnings template records
-[**create_employee_leave**](PayrollUkApi.md#create_employee_leave) | **POST** /Employees/{EmployeeId}/Leave | creates employee leave records
-[**create_employee_leave_type**](PayrollUkApi.md#create_employee_leave_type) | **POST** /Employees/{EmployeeId}/LeaveTypes | creates employee leave type records
-[**create_employee_opening_balances**](PayrollUkApi.md#create_employee_opening_balances) | **POST** /Employees/{EmployeeId}/ukopeningbalances | creates employee opening balances
-[**create_employee_payment_method**](PayrollUkApi.md#create_employee_payment_method) | **POST** /Employees/{EmployeeId}/PaymentMethods | creates employee payment method
-[**create_employee_salary_and_wage**](PayrollUkApi.md#create_employee_salary_and_wage) | **POST** /Employees/{EmployeeId}/SalaryAndWages | creates employee salary and wage record
-[**create_employee_statutory_sick_leave**](PayrollUkApi.md#create_employee_statutory_sick_leave) | **POST** /StatutoryLeaves/Sick | creates employee statutory sick leave records
-[**create_employment**](PayrollUkApi.md#create_employment) | **POST** /Employees/{EmployeeId}/Employment | creates employment
-[**create_leave_type**](PayrollUkApi.md#create_leave_type) | **POST** /LeaveTypes | create a new leave type
-[**create_multiple_employee_earnings_template**](PayrollUkApi.md#create_multiple_employee_earnings_template) | **POST** /Employees/{EmployeeId}/paytemplateearnings | creates multiple employee earnings template records
-[**create_pay_run_calendar**](PayrollUkApi.md#create_pay_run_calendar) | **POST** /PayRunCalendars | create a new payrun calendar
-[**create_reimbursement**](PayrollUkApi.md#create_reimbursement) | **POST** /Reimbursements | create a new reimbursement
-[**create_timesheet**](PayrollUkApi.md#create_timesheet) | **POST** /Timesheets | create a new timesheet
-[**create_timesheet_line**](PayrollUkApi.md#create_timesheet_line) | **POST** /Timesheets/{TimesheetID}/Lines | create a new timesheet line
-[**delete_employee_earnings_template**](PayrollUkApi.md#delete_employee_earnings_template) | **DELETE** /Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID} | deletes an employee earnings template record
-[**delete_employee_leave**](PayrollUkApi.md#delete_employee_leave) | **DELETE** /Employees/{EmployeeId}/Leave/{LeaveID} | deletes an employee leave record
-[**delete_employee_salary_and_wage**](PayrollUkApi.md#delete_employee_salary_and_wage) | **DELETE** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | deletes an employee salary and wages record
-[**delete_timesheet**](PayrollUkApi.md#delete_timesheet) | **DELETE** /Timesheets/{TimesheetID} | delete a timesheet
-[**delete_timesheet_line**](PayrollUkApi.md#delete_timesheet_line) | **DELETE** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | delete a timesheet line
-[**get_benefit**](PayrollUkApi.md#get_benefit) | **GET** /Benefits/{id} | retrieve a single benefit by id
-[**get_benefits**](PayrollUkApi.md#get_benefits) | **GET** /Benefits | searches benefits
-[**get_deduction**](PayrollUkApi.md#get_deduction) | **GET** /Deductions/{deductionId} | retrieve a single deduction by id
-[**get_deductions**](PayrollUkApi.md#get_deductions) | **GET** /Deductions | searches deductions
-[**get_earnings_order**](PayrollUkApi.md#get_earnings_order) | **GET** /EarningsOrders/{id} | retrieve a single deduction by id
-[**get_earnings_orders**](PayrollUkApi.md#get_earnings_orders) | **GET** /EarningsOrders | searches earnings orders
-[**get_earnings_rate**](PayrollUkApi.md#get_earnings_rate) | **GET** /EarningsRates/{EarningsRateID} | retrieve a single earnings rates by id
-[**get_earnings_rates**](PayrollUkApi.md#get_earnings_rates) | **GET** /EarningsRates | searches earnings rates
-[**get_employee**](PayrollUkApi.md#get_employee) | **GET** /Employees/{EmployeeId} | searches employees
-[**get_employee_leave**](PayrollUkApi.md#get_employee_leave) | **GET** /Employees/{EmployeeId}/Leave/{LeaveID} | retrieve a single employee leave record
-[**get_employee_leave_balances**](PayrollUkApi.md#get_employee_leave_balances) | **GET** /Employees/{EmployeeId}/LeaveBalances | search employee leave balances
-[**get_employee_leave_periods**](PayrollUkApi.md#get_employee_leave_periods) | **GET** /Employees/{EmployeeId}/LeavePeriods | searches employee leave periods
-[**get_employee_leave_types**](PayrollUkApi.md#get_employee_leave_types) | **GET** /Employees/{EmployeeId}/LeaveTypes | searches employee leave types
-[**get_employee_leaves**](PayrollUkApi.md#get_employee_leaves) | **GET** /Employees/{EmployeeId}/Leave | search employee leave records
-[**get_employee_opening_balances**](PayrollUkApi.md#get_employee_opening_balances) | **GET** /Employees/{EmployeeId}/ukopeningbalances | retrieve employee openingbalances
-[**get_employee_pay_template**](PayrollUkApi.md#get_employee_pay_template) | **GET** /Employees/{EmployeeId}/PayTemplates | searches employee pay templates
-[**get_employee_payment_method**](PayrollUkApi.md#get_employee_payment_method) | **GET** /Employees/{EmployeeId}/PaymentMethods | retrieves an employee's payment method
-[**get_employee_salary_and_wage**](PayrollUkApi.md#get_employee_salary_and_wage) | **GET** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | get employee salary and wages record by id
-[**get_employee_salary_and_wages**](PayrollUkApi.md#get_employee_salary_and_wages) | **GET** /Employees/{EmployeeId}/SalaryAndWages | retrieves an employee's salary and wages
-[**get_employee_statutory_leave_balances**](PayrollUkApi.md#get_employee_statutory_leave_balances) | **GET** /Employees/{EmployeeId}/StatutoryLeaveBalance | search employee leave balances
-[**get_employee_statutory_sick_leave**](PayrollUkApi.md#get_employee_statutory_sick_leave) | **GET** /StatutoryLeaves/Sick/{StatutorySickLeaveID} | retrieve a statutory sick leave for an employee
-[**get_employee_tax**](PayrollUkApi.md#get_employee_tax) | **GET** /Employees/{EmployeeId}/Tax | searches tax records for an employee
-[**get_employees**](PayrollUkApi.md#get_employees) | **GET** /Employees | searches employees
-[**get_leave_type**](PayrollUkApi.md#get_leave_type) | **GET** /LeaveTypes/{LeaveTypeID} | retrieve a single leave type by id
-[**get_leave_types**](PayrollUkApi.md#get_leave_types) | **GET** /LeaveTypes | searches leave types
-[**get_pay_run**](PayrollUkApi.md#get_pay_run) | **GET** /PayRuns/{PayRunID} | retrieve a single pay run by id
-[**get_pay_run_calendar**](PayrollUkApi.md#get_pay_run_calendar) | **GET** /PayRunCalendars/{PayRunCalendarID} | retrieve a single payrun calendar by id
-[**get_pay_run_calendars**](PayrollUkApi.md#get_pay_run_calendars) | **GET** /PayRunCalendars | searches payrun calendars
-[**get_pay_runs**](PayrollUkApi.md#get_pay_runs) | **GET** /PayRuns | searches pay runs
-[**get_pay_slip**](PayrollUkApi.md#get_pay_slip) | **GET** /Payslips/{PayslipID} | retrieve a single payslip by id
-[**get_pay_slips**](PayrollUkApi.md#get_pay_slips) | **GET** /Payslips | searches payslips
-[**get_reimbursement**](PayrollUkApi.md#get_reimbursement) | **GET** /Reimbursements/{ReimbursementID} | retrieve a single reimbursement by id
-[**get_reimbursements**](PayrollUkApi.md#get_reimbursements) | **GET** /Reimbursements | searches reimbursements
-[**get_settings**](PayrollUkApi.md#get_settings) | **GET** /Settings | searches settings
-[**get_statutory_leave_summary**](PayrollUkApi.md#get_statutory_leave_summary) | **GET** /statutoryleaves/summary/{EmployeeId} | retrieve a summary of statutory leaves for an employee
-[**get_timesheet**](PayrollUkApi.md#get_timesheet) | **GET** /Timesheets/{TimesheetID} | retrieve a single timesheet by id
-[**get_timesheets**](PayrollUkApi.md#get_timesheets) | **GET** /Timesheets | searches timesheets
-[**get_tracking_categories**](PayrollUkApi.md#get_tracking_categories) | **GET** /settings/trackingCategories | searches tracking categories
-[**revert_timesheet**](PayrollUkApi.md#revert_timesheet) | **POST** /Timesheets/{TimesheetID}/RevertToDraft | revert a timesheet to draft
-[**update_employee**](PayrollUkApi.md#update_employee) | **PUT** /Employees/{EmployeeId} | updates employee
-[**update_employee_earnings_template**](PayrollUkApi.md#update_employee_earnings_template) | **PUT** /Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID} | updates employee earnings template records
-[**update_employee_leave**](PayrollUkApi.md#update_employee_leave) | **PUT** /Employees/{EmployeeId}/Leave/{LeaveID} | updates employee leave records
-[**update_employee_opening_balances**](PayrollUkApi.md#update_employee_opening_balances) | **PUT** /Employees/{EmployeeId}/ukopeningbalances | updates employee opening balances
-[**update_employee_salary_and_wage**](PayrollUkApi.md#update_employee_salary_and_wage) | **PUT** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | updates employee salary and wages record
-[**update_pay_run**](PayrollUkApi.md#update_pay_run) | **PUT** /PayRuns/{PayRunID} | update a pay run
-[**update_timesheet_line**](PayrollUkApi.md#update_timesheet_line) | **PUT** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | update a timesheet line
-
-
-
-## approve_timesheet
-
-> TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id)
-
-approve a timesheet
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet
-begin
-  #approve a timesheet
-  result = api_instance.approve_timesheet(xero_tenant_id, timesheet_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->approve_timesheet: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **timesheet_id** | [**String**](.md)| Identifier for the timesheet | 
-
-### Return type
-
-[**TimesheetObject**](TimesheetObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## create_benefit
-
-> BenefitObject create_benefit(xero_tenant_id, benefit)
-
-create a new benefit
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-benefit = { "name": "My Big Bennie", "category": "StakeholderPension", "liabilityAccountId": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "expenseAccountId": "4b03500d-32fd-4616-8d70-e1e56e0519c6", "standardAmount": 50, "percentage": 25, "calculationType": "PercentageOfGross" } # Benefit | 
-begin
-  #create a new benefit
-  result = api_instance.create_benefit(xero_tenant_id, benefit)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_benefit: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **benefit** | [**Benefit**](Benefit.md)|  | 
-
-### Return type
-
-[**BenefitObject**](BenefitObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_deduction
-
-> DeductionObject create_deduction(xero_tenant_id, deduction)
-
-create a new deduction
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-deduction = { "deductionName": "My new deducation", "deductionCategory": "SalarySacrifice", "liabilityAccountId": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "calculationType": "FixedAmount" } # Deduction | 
-begin
-  #create a new deduction
-  result = api_instance.create_deduction(xero_tenant_id, deduction)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_deduction: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **deduction** | [**Deduction**](Deduction.md)|  | 
-
-### Return type
-
-[**DeductionObject**](DeductionObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_earnings_rate
-
-> EarningsRateObject create_earnings_rate(xero_tenant_id, earnings_rate)
-
-create a new earnings rate
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-earnings_rate = { "name": "My Earnings Rate", "earningsType": "RegularEarnings", "rateType": "RatePerUnit", "typeOfUnits": "hours", "expenseAccountID": "4b03500d-32fd-4616-8d70-e1e56e0519c6" } # EarningsRate | 
-begin
-  #create a new earnings rate
-  result = api_instance.create_earnings_rate(xero_tenant_id, earnings_rate)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_earnings_rate: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **earnings_rate** | [**EarningsRate**](EarningsRate.md)|  | 
-
-### Return type
-
-[**EarningsRateObject**](EarningsRateObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_employee
-
-> EmployeeObject create_employee(xero_tenant_id, employee)
-
-creates employees
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee = { "title":"Mr", "firstName":"Mike", "lastName":"Fancy", "dateOfBirth":"1999-01-01", "address":{ "addressLine1":"101 Green St", "city":"San Francisco", "postCode":"6TGR4F", "country":"UK" }, "email":"mike@starkindustries.com", "gender":"M" } # Employee | 
-begin
-  #creates employees
-  result = api_instance.create_employee(xero_tenant_id, employee)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_employee: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee** | [**Employee**](Employee.md)|  | 
-
-### Return type
-
-[**EmployeeObject**](EmployeeObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_employee_earnings_template
-
-> EarningsTemplateObject create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template)
-
-creates employee earnings template records
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-earnings_template = XeroRuby::PayrollUk::EarningsTemplate.new # EarningsTemplate | 
-begin
-  #creates employee earnings template records
-  result = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_employee_earnings_template: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **earnings_template** | [**EarningsTemplate**](EarningsTemplate.md)|  | 
-
-### Return type
-
-[**EarningsTemplateObject**](EarningsTemplateObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_employee_leave
-
-> EmployeeLeaveObject create_employee_leave(xero_tenant_id, employee_id, employee_leave)
-
-creates employee leave records
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-employee_leave = { "leaveTypeID": "1d2778ee-86ea-45c0-bbf8-1045485f6b3f", "description": "Creating a Desription", "startDate": "2020-03-24", "endDate": "2020-03-26" } # EmployeeLeave | 
-begin
-  #creates employee leave records
-  result = api_instance.create_employee_leave(xero_tenant_id, employee_id, employee_leave)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_employee_leave: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **employee_leave** | [**EmployeeLeave**](EmployeeLeave.md)|  | 
-
-### Return type
-
-[**EmployeeLeaveObject**](EmployeeLeaveObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_employee_leave_type
-
-> EmployeeLeaveTypeObject create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type)
-
-creates employee leave type records
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-employee_leave_type = { "leaveTypeID": "4918f233-bd31-43f9-9633-bcc6de1178f2", "scheduleOfAccrual": "BeginningOfCalendarYear", "hoursAccruedAnnually": 10 } # EmployeeLeaveType | 
-begin
-  #creates employee leave type records
-  result = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_employee_leave_type: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **employee_leave_type** | [**EmployeeLeaveType**](EmployeeLeaveType.md)|  | 
-
-### Return type
-
-[**EmployeeLeaveTypeObject**](EmployeeLeaveTypeObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_employee_opening_balances
-
-> EmployeeOpeningBalancesObject create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances)
-
-creates employee opening balances
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-employee_opening_balances = { "statutoryAdoptionPay": 10, "statutoryMaternityPay": 10, "statutoryPaternityPay": 10, "statutorySharedParentalPay": 10, "statutorySickPay": 10, "priorEmployeeNumber": 10 } # EmployeeOpeningBalances | 
-begin
-  #creates employee opening balances
-  result = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_employee_opening_balances: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **employee_opening_balances** | [**EmployeeOpeningBalances**](EmployeeOpeningBalances.md)|  | 
-
-### Return type
-
-[**EmployeeOpeningBalancesObject**](EmployeeOpeningBalancesObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_employee_payment_method
-
-> PaymentMethodObject create_employee_payment_method(xero_tenant_id, employee_id, payment_method)
-
-creates employee payment method
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-payment_method = { "paymentMethod": "Electronically", "bankAccounts": [ { "accountName": "Sid BofA", "accountNumber": "24987654", "sortCode": "287654" } ] } # PaymentMethod | 
-begin
-  #creates employee payment method
-  result = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, payment_method)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_employee_payment_method: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **payment_method** | [**PaymentMethod**](PaymentMethod.md)|  | 
-
-### Return type
-
-[**PaymentMethodObject**](PaymentMethodObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_employee_salary_and_wage
-
-> SalaryAndWageObject create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage)
-
-creates employee salary and wage record
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-salary_and_wage = { "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnitsPerWeek": 2, "ratePerUnit": 10, "numberOfUnitsPerDay": 2, "effectiveFrom": "2020-05-01", "annualSalary": 100, "status": "ACTIVE", "paymentType": "Salary" } # SalaryAndWage | 
-begin
-  #creates employee salary and wage record
-  result = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_employee_salary_and_wage: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **salary_and_wage** | [**SalaryAndWage**](SalaryAndWage.md)|  | 
-
-### Return type
-
-[**SalaryAndWageObject**](SalaryAndWageObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_employee_statutory_sick_leave
-
-> EmployeeStatutorySickLeaveObject create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave)
-
-creates employee statutory sick leave records
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_statutory_sick_leave = { "employeeID": "aad6b292-7b94-408b-93f6-e489867e3fb0", "leaveTypeID": "aab78802-e9d3-4bbd-bc87-df858054988f", "startDate": "2020-04-21", "endDate": "2020-04-24", "workPattern": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "isPregnancyRelated": false, "sufficientNotice": true } # EmployeeStatutorySickLeave | 
-begin
-  #creates employee statutory sick leave records
-  result = api_instance.create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_employee_statutory_sick_leave: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_statutory_sick_leave** | [**EmployeeStatutorySickLeave**](EmployeeStatutorySickLeave.md)|  | 
-
-### Return type
-
-[**EmployeeStatutorySickLeaveObject**](EmployeeStatutorySickLeaveObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_employment
-
-> EmploymentObject create_employment(xero_tenant_id, employee_id, employment)
-
-creates employment
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-employment = { "PayrollCalendarID": "216d80e6-af55-47b1-b718-9457c3f5d2fe", "StartDate": "2020-04-01", "EmployeeNumber": "123ABC", "NICategory": "A" } # Employment | 
-begin
-  #creates employment
-  result = api_instance.create_employment(xero_tenant_id, employee_id, employment)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_employment: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **employment** | [**Employment**](Employment.md)|  | 
-
-### Return type
-
-[**EmploymentObject**](EmploymentObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_leave_type
-
-> LeaveTypeObject create_leave_type(xero_tenant_id, leave_type)
-
-create a new leave type
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-leave_type = { "name": "My opebvwbfxf Leave", "isPaidLeave": false, "showOnPayslip": true } # LeaveType | 
-begin
-  #create a new leave type
-  result = api_instance.create_leave_type(xero_tenant_id, leave_type)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_leave_type: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **leave_type** | [**LeaveType**](LeaveType.md)|  | 
-
-### Return type
-
-[**LeaveTypeObject**](LeaveTypeObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_multiple_employee_earnings_template
-
-> EmployeePayTemplates create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template)
-
-creates multiple employee earnings template records
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-earnings_template = [ { "ratePerUnit":20.0, "numberOfUnits":8.0, "earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27" }, { "ratePerUnit":20.0, "numberOfUnits":8.0, "earningsRateID":"973365f3-66b2-4c33-8ae6-14b75f78f68b" } ] # Array<EarningsTemplate> | 
-begin
-  #creates multiple employee earnings template records
-  result = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_multiple_employee_earnings_template: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **earnings_template** | [**Array&lt;EarningsTemplate&gt;**](EarningsTemplate.md)|  | 
-
-### Return type
-
-[**EmployeePayTemplates**](EmployeePayTemplates.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_pay_run_calendar
-
-> PayRunCalendarObject create_pay_run_calendar(xero_tenant_id, pay_run_calendar)
-
-create a new payrun calendar
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-pay_run_calendar = { "name": "My Weekly Cal", "calendarType": "Weekly", "periodStartDate": "2020-05-01", "paymentDate": "2020-05-15" } # PayRunCalendar | 
-begin
-  #create a new payrun calendar
-  result = api_instance.create_pay_run_calendar(xero_tenant_id, pay_run_calendar)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_pay_run_calendar: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **pay_run_calendar** | [**PayRunCalendar**](PayRunCalendar.md)|  | 
-
-### Return type
-
-[**PayRunCalendarObject**](PayRunCalendarObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_reimbursement
-
-> ReimbursementObject create_reimbursement(xero_tenant_id, reimbursement)
-
-create a new reimbursement
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-reimbursement = { "name": "My new Reimburse", "accountID": "9ee28149-32a9-4661-8eab-a28738696983" } # Reimbursement | 
-begin
-  #create a new reimbursement
-  result = api_instance.create_reimbursement(xero_tenant_id, reimbursement)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_reimbursement: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **reimbursement** | [**Reimbursement**](Reimbursement.md)|  | 
-
-### Return type
-
-[**ReimbursementObject**](ReimbursementObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_timesheet
-
-> TimesheetObject create_timesheet(xero_tenant_id, timesheet)
-
-create a new timesheet
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet = { "payrollCalendarID": "216d80e6-af55-47b1-b718-9457c3f5d2fe", "employeeID": "aad6b292-7b94-408b-93f6-e489867e3fb0", "startDate": "2020-04-13", "endDate": "2020-04-19", "timesheetLines": [ { "date": "2020-04-13", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 8 }, { "date": "2020-04-15", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 6 } ] } # Timesheet | 
-begin
-  #create a new timesheet
-  result = api_instance.create_timesheet(xero_tenant_id, timesheet)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_timesheet: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **timesheet** | [**Timesheet**](Timesheet.md)|  | 
-
-### Return type
-
-[**TimesheetObject**](TimesheetObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_timesheet_line
-
-> TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line)
-
-create a new timesheet line
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet
-timesheet_line = { "date": "2020-04-14", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 1 } # TimesheetLine | 
-begin
-  #create a new timesheet line
-  result = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->create_timesheet_line: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **timesheet_id** | [**String**](.md)| Identifier for the timesheet | 
- **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)|  | 
-
-### Return type
-
-[**TimesheetLineObject**](TimesheetLineObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## delete_employee_earnings_template
-
-> delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id)
-
-deletes an employee earnings template record
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # String | Id for single pay template earnings object
-begin
-  #deletes an employee earnings template record
-  api_instance.delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id)
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->delete_employee_earnings_template: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **pay_template_earning_id** | [**String**](.md)| Id for single pay template earnings object | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## delete_employee_leave
-
-> EmployeeLeaveObject delete_employee_leave(xero_tenant_id, employee_id, leave_id)
-
-deletes an employee leave record
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314' # String | Leave id for single object
-begin
-  #deletes an employee leave record
-  result = api_instance.delete_employee_leave(xero_tenant_id, employee_id, leave_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->delete_employee_leave: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **leave_id** | [**String**](.md)| Leave id for single object | 
-
-### Return type
-
-[**EmployeeLeaveObject**](EmployeeLeaveObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## delete_employee_salary_and_wage
-
-> delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
-
-deletes an employee salary and wages record
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # String | Id for single salary and wages object
-begin
-  #deletes an employee salary and wages record
-  api_instance.delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->delete_employee_salary_and_wage: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **salary_and_wages_id** | [**String**](.md)| Id for single salary and wages object | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## delete_timesheet
-
-> TimesheetLine delete_timesheet(xero_tenant_id, timesheet_id)
-
-delete a timesheet
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet
-begin
-  #delete a timesheet
-  result = api_instance.delete_timesheet(xero_tenant_id, timesheet_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->delete_timesheet: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **timesheet_id** | [**String**](.md)| Identifier for the timesheet | 
-
-### Return type
-
-[**TimesheetLine**](TimesheetLine.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## delete_timesheet_line
-
-> TimesheetLine delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id)
-
-delete a timesheet line
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet
-timesheet_line_id = 'timesheet_line_id_example' # String | Identifier for the timesheet line
-begin
-  #delete a timesheet line
-  result = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->delete_timesheet_line: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **timesheet_id** | [**String**](.md)| Identifier for the timesheet | 
- **timesheet_line_id** | [**String**](.md)| Identifier for the timesheet line | 
-
-### Return type
-
-[**TimesheetLine**](TimesheetLine.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_benefit
-
-> BenefitObject get_benefit(xero_tenant_id, id)
-
-retrieve a single benefit by id
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-id = 'id_example' # String | Identifier for the benefit
-begin
-  #retrieve a single benefit by id
-  result = api_instance.get_benefit(xero_tenant_id, id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_benefit: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **id** | [**String**](.md)| Identifier for the benefit | 
-
-### Return type
-
-[**BenefitObject**](BenefitObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_benefits
-
-> Benefits get_benefits(xero_tenant_id, opts)
-
-searches benefits
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-
-begin
-  #searches benefits
-  result = api_instance.get_benefits(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_benefits: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] 
-
-### Return type
-
-[**Benefits**](Benefits.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_deduction
-
-> DeductionObject get_deduction(xero_tenant_id, deduction_id)
-
-retrieve a single deduction by id
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-deduction_id = 'deduction_id_example' # String | Identifier for the deduction
-begin
-  #retrieve a single deduction by id
-  result = api_instance.get_deduction(xero_tenant_id, deduction_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_deduction: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **deduction_id** | [**String**](.md)| Identifier for the deduction | 
-
-### Return type
-
-[**DeductionObject**](DeductionObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_deductions
-
-> Deductions get_deductions(xero_tenant_id, opts)
-
-searches deductions
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-
-begin
-  #searches deductions
-  result = api_instance.get_deductions(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_deductions: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] 
-
-### Return type
-
-[**Deductions**](Deductions.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_earnings_order
-
-> EarningsOrderObject get_earnings_order(xero_tenant_id, id)
-
-retrieve a single deduction by id
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-id = 'id_example' # String | Identifier for the deduction
-begin
-  #retrieve a single deduction by id
-  result = api_instance.get_earnings_order(xero_tenant_id, id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_earnings_order: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **id** | [**String**](.md)| Identifier for the deduction | 
-
-### Return type
-
-[**EarningsOrderObject**](EarningsOrderObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_earnings_orders
-
-> EarningsOrders get_earnings_orders(xero_tenant_id, opts)
-
-searches earnings orders
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-
-begin
-  #searches earnings orders
-  result = api_instance.get_earnings_orders(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_earnings_orders: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] 
-
-### Return type
-
-[**EarningsOrders**](EarningsOrders.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_earnings_rate
-
-> EarningsRateObject get_earnings_rate(xero_tenant_id, earnings_rate_id)
-
-retrieve a single earnings rates by id
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-earnings_rate_id = 'earnings_rate_id_example' # String | Identifier for the earnings rate
-begin
-  #retrieve a single earnings rates by id
-  result = api_instance.get_earnings_rate(xero_tenant_id, earnings_rate_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_earnings_rate: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **earnings_rate_id** | [**String**](.md)| Identifier for the earnings rate | 
-
-### Return type
-
-[**EarningsRateObject**](EarningsRateObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_earnings_rates
-
-> EarningsRates get_earnings_rates(xero_tenant_id, opts)
-
-searches earnings rates
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-
-begin
-  #searches earnings rates
-  result = api_instance.get_earnings_rates(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_earnings_rates: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] 
-
-### Return type
-
-[**EarningsRates**](EarningsRates.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employee
-
-> EmployeeObject get_employee(xero_tenant_id, employee_id)
-
-searches employees
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #searches employees
-  result = api_instance.get_employee(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employee: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
-
-### Return type
-
-[**EmployeeObject**](EmployeeObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employee_leave
-
-> EmployeeLeaveObject get_employee_leave(xero_tenant_id, employee_id, leave_id)
-
-retrieve a single employee leave record
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314' # String | Leave id for single object
-begin
-  #retrieve a single employee leave record
-  result = api_instance.get_employee_leave(xero_tenant_id, employee_id, leave_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employee_leave: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **leave_id** | [**String**](.md)| Leave id for single object | 
-
-### Return type
-
-[**EmployeeLeaveObject**](EmployeeLeaveObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employee_leave_balances
-
-> EmployeeLeaveBalances get_employee_leave_balances(xero_tenant_id, employee_id)
-
-search employee leave balances
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #search employee leave balances
-  result = api_instance.get_employee_leave_balances(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employee_leave_balances: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
-
-### Return type
-
-[**EmployeeLeaveBalances**](EmployeeLeaveBalances.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employee_leave_periods
-
-> LeavePeriods get_employee_leave_periods(xero_tenant_id, employee_id, opts)
-
-searches employee leave periods
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-opts = {
-  start_date: Date.parse('2013-10-20'), # Date | Filter by start date
-
-  end_date: Date.parse('Johnson') # Date | Filter by end date
-}
-
-begin
-  #searches employee leave periods
-  result = api_instance.get_employee_leave_periods(xero_tenant_id, employee_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employee_leave_periods: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **start_date** | **Date**| Filter by start date | [optional] 
- **end_date** | **Date**| Filter by end date | [optional] 
-
-### Return type
-
-[**LeavePeriods**](LeavePeriods.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employee_leave_types
-
-> EmployeeLeaveTypes get_employee_leave_types(xero_tenant_id, employee_id)
-
-searches employee leave types
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #searches employee leave types
-  result = api_instance.get_employee_leave_types(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employee_leave_types: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
-
-### Return type
-
-[**EmployeeLeaveTypes**](EmployeeLeaveTypes.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employee_leaves
-
-> EmployeeLeaves get_employee_leaves(xero_tenant_id, employee_id)
-
-search employee leave records
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #search employee leave records
-  result = api_instance.get_employee_leaves(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employee_leaves: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
-
-### Return type
-
-[**EmployeeLeaves**](EmployeeLeaves.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employee_opening_balances
-
-> EmployeeOpeningBalancesObject get_employee_opening_balances(xero_tenant_id, employee_id)
-
-retrieve employee openingbalances
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #retrieve employee openingbalances
-  result = api_instance.get_employee_opening_balances(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employee_opening_balances: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
-
-### Return type
-
-[**EmployeeOpeningBalancesObject**](EmployeeOpeningBalancesObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employee_pay_template
-
-> EmployeePayTemplateObject get_employee_pay_template(xero_tenant_id, employee_id)
-
-searches employee pay templates
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #searches employee pay templates
-  result = api_instance.get_employee_pay_template(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employee_pay_template: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
-
-### Return type
-
-[**EmployeePayTemplateObject**](EmployeePayTemplateObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employee_payment_method
-
-> PaymentMethodObject get_employee_payment_method(xero_tenant_id, employee_id)
-
-retrieves an employee's payment method
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #retrieves an employee's payment method
-  result = api_instance.get_employee_payment_method(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employee_payment_method: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
-
-### Return type
-
-[**PaymentMethodObject**](PaymentMethodObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employee_salary_and_wage
-
-> SalaryAndWages get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
-
-get employee salary and wages record by id
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # String | Id for single pay template earnings object
-begin
-  #get employee salary and wages record by id
-  result = api_instance.get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employee_salary_and_wage: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **salary_and_wages_id** | [**String**](.md)| Id for single pay template earnings object | 
-
-### Return type
-
-[**SalaryAndWages**](SalaryAndWages.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employee_salary_and_wages
-
-> SalaryAndWages get_employee_salary_and_wages(xero_tenant_id, employee_id, opts)
-
-retrieves an employee's salary and wages
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-
-begin
-  #retrieves an employee's salary and wages
-  result = api_instance.get_employee_salary_and_wages(xero_tenant_id, employee_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employee_salary_and_wages: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] 
-
-### Return type
-
-[**SalaryAndWages**](SalaryAndWages.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employee_statutory_leave_balances
-
-> EmployeeStatutoryLeaveBalanceObject get_employee_statutory_leave_balances(xero_tenant_id, employee_id, opts)
-
-search employee leave balances
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-opts = {
-  leave_type: 'sick', # String | Filter by the type of statutory leave
-
-  as_of_date: Date.parse('2013-10-20') # Date | The date from which to calculate balance remaining. If not specified, current date UTC is used.
-}
-
-begin
-  #search employee leave balances
-  result = api_instance.get_employee_statutory_leave_balances(xero_tenant_id, employee_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employee_statutory_leave_balances: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **leave_type** | **String**| Filter by the type of statutory leave | [optional] 
- **as_of_date** | **Date**| The date from which to calculate balance remaining. If not specified, current date UTC is used. | [optional] 
-
-### Return type
-
-[**EmployeeStatutoryLeaveBalanceObject**](EmployeeStatutoryLeaveBalanceObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employee_statutory_sick_leave
-
-> EmployeeStatutorySickLeaveObject get_employee_statutory_sick_leave(xero_tenant_id, statutory_sick_leave_id)
-
-retrieve a statutory sick leave for an employee
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-statutory_sick_leave_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Statutory sick leave id for single object
-begin
-  #retrieve a statutory sick leave for an employee
-  result = api_instance.get_employee_statutory_sick_leave(xero_tenant_id, statutory_sick_leave_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employee_statutory_sick_leave: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **statutory_sick_leave_id** | [**String**](.md)| Statutory sick leave id for single object | 
-
-### Return type
-
-[**EmployeeStatutorySickLeaveObject**](EmployeeStatutorySickLeaveObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employee_tax
-
-> EmployeeTaxObject get_employee_tax(xero_tenant_id, employee_id)
-
-searches tax records for an employee
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #searches tax records for an employee
-  result = api_instance.get_employee_tax(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employee_tax: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
-
-### Return type
-
-[**EmployeeTaxObject**](EmployeeTaxObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_employees
-
-> Employees get_employees(xero_tenant_id, opts)
-
-searches employees
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  first_name: 'John', # String | Filter by first name
-
-  last_name: 'Johnson', # String | Filter by last name
-
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-
-begin
-  #searches employees
-  result = api_instance.get_employees(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_employees: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **first_name** | **String**| Filter by first name | [optional] 
- **last_name** | **String**| Filter by last name | [optional] 
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] 
-
-### Return type
-
-[**Employees**](Employees.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_leave_type
-
-> LeaveTypeObject get_leave_type(xero_tenant_id, leave_type_id)
-
-retrieve a single leave type by id
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-leave_type_id = 'leave_type_id_example' # String | Identifier for the leave type
-begin
-  #retrieve a single leave type by id
-  result = api_instance.get_leave_type(xero_tenant_id, leave_type_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_leave_type: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **leave_type_id** | [**String**](.md)| Identifier for the leave type | 
-
-### Return type
-
-[**LeaveTypeObject**](LeaveTypeObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_leave_types
-
-> LeaveTypes get_leave_types(xero_tenant_id, opts)
-
-searches leave types
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56, # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-
-  active_only: true # Boolean | Filters leave types by active status. By default the API returns all leave types.
-}
-
-begin
-  #searches leave types
-  result = api_instance.get_leave_types(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_leave_types: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] 
- **active_only** | **Boolean**| Filters leave types by active status. By default the API returns all leave types. | [optional] 
-
-### Return type
-
-[**LeaveTypes**](LeaveTypes.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_pay_run
-
-> PayRunObject get_pay_run(xero_tenant_id, pay_run_id)
-
-retrieve a single pay run by id
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-pay_run_id = 'pay_run_id_example' # String | Identifier for the pay run
-begin
-  #retrieve a single pay run by id
-  result = api_instance.get_pay_run(xero_tenant_id, pay_run_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_pay_run: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **pay_run_id** | [**String**](.md)| Identifier for the pay run | 
-
-### Return type
-
-[**PayRunObject**](PayRunObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_pay_run_calendar
-
-> PayRunCalendarObject get_pay_run_calendar(xero_tenant_id, pay_run_calendar_id)
-
-retrieve a single payrun calendar by id
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-pay_run_calendar_id = 'pay_run_calendar_id_example' # String | Identifier for the payrun calendars
-begin
-  #retrieve a single payrun calendar by id
-  result = api_instance.get_pay_run_calendar(xero_tenant_id, pay_run_calendar_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_pay_run_calendar: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **pay_run_calendar_id** | [**String**](.md)| Identifier for the payrun calendars | 
-
-### Return type
-
-[**PayRunCalendarObject**](PayRunCalendarObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_pay_run_calendars
-
-> PayRunCalendars get_pay_run_calendars(xero_tenant_id, opts)
-
-searches payrun calendars
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-
-begin
-  #searches payrun calendars
-  result = api_instance.get_pay_run_calendars(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_pay_run_calendars: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] 
-
-### Return type
-
-[**PayRunCalendars**](PayRunCalendars.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_pay_runs
-
-> PayRuns get_pay_runs(xero_tenant_id, opts)
-
-searches pay runs
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56, # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-
-  status: 'status_example' # String | 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.
-}
-
-begin
-  #searches pay runs
-  result = api_instance.get_pay_runs(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_pay_runs: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] 
- **status** | **String**| 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&#x3D;{PayRunStatus} to filter the payruns by status. | [optional] 
-
-### Return type
-
-[**PayRuns**](PayRuns.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_pay_slip
-
-> PayslipObject get_pay_slip(xero_tenant_id, payslip_id)
-
-retrieve a single payslip by id
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-payslip_id = 'payslip_id_example' # String | Identifier for the payslip
-begin
-  #retrieve a single payslip by id
-  result = api_instance.get_pay_slip(xero_tenant_id, payslip_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_pay_slip: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **payslip_id** | [**String**](.md)| Identifier for the payslip | 
-
-### Return type
-
-[**PayslipObject**](PayslipObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_pay_slips
-
-> Payslips get_pay_slips(xero_tenant_id, pay_run_id, opts)
-
-searches payslips
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-pay_run_id = 'pay_run_id_example' # String | PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun.
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-
-begin
-  #searches payslips
-  result = api_instance.get_pay_slips(xero_tenant_id, pay_run_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_pay_slips: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **pay_run_id** | [**String**](.md)| PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun. | 
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] 
-
-### Return type
-
-[**Payslips**](Payslips.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_reimbursement
-
-> ReimbursementObject get_reimbursement(xero_tenant_id, reimbursement_id)
-
-retrieve a single reimbursement by id
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-reimbursement_id = 'reimbursement_id_example' # String | Identifier for the reimbursement
-begin
-  #retrieve a single reimbursement by id
-  result = api_instance.get_reimbursement(xero_tenant_id, reimbursement_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_reimbursement: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **reimbursement_id** | [**String**](.md)| Identifier for the reimbursement | 
-
-### Return type
-
-[**ReimbursementObject**](ReimbursementObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_reimbursements
-
-> Reimbursements get_reimbursements(xero_tenant_id, opts)
-
-searches reimbursements
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-
-begin
-  #searches reimbursements
-  result = api_instance.get_reimbursements(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_reimbursements: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] 
-
-### Return type
-
-[**Reimbursements**](Reimbursements.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_settings
-
-> Settings get_settings(xero_tenant_id)
-
-searches settings
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-begin
-  #searches settings
-  result = api_instance.get_settings(xero_tenant_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_settings: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
-
-### Return type
-
-[**Settings**](Settings.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_statutory_leave_summary
-
-> EmployeeStatutoryLeavesSummaries get_statutory_leave_summary(xero_tenant_id, employee_id, opts)
-
-retrieve a summary of statutory leaves for an employee
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-opts = {
-  active_only: true # Boolean | Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future scheduled) are returned
-}
-
-begin
-  #retrieve a summary of statutory leaves for an employee
-  result = api_instance.get_statutory_leave_summary(xero_tenant_id, employee_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_statutory_leave_summary: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **active_only** | **Boolean**| Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future scheduled) are returned | [optional] 
-
-### Return type
-
-[**EmployeeStatutoryLeavesSummaries**](EmployeeStatutoryLeavesSummaries.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_timesheet
-
-> TimesheetObject get_timesheet(xero_tenant_id, timesheet_id)
-
-retrieve a single timesheet by id
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet
-begin
-  #retrieve a single timesheet by id
-  result = api_instance.get_timesheet(xero_tenant_id, timesheet_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_timesheet: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **timesheet_id** | [**String**](.md)| Identifier for the timesheet | 
-
-### Return type
-
-[**TimesheetObject**](TimesheetObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_timesheets
-
-> Timesheets get_timesheets(xero_tenant_id, opts)
-
-searches timesheets
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56, # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-
-  employee_id: 'employee_id_example', # String | 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.
-
-  payroll_calendar_id: 'payroll_calendar_id_example' # String | By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id
-}
-
-begin
-  #searches timesheets
-  result = api_instance.get_timesheets(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_timesheets: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] 
- **employee_id** | [**String**](.md)| By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter&#x3D;employeeId&#x3D;&#x3D;{EmployeeId} to get only the timesheets of a particular employee. | [optional] 
- **payroll_calendar_id** | [**String**](.md)| By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter&#x3D;payrollCalendarId&#x3D;&#x3D;{PayrollCalendarID} to filter the timesheets by payroll calendar id | [optional] 
-
-### Return type
-
-[**Timesheets**](Timesheets.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_tracking_categories
-
-> TrackingCategories get_tracking_categories(xero_tenant_id)
-
-searches tracking categories
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-begin
-  #searches tracking categories
-  result = api_instance.get_tracking_categories(xero_tenant_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->get_tracking_categories: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
-
-### Return type
-
-[**TrackingCategories**](TrackingCategories.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## revert_timesheet
-
-> TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id)
-
-revert a timesheet to draft
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet
-begin
-  #revert a timesheet to draft
-  result = api_instance.revert_timesheet(xero_tenant_id, timesheet_id)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->revert_timesheet: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **timesheet_id** | [**String**](.md)| Identifier for the timesheet | 
-
-### Return type
-
-[**TimesheetObject**](TimesheetObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## update_employee
-
-> EmployeeObject update_employee(xero_tenant_id, employee_id, employee)
-
-updates employee
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-employee = { "title":"Mr", "firstName":"Mike", "lastName":"Johnllsbkrhwopson", "dateOfBirth":"1999-01-01", "address":{ "addressLine1":"101 Green St", "city":"San Francisco", "postCode":"6TGR4F", "country":"UK" }, "email":"84044@starkindustries.com", "gender":"M" } # Employee | 
-begin
-  #updates employee
-  result = api_instance.update_employee(xero_tenant_id, employee_id, employee)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->update_employee: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **employee** | [**Employee**](Employee.md)|  | 
-
-### Return type
-
-[**EmployeeObject**](EmployeeObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## update_employee_earnings_template
-
-> EarningsTemplateObject update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template)
-
-updates employee earnings template records
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # String | Id for single pay template earnings object
-earnings_template = { "ratePerUnit": 30, "numberOfUnits": 4, "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27" } # EarningsTemplate | 
-begin
-  #updates employee earnings template records
-  result = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->update_employee_earnings_template: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **pay_template_earning_id** | [**String**](.md)| Id for single pay template earnings object | 
- **earnings_template** | [**EarningsTemplate**](EarningsTemplate.md)|  | 
-
-### Return type
-
-[**EarningsTemplateObject**](EarningsTemplateObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## update_employee_leave
-
-> EmployeeLeaveObject update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave)
-
-updates employee leave records
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314' # String | Leave id for single object
-employee_leave = { "leaveTypeID": "ed08dffe-788e-4b24-9630-f0fa2f4d164c", "description": "Creating a Description", "startDate": "2020-04-24", "endDate": "2020-04-26", "periods": [ { "periodStartDate": "2020-04-20", "periodEndDate": "2020-04-26", "numberOfUnits": 1, "periodStatus": "Approved" } ] } # EmployeeLeave | 
-begin
-  #updates employee leave records
-  result = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->update_employee_leave: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **leave_id** | [**String**](.md)| Leave id for single object | 
- **employee_leave** | [**EmployeeLeave**](EmployeeLeave.md)|  | 
-
-### Return type
-
-[**EmployeeLeaveObject**](EmployeeLeaveObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## update_employee_opening_balances
-
-> EmployeeOpeningBalancesObject update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances)
-
-updates employee opening balances
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-employee_opening_balances = { "statutoryAdoptionPay": 20, "statutoryMaternityPay": 20, "statutoryPaternityPay": 20, "statutorySharedParentalPay": 20, "statutorySickPay": 20, "priorEmployeeNumber": 20 } # EmployeeOpeningBalances | 
-begin
-  #updates employee opening balances
-  result = api_instance.update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->update_employee_opening_balances: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **employee_opening_balances** | [**EmployeeOpeningBalances**](EmployeeOpeningBalances.md)|  | 
-
-### Return type
-
-[**EmployeeOpeningBalancesObject**](EmployeeOpeningBalancesObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## update_employee_salary_and_wage
-
-> SalaryAndWageObject update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage)
-
-updates employee salary and wages record
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # String | Id for single pay template earnings object
-salary_and_wage = { "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnitsPerWeek": 3, "ratePerUnit": 11, "effectiveFrom": "2020-05-15", "annualSalary": 101, "status": "ACTIVE", "paymentType": "Salary" } # SalaryAndWage | 
-begin
-  #updates employee salary and wages record
-  result = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->update_employee_salary_and_wage: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **employee_id** | [**String**](.md)| Employee id for single object | 
- **salary_and_wages_id** | [**String**](.md)| Id for single pay template earnings object | 
- **salary_and_wage** | [**SalaryAndWage**](SalaryAndWage.md)|  | 
-
-### Return type
-
-[**SalaryAndWageObject**](SalaryAndWageObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## update_pay_run
-
-> PayRunObject update_pay_run(xero_tenant_id, pay_run_id, pay_run)
-
-update a pay run
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-pay_run_id = 'pay_run_id_example' # String | Identifier for the pay run
-pay_run = { "paymentDate": "2020-05-01" } # PayRun | 
-begin
-  #update a pay run
-  result = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->update_pay_run: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **pay_run_id** | [**String**](.md)| Identifier for the pay run | 
- **pay_run** | [**PayRun**](PayRun.md)|  | 
-
-### Return type
-
-[**PayRunObject**](PayRunObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## update_timesheet_line
-
-> TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line)
-
-update a timesheet line
-
-### Example
-
-```ruby
-# load the gem
-require 'xero-ruby'
-
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-
-token_set = fetch_valid_token_set(user) # example
-
-xero_client.refresh_token_set(token_set)
-
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet
-timesheet_line_id = 'timesheet_line_id_example' # String | Identifier for the timesheet line
-timesheet_line = { "date": "2020-04-14", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 2 } # TimesheetLine | 
-begin
-  #update a timesheet line
-  result = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line)
-  p result
-rescue XeroRuby::PayrollUk::ApiError => e
-  puts "Exception when calling PayrollUkApi->update_timesheet_line: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **timesheet_id** | [**String**](.md)| Identifier for the timesheet | 
- **timesheet_line_id** | [**String**](.md)| Identifier for the timesheet line | 
- **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)|  | 
-
-### Return type
-
-[**TimesheetLineObject**](TimesheetLineObject.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-