xero-ruby 2.3.0 → 2.5.1

data/docs/payroll_uk/CourtOrderLine.md

@@ -1,19 +0,0 @@
-# XeroRuby::PayrollUk::CourtOrderLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**court_order_type_id** | **String** | Xero identifier for payroll court order type | [optional] 
-**amount** | **Float** | Amount | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::CourtOrderLine.new(court_order_type_id: null,
-                                 amount: null)
-```
-
-

data/docs/payroll_uk/Deduction.md

@@ -1,47 +0,0 @@
-# XeroRuby::PayrollUk::Deduction
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**deduction_id** | **String** | The Xero identifier for Deduction | [optional] 
-**deduction_name** | **String** | Name of the deduction | 
-**deduction_category** | **String** | Deduction Category type | [optional] 
-**liability_account_id** | **String** | Xero identifier for Liability Account | 
-**current_record** | **Boolean** | Identifier of a record is active or not. | [optional] 
-**standard_amount** | **BigDecimal** | Standard amount of the deduction | [optional] 
-**reduces_super_liability** | **Boolean** | Identifier of reduces super liability | [optional] 
-**reduces_tax_liability** | **Boolean** | Identifier of reduces tax liability | [optional] 
-**calculation_type** | **String** | determine the calculation type whether fixed amount or percentage of gross | [optional] 
-**percentage** | **BigDecimal** | Percentage of gross | [optional] 
-**subject_to_nic** | **Boolean** | Identifier of subject To NIC | [optional] 
-**subject_to_tax** | **Boolean** | Identifier of subject To Tax | [optional] 
-**is_reduced_by_basic_rate** | **Boolean** | Identifier of reduced by basic rate applicable or not | [optional] 
-**apply_to_pension_calculations** | **Boolean** | Identifier for apply to pension calculations | [optional] 
-**is_calculating_on_qualifying_earnings** | **Boolean** | Identifier of calculating on qualifying earnings | [optional] 
-**is_pension** | **Boolean** | Identifier of applicable for pension or not | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::Deduction.new(deduction_id: null,
-                                 deduction_name: null,
-                                 deduction_category: null,
-                                 liability_account_id: null,
-                                 current_record: null,
-                                 standard_amount: null,
-                                 reduces_super_liability: null,
-                                 reduces_tax_liability: null,
-                                 calculation_type: null,
-                                 percentage: null,
-                                 subject_to_nic: null,
-                                 subject_to_tax: null,
-                                 is_reduced_by_basic_rate: null,
-                                 apply_to_pension_calculations: null,
-                                 is_calculating_on_qualifying_earnings: null,
-                                 is_pension: null)
-```
-
-

data/docs/payroll_uk/DeductionLine.md

@@ -1,23 +0,0 @@
-# XeroRuby::PayrollUk::DeductionLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**deduction_type_id** | **String** | Xero identifier for payroll deduction | [optional] 
-**amount** | **Float** | The amount of the deduction line | [optional] 
-**subject_to_tax** | **Boolean** | Identifies if the deduction is subject to tax | [optional] 
-**percentage** | **Float** | Deduction rate percentage | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::DeductionLine.new(deduction_type_id: null,
-                                 amount: null,
-                                 subject_to_tax: null,
-                                 percentage: null)
-```
-
-

data/docs/payroll_uk/DeductionObject.md

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

data/docs/payroll_uk/Deductions.md

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

data/docs/payroll_uk/EarningsLine.md

@@ -1,33 +0,0 @@
-# XeroRuby::PayrollUk::EarningsLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**earnings_line_id** | **String** | Xero identifier for payroll earnings line | [optional] 
-**earnings_rate_id** | **String** | Xero identifier for payroll earnings rate | [optional] 
-**display_name** | **String** | name of earnings rate for display in UI | [optional] 
-**rate_per_unit** | **Float** | Rate per unit for earnings line | [optional] 
-**number_of_units** | **Float** | Earnings number of units | [optional] 
-**fixed_amount** | **Float** | 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 earnings is taken from the timesheet. False for earnings line | [optional] 
-**is_average_daily_pay_rate** | **Boolean** | Identifies if the earnings is using an average daily pay rate | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::EarningsLine.new(earnings_line_id: null,
-                                 earnings_rate_id: null,
-                                 display_name: null,
-                                 rate_per_unit: null,
-                                 number_of_units: null,
-                                 fixed_amount: null,
-                                 amount: null,
-                                 is_linked_to_timesheet: null,
-                                 is_average_daily_pay_rate: null)
-```
-
-

data/docs/payroll_uk/EarningsOrder.md

