xero-ruby 2.4.0 → 2.4.1

data/docs/payroll_uk/EmployeeStatutorySickLeaveObject.md

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

data/docs/payroll_uk/EmployeeStatutorySickLeaves.md

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

data/docs/payroll_uk/EmployeeTax.md

@@ -1,37 +0,0 @@
-# XeroRuby::PayrollUk::EmployeeTax
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**starter_type** | **String** | The Starter type. | [optional] 
-**starter_declaration** | **String** | Starter declaration. | [optional] 
-**tax_code** | **String** | The Tax code. | [optional] 
-**w1_m1** | **Boolean** | Describes whether the tax settings is W1M1 | [optional] 
-**previous_taxable_pay** | **BigDecimal** | The previous taxable pay | [optional] 
-**previous_tax_paid** | **BigDecimal** | The tax amount previously paid | [optional] 
-**student_loan_deduction** | **String** | The employee's student loan deduction type | [optional] 
-**has_post_graduate_loans** | **Boolean** | Describes whether the employee has post graduate loans | [optional] 
-**is_director** | **Boolean** | Describes whether the employee is director | [optional] 
-**directorship_start_date** | **Date** | The directorship start date | [optional] 
-**nic_calculation_method** | **String** | NICs calculation method | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::EmployeeTax.new(starter_type: New Employee with P45,
-                                 starter_declaration: B.) This is currently their only job,
-                                 tax_code: 1185L,
-                                 w1_m1: null,
-                                 previous_taxable_pay: null,
-                                 previous_tax_paid: null,
-                                 student_loan_deduction: Plan Type 2,
-                                 has_post_graduate_loans: null,
-                                 is_director: null,
-                                 directorship_start_date: null,
-                                 nic_calculation_method: Annualized)
-```
-
-

data/docs/payroll_uk/EmployeeTaxObject.md

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

data/docs/payroll_uk/Employees.md

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

data/docs/payroll_uk/Employment.md

@@ -1,23 +0,0 @@
-# XeroRuby::PayrollUk::Employment
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payroll_calendar_id** | **String** | Xero unique identifier for the payroll calendar of the employee | [optional] 
-**start_date** | **Date** | Start date of the employment (YYYY-MM-DD) | [optional] 
-**employee_number** | **String** | The employment number of the employee | [optional] 
-**ni_category** | **String** | The NI Category of the employee | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::Employment.new(payroll_calendar_id: null,
-                                 start_date: null,
-                                 employee_number: 7,
-                                 ni_category: A)
-```
-
-

data/docs/payroll_uk/EmploymentObject.md

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

data/docs/payroll_uk/InvalidField.md

@@ -1,19 +0,0 @@
-# XeroRuby::PayrollUk::InvalidField
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name of the field that caused the error | [optional] 
-**reason** | **String** | The reason the error occurred | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::InvalidField.new(name: DateOfBirth,
-                                 reason: The Date of Birth is required.)
-```
-
-

data/docs/payroll_uk/LeaveAccrualLine.md

@@ -1,19 +0,0 @@
-# XeroRuby::PayrollUk::LeaveAccrualLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**leave_type_id** | **String** | Xero identifier for the Leave type | [optional] 
-**number_of_units** | **Float** | Leave accrual number of units | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::LeaveAccrualLine.new(leave_type_id: null,
-                                 number_of_units: null)
-```
-
-

data/docs/payroll_uk/LeaveEarningsLine.md

@@ -1,27 +0,0 @@
-# XeroRuby::PayrollUk::LeaveEarningsLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**earnings_rate_id** | **String** | Xero identifier for payroll leave earnings rate | [optional] 
-**rate_per_unit** | **Float** | Rate per unit for leave earnings line | [optional] 
-**number_of_units** | **Float** | Leave earnings number of units | [optional] 
-**fixed_amount** | **Float** | Leave earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed | [optional] 
-**amount** | **Float** | The amount of the earnings line. | [optional] 
-**is_linked_to_timesheet** | **Boolean** | Identifies if the leave earnings is taken from the timesheet. False for leave earnings line | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::LeaveEarningsLine.new(earnings_rate_id: null,
-                                 rate_per_unit: null,
-                                 number_of_units: null,
-                                 fixed_amount: null,
-                                 amount: null,
-                                 is_linked_to_timesheet: null)
-```
-
-

data/docs/payroll_uk/LeavePeriod.md

@@ -1,23 +0,0 @@
-# XeroRuby::PayrollUk::LeavePeriod
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**period_start_date** | **Date** | The Pay Period Start Date (YYYY-MM-DD) | [optional] 
-**period_end_date** | **Date** | The Pay Period End Date (YYYY-MM-DD) | [optional] 
-**number_of_units** | **Float** | The Number of Units for the leave | [optional] 
-**period_status** | **String** | Period Status | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::LeavePeriod.new(period_start_date: null,
-                                 period_end_date: null,
-                                 number_of_units: null,
-                                 period_status: null)
-```
-
-

