xero-ruby 2.2.2 → 2.4.0

data/docs/payroll_nz/EmployeePayTemplates.md

@@ -0,0 +1,21 @@
+# 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)
+```
+
+

data/docs/payroll_nz/EmployeeStatutoryLeaveBalance.md

@@ -0,0 +1,21 @@
+# XeroRuby::PayrollNz::EmployeeStatutoryLeaveBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**leave_type** | **String** | The type of statutory leave | [optional] 
+**balance_remaining** | **BigDecimal** | 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::PayrollNz'
+
+instance = XeroRuby::PayrollNz::EmployeeStatutoryLeaveBalance.new(leave_type: null,
+                                 balance_remaining: null,
+                                 units: null)
+```
+
+

data/docs/payroll_nz/EmployeeStatutoryLeaveBalanceObject.md

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

data/docs/payroll_nz/EmployeeStatutoryLeaveSummary.md

@@ -0,0 +1,29 @@
+# XeroRuby::PayrollNz::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::PayrollNz'
+
+instance = XeroRuby::PayrollNz::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_nz/EmployeeStatutoryLeavesSummaries.md

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

data/docs/payroll_nz/EmployeeStatutorySickLeave.md

@@ -0,0 +1,47 @@
+# XeroRuby::PayrollNz::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** | **BigDecimal** | The amount of requested time (in weeks) | [optional] 
+**entitlement_weeks_qualified** | **BigDecimal** | 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** | **BigDecimal** | 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::PayrollNz'
+
+instance = XeroRuby::PayrollNz::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)
+```
+
+

data/docs/payroll_nz/EmployeeStatutorySickLeaveObject.md

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

data/docs/payroll_nz/EmployeeStatutorySickLeaves.md

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

data/docs/payroll_nz/EmployeeTax.md

@@ -0,0 +1,47 @@
+# XeroRuby::PayrollNz::EmployeeTax
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ird_number** | **String** | The IRD Number. | [optional] 
+**tax_code** | [**TaxCode**](TaxCode.md) |  | [optional] 
+**special_tax_rate_percentage** | **BigDecimal** | Special tax rate percentage. | [optional] 
+**has_special_student_loan_rate** | **Boolean** | Does the employee has a special student loan rate? | [optional] 
+**special_student_loan_rate_percentage** | **BigDecimal** | The employee student loan rate percentage. | [optional] 
+**is_eligible_for_kiwi_saver** | **Boolean** | The employee eligibility for KiwiSaver. | [optional] 
+**esct_rate_percentage** | **BigDecimal** | Employer superannuation contribution tax rate. | [optional] 
+**kiwi_saver_contributions** | **String** | Contribution Option which can be 'MakeContributions' 'OptOut', 'OnAContributionsHoliday', 'OnASavingsSuspension', 'NotCurrentlyAKiwiSaverMember' for employees without a KiwiSaver membership | [optional] 
+**kiwi_saver_employee_contribution_rate_percentage** | **BigDecimal** | Employee Contribution percentage. | [optional] 
+**kiwi_saver_employer_contribution_rate_percentage** | **BigDecimal** | Employer Contribution percentage. | [optional] 
+**kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage** | **BigDecimal** | Employer Contribution through Salary Sacrifice percentage. | [optional] 
+**kiwi_saver_opt_out_date** | **Date** | Opt Out Date. | [optional] 
+**kiwi_saver_contribution_holiday_end_date** | **Date** | Contribution holiday expiry date or end date. | [optional] 
+**has_student_loan_balance** | **Boolean** | Does the employee have a remaining student loan balance? Set a remaining balance if you have received a letter from IR. | [optional] 
+**student_loan_balance** | **BigDecimal** | The employee's student loan balance shown on the letter from IR. | [optional] 
+**student_loan_as_at** | **Date** | The date of the letter from IR. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::EmployeeTax.new(ird_number: 111111111,
+                                 tax_code: null,
+                                 special_tax_rate_percentage: 17.5,
+                                 has_special_student_loan_rate: true,
+                                 special_student_loan_rate_percentage: 2.0,
+                                 is_eligible_for_kiwi_saver: true,
+                                 esct_rate_percentage: 1.0,
+                                 kiwi_saver_contributions: MakeContributions,
+                                 kiwi_saver_employee_contribution_rate_percentage: 4.0,
+                                 kiwi_saver_employer_contribution_rate_percentage: 10.0,
+                                 kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage: 2.0,
+                                 kiwi_saver_opt_out_date: null,
+                                 kiwi_saver_contribution_holiday_end_date: null,
+                                 has_student_loan_balance: false,
+                                 student_loan_balance: 30.0,
+                                 student_loan_as_at: null)
+```
+
+

