xero-ruby 2.3.0 → 2.3.1

data/docs/payroll_au/SuperFundProduct.md

@@ -1,23 +0,0 @@
-# XeroRuby::PayrollAu::SuperFundProduct
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**abn** | **String** | The ABN of the Regulated SuperFund | [optional] 
-**usi** | **String** | The USI of the Regulated SuperFund | [optional] 
-**spin** | **String** | The SPIN of the Regulated SuperFund. This field has been deprecated. New superfunds will not have a SPIN value. The USI field should be used instead of SPIN | [optional] 
-**product_name** | **String** | The name of the Regulated SuperFund | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollAu'
-
-instance = XeroRuby::PayrollAu::SuperFundProduct.new(abn: 839182848805,
-                                 usi: 839182848805001,
-                                 spin: NML0117AU,
-                                 product_name: MLC Navigator Retirement Plan - Superannuation Service (including Series 2) (MLC Superannuation Fund))
-```
-
-

data/docs/payroll_au/SuperFundProducts.md

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

data/docs/payroll_au/SuperFundType.md

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

data/docs/payroll_au/SuperFunds.md

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

data/docs/payroll_au/SuperLine.md

@@ -1,31 +0,0 @@
-# XeroRuby::PayrollAu::SuperLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**super_membership_id** | **String** | Xero super membership ID | [optional] 
-**contribution_type** | [**SuperannuationContributionType**](SuperannuationContributionType.md) |  | [optional] 
-**calculation_type** | [**SuperannuationCalculationType**](SuperannuationCalculationType.md) |  | [optional] 
-**minimum_monthly_earnings** | **BigDecimal** | amount of mimimum earnings | [optional] 
-**expense_account_code** | **String** | expense account code | [optional] 
-**liability_account_code** | **String** | liabilty account code | [optional] 
-**percentage** | **BigDecimal** | percentage for super line | [optional] 
-**amount** | **BigDecimal** | Super membership amount | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollAu'
-
-instance = XeroRuby::PayrollAu::SuperLine.new(super_membership_id: 4333d5cd-53a5-4c31-98e5-a8b4e5676b0b,
-                                 contribution_type: null,
-                                 calculation_type: null,
-                                 minimum_monthly_earnings: 450.0,
-                                 expense_account_code: 478,
-                                 liability_account_code: 826,
-                                 percentage: 9.0,
-                                 amount: 10.0)
-```
-
-

data/docs/payroll_au/SuperMembership.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollAu::SuperMembership
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**super_membership_id** | **String** | Xero unique identifier for Super membership | [optional] 
-**super_fund_id** | **String** | Xero identifier for super fund | 
-**employee_number** | **String** | The memberhsip number assigned to the employee by the super fund. | 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollAu'
-
-instance = XeroRuby::PayrollAu::SuperMembership.new(super_membership_id: 4333d5cd-53a5-4c31-98e5-a8b4e5676b0b,
-                                 super_fund_id: 2187a42b-639a-45cb-9eed-cd4ae488306a,
-                                 employee_number: 1234)
-```
-
-

data/docs/payroll_au/SuperannuationCalculationType.md

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

data/docs/payroll_au/SuperannuationContributionType.md

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

data/docs/payroll_au/SuperannuationLine.md

@@ -1,33 +0,0 @@
-# XeroRuby::PayrollAu::SuperannuationLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**super_membership_id** | **String** | Xero identifier for payroll super fund membership ID. | [optional] 
-**contribution_type** | [**SuperannuationContributionType**](SuperannuationContributionType.md) |  | [optional] 
-**calculation_type** | [**SuperannuationCalculationType**](SuperannuationCalculationType.md) |  | [optional] 
-**minimum_monthly_earnings** | **BigDecimal** | Superannuation minimum monthly earnings. | [optional] 
-**expense_account_code** | **String** | Superannuation expense account code. | [optional] 
-**liability_account_code** | **String** | Superannuation liability account code | [optional] 
-**payment_date_for_this_period** | **Date** | Superannuation payment date for the current period (YYYY-MM-DD) | [optional] 
-**percentage** | **BigDecimal** | Superannuation percentage | [optional] 
-**amount** | **BigDecimal** | Superannuation amount | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollAu'
-
-instance = XeroRuby::PayrollAu::SuperannuationLine.new(super_membership_id: e0eb6747-7c17-4075-b804-989f8d4e5d39,
-                                 contribution_type: null,
-                                 calculation_type: null,
-                                 minimum_monthly_earnings: 100.5,
-                                 expense_account_code: 450,
-                                 liability_account_code: 650,
-                                 payment_date_for_this_period: /Date(322560000000+0000)/,
-                                 percentage: 4.0,
-                                 amount: 10.5)
-```
-
-

