xero-ruby 2.4.0 → 2.4.1

data/docs/payroll_uk/EmployeeLeaveBalance.md

@@ -1,23 +0,0 @@
-# XeroRuby::PayrollUk::EmployeeLeaveBalance
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | Name of the leave type. | [optional] 
-**leave_type_id** | **String** | The Xero identifier for leave type | [optional] 
-**balance** | **Float** | The employees current balance for the corresponding leave type. | [optional] 
-**type_of_units** | **String** | The type of the units of the leave. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::EmployeeLeaveBalance.new(name: Holiday,
-                                 leave_type_id: null,
-                                 balance: null,
-                                 type_of_units: hours)
-```
-
-

data/docs/payroll_uk/EmployeeLeaveBalances.md

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

data/docs/payroll_uk/EmployeeLeaveObject.md

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

data/docs/payroll_uk/EmployeeLeaveType.md

@@ -1,27 +0,0 @@
-# XeroRuby::PayrollUk::EmployeeLeaveType
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**leave_type_id** | **String** | The Xero identifier for leave type | 
-**schedule_of_accrual** | **String** | The schedule of accrual | 
-**hours_accrued_annually** | **Float** | The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is \"OnHourWorked\" | [optional] 
-**maximum_to_accrue** | **Float** | The maximum number of hours that can be accrued for the leave | [optional] 
-**opening_balance** | **Float** | The initial number of hours assigned when the leave was added to the employee | [optional] 
-**rate_accrued_hourly** | **Float** | The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\" | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::EmployeeLeaveType.new(leave_type_id: null,
-                                 schedule_of_accrual: null,
-                                 hours_accrued_annually: null,
-                                 maximum_to_accrue: null,
-                                 opening_balance: null,
-                                 rate_accrued_hourly: null)
-```
-
-

data/docs/payroll_uk/EmployeeLeaveTypeObject.md

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

data/docs/payroll_uk/EmployeeLeaveTypes.md

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

data/docs/payroll_uk/EmployeeLeaves.md

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

data/docs/payroll_uk/EmployeeObject.md

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

data/docs/payroll_uk/EmployeeOpeningBalances.md

@@ -1,27 +0,0 @@
-# XeroRuby::PayrollUk::EmployeeOpeningBalances
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**statutory_adoption_pay** | **BigDecimal** | The total accumulated statutory adoption pay amount received by the employee for current fiscal year to date | [optional] 
-**statutory_maternity_pay** | **BigDecimal** | The total accumulated statutory maternity pay amount received by the employee for current fiscal year to date | [optional] 
-**statutory_paternity_pay** | **BigDecimal** | The total accumulated statutory paternity pay amount received by the employee for current fiscal year to date | [optional] 
-**statutory_shared_parental_pay** | **BigDecimal** | The total accumulated statutory shared parental pay amount received by the employee for current fiscal year to date | [optional] 
-**statutory_sick_pay** | **BigDecimal** | The total accumulated statutory sick pay amount received by the employee for current fiscal year to date | [optional] 
-**prior_employee_number** | **Float** | The unique employee number issued by the employee's former employer | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::EmployeeOpeningBalances.new(statutory_adoption_pay: null,
-                                 statutory_maternity_pay: null,
-                                 statutory_paternity_pay: null,
-                                 statutory_shared_parental_pay: null,
-                                 statutory_sick_pay: null,
-                                 prior_employee_number: null)
-```
-
-

data/docs/payroll_uk/EmployeeOpeningBalancesObject.md

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

data/docs/payroll_uk/EmployeePayTemplate.md

@@ -1,19 +0,0 @@
-# XeroRuby::PayrollUk::EmployeePayTemplate
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**employee_id** | **String** | Unique identifier for the employee | [optional] 
-**earning_templates** | [**Array<EarningsTemplate>**](EarningsTemplate.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::EmployeePayTemplate.new(employee_id: null,
-                                 earning_templates: null)
-```
-
-

data/docs/payroll_uk/EmployeePayTemplateObject.md

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

data/docs/payroll_uk/EmployeePayTemplates.md

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