data/docs/payroll_nz/EmployeeTaxObject.md

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

data/docs/payroll_nz/Employees.md

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

data/docs/payroll_nz/Employment.md

@@ -0,0 +1,21 @@
+# XeroRuby::PayrollNz::Employment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payroll_calendar_id** | **String** | Xero unique identifier for the payroll calendar of the employee | [optional] 
+**pay_run_calendar_id** | **String** | Xero unique identifier for the payrun calendar for the employee (Deprecated in version 1.1.6) | [optional] 
+**start_date** | **Date** | Start date of the employment (YYYY-MM-DD) | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::Employment.new(payroll_calendar_id: null,
+                                 pay_run_calendar_id: null,
+                                 start_date: null)
+```
+
+

data/docs/payroll_nz/EmploymentObject.md

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

data/docs/payroll_nz/GrossEarningsHistory.md

@@ -0,0 +1,19 @@
+# XeroRuby::PayrollNz::GrossEarningsHistory
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**days_paid** | **Integer** | Number of days the employee worked in the pay period (0 - 365) | [optional] 
+**unpaid_weeks** | **Integer** | Number of full weeks the employee didn't work in the pay period (0 - 52) | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::GrossEarningsHistory.new(days_paid: null,
+                                 unpaid_weeks: null)
+```
+
+

data/docs/payroll_nz/InvalidField.md

@@ -0,0 +1,19 @@
+# XeroRuby::PayrollNz::InvalidField
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the field that caused the error | [optional] 
+**reason** | **String** | The reason the error occurred | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::InvalidField.new(name: DateOfBirth,
+                                 reason: The Date of Birth is required.)
+```
+
+

data/docs/payroll_nz/LeaveAccrualLine.md

@@ -0,0 +1,19 @@
+# XeroRuby::PayrollNz::LeaveAccrualLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**leave_type_id** | **String** | Xero identifier for the Leave type | [optional] 
+**number_of_units** | **BigDecimal** | Leave accrual number of units | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::LeaveAccrualLine.new(leave_type_id: null,
+                                 number_of_units: null)
+```
+
+

data/docs/payroll_nz/LeaveEarningsLine.md

@@ -0,0 +1,35 @@
+# XeroRuby::PayrollNz::LeaveEarningsLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**earnings_line_id** | **String** | Xero identifier for payroll earnings line | [optional] 
+**earnings_rate_id** | **String** | Xero identifier for payroll leave earnings rate | [optional] 
+**display_name** | **String** | name of earnings rate for display in UI | [optional] 
+**rate_per_unit** | **BigDecimal** | Rate per unit for leave earnings line | [optional] 
+**number_of_units** | **BigDecimal** | Leave earnings number of units | [optional] 
+**fixed_amount** | **BigDecimal** | Leave earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed | [optional] 
+**amount** | **BigDecimal** | The amount of the earnings line. | [optional] 
+**is_linked_to_timesheet** | **Boolean** | Identifies if the leave earnings is taken from the timesheet. False for leave earnings line | [optional] 
+**is_average_daily_pay_rate** | **Boolean** | Identifies if the earnings is using an average daily pay rate | [optional] 
+**is_system_generated** | **Boolean** | Flag to indentify whether the earnings line is system generated or not. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::LeaveEarningsLine.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,
+                                 is_system_generated: null)
+```
+
+