data/docs/payroll_au/TFNExemptionType.md

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

data/docs/payroll_au/TaxDeclaration.md

@@ -1,47 +0,0 @@
-# XeroRuby::PayrollAu::TaxDeclaration
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**employee_id** | **String** | Address line 1 for employee home address | [optional] 
-**employment_basis** | [**EmploymentBasis**](EmploymentBasis.md) |  | [optional] 
-**tfn_exemption_type** | [**TFNExemptionType**](TFNExemptionType.md) |  | [optional] 
-**tax_file_number** | **String** | The tax file number e.g 123123123. | [optional] 
-**australian_resident_for_tax_purposes** | **Boolean** | If the employee is Australian resident for tax purposes. e.g true or false | [optional] 
-**residency_status** | [**ResidencyStatus**](ResidencyStatus.md) |  | [optional] 
-**tax_free_threshold_claimed** | **Boolean** | If tax free threshold claimed. e.g true or false | [optional] 
-**tax_offset_estimated_amount** | **Float** | If has tax offset estimated then the tax offset estimated amount. e.g 100 | [optional] 
-**has_help_debt** | **Boolean** | If employee has HECS or HELP debt. e.g true or false | [optional] 
-**has_sfss_debt** | **Boolean** | If employee has financial supplement debt. e.g true or false | [optional] 
-**has_trade_support_loan_debt** | **Boolean** | If employee has trade support loan. e.g true or false | [optional] 
-**upward_variation_tax_withholding_amount** | **Float** | If the employee has requested that additional tax be withheld each pay run. e.g 50 | [optional] 
-**eligible_to_receive_leave_loading** | **Boolean** | If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%). e.g true or false | [optional] 
-**approved_withholding_variation_percentage** | **Float** | If the employee has approved withholding variation. e.g (0 - 100) | [optional] 
-**has_student_startup_loan** | **Boolean** | If the employee is eligible for student startup loan rules | [optional] 
-**updated_date_utc** | **DateTime** | Last modified timestamp | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollAu'
-
-instance = XeroRuby::PayrollAu::TaxDeclaration.new(employee_id: null,
-                                 employment_basis: null,
-                                 tfn_exemption_type: null,
-                                 tax_file_number: 123123123,
-                                 australian_resident_for_tax_purposes: true,
-                                 residency_status: null,
-                                 tax_free_threshold_claimed: false,
-                                 tax_offset_estimated_amount: 100,
-                                 has_help_debt: false,
-                                 has_sfss_debt: false,
-                                 has_trade_support_loan_debt: false,
-                                 upward_variation_tax_withholding_amount: 50,
-                                 eligible_to_receive_leave_loading: false,
-                                 approved_withholding_variation_percentage: 75,
-                                 has_student_startup_loan: true,
-                                 updated_date_utc: /Date(1583967733054+0000)/)
-```
-
-

data/docs/payroll_au/TaxLine.md

@@ -1,27 +0,0 @@
-# XeroRuby::PayrollAu::TaxLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payslip_tax_line_id** | **String** | Xero identifier for payslip tax line ID. | [optional] 
-**amount** | **BigDecimal** | The tax line amount | [optional] 
-**tax_type_name** | **String** | Name of the tax type. | [optional] 
-**description** | **String** | Description of the tax line. | [optional] 
-**manual_tax_type** | [**ManualTaxType**](ManualTaxType.md) |  | [optional] 
-**liability_account** | **String** | The tax line liability account code. For posted pay run you should be able to see liability account code | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollAu'
-
-instance = XeroRuby::PayrollAu::TaxLine.new(payslip_tax_line_id: e0eb6747-7c17-4075-b804-989f8d4e5d39,
-                                 amount: 50.0,
-                                 tax_type_name: Manual Adjustment,
-                                 description: null,
-                                 manual_tax_type: null,
-                                 liability_account: 620)
-```
-
-

