xero-ruby 2.2.4 → 2.3.0

data/docs/payroll_nz/Accounts.md

@@ -0,0 +1,17 @@
+# XeroRuby::PayrollNz::Accounts
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accounts** | [**Array<Account>**](Account.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::Accounts.new(accounts: null)
+```
+
+

data/docs/payroll_nz/Address.md

@@ -0,0 +1,27 @@
+# XeroRuby::PayrollNz::Address
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address_line1** | **String** | Address line 1 for employee home address | 
+**address_line2** | **String** | Address line 2 for employee home address | [optional] 
+**city** | **String** | Suburb for employee home address | 
+**suburb** | **String** | Suburb for employee home address | [optional] 
+**post_code** | **String** | PostCode for employee home address | 
+**country_name** | **String** | Country of HomeAddress | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::Address.new(address_line1: 19 Taranaki Street,
+                                 address_line2: Apt 4,
+                                 city: Wellington,
+                                 suburb: Te Aro,
+                                 post_code: 6011,
+                                 country_name: NEW ZEALAND)
+```
+
+

data/docs/payroll_nz/BankAccount.md

@@ -0,0 +1,31 @@
+# XeroRuby::PayrollNz::BankAccount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_name** | **String** | Bank account name (max length = 32) | 
+**account_number** | **String** | Bank account number (digits only; max length = 8) | 
+**sort_code** | **String** | Bank account sort code (6 digits) | 
+**particulars** | **String** | Particulars that appear on the statement. | [optional] 
+**code** | **String** | Code of a transaction that appear on the statement. | [optional] 
+**dollar_amount** | **BigDecimal** | Dollar amount of a transaction. | [optional] 
+**reference** | **String** | Statement Text/reference for a transaction that appear on the statement. | [optional] 
+**calculation_type** | **String** | Calculation type for the transaction can be 'Fixed Amount' or 'Balance' | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::BankAccount.new(account_name: null,
+                                 account_number: null,
+                                 sort_code: null,
+                                 particulars: null,
+                                 code: null,
+                                 dollar_amount: null,
+                                 reference: null,
+                                 calculation_type: null)
+```
+
+

data/docs/payroll_nz/Benefit.md

@@ -0,0 +1,35 @@
+# XeroRuby::PayrollNz::Benefit
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Xero identifier for superannuation | [optional] 
+**name** | **String** | Name of the superannuations | 
+**category** | **String** | Superannuations Category type | 
+**liability_account_id** | **String** | Xero identifier for Liability Account | 
+**expense_account_id** | **String** | Xero identifier for Expense Account | 
+**calculation_type_nz** | **String** | Calculation Type of the superannuation either FixedAmount or PercentageOfTaxableEarnings | [optional] 
+**standard_amount** | **BigDecimal** | Standard amount of the superannuation | [optional] 
+**percentage** | **BigDecimal** | Percentage of Taxable Earnings of the superannuation | [optional] 
+**company_max** | **BigDecimal** | Company Maximum amount of the superannuation | [optional] 
+**current_record** | **Boolean** | Identifier of a record is active or not. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::Benefit.new(id: null,
+                                 name: null,
+                                 category: null,
+                                 liability_account_id: null,
+                                 expense_account_id: null,
+                                 calculation_type_nz: null,
+                                 standard_amount: null,
+                                 percentage: null,
+                                 company_max: null,
+                                 current_record: null)
+```
+
+

data/docs/payroll_nz/Deduction.md

@@ -0,0 +1,27 @@
+# XeroRuby::PayrollNz::Deduction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deduction_id** | **String** | The Xero identifier for Deduction | [optional] 
+**deduction_name** | **String** | Name of the deduction | 
+**deduction_category** | **String** | Deduction Category type | 
+**liability_account_id** | **String** | Xero identifier for Liability Account | 
+**current_record** | **Boolean** | Identifier of a record is active or not. | [optional] 
+**standard_amount** | **BigDecimal** | Standard amount of the deduction. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::Deduction.new(deduction_id: null,
+                                 deduction_name: null,
+                                 deduction_category: null,
+                                 liability_account_id: null,
+                                 current_record: null,
+                                 standard_amount: null)
+```
+
+

data/docs/payroll_nz/DeductionLine.md

@@ -0,0 +1,25 @@
+# XeroRuby::PayrollNz::DeductionLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deduction_type_id** | **String** | Xero identifier for payroll deduction | [optional] 
+**display_name** | **String** | name of earnings rate for display in UI | [optional] 
+**amount** | **BigDecimal** | The amount of the deduction line | [optional] 
+**subject_to_tax** | **Boolean** | Identifies if the deduction is subject to tax | [optional] 
+**percentage** | **BigDecimal** | Deduction rate percentage | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::DeductionLine.new(deduction_type_id: null,
+                                 display_name: null,
+                                 amount: null,
+                                 subject_to_tax: null,
+                                 percentage: null)
+```
+
+

data/docs/payroll_nz/DeductionObject.md

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

data/docs/payroll_nz/Deductions.md

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

data/docs/payroll_nz/EarningsLine.md

@@ -0,0 +1,35 @@
+# XeroRuby::PayrollNz::EarningsLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**earnings_line_id** | **String** | Xero identifier for payroll earnings line | [optional] 
+**earnings_rate_id** | **String** | Xero identifier for payroll earnings rate | [optional] 
+**display_name** | **String** | name of earnings rate for display in UI | [optional] 
+**rate_per_unit** | **BigDecimal** | Rate per unit for earnings line | [optional] 
+**number_of_units** | **BigDecimal** | Earnings number of units | [optional] 
+**fixed_amount** | **BigDecimal** | 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 earnings is taken from the timesheet. False for 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::EarningsLine.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)
+```
+
+

data/docs/payroll_nz/EarningsOrder.md

@@ -0,0 +1,25 @@
+# XeroRuby::PayrollNz::EarningsOrder
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Xero unique identifier for an earning rate | [optional] 
+**name** | **String** | Name of the earning order | 
+**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] [default to true]
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::EarningsOrder.new(id: null,
+                                 name: null,
+                                 statutory_deduction_category: null,
+                                 liability_account_id: null,
+                                 current_record: null)
+```
+
+

