xero-ruby 2.3.1 → 2.4.0

data/docs/payroll_nz/Problem.md

@@ -0,0 +1,27 @@
+# XeroRuby::PayrollNz::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::PayrollNz'
+
+instance = XeroRuby::PayrollNz::Problem.new(type: application/problem+json,
+                                 title: BadRequest,
+                                 status: 400,
+                                 detail: Validation error occurred.,
+                                 instance: null,
+                                 invalid_fields: null)
+```
+
+

data/docs/payroll_nz/Reimbursement.md

@@ -0,0 +1,33 @@
+# XeroRuby::PayrollNz::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] 
+**reimbursement_category** | **String** | See Reimbursement Categories | [optional] 
+**calculation_type** | **String** | See Calculation Types | [optional] 
+**standard_amount** | **String** | Optional Fixed Rate Amount. Applicable when calculation type is Fixed Amount | [optional] 
+**standard_type_of_units** | **String** | Optional Type Of Units. Applicable when calculation type is Rate Per Unit | [optional] 
+**standard_rate_per_unit** | **BigDecimal** | Optional Rate Per Unit. Applicable when calculation type is Rate Per Unit | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::Reimbursement.new(reimbursement_id: null,
+                                 name: null,
+                                 account_id: null,
+                                 current_record: null,
+                                 reimbursement_category: null,
+                                 calculation_type: null,
+                                 standard_amount: null,
+                                 standard_type_of_units: null,
+                                 standard_rate_per_unit: null)
+```
+
+

data/docs/payroll_nz/ReimbursementLine.md

@@ -0,0 +1,25 @@
+# XeroRuby::PayrollNz::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] 
+**rate_per_unit** | **BigDecimal** | Rate per unit for leave earnings line | [optional] 
+**number_of_units** | **BigDecimal** | Leave earnings number of units | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::ReimbursementLine.new(reimbursement_type_id: null,
+                                 description: null,
+                                 amount: null,
+                                 rate_per_unit: null,
+                                 number_of_units: null)
+```
+
+

data/docs/payroll_nz/ReimbursementObject.md

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

data/docs/payroll_nz/Reimbursements.md

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

data/docs/payroll_nz/SalaryAndWage.md

@@ -0,0 +1,35 @@
+# XeroRuby::PayrollNz::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** | **BigDecimal** | The Number of Units per week for the corresponding salary and wages | 
+**rate_per_unit** | **BigDecimal** | The rate of each unit for the corresponding salary and wages | [optional] 
+**number_of_units_per_day** | **BigDecimal** | The Number of Units per day for the corresponding salary and wages | 
+**days_per_week** | **Integer** | The days per week for the salary. | [optional] 
+**effective_from** | **Date** | The effective date of the corresponding salary and wages | 
+**annual_salary** | **BigDecimal** | 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::PayrollNz'
+
+instance = XeroRuby::PayrollNz::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,
+                                 days_per_week: null,
+                                 effective_from: null,
+                                 annual_salary: null,
+                                 status: null,
+                                 payment_type: null)
+```
+
+

data/docs/payroll_nz/SalaryAndWageObject.md

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

data/docs/payroll_nz/SalaryAndWages.md

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

data/docs/payroll_nz/Settings.md

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

data/docs/payroll_nz/StatutoryDeduction.md

@@ -0,0 +1,25 @@
+# XeroRuby::PayrollNz::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::PayrollNz'
+
+instance = XeroRuby::PayrollNz::StatutoryDeduction.new(id: null,
+                                 name: null,
+                                 statutory_deduction_category: null,
+                                 liability_account_id: null,
+                                 current_record: null)
+```
+
+

data/docs/payroll_nz/StatutoryDeductionCategory.md

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

data/docs/payroll_nz/StatutoryDeductionLine.md

@@ -0,0 +1,23 @@
+# XeroRuby::PayrollNz::StatutoryDeductionLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statutory_deduction_type_id** | **String** | Xero identifier for payroll statutory deduction type | [optional] 
+**amount** | **BigDecimal** | The amount of the statutory deduction line | [optional] 
+**fixed_amount** | **BigDecimal** | Fixed Amount | [optional] 
+**manual_adjustment** | **Boolean** | Identifies if the tax line is a manual adjustment | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::StatutoryDeductionLine.new(statutory_deduction_type_id: null,
+                                 amount: null,
+                                 fixed_amount: null,
+                                 manual_adjustment: null)
+```
+
+

data/docs/payroll_nz/StatutoryDeductionObject.md

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

data/docs/payroll_nz/StatutoryDeductions.md

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

data/docs/payroll_nz/SuperannuationLine.md

@@ -0,0 +1,27 @@
+# XeroRuby::PayrollNz::SuperannuationLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**superannuation_type_id** | **String** | Xero identifier for payroll superannucation type | [optional] 
+**display_name** | **String** | Benefit display name | [optional] 
+**amount** | **BigDecimal** | The amount of the superannuation line | [optional] 
+**fixed_amount** | **BigDecimal** | Superannuation fixed amount | [optional] 
+**percentage** | **BigDecimal** | Superannuation rate percentage | [optional] 
+**manual_adjustment** | **Boolean** | manual adjustment made | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::SuperannuationLine.new(superannuation_type_id: null,
+                                 display_name: null,
+                                 amount: null,
+                                 fixed_amount: null,
+                                 percentage: null,
+                                 manual_adjustment: null)
+```
+
+

data/docs/payroll_nz/SuperannuationObject.md

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

data/docs/payroll_nz/Superannuations.md

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

data/docs/payroll_nz/TaxCode.md

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

data/docs/payroll_nz/TaxLine.md

@@ -0,0 +1,25 @@
+# XeroRuby::PayrollNz::TaxLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tax_line_id** | **String** | Xero identifier for payroll tax line | [optional] 
+**description** | **String** | Tax line description | [optional] 
+**amount** | **BigDecimal** | 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::PayrollNz'
+
+instance = XeroRuby::PayrollNz::TaxLine.new(tax_line_id: null,
+                                 description: null,
+                                 amount: null,
+                                 global_tax_type_id: null,
+                                 manual_adjustment: null)
+```
+
+