data/docs/payroll_uk/LeavePeriods.md

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

data/docs/payroll_uk/LeaveType.md

@@ -1,31 +0,0 @@
-# XeroRuby::PayrollUk::LeaveType
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**leave_id** | **String** | Xero unique identifier for the leave | [optional] 
-**leave_type_id** | **String** | Xero unique identifier for the leave type | [optional] 
-**name** | **String** | Name of the leave type | 
-**is_paid_leave** | **Boolean** | Indicate that an employee will be paid when taking this type of leave | 
-**show_on_payslip** | **Boolean** | Indicate that a balance for this leave type to be shown on the employee’s payslips | 
-**updated_date_utc** | **DateTime** | UTC timestamp of last update to the leave type note | [optional] 
-**is_active** | **Boolean** | Shows whether the leave type is active or not | [optional] 
-**is_statutory_leave** | **Boolean** | Shows whether the leave type is a statutory leave type or not | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::LeaveType.new(leave_id: null,
-                                 leave_type_id: null,
-                                 name: null,
-                                 is_paid_leave: null,
-                                 show_on_payslip: null,
-                                 updated_date_utc: null,
-                                 is_active: null,
-                                 is_statutory_leave: null)
-```
-
-

data/docs/payroll_uk/LeaveTypeObject.md

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

data/docs/payroll_uk/LeaveTypes.md

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

data/docs/payroll_uk/Pagination.md

@@ -1,23 +0,0 @@
-# XeroRuby::PayrollUk::Pagination
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**page** | **Integer** |  | [optional] 
-**page_size** | **Integer** |  | [optional] 
-**page_count** | **Integer** |  | [optional] 
-**item_count** | **Integer** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::Pagination.new(page: 1,
-                                 page_size: 10,
-                                 page_count: 1,
-                                 item_count: 2)
-```
-
-

data/docs/payroll_uk/PayRun.md

@@ -1,39 +0,0 @@
-# XeroRuby::PayrollUk::PayRun
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pay_run_id** | **String** | Xero unique identifier for the pay run | [optional] 
-**payroll_calendar_id** | **String** | Xero unique identifier for the payroll calendar | [optional] 
-**period_start_date** | **Date** | Period start date of the payroll calendar | [optional] 
-**period_end_date** | **Date** | Period end date of the payroll calendar | [optional] 
-**payment_date** | **Date** | Payment date of the pay run | [optional] 
-**total_cost** | **Float** | Total cost of the pay run | [optional] 
-**total_pay** | **Float** | Total pay of the pay run | [optional] 
-**pay_run_status** | **String** | Pay run status | [optional] 
-**pay_run_type** | **String** | Pay run type | [optional] 
-**calendar_type** | **String** | Calendar type of the pay run | [optional] 
-**posted_date_time** | **Date** | Posted date time of the pay run | [optional] 
-**pay_slips** | [**Array<Payslip>**](Payslip.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::PayRun.new(pay_run_id: null,
-                                 payroll_calendar_id: null,
-                                 period_start_date: null,
-                                 period_end_date: null,
-                                 payment_date: null,
-                                 total_cost: null,
-                                 total_pay: null,
-                                 pay_run_status: null,
-                                 pay_run_type: null,
-                                 calendar_type: null,
-                                 posted_date_time: null,
-                                 pay_slips: null)
-```
-
-

data/docs/payroll_uk/PayRunCalendar.md

@@ -1,29 +0,0 @@
-# XeroRuby::PayrollUk::PayRunCalendar
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payroll_calendar_id** | **String** | Xero unique identifier for the payroll calendar | [optional] 
-**name** | **String** | Name of the calendar | 
-**calendar_type** | **String** | Type of the calendar | 
-**period_start_date** | **Date** | Period start date of the calendar | 
-**period_end_date** | **Date** | Period end date of the calendar | [optional] 
-**payment_date** | **Date** | Payment date of the calendar | 
-**updated_date_utc** | **DateTime** | UTC timestamp of the last update to the pay run calendar | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::PayRunCalendar.new(payroll_calendar_id: null,
-                                 name: null,
-                                 calendar_type: null,
-                                 period_start_date: null,
-                                 period_end_date: null,
-                                 payment_date: null,
-                                 updated_date_utc: null)
-```
-
-