data/docs/payroll_nz/EarningsOrderObject.md

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

data/docs/payroll_nz/EarningsOrders.md

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

data/docs/payroll_nz/EarningsRate.md

@@ -0,0 +1,35 @@
+# XeroRuby::PayrollNz::EarningsRate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**earnings_rate_id** | **String** | Xero unique identifier for an earning rate | [optional] 
+**name** | **String** | Name of the earning rate | 
+**earnings_type** | **String** | Indicates how an employee will be paid when taking this type of earning | 
+**rate_type** | **String** | Indicates the type of the earning rate | 
+**type_of_units** | **String** | The type of units used to record earnings | 
+**current_record** | **Boolean** | Indicates whether an earning type is active | [optional] 
+**expense_account_id** | **String** | The account that will be used for the earnings rate | 
+**rate_per_unit** | **BigDecimal** | Default rate per unit (optional). Only applicable if RateType is RatePerUnit | [optional] 
+**multiple_of_ordinary_earnings_rate** | **BigDecimal** | This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate. For example, for time and a half enter 1.5. Only applicable if RateType is MultipleOfOrdinaryEarningsRate | [optional] 
+**fixed_amount** | **BigDecimal** | Optional Fixed Rate Amount. Applicable for FixedAmount Rate | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::EarningsRate.new(earnings_rate_id: null,
+                                 name: null,
+                                 earnings_type: null,
+                                 rate_type: null,
+                                 type_of_units: null,
+                                 current_record: null,
+                                 expense_account_id: null,
+                                 rate_per_unit: null,
+                                 multiple_of_ordinary_earnings_rate: null,
+                                 fixed_amount: null)
+```
+
+

data/docs/payroll_nz/EarningsRateObject.md

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

data/docs/payroll_nz/EarningsRates.md

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

data/docs/payroll_nz/EarningsTemplate.md

@@ -0,0 +1,27 @@
+# XeroRuby::PayrollNz::EarningsTemplate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pay_template_earning_id** | **String** | The Xero identifier for the earnings template | [optional] 
+**rate_per_unit** | **BigDecimal** | The rate per unit | [optional] 
+**number_of_units** | **BigDecimal** | The rate per unit | [optional] 
+**fixed_amount** | **BigDecimal** | The fixed amount per period | [optional] 
+**earnings_rate_id** | **String** | The corresponding earnings rate identifier | [optional] 
+**name** | **String** | The read-only name of the Earning Template. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollNz'
+
+instance = XeroRuby::PayrollNz::EarningsTemplate.new(pay_template_earning_id: null,
+                                 rate_per_unit: null,
+                                 number_of_units: null,
+                                 fixed_amount: null,
+                                 earnings_rate_id: null,
+                                 name: null)
+```
+
+

data/docs/payroll_nz/EarningsTemplateObject.md

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