xero-ruby 2.3.0 → 2.3.1

data/docs/payroll_nz/Employee.md

@@ -1,43 +0,0 @@
-# XeroRuby::PayrollNz::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] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollNz'
-
-instance = XeroRuby::PayrollNz::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)
-```
-
-

data/docs/payroll_nz/EmployeeEarningsTemplates.md

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

data/docs/payroll_nz/EmployeeLeave.md

@@ -1,29 +0,0 @@
-# XeroRuby::PayrollNz::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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::EmployeeLeave.new(leave_id: null,
-                                 leave_type_id: null,
-                                 description: null,
-                                 start_date: null,
-                                 end_date: null,
-                                 periods: null,
-                                 updated_date_utc: null)
-```
-
-

data/docs/payroll_nz/EmployeeLeaveBalance.md

@@ -1,23 +0,0 @@
-# XeroRuby::PayrollNz::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** | **BigDecimal** | 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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::EmployeeLeaveBalance.new(name: Holiday,
-                                 leave_type_id: null,
-                                 balance: null,
-                                 type_of_units: hours)
-```
-
-

data/docs/payroll_nz/EmployeeLeaveBalances.md

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

data/docs/payroll_nz/EmployeeLeaveObject.md

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

data/docs/payroll_nz/EmployeeLeaveSetup.md

@@ -1,29 +0,0 @@
-# XeroRuby::PayrollNz::EmployeeLeaveSetup
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**include_holiday_pay** | **Boolean** | Identifier if holiday pay will be included in each payslip | [optional] 
-**holiday_pay_opening_balance** | **BigDecimal** | Initial holiday pay balance. A percentage — usually 8% — of gross earnings since their last work anniversary. | [optional] 
-**annual_leave_opening_balance** | **BigDecimal** | Initial annual leave balance. The balance at their last anniversary, less any leave taken since then and excluding accrued annual leave. | [optional] 
-**negative_annual_leave_balance_paid_amount** | **BigDecimal** | The dollar value of annual leave opening balance if negative. | [optional] 
-**sick_leave_hours_to_accrue_annually** | **BigDecimal** | Number of hours accrued annually for sick leave. Multiply the number of days they're entitled to by the hours worked per day | [optional] 
-**sick_leave_maximum_hours_to_accrue** | **BigDecimal** | Maximum number of hours accrued annually for sick leave. Multiply the maximum days they can accrue by the hours worked per day | [optional] 
-**sick_leave_opening_balance** | **BigDecimal** | Initial sick leave balance. This will be positive unless they've taken sick leave in advance | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollNz'
-
-instance = XeroRuby::PayrollNz::EmployeeLeaveSetup.new(include_holiday_pay: false,
-                                 holiday_pay_opening_balance: 10.5,
-                                 annual_leave_opening_balance: 25.89,
-                                 negative_annual_leave_balance_paid_amount: 10.0,
-                                 sick_leave_hours_to_accrue_annually: 100.5,
-                                 sick_leave_maximum_hours_to_accrue: 200.5,
-                                 sick_leave_opening_balance: 10.5)
-```
-
-

data/docs/payroll_nz/EmployeeLeaveSetupObject.md

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

data/docs/payroll_nz/EmployeeLeaveType.md

@@ -1,35 +0,0 @@
-# XeroRuby::PayrollNz::EmployeeLeaveType
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**leave_type_id** | **String** | The Xero identifier for leave type | [optional] 
-**schedule_of_accrual** | **String** | The schedule of accrual | [optional] 
-**hours_accrued_annually** | **BigDecimal** | The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is \"OnHourWorked\" | [optional] 
-**maximum_to_accrue** | **BigDecimal** | The maximum number of hours that can be accrued for the leave | [optional] 
-**opening_balance** | **BigDecimal** | The initial number of hours assigned when the leave was added to the employee | [optional] 
-**rate_accrued_hourly** | **BigDecimal** | 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] 
-**percentage_of_gross_earnings** | **BigDecimal** | Specific for scheduleOfAccrual having percentage of gross earnings. Identifies how much percentage of gross earnings is accrued per pay period. | [optional] 
-**include_holiday_pay_every_pay** | **Boolean** | Specific to Holiday pay. Flag determining if pay for leave type is added on each pay run. | [optional] 
-**show_annual_leave_in_advance** | **Boolean** | Specific to Annual Leave. Flag to include leave available to take in advance in the balance in the payslip | [optional] 
-**annual_leave_total_amount_paid** | **BigDecimal** | Specific to Annual Leave. Annual leave balance in dollars | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollNz'
-
-instance = XeroRuby::PayrollNz::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,
-                                 percentage_of_gross_earnings: null,
-                                 include_holiday_pay_every_pay: null,
-                                 show_annual_leave_in_advance: null,
-                                 annual_leave_total_amount_paid: null)
-```
-
-

data/docs/payroll_nz/EmployeeLeaveTypeObject.md

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

data/docs/payroll_nz/EmployeeLeaveTypes.md

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

data/docs/payroll_nz/EmployeeLeaves.md

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

data/docs/payroll_nz/EmployeeObject.md

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

data/docs/payroll_nz/EmployeeOpeningBalance.md

@@ -1,23 +0,0 @@
-# XeroRuby::PayrollNz::EmployeeOpeningBalance
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**period_end_date** | **Date** | The opening balance period end date. | [optional] 
-**days_paid** | **Integer** | The paid number of days. | [optional] 
-**unpaid_weeks** | **Integer** | The number of unpaid weeks. | [optional] 
-**gross_earnings** | **BigDecimal** | The gross earnings during the period. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollNz'
-
-instance = XeroRuby::PayrollNz::EmployeeOpeningBalance.new(period_end_date: null,
-                                 days_paid: null,
-                                 unpaid_weeks: null,
-                                 gross_earnings: null)
-```
-
-

data/docs/payroll_nz/EmployeeOpeningBalancesObject.md

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

data/docs/payroll_nz/EmployeePayTemplate.md

@@ -1,19 +0,0 @@
-# XeroRuby::PayrollNz::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::PayrollNz'
-
-instance = XeroRuby::PayrollNz::EmployeePayTemplate.new(employee_id: null,
-                                 earning_templates: null)
-```
-
-

data/docs/payroll_nz/EmployeePayTemplateObject.md

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

data/docs/payroll_nz/EmployeePayTemplates.md

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