@@ -1,25 +0,0 @@
-# XeroRuby::PayrollUk::EarningsOrder
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Xero unique identifier for an earning rate | [optional] 
-**name** | **String** | Name of the earning order | 
-**statutory_deduction_category** | [**StatutoryDeductionCategory**](StatutoryDeductionCategory.md) |  | [optional] 
-**liability_account_id** | **String** | Xero identifier for Liability Account | [optional] 
-**current_record** | **Boolean** | Identifier of a record is active or not. | [optional] [default to true]
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::EarningsOrder.new(id: null,
-                                 name: null,
-                                 statutory_deduction_category: null,
-                                 liability_account_id: null,
-                                 current_record: null)
-```
-
-

data/docs/payroll_uk/EarningsOrderObject.md

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

data/docs/payroll_uk/EarningsOrders.md

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

data/docs/payroll_uk/EarningsRate.md

@@ -1,35 +0,0 @@
-# XeroRuby::PayrollUk::EarningsRate
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**earnings_rate_id** | **String** | Xero unique identifier for an earning rate | [optional] 
-**name** | **String** | Name of the earning rate | 
-**earnings_type** | **String** | Indicates how an employee will be paid when taking this type of earning | 
-**rate_type** | **String** | Indicates the type of the earning rate | 
-**type_of_units** | **String** | The type of units used to record earnings | 
-**current_record** | **Boolean** | Indicates whether an earning type is active | [optional] 
-**expense_account_id** | **String** | The account that will be used for the earnings rate | 
-**rate_per_unit** | **BigDecimal** | Default rate per unit (optional). Only applicable if RateType is RatePerUnit | [optional] 
-**multiple_of_ordinary_earnings_rate** | **BigDecimal** | This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate. For example, for time and a half enter 1.5. Only applicable if RateType is MultipleOfOrdinaryEarningsRate | [optional] 
-**fixed_amount** | **BigDecimal** | Optional Fixed Rate Amount. Applicable for FixedAmount Rate | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::EarningsRate.new(earnings_rate_id: null,
-                                 name: null,
-                                 earnings_type: null,
-                                 rate_type: null,
-                                 type_of_units: null,
-                                 current_record: null,
-                                 expense_account_id: null,
-                                 rate_per_unit: null,
-                                 multiple_of_ordinary_earnings_rate: null,
-                                 fixed_amount: null)
-```
-
-

data/docs/payroll_uk/EarningsRateObject.md

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

data/docs/payroll_uk/EarningsRates.md

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

data/docs/payroll_uk/EarningsTemplate.md

@@ -1,27 +0,0 @@
-# XeroRuby::PayrollUk::EarningsTemplate
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pay_template_earning_id** | **String** | The Xero identifier for the earnings template | [optional] 
-**rate_per_unit** | **BigDecimal** | The rate per unit | [optional] 
-**number_of_units** | **BigDecimal** | The rate per unit | [optional] 
-**fixed_amount** | **BigDecimal** | The fixed amount per period | [optional] 
-**earnings_rate_id** | **String** | The corresponding earnings rate identifier | [optional] 
-**name** | **String** | The read-only name of the Earning Template. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::EarningsTemplate.new(pay_template_earning_id: null,
-                                 rate_per_unit: null,
-                                 number_of_units: null,
-                                 fixed_amount: null,
-                                 earnings_rate_id: null,
-                                 name: null)
-```
-
-

data/docs/payroll_uk/EarningsTemplateObject.md

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

data/docs/payroll_uk/Employee.md

@@ -1,45 +0,0 @@
-# XeroRuby::PayrollUk::Employee
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**employee_id** | **String** | Xero unique identifier for the employee | [optional] 
-**title** | **String** | Title of the employee | [optional] 
-**first_name** | **String** | First name of employee | [optional] 
-**last_name** | **String** | Last name of employee | [optional] 
-**date_of_birth** | **Date** | Date of birth of the employee (YYYY-MM-DD) | [optional] 
-**address** | [**Address**](Address.md) |  | [optional] 
-**email** | **String** | The email address for the employee | [optional] 
-**gender** | **String** | The employee’s gender | [optional] 
-**phone_number** | **String** | Employee phone number | [optional] 
-**start_date** | **Date** | Employment start date of the employee at the time it was requested | [optional] 
-**end_date** | **Date** | Employment end date of the employee at the time it was requested | [optional] 
-**payroll_calendar_id** | **String** | Xero unique identifier for the payroll calendar of the employee | [optional] 
-**updated_date_utc** | **DateTime** | UTC timestamp of last update to the employee | [optional] 
-**created_date_utc** | **DateTime** | UTC timestamp when the employee was created in Xero | [optional] 
-**national_insurance_number** | **String** | National insurance number of the employee | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::Employee.new(employee_id: d90457c4-f1be-4f2e-b4e3-f766390a7e30,
-                                 title: Mrs,
-                                 first_name: Karen,
-                                 last_name: Jones,
-                                 date_of_birth: Wed Jan 02 00:00:00 GMT 2019,
-                                 address: null,
-                                 email: developer@me.com,
-                                 gender: F,
-                                 phone_number: 415-555-1212,
-                                 start_date: Sun Jan 19 00:00:00 GMT 2020,
-                                 end_date: Sun Jan 19 00:00:00 GMT 2020,
-                                 payroll_calendar_id: null,
-                                 updated_date_utc: null,
-                                 created_date_utc: null,
-                                 national_insurance_number: AB123456C)
-```
-
-

data/docs/payroll_uk/EmployeeLeave.md

@@ -1,29 +0,0 @@
-# XeroRuby::PayrollUk::EmployeeLeave
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**leave_id** | **String** | The Xero identifier for LeaveType | [optional] 
-**leave_type_id** | **String** | The Xero identifier for LeaveType | 
-**description** | **String** | The description of the leave  (max length = 50) | 
-**start_date** | **Date** | Start date of the leave (YYYY-MM-DD) | 
-**end_date** | **Date** | End date of the leave (YYYY-MM-DD) | 
-**periods** | [**Array<LeavePeriod>**](LeavePeriod.md) | The leave period information. The StartDate, EndDate and NumberOfUnits needs to be specified when you do not want to calculate NumberOfUnits automatically. Using incorrect period StartDate and EndDate will result in automatic computation of the NumberOfUnits. | [optional] 
-**updated_date_utc** | **DateTime** | UTC timestamp of last update to the leave type note | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::EmployeeLeave.new(leave_id: null,
-                                 leave_type_id: null,
-                                 description: null,
-                                 start_date: null,
-                                 end_date: null,
-                                 periods: null,
-                                 updated_date_utc: null)
-```
-
-