data/docs/payroll_au/Timesheet.md

@@ -1,33 +0,0 @@
-# XeroRuby::PayrollAu::Timesheet
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**employee_id** | **String** | The Xero identifier for an employee | 
-**start_date** | **Date** | Period start date (YYYY-MM-DD) | 
-**end_date** | **Date** | Period end date (YYYY-MM-DD) | 
-**status** | [**TimesheetStatus**](TimesheetStatus.md) |  | [optional] 
-**hours** | **BigDecimal** | Timesheet total hours | [optional] 
-**timesheet_id** | **String** | The Xero identifier for a Payroll Timesheet | [optional] 
-**timesheet_lines** | [**Array<TimesheetLine>**](TimesheetLine.md) |  | [optional] 
-**updated_date_utc** | **DateTime** | Last modified timestamp | [optional] 
-**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollAu'
-
-instance = XeroRuby::PayrollAu::Timesheet.new(employee_id: 72a0d0c2-0cf8-4f0b-ade1-33231f47b41b,
-                                 start_date: /Date(322560000000+0000)/,
-                                 end_date: /Date(322560000000+0000)/,
-                                 status: null,
-                                 hours: 31.0,
-                                 timesheet_id: 049765fc-4506-48fb-bf88-3578dec0ec47,
-                                 timesheet_lines: null,
-                                 updated_date_utc: /Date(1583967733054+0000)/,
-                                 validation_errors: null)
-```
-
-

data/docs/payroll_au/TimesheetLine.md

@@ -1,23 +0,0 @@
-# XeroRuby::PayrollAu::TimesheetLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**earnings_rate_id** | **String** | The Xero identifier for an Earnings Rate | [optional] 
-**tracking_item_id** | **String** | The Xero identifier for a Tracking Category. The TrackingOptionID must belong to the TrackingCategory selected as TimesheetCategories under Payroll Settings. | [optional] 
-**number_of_units** | **Array<Float>** | The number of units on a timesheet line | [optional] 
-**updated_date_utc** | **DateTime** | Last modified timestamp | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollAu'
-
-instance = XeroRuby::PayrollAu::TimesheetLine.new(earnings_rate_id: 966c5c77-2ef0-4320-b6a9-6c27b080ecc5,
-                                 tracking_item_id: ae777a87-5ef3-4fa0-a4f0-d10e1f13073a,
-                                 number_of_units: null,
-                                 updated_date_utc: /Date(1583967733054+0000)/)
-```
-
-

data/docs/payroll_au/TimesheetObject.md

@@ -1,17 +0,0 @@
-# XeroRuby::PayrollAu::TimesheetObject
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**timesheet** | [**Timesheet**](Timesheet.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollAu'
-
-instance = XeroRuby::PayrollAu::TimesheetObject.new(timesheet: null)
-```
-
-

data/docs/payroll_au/TimesheetStatus.md

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

data/docs/payroll_au/Timesheets.md

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

data/docs/payroll_au/ValidationError.md

@@ -1,17 +0,0 @@
-# XeroRuby::PayrollAu::ValidationError
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **String** | Validation error message | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollAu'
-
-instance = XeroRuby::PayrollAu::ValidationError.new(message: null)
-```
-
-

data/docs/payroll_nz/Account.md

@@ -1,23 +0,0 @@
-# XeroRuby::PayrollNz::Account
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**account_id** | **String** | The Xero identifier for Settings. | [optional] 
-**type** | **String** | The assigned AccountType | [optional] 
-**code** | **String** | A unique 3 digit number for each Account | [optional] 
-**name** | **String** | Name of the Account. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollNz'
-
-instance = XeroRuby::PayrollNz::Account.new(account_id: null,
-                                 type: null,
-                                 code: null,
-                                 name: null)
-```
-
-