xero-ruby 2.3.1 → 2.4.0

data/docs/payroll_uk/Payslip.md

@@ -0,0 +1,71 @@
+# XeroRuby::PayrollUk::Payslip
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pay_slip_id** | **String** | The Xero identifier for a Payslip | [optional] 
+**employee_id** | **String** | The Xero identifier for payroll employee | [optional] 
+**pay_run_id** | **String** | The Xero identifier for the associated payrun | [optional] 
+**last_edited** | **Date** | The date payslip was last updated | [optional] 
+**first_name** | **String** | Employee first name | [optional] 
+**last_name** | **String** | Employee last name | [optional] 
+**total_earnings** | **Float** | Total earnings before any deductions. Same as gross earnings for UK. | [optional] 
+**gross_earnings** | **Float** | Total earnings before any deductions. Same as total earnings for UK. | [optional] 
+**total_pay** | **Float** | The employee net pay | [optional] 
+**total_employer_taxes** | **Float** | The employer's tax obligation | [optional] 
+**total_employee_taxes** | **Float** | The part of an employee's earnings that is deducted for tax purposes | [optional] 
+**total_deductions** | **Float** | Total amount subtracted from an employee's earnings to reach total pay | [optional] 
+**total_reimbursements** | **Float** | Total reimbursements are nontaxable payments to an employee used to repay out-of-pocket expenses when the person incurs those expenses through employment | [optional] 
+**total_court_orders** | **Float** | Total amounts required by law to subtract from the employee's earnings | [optional] 
+**total_benefits** | **Float** | Benefits (also called fringe benefits, perquisites or perks) are various non-earnings compensations provided to employees in addition to their normal earnings or salaries | [optional] 
+**bacs_hash** | **String** | BACS Service User Number | [optional] 
+**payment_method** | **String** | The payment method code | [optional] 
+**earnings_lines** | [**Array<EarningsLine>**](EarningsLine.md) |  | [optional] 
+**leave_earnings_lines** | [**Array<LeaveEarningsLine>**](LeaveEarningsLine.md) |  | [optional] 
+**timesheet_earnings_lines** | [**Array<TimesheetEarningsLine>**](TimesheetEarningsLine.md) |  | [optional] 
+**deduction_lines** | [**Array<DeductionLine>**](DeductionLine.md) |  | [optional] 
+**reimbursement_lines** | [**Array<ReimbursementLine>**](ReimbursementLine.md) |  | [optional] 
+**leave_accrual_lines** | [**Array<LeaveAccrualLine>**](LeaveAccrualLine.md) |  | [optional] 
+**benefit_lines** | [**Array<BenefitLine>**](BenefitLine.md) |  | [optional] 
+**payment_lines** | [**Array<PaymentLine>**](PaymentLine.md) |  | [optional] 
+**employee_tax_lines** | [**Array<TaxLine>**](TaxLine.md) |  | [optional] 
+**employer_tax_lines** | [**Array<TaxLine>**](TaxLine.md) |  | [optional] 
+**court_order_lines** | [**Array<CourtOrderLine>**](CourtOrderLine.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollUk'
+
+instance = XeroRuby::PayrollUk::Payslip.new(pay_slip_id: null,
+                                 employee_id: null,
+                                 pay_run_id: null,
+                                 last_edited: null,
+                                 first_name: null,
+                                 last_name: null,
+                                 total_earnings: null,
+                                 gross_earnings: null,
+                                 total_pay: null,
+                                 total_employer_taxes: null,
+                                 total_employee_taxes: null,
+                                 total_deductions: null,
+                                 total_reimbursements: null,
+                                 total_court_orders: null,
+                                 total_benefits: null,
+                                 bacs_hash: null,
+                                 payment_method: null,
+                                 earnings_lines: null,
+                                 leave_earnings_lines: null,
+                                 timesheet_earnings_lines: null,
+                                 deduction_lines: null,
+                                 reimbursement_lines: null,
+                                 leave_accrual_lines: null,
+                                 benefit_lines: null,
+                                 payment_lines: null,
+                                 employee_tax_lines: null,
+                                 employer_tax_lines: null,
+                                 court_order_lines: null)
+```
+
+

data/docs/payroll_uk/PayslipObject.md

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

data/docs/payroll_uk/Payslips.md

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

data/docs/payroll_uk/Problem.md

@@ -0,0 +1,27 @@
+# XeroRuby::PayrollUk::Problem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of error format | [optional] 
+**title** | **String** | The type of the error | [optional] 
+**status** | **String** | The error status code | [optional] 
+**detail** | **String** | A description of the error | [optional] 
+**instance** | **String** |  | [optional] 
+**invalid_fields** | [**Array<InvalidField>**](InvalidField.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollUk'
+
+instance = XeroRuby::PayrollUk::Problem.new(type: application/problem+json,
+                                 title: BadRequest,
+                                 status: 400,
+                                 detail: Validation error occurred.,
+                                 instance: null,
+                                 invalid_fields: null)
+```
+
+

data/docs/payroll_uk/Reimbursement.md

@@ -0,0 +1,23 @@
+# XeroRuby::PayrollUk::Reimbursement
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reimbursement_id** | **String** | Xero unique identifier for a reimbursement | [optional] 
+**name** | **String** | Name of the reimbursement | 
+**account_id** | **String** | Xero unique identifier for the account used for the reimbursement | 
+**current_record** | **Boolean** | Indicates that whether the reimbursement is active | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollUk'
+
+instance = XeroRuby::PayrollUk::Reimbursement.new(reimbursement_id: null,
+                                 name: null,
+                                 account_id: null,
+                                 current_record: null)
+```
+
+

data/docs/payroll_uk/ReimbursementLine.md

@@ -0,0 +1,21 @@
+# XeroRuby::PayrollUk::ReimbursementLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reimbursement_type_id** | **String** | Xero identifier for payroll reimbursement | [optional] 
+**description** | **String** | Reimbursement line description | [optional] 
+**amount** | **BigDecimal** | Reimbursement amount | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollUk'
+
+instance = XeroRuby::PayrollUk::ReimbursementLine.new(reimbursement_type_id: null,
+                                 description: null,
+                                 amount: null)
+```
+
+

data/docs/payroll_uk/ReimbursementObject.md

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

data/docs/payroll_uk/Reimbursements.md

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

data/docs/payroll_uk/SalaryAndWage.md

@@ -0,0 +1,33 @@
+# XeroRuby::PayrollUk::SalaryAndWage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**salary_and_wages_id** | **String** | Xero unique identifier for a salary and wages record | [optional] 
+**earnings_rate_id** | **String** | Xero unique identifier for an earnings rate | 
+**number_of_units_per_week** | **Float** | The Number of Units per week for the corresponding salary and wages | 
+**rate_per_unit** | **Float** | The rate of each unit for the corresponding salary and wages | [optional] 
+**number_of_units_per_day** | **Float** | The Number of Units per day for the corresponding salary and wages | [optional] 
+**effective_from** | **Date** | The effective date of the corresponding salary and wages | 
+**annual_salary** | **Float** | The annual salary | 
+**status** | **String** | The current status of the corresponding salary and wages | 
+**payment_type** | **String** | The type of the payment of the corresponding salary and wages | 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollUk'
+
+instance = XeroRuby::PayrollUk::SalaryAndWage.new(salary_and_wages_id: null,
+                                 earnings_rate_id: null,
+                                 number_of_units_per_week: null,
+                                 rate_per_unit: null,
+                                 number_of_units_per_day: null,
+                                 effective_from: null,
+                                 annual_salary: null,
+                                 status: null,
+                                 payment_type: null)
+```
+
+

data/docs/payroll_uk/SalaryAndWageObject.md

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

data/docs/payroll_uk/SalaryAndWages.md

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

data/docs/payroll_uk/Settings.md

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

data/docs/payroll_uk/StatutoryDeduction.md

@@ -0,0 +1,25 @@
+# XeroRuby::PayrollUk::StatutoryDeduction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Xero identifier for earnings order | [optional] 
+**name** | **String** | Name of the earnings order | [optional] 
+**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] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollUk'
+
+instance = XeroRuby::PayrollUk::StatutoryDeduction.new(id: null,
+                                 name: null,
+                                 statutory_deduction_category: null,
+                                 liability_account_id: null,
+                                 current_record: null)
+```
+
+

data/docs/payroll_uk/StatutoryDeductionCategory.md

@@ -0,0 +1,16 @@
+# XeroRuby::PayrollUk::StatutoryDeductionCategory
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollUk'
+
+instance = XeroRuby::PayrollUk::StatutoryDeductionCategory.new()
+```
+
+

data/docs/payroll_uk/TaxLine.md

@@ -0,0 +1,27 @@
+# XeroRuby::PayrollUk::TaxLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tax_line_id** | **String** | Xero identifier for payroll tax line | [optional] 
+**description** | **String** | Tax line description | [optional] 
+**is_employer_tax** | **Boolean** | Identifies if the amount is paid for by the employee or employer. True if employer pays the tax | [optional] 
+**amount** | **Float** | The amount of the tax line | [optional] 
+**global_tax_type_id** | **String** | Tax type ID | [optional] 
+**manual_adjustment** | **Boolean** | Identifies if the tax line is a manual adjustment | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollUk'
+
+instance = XeroRuby::PayrollUk::TaxLine.new(tax_line_id: null,
+                                 description: null,
+                                 is_employer_tax: null,
+                                 amount: null,
+                                 global_tax_type_id: null,
+                                 manual_adjustment: null)
+```
+
+

data/docs/payroll_uk/Timesheet.md

@@ -0,0 +1,33 @@
+# XeroRuby::PayrollUk::Timesheet
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timesheet_id** | **String** | The Xero identifier for a Timesheet | [optional] 
+**payroll_calendar_id** | **String** | The Xero identifier for the Payroll Calandar that the Timesheet applies to | 
+**employee_id** | **String** | The Xero identifier for the Employee that the Timesheet is for | 
+**start_date** | **Date** | The Start Date of the Timesheet period (YYYY-MM-DD) | 
+**end_date** | **Date** | The End Date of the Timesheet period (YYYY-MM-DD) | 
+**status** | **String** | Status of the timesheet | [optional] 
+**total_hours** | **Float** | The Total Hours of the Timesheet | [optional] 
+**updated_date_utc** | **DateTime** | The UTC date time that the Timesheet was last updated | [optional] 
+**timesheet_lines** | [**Array<TimesheetLine>**](TimesheetLine.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollUk'
+
+instance = XeroRuby::PayrollUk::Timesheet.new(timesheet_id: null,
+                                 payroll_calendar_id: null,
+                                 employee_id: null,
+                                 start_date: null,
+                                 end_date: null,
+                                 status: null,
+                                 total_hours: null,
+                                 updated_date_utc: null,
+                                 timesheet_lines: null)
+```
+
+