xero-ruby 2.4.0 → 2.4.1

data/docs/payroll_nz/LeavePeriod.md

@@ -1,23 +0,0 @@
-# XeroRuby::PayrollNz::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** | **BigDecimal** | The Number of Units for the leave | [optional] 
-**period_status** | **String** | Period Status | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollNz'
-
-instance = XeroRuby::PayrollNz::LeavePeriod.new(period_start_date: null,
-                                 period_end_date: null,
-                                 number_of_units: null,
-                                 period_status: null)
-```
-
-

data/docs/payroll_nz/LeavePeriods.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollNz::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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::LeavePeriods.new(pagination: null,
-                                 problem: null,
-                                 periods: null)
-```
-
-

data/docs/payroll_nz/LeaveType.md

@@ -1,27 +0,0 @@
-# XeroRuby::PayrollNz::LeaveType
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**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] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollNz'
-
-instance = XeroRuby::PayrollNz::LeaveType.new(leave_type_id: null,
-                                 name: null,
-                                 is_paid_leave: null,
-                                 show_on_payslip: null,
-                                 updated_date_utc: null,
-                                 is_active: null)
-```
-
-

data/docs/payroll_nz/LeaveTypeObject.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollNz::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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::LeaveTypeObject.new(pagination: null,
-                                 problem: null,
-                                 leave_type: null)
-```
-
-

data/docs/payroll_nz/LeaveTypes.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollNz::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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::LeaveTypes.new(pagination: null,
-                                 problem: null,
-                                 leave_types: null)
-```
-
-

data/docs/payroll_nz/Pagination.md

@@ -1,23 +0,0 @@
-# XeroRuby::PayrollNz::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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::Pagination.new(page: 1,
-                                 page_size: 10,
-                                 page_count: 1,
-                                 item_count: 2)
-```
-
-

data/docs/payroll_nz/PayRun.md

@@ -1,39 +0,0 @@
-# XeroRuby::PayrollNz::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** | **BigDecimal** | Total cost of the pay run | [optional] 
-**total_pay** | **BigDecimal** | 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** | [**CalendarType**](CalendarType.md) |  | [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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::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_nz/PayRunCalendar.md

@@ -1,29 +0,0 @@
-# XeroRuby::PayrollNz::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** | [**CalendarType**](CalendarType.md) |  | 
-**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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::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)
-```
-
-

data/docs/payroll_nz/PayRunCalendarObject.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollNz::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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::PayRunCalendarObject.new(pagination: null,
-                                 problem: null,
-                                 pay_run_calendar: null)
-```
-
-

data/docs/payroll_nz/PayRunCalendars.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollNz::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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::PayRunCalendars.new(pagination: null,
-                                 problem: null,
-                                 pay_run_calendars: null)
-```
-
-

data/docs/payroll_nz/PayRunObject.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollNz::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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::PayRunObject.new(pagination: null,
-                                 problem: null,
-                                 pay_run: null)
-```
-
-

data/docs/payroll_nz/PayRuns.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollNz::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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::PayRuns.new(pagination: null,
-                                 problem: null,
-                                 pay_runs: null)
-```
-
-

data/docs/payroll_nz/PaySlip.md

@@ -1,75 +0,0 @@
-# XeroRuby::PayrollNz::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** | **BigDecimal** | Total earnings before any deductions. Same as gross earnings for NZ. | [optional] 
-**gross_earnings** | **BigDecimal** | Total earnings before any deductions. Same as total earnings for NZ. | [optional] 
-**total_pay** | **BigDecimal** | The employee net pay | [optional] 
-**total_employer_taxes** | **BigDecimal** | The employer's tax obligation | [optional] 
-**total_employee_taxes** | **BigDecimal** | The part of an employee's earnings that is deducted for tax purposes | [optional] 
-**total_deductions** | **BigDecimal** | Total amount subtracted from an employee's earnings to reach total pay | [optional] 
-**total_reimbursements** | **BigDecimal** | 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_statutory_deductions** | **BigDecimal** | Total amounts required by law to subtract from the employee's earnings | [optional] 
-**total_superannuation** | **BigDecimal** | 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] 
-**superannuation_lines** | [**Array<SuperannuationLine>**](SuperannuationLine.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] 
-**statutory_deduction_lines** | [**Array<StatutoryDeductionLine>**](StatutoryDeductionLine.md) |  | [optional] 
-**tax_settings** | [**TaxSettings**](TaxSettings.md) |  | [optional] 
-**gross_earnings_history** | [**GrossEarningsHistory**](GrossEarningsHistory.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollNz'
-
-instance = XeroRuby::PayrollNz::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_statutory_deductions: null,
-                                 total_superannuation: 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,
-                                 superannuation_lines: null,
-                                 payment_lines: null,
-                                 employee_tax_lines: null,
-                                 employer_tax_lines: null,
-                                 statutory_deduction_lines: null,
-                                 tax_settings: null,
-                                 gross_earnings_history: null)
-```
-
-

data/docs/payroll_nz/PaySlipObject.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollNz::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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::PaySlipObject.new(pagination: null,
-                                 problem: null,
-                                 pay_slip: null)
-```
-
-

data/docs/payroll_nz/PaySlips.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollNz::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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::PaySlips.new(pagination: null,
-                                 problem: null,
-                                 pay_slips: null)
-```
-
-

data/docs/payroll_nz/PaymentLine.md

@@ -1,25 +0,0 @@
-# XeroRuby::PayrollNz::PaymentLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payment_line_id** | **String** | Xero identifier for payroll payment line | [optional] 
-**amount** | **BigDecimal** | 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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::PaymentLine.new(payment_line_id: null,
-                                 amount: null,
-                                 account_number: null,
-                                 sort_code: null,
-                                 account_name: null)
-```
-
-