xero-ruby 2.3.1 → 2.4.0

data/docs/payroll_au/PayrollCalendar.md

@@ -0,0 +1,29 @@
+# XeroRuby::PayrollAu::PayrollCalendar
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the Payroll Calendar | [optional] 
+**calendar_type** | [**CalendarType**](CalendarType.md) |  | [optional] 
+**start_date** | **Date** | The start date of the upcoming pay period. The end date will be calculated based upon this date, and the calendar type selected (YYYY-MM-DD) | [optional] 
+**payment_date** | **Date** | The date on which employees will be paid for the upcoming pay period (YYYY-MM-DD) | [optional] 
+**payroll_calendar_id** | **String** | Xero identifier | [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::PayrollCalendar.new(name: Fortnightly Calendar,
+                                 calendar_type: null,
+                                 start_date: /Date(322560000000+0000)/,
+                                 payment_date: /Date(322560000000+0000)/,
+                                 payroll_calendar_id: e0eb6747-7c17-4075-b804-989f8d4e5d39,
+                                 updated_date_utc: /Date(1583967733054+0000)/,
+                                 validation_errors: null)
+```
+
+

data/docs/payroll_au/PayrollCalendars.md

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

data/docs/payroll_au/Payslip.md

@@ -0,0 +1,53 @@
+# XeroRuby::PayrollAu::Payslip
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**employee_id** | **String** | The Xero identifier for an employee | [optional] 
+**payslip_id** | **String** | Xero identifier for the payslip | [optional] 
+**first_name** | **String** | First name of employee | [optional] 
+**last_name** | **String** | Last name of employee | [optional] 
+**wages** | **BigDecimal** | The Wages for the Payslip | [optional] 
+**deductions** | **BigDecimal** | The Deductions for the Payslip | [optional] 
+**tax** | **BigDecimal** | The Tax for the Payslip | [optional] 
+**_super** | **BigDecimal** | The Super for the Payslip | [optional] 
+**reimbursements** | **BigDecimal** | The Reimbursements for the Payslip | [optional] 
+**net_pay** | **BigDecimal** | The NetPay for the Payslip | [optional] 
+**earnings_lines** | [**Array<EarningsLine>**](EarningsLine.md) |  | [optional] 
+**leave_earnings_lines** | [**Array<LeaveEarningsLine>**](LeaveEarningsLine.md) |  | [optional] 
+**timesheet_earnings_lines** | [**Array<EarningsLine>**](EarningsLine.md) |  | [optional] 
+**deduction_lines** | [**Array<DeductionLine>**](DeductionLine.md) |  | [optional] 
+**leave_accrual_lines** | [**Array<LeaveAccrualLine>**](LeaveAccrualLine.md) |  | [optional] 
+**reimbursement_lines** | [**Array<ReimbursementLine>**](ReimbursementLine.md) |  | [optional] 
+**superannuation_lines** | [**Array<SuperannuationLine>**](SuperannuationLine.md) |  | [optional] 
+**tax_lines** | [**Array<TaxLine>**](TaxLine.md) |  | [optional] 
+**updated_date_utc** | **DateTime** | Last modified timestamp | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::Payslip.new(employee_id: 4729f087-8eec-49c1-8294-4d11a5a0a37c,
+                                 payslip_id: f3c0874d-7cdd-459a-a95c-d90d51decc42,
+                                 first_name: Karen,
+                                 last_name: Jones,
+                                 wages: 1060.5,
+                                 deductions: 0.0,
+                                 tax: 198.0,
+                                 _super: 75.6,
+                                 reimbursements: 0.0,
+                                 net_pay: 862.5,
+                                 earnings_lines: null,
+                                 leave_earnings_lines: null,
+                                 timesheet_earnings_lines: null,
+                                 deduction_lines: null,
+                                 leave_accrual_lines: null,
+                                 reimbursement_lines: null,
+                                 superannuation_lines: null,
+                                 tax_lines: null,
+                                 updated_date_utc: /Date(1583967733054+0000)/)
+```
+
+

data/docs/payroll_au/PayslipLines.md

@@ -0,0 +1,31 @@
+# XeroRuby::PayrollAu::PayslipLines
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**earnings_lines** | [**Array<EarningsLine>**](EarningsLine.md) |  | [optional] 
+**leave_earnings_lines** | [**Array<LeaveEarningsLine>**](LeaveEarningsLine.md) |  | [optional] 
+**timesheet_earnings_lines** | [**Array<EarningsLine>**](EarningsLine.md) |  | [optional] 
+**deduction_lines** | [**Array<DeductionLine>**](DeductionLine.md) |  | [optional] 
+**leave_accrual_lines** | [**Array<LeaveAccrualLine>**](LeaveAccrualLine.md) |  | [optional] 
+**reimbursement_lines** | [**Array<ReimbursementLine>**](ReimbursementLine.md) |  | [optional] 
+**superannuation_lines** | [**Array<SuperannuationLine>**](SuperannuationLine.md) |  | [optional] 
+**tax_lines** | [**Array<TaxLine>**](TaxLine.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::PayslipLines.new(earnings_lines: null,
+                                 leave_earnings_lines: null,
+                                 timesheet_earnings_lines: null,
+                                 deduction_lines: null,
+                                 leave_accrual_lines: null,
+                                 reimbursement_lines: null,
+                                 superannuation_lines: null,
+                                 tax_lines: null)
+```
+
+

data/docs/payroll_au/PayslipObject.md

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

data/docs/payroll_au/PayslipSummary.md

@@ -0,0 +1,39 @@
+# XeroRuby::PayrollAu::PayslipSummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**employee_id** | **String** | The Xero identifier for an employee | [optional] 
+**payslip_id** | **String** | Xero identifier for the payslip | [optional] 
+**first_name** | **String** | First name of employee | [optional] 
+**last_name** | **String** | Last name of employee | [optional] 
+**employee_group** | **String** | Employee group name | [optional] 
+**wages** | **BigDecimal** | The Wages for the Payslip | [optional] 
+**deductions** | **BigDecimal** | The Deductions for the Payslip | [optional] 
+**tax** | **BigDecimal** | The Tax for the Payslip | [optional] 
+**_super** | **BigDecimal** | The Super for the Payslip | [optional] 
+**reimbursements** | **BigDecimal** | The Reimbursements for the Payslip | [optional] 
+**net_pay** | **BigDecimal** | The NetPay for the Payslip | [optional] 
+**updated_date_utc** | **DateTime** | Last modified timestamp | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::PayslipSummary.new(employee_id: 4729f087-8eec-49c1-8294-4d11a5a0a37c,
+                                 payslip_id: f3c0874d-7cdd-459a-a95c-d90d51decc42,
+                                 first_name: Karen,
+                                 last_name: Jones,
+                                 employee_group: Marketing,
+                                 wages: 1060.5,
+                                 deductions: 0.0,
+                                 tax: 198.0,
+                                 _super: 75.6,
+                                 reimbursements: 0.0,
+                                 net_pay: 862.5,
+                                 updated_date_utc: /Date(1583967733054+0000)/)
+```
+
+

data/docs/payroll_au/Payslips.md

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

data/docs/payroll_au/RateType.md

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

data/docs/payroll_au/ReimbursementLine.md

@@ -0,0 +1,23 @@
+# XeroRuby::PayrollAu::ReimbursementLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reimbursement_type_id** | **String** | Xero reimbursement type identifier | [optional] 
+**amount** | **BigDecimal** | Reimbursement type amount | [optional] 
+**description** | **String** | Reimbursement lines description (max length 50) | [optional] 
+**expense_account** | **String** | Reimbursement expense account. For posted pay run you should be able to see expense account code. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::ReimbursementLine.new(reimbursement_type_id: bd246b96-c637-4767-81cf-851ba8fa93c2,
+                                 amount: 10.0,
+                                 description: For the taxi,
+                                 expense_account: 420)
+```
+
+

data/docs/payroll_au/ReimbursementLines.md

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

data/docs/payroll_au/ReimbursementType.md

@@ -0,0 +1,25 @@
+# XeroRuby::PayrollAu::ReimbursementType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the earnings rate (max length = 100) | [optional] 
+**account_code** | **String** | See Accounts | [optional] 
+**reimbursement_type_id** | **String** | Xero identifier | [optional] 
+**updated_date_utc** | **DateTime** | Last modified timestamp | [optional] 
+**current_record** | **Boolean** | Is the current record | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::ReimbursementType.new(name: PTO,
+                                 account_code: 720,
+                                 reimbursement_type_id: e0eb6747-7c17-4075-b804-989f8d4e5d39,
+                                 updated_date_utc: /Date(1583967733054+0000)/,
+                                 current_record: true)
+```
+
+

data/docs/payroll_au/ResidencyStatus.md

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

data/docs/payroll_au/Settings.md

@@ -0,0 +1,21 @@
+# XeroRuby::PayrollAu::Settings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accounts** | [**Array<Account>**](Account.md) | Payroll Account details for SuperExpense, SuperLiabilty, WagesExpense, PAYGLiability & WagesPayable. | [optional] 
+**tracking_categories** | [**SettingsTrackingCategories**](SettingsTrackingCategories.md) |  | [optional] 
+**days_in_payroll_year** | **Integer** | Number of days in the Payroll year | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::Settings.new(accounts: null,
+                                 tracking_categories: null,
+                                 days_in_payroll_year: 365)
+```
+
+

data/docs/payroll_au/SettingsObject.md

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

data/docs/payroll_au/SettingsTrackingCategories.md

@@ -0,0 +1,19 @@
+# XeroRuby::PayrollAu::SettingsTrackingCategories
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**employee_groups** | [**SettingsTrackingCategoriesEmployeeGroups**](SettingsTrackingCategoriesEmployeeGroups.md) |  | [optional] 
+**timesheet_categories** | [**SettingsTrackingCategoriesTimesheetCategories**](SettingsTrackingCategoriesTimesheetCategories.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::SettingsTrackingCategories.new(employee_groups: null,
+                                 timesheet_categories: null)
+```
+
+

data/docs/payroll_au/SettingsTrackingCategoriesEmployeeGroups.md

@@ -0,0 +1,19 @@
+# XeroRuby::PayrollAu::SettingsTrackingCategoriesEmployeeGroups
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tracking_category_id** | **String** | The identifier for the tracking category | [optional] 
+**tracking_category_name** | **String** | Name of the tracking category | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::SettingsTrackingCategoriesEmployeeGroups.new(tracking_category_id: e0eb6747-7c17-4075-b804-989f8d4e5d39,
+                                 tracking_category_name: null)
+```
+
+

data/docs/payroll_au/SettingsTrackingCategoriesTimesheetCategories.md

@@ -0,0 +1,19 @@
+# XeroRuby::PayrollAu::SettingsTrackingCategoriesTimesheetCategories
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tracking_category_id** | **String** | The identifier for the tracking category | [optional] 
+**tracking_category_name** | **String** | Name of the tracking category | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::SettingsTrackingCategoriesTimesheetCategories.new(tracking_category_id: e0eb6747-7c17-4075-b804-989f8d4e5d39,
+                                 tracking_category_name: null)
+```
+
+

data/docs/payroll_au/State.md

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

data/docs/payroll_au/SuperFund.md

@@ -0,0 +1,41 @@
+# XeroRuby::PayrollAu::SuperFund
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**super_fund_id** | **String** | Xero identifier for a super fund | [optional] 
+**type** | [**SuperFundType**](SuperFundType.md) |  | 
+**name** | **String** | Name of the super fund | [optional] 
+**abn** | **String** | ABN of the self managed super fund | [optional] 
+**bsb** | **String** | BSB of the self managed super fund | [optional] 
+**account_number** | **String** | The account number for the self managed super fund. | [optional] 
+**account_name** | **String** | The account name for the self managed super fund. | [optional] 
+**electronic_service_address** | **String** | The electronic service address for the self managed super fund. | [optional] 
+**employer_number** | **String** | Some funds assign a unique number to each employer | [optional] 
+**spin** | **String** | The SPIN of the Regulated SuperFund. This field has been deprecated. It will only be present for legacy superfunds. New superfunds will not have a SPIN value. The USI field should be used instead of SPIN. | [optional] 
+**usi** | **String** | The USI of the Regulated SuperFund | [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::SuperFund.new(super_fund_id: bfac31bd-ea62-4fc8-a5e7-7965d9504b15,
+                                 type: null,
+                                 name: MLC Navigator Retirement Plan - Superannuation Service (including Series 2) (MLC Superannuation Fund),
+                                 abn: 40022701955,
+                                 bsb: 234324,
+                                 account_number: 234234234,
+                                 account_name: Money account,
+                                 electronic_service_address: 12345678,
+                                 employer_number: 324324,
+                                 spin: 4545445454,
+                                 usi: 40022701955001,
+                                 updated_date_utc: /Date(1583967733054+0000)/,
+                                 validation_errors: null)
+```
+
+