data/docs/payroll_uk/EmployeeStatutoryLeaveBalance.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollUk::EmployeeStatutoryLeaveBalance
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**leave_type** | **String** | The type of statutory leave | [optional] 
-**balance_remaining** | **Float** | The balance remaining for the corresponding leave type as of specified date. | [optional] 
-**units** | **String** | The units will be \"Hours\" | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::EmployeeStatutoryLeaveBalance.new(leave_type: null,
-                                 balance_remaining: null,
-                                 units: null)
-```
-
-

data/docs/payroll_uk/EmployeeStatutoryLeaveBalanceObject.md

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

data/docs/payroll_uk/EmployeeStatutoryLeaveSummary.md

@@ -1,29 +0,0 @@
-# XeroRuby::PayrollUk::EmployeeStatutoryLeaveSummary
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**statutory_leave_id** | **String** | The unique identifier (guid) of a statutory leave. | [optional] 
-**employee_id** | **String** | The unique identifier (guid) of the employee | [optional] 
-**type** | **String** | The category of statutory leave | [optional] 
-**start_date** | **Date** | The date when the leave starts | [optional] 
-**end_date** | **Date** | The date when the leave ends | [optional] 
-**is_entitled** | **Boolean** | Whether the leave was entitled to receive payment | [optional] 
-**status** | **String** | The status of the leave | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::EmployeeStatutoryLeaveSummary.new(statutory_leave_id: null,
-                                 employee_id: null,
-                                 type: null,
-                                 start_date: null,
-                                 end_date: null,
-                                 is_entitled: null,
-                                 status: null)
-```
-
-

data/docs/payroll_uk/EmployeeStatutoryLeavesSummaries.md

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

data/docs/payroll_uk/EmployeeStatutorySickLeave.md

@@ -1,47 +0,0 @@
-# XeroRuby::PayrollUk::EmployeeStatutorySickLeave
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**statutory_leave_id** | **String** | The unique identifier (guid) of a statutory leave | [optional] 
-**employee_id** | **String** | The unique identifier (guid) of the employee | 
-**leave_type_id** | **String** | The unique identifier (guid) of the \"Statutory Sick Leave (non-pensionable)\" pay item | 
-**start_date** | **Date** | The date when the leave starts | 
-**end_date** | **Date** | The date when the leave ends | 
-**type** | **String** | the type of statutory leave | [optional] 
-**status** | **String** | the type of statutory leave | [optional] 
-**work_pattern** | **Array<String>** | The days of the work week the employee is scheduled to work at the time the leave is taken | 
-**is_pregnancy_related** | **Boolean** | Whether the sick leave was pregnancy related | 
-**sufficient_notice** | **Boolean** | Whether the employee provided sufficent notice and documentation as required by the employer supporting the sick leave request | 
-**is_entitled** | **Boolean** | Whether the leave was entitled to receive payment | [optional] 
-**entitlement_weeks_requested** | **Float** | The amount of requested time (in weeks) | [optional] 
-**entitlement_weeks_qualified** | **Float** | The amount of statutory sick leave time off (in weeks) that is available to take at the time the leave was requested | [optional] 
-**entitlement_weeks_remaining** | **Float** | A calculated amount of time (in weeks) that remains for the statutory sick leave period | [optional] 
-**overlaps_with_other_leave** | **Boolean** | Whether another leave (Paternity, Shared Parental specifically) occurs during the requested leave's period. While this is allowed it could affect payment amounts | [optional] 
-**entitlement_failure_reasons** | **Array<String>** | If the leave requested was considered \"not entitled\", the reasons why are listed here. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::EmployeeStatutorySickLeave.new(statutory_leave_id: null,
-                                 employee_id: null,
-                                 leave_type_id: null,
-                                 start_date: null,
-                                 end_date: null,
-                                 type: Sick,
-                                 status: Pending,
-                                 work_pattern: null,
-                                 is_pregnancy_related: null,
-                                 sufficient_notice: null,
-                                 is_entitled: null,
-                                 entitlement_weeks_requested: null,
-                                 entitlement_weeks_qualified: null,
-                                 entitlement_weeks_remaining: null,
-                                 overlaps_with_other_leave: null,
-                                 entitlement_failure_reasons: null)
-```
-
-