xero-ruby 2.2.4 → 2.5.0

data/docs/payroll_au/Employee.md

@@ -0,0 +1,77 @@
+# XeroRuby::PayrollAu::Employee
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** | First name of employee | 
+**last_name** | **String** | Last name of employee | 
+**date_of_birth** | **Date** | Date of birth of the employee (YYYY-MM-DD) | 
+**home_address** | [**HomeAddress**](HomeAddress.md) |  | [optional] 
+**start_date** | **Date** | Start date for an employee (YYYY-MM-DD) | [optional] 
+**title** | **String** | Title of the employee | [optional] 
+**middle_names** | **String** | Middle name(s) of the employee | [optional] 
+**email** | **String** | The email address for the employee | [optional] 
+**gender** | **String** | The employee’s gender. See Employee Gender | [optional] 
+**phone** | **String** | Employee phone number | [optional] 
+**mobile** | **String** | Employee mobile number | [optional] 
+**twitter_user_name** | **String** | Employee’s twitter name | [optional] 
+**is_authorised_to_approve_leave** | **Boolean** | Authorised to approve other employees' leave requests | [optional] 
+**is_authorised_to_approve_timesheets** | **Boolean** | Authorised to approve timesheets | [optional] 
+**job_title** | **String** | JobTitle of the employee | [optional] 
+**classification** | **String** | Employees classification | [optional] 
+**ordinary_earnings_rate_id** | **String** | Xero unique identifier for earnings rate | [optional] 
+**payroll_calendar_id** | **String** | Xero unique identifier for payroll calendar for the employee | [optional] 
+**employee_group_name** | **String** | The Employee Group allows you to report on payroll expenses and liabilities for each group of employees | [optional] 
+**employee_id** | **String** | Xero unique identifier for an Employee | [optional] 
+**termination_date** | **Date** | Employee Termination Date (YYYY-MM-DD) | [optional] 
+**bank_accounts** | [**Array<BankAccount>**](BankAccount.md) |  | [optional] 
+**pay_template** | [**PayTemplate**](PayTemplate.md) |  | [optional] 
+**opening_balances** | [**OpeningBalances**](OpeningBalances.md) |  | [optional] 
+**tax_declaration** | [**TaxDeclaration**](TaxDeclaration.md) |  | [optional] 
+**leave_balances** | [**Array<LeaveBalance>**](LeaveBalance.md) |  | [optional] 
+**leave_lines** | [**Array<LeaveLine>**](LeaveLine.md) |  | [optional] 
+**super_memberships** | [**Array<SuperMembership>**](SuperMembership.md) |  | [optional] 
+**status** | [**EmployeeStatus**](EmployeeStatus.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::Employee.new(first_name: Karen,
+                                 last_name: Jones,
+                                 date_of_birth: /Date(322560000000+0000)/,
+                                 home_address: null,
+                                 start_date: /Date(320284900000+0000)/,
+                                 title: Mrs,
+                                 middle_names: Adena,
+                                 email: developer@me.com,
+                                 gender: F,
+                                 phone: 415-555-1212,
+                                 mobile: 415-234-5678,
+                                 twitter_user_name: xeroapi,
+                                 is_authorised_to_approve_leave: false,
+                                 is_authorised_to_approve_timesheets: true,
+                                 job_title: Manager,
+                                 classification: 99383,
+                                 ordinary_earnings_rate_id: null,
+                                 payroll_calendar_id: 2ee8e5cc-9835-40d5-bb18-09fdb118db9c,
+                                 employee_group_name: marketing,
+                                 employee_id: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c,
+                                 termination_date: /Date(1584662400000+0000)/,
+                                 bank_accounts: null,
+                                 pay_template: null,
+                                 opening_balances: null,
+                                 tax_declaration: null,
+                                 leave_balances: null,
+                                 leave_lines: null,
+                                 super_memberships: null,
+                                 status: null,
+                                 updated_date_utc: /Date(1583967733054+0000)/,
+                                 validation_errors: null)
+```
+
+

data/docs/payroll_au/EmployeeStatus.md

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

data/docs/payroll_au/Employees.md

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

data/docs/payroll_au/EmploymentBasis.md

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

data/docs/payroll_au/EmploymentTerminationPaymentType.md

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

data/docs/payroll_au/EntitlementFinalPayPayoutType.md

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

data/docs/payroll_au/HomeAddress.md

@@ -0,0 +1,27 @@
+# XeroRuby::PayrollAu::HomeAddress
+
+## 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 | [optional] 
+**region** | [**State**](State.md) |  | [optional] 
+**postal_code** | **String** | PostCode for employee home address | [optional] 
+**country** | **String** | Country of HomeAddress | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::HomeAddress.new(address_line1: 123 Main St,
+                                 address_line2: Apt 4,
+                                 city: St. Kilda,
+                                 region: null,
+                                 postal_code: 3182,
+                                 country: AUSTRALIA)
+```
+
+

data/docs/payroll_au/LeaveAccrualLine.md

@@ -0,0 +1,21 @@
+# XeroRuby::PayrollAu::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] 
+**auto_calculate** | **Boolean** | If you want to auto calculate leave. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::LeaveAccrualLine.new(leave_type_id: e0eb6747-7c17-4075-b804-989f8d4e5d39,
+                                 number_of_units: 105.5,
+                                 auto_calculate: true)
+```
+
+

data/docs/payroll_au/LeaveApplication.md

@@ -0,0 +1,35 @@
+# XeroRuby::PayrollAu::LeaveApplication
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**leave_application_id** | **String** | The Xero identifier for Payroll Employee | [optional] 
+**employee_id** | **String** | The Xero identifier for Payroll Employee | [optional] 
+**leave_type_id** | **String** | The Xero identifier for Leave Type | [optional] 
+**title** | **String** | The title of the leave | [optional] 
+**start_date** | **Date** | Start date of the leave (YYYY-MM-DD) | [optional] 
+**end_date** | **Date** | End date of the leave (YYYY-MM-DD) | [optional] 
+**description** | **String** | The Description of the Leave | [optional] 
+**leave_periods** | [**Array<LeavePeriod>**](LeavePeriod.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::LeaveApplication.new(leave_application_id: e0eb6747-7c17-4075-b804-989f8d4e5d39,
+                                 employee_id: fb4ebd68-6568-41eb-96ab-628a0f54b4b8,
+                                 leave_type_id: 742998cb-7584-4ecf-aa88-d694f59c50f9,
+                                 title: Annual Leave,
+                                 start_date: /Date(322560000000+0000)/,
+                                 end_date: /Date(322560000000+0000)/,
+                                 description: My leave,
+                                 leave_periods: null,
+                                 updated_date_utc: /Date(1583967733054+0000)/,
+                                 validation_errors: null)
+```
+
+

data/docs/payroll_au/LeaveApplications.md

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

data/docs/payroll_au/LeaveBalance.md

@@ -0,0 +1,23 @@
+# XeroRuby::PayrollAu::LeaveBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**leave_name** | **String** | The name of the leave type | [optional] 
+**leave_type_id** | **String** | Identifier of the leave type (see PayItems) | [optional] 
+**number_of_units** | **BigDecimal** | The balance of the leave available | [optional] 
+**type_of_units** | **String** | The type of units as specified by the LeaveType (see PayItems) | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::LeaveBalance.new(leave_name: Annual Leave,
+                                 leave_type_id: 544d9292-4329-4512-bfff-a9f15236d776,
+                                 number_of_units: 81.2602,
+                                 type_of_units: Hours)
+```
+
+

data/docs/payroll_au/LeaveEarningsLine.md

@@ -0,0 +1,21 @@
+# XeroRuby::PayrollAu::LeaveEarningsLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**earnings_rate_id** | **String** | Xero identifier | [optional] 
+**rate_per_unit** | **BigDecimal** | Rate per unit of the EarningsLine. | [optional] 
+**number_of_units** | **BigDecimal** | Earnings rate number of units. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::LeaveEarningsLine.new(earnings_rate_id: e0eb6747-7c17-4075-b804-989f8d4e5d39,
+                                 rate_per_unit: 38.0,
+                                 number_of_units: 2.5)
+```
+
+

data/docs/payroll_au/LeaveLine.md

@@ -0,0 +1,31 @@
+# XeroRuby::PayrollAu::LeaveLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**leave_type_id** | **String** | Xero leave type identifier | [optional] 
+**calculation_type** | [**LeaveLineCalculationType**](LeaveLineCalculationType.md) |  | [optional] 
+**entitlement_final_pay_payout_type** | [**EntitlementFinalPayPayoutType**](EntitlementFinalPayPayoutType.md) |  | [optional] 
+**employment_termination_payment_type** | [**EmploymentTerminationPaymentType**](EmploymentTerminationPaymentType.md) |  | [optional] 
+**include_superannuation_guarantee_contribution** | **Boolean** | amount of leave line | [optional] 
+**number_of_units** | **BigDecimal** | Number of units for leave line. | [optional] 
+**annual_number_of_units** | **BigDecimal** | Hours of leave accrued each year | [optional] 
+**full_time_number_of_units_per_period** | **BigDecimal** | Normal ordinary earnings number of units for leave line. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::LeaveLine.new(leave_type_id: 742998cb-7584-4ecf-aa88-d694f59c50f9,
+                                 calculation_type: null,
+                                 entitlement_final_pay_payout_type: null,
+                                 employment_termination_payment_type: null,
+                                 include_superannuation_guarantee_contribution: true,
+                                 number_of_units: 2.5,
+                                 annual_number_of_units: 2.5,
+                                 full_time_number_of_units_per_period: 2.5)
+```
+
+

data/docs/payroll_au/LeaveLineCalculationType.md

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

data/docs/payroll_au/LeaveLines.md

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

data/docs/payroll_au/LeavePeriod.md

@@ -0,0 +1,23 @@
+# XeroRuby::PayrollAu::LeavePeriod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number_of_units** | **BigDecimal** | The Number of Units for the leave | [optional] 
+**pay_period_end_date** | **Date** | The Pay Period End Date (YYYY-MM-DD) | [optional] 
+**pay_period_start_date** | **Date** | The Pay Period Start Date (YYYY-MM-DD) | [optional] 
+**leave_period_status** | [**LeavePeriodStatus**](LeavePeriodStatus.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::LeavePeriod.new(number_of_units: 22.8,
+                                 pay_period_end_date: /Date(322560000000+0000)/,
+                                 pay_period_start_date: /Date(322560000000+0000)/,
+                                 leave_period_status: null)
+```
+
+

data/docs/payroll_au/LeavePeriodStatus.md

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

data/docs/payroll_au/LeaveType.md

@@ -0,0 +1,33 @@
+# XeroRuby::PayrollAu::LeaveType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the earnings rate (max length = 100) | [optional] 
+**type_of_units** | **String** | The type of units by which leave entitlements are normally tracked. These are typically the same as the type of units used for the employee’s ordinary earnings rate | [optional] 
+**leave_type_id** | **String** | Xero identifier | [optional] 
+**normal_entitlement** | **Float** | The number of units the employee is entitled to each year | [optional] 
+**leave_loading_rate** | **Float** | Enter an amount here if your organisation pays an additional percentage on top of ordinary earnings when your employees take leave (typically 17.5%) | [optional] 
+**updated_date_utc** | **DateTime** | Last modified timestamp | [optional] 
+**is_paid_leave** | **Boolean** | Set this to indicate that an employee will be paid when taking this type of leave | [optional] 
+**show_on_payslip** | **Boolean** | Set this if you want a balance for this leave type to be shown on your employee’s payslips | [optional] 
+**current_record** | **Boolean** | Is the current record | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::LeaveType.new(name: PTO,
+                                 type_of_units: Hours,
+                                 leave_type_id: e0eb6747-7c17-4075-b804-989f8d4e5d39,
+                                 normal_entitlement: 152.0,
+                                 leave_loading_rate: 2.0,
+                                 updated_date_utc: /Date(1583967733054+0000)/,
+                                 is_paid_leave: true,
+                                 show_on_payslip: true,
+                                 current_record: true)
+```
+
+