xero-ruby 2.3.1 → 2.4.0

data/docs/files/Folder.md

@@ -0,0 +1,25 @@
+# XeroRuby::Files::Folder
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the folder | [optional] 
+**file_count** | **Integer** | The number of files in the folder | [optional] 
+**email** | **String** | The email address used to email files to the inbox. Only the inbox will have this element. | [optional] 
+**is_inbox** | **Boolean** | to indicate if the folder is the Inbox. The Inbox cannot be renamed or deleted. | [optional] 
+**id** | **String** | Xero unique identifier for a folder  Files | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Files'
+
+instance = XeroRuby::Files::Folder.new(name: assets,
+                                 file_count: 5,
+                                 email: foo@bar.com,
+                                 is_inbox: true,
+                                 id: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c)
+```
+
+

data/docs/files/Folders.md

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

data/docs/files/InlineObject.md

@@ -0,0 +1,23 @@
+# XeroRuby::Files::InlineObject
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | **String** |  | [optional] 
+**name** | **String** | exact name of the file you are uploading | [optional] 
+**filename** | **String** |  | [optional] 
+**mime_type** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Files'
+
+instance = XeroRuby::Files::InlineObject.new(body: null,
+                                 name: null,
+                                 filename: null,
+                                 mime_type: null)
+```
+
+

data/docs/files/ObjectGroup.md

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

data/docs/files/ObjectType.md

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

data/docs/files/User.md

@@ -0,0 +1,25 @@
+# XeroRuby::Files::User
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Xero identifier | 
+**name** | **String** | Key is Name, but returns Email address of user who created the file | [optional] 
+**first_name** | **String** | First name of user | [optional] 
+**last_name** | **String** | Last name of user | [optional] 
+**full_name** | **String** | Last name of user | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Files'
+
+instance = XeroRuby::Files::User.new(id: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c,
+                                 name: john.smith@mail.com,
+                                 first_name: John,
+                                 last_name: Smith,
+                                 full_name: Smith)
+```
+
+

data/docs/payroll_au/APIException.md

@@ -0,0 +1,21 @@
+# XeroRuby::PayrollAu::APIException
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_number** | **Float** | The error number | [optional] 
+**type** | **String** | The type of error | [optional] 
+**message** | **String** | The message describing the error | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::APIException.new(error_number: 16,
+                                 type: QueryParseException,
+                                 message: No property or field 'hi' exists in type 'Employee' (at index 0))
+```
+
+

data/docs/payroll_au/Account.md

@@ -0,0 +1,23 @@
+# XeroRuby::PayrollAu::Account
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | Xero identifier for accounts | [optional] 
+**type** | [**AccountType**](AccountType.md) |  | [optional] 
+**code** | **String** | Customer defined account code | [optional] 
+**name** | **String** | Name of account | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::Account.new(account_id: c56b19ef-75bf-45e8-98a4-e699a96609f7,
+                                 type: null,
+                                 code: 420,
+                                 name: General expenses)
+```
+
+

data/docs/payroll_au/AccountType.md

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

data/docs/payroll_au/AllowanceType.md

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

data/docs/payroll_au/BankAccount.md

@@ -0,0 +1,27 @@
+# XeroRuby::PayrollAu::BankAccount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statement_text** | **String** | The text that will appear on your employee's bank statement when they receive payment | [optional] 
+**account_name** | **String** | The name of the account | [optional] 
+**bsb** | **String** | The BSB number of the account | [optional] 
+**account_number** | **String** | The account number | [optional] 
+**remainder** | **Boolean** | If this account is the Remaining bank account | [optional] 
+**amount** | **BigDecimal** | Fixed amounts (for example, if an employee wants to have $100 of their salary transferred to one account, and the remaining amount to another) | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::BankAccount.new(statement_text: Salary,
+                                 account_name: James Lebron Savings,
+                                 bsb: 122344,
+                                 account_number: 345678,
+                                 remainder: false,
+                                 amount: 200.0)
+```
+
+

data/docs/payroll_au/CalendarType.md

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

data/docs/payroll_au/DeductionLine.md

@@ -0,0 +1,25 @@
+# XeroRuby::PayrollAu::DeductionLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deduction_type_id** | **String** | Xero deduction type identifier | 
+**calculation_type** | [**DeductionTypeCalculationType**](DeductionTypeCalculationType.md) |  | 
+**amount** | **BigDecimal** | Deduction type amount | [optional] 
+**percentage** | **BigDecimal** | The Percentage of the Deduction | [optional] 
+**number_of_units** | **BigDecimal** | Deduction number of units | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::DeductionLine.new(deduction_type_id: 59cd9d04-4521-4cc3-93ac-7841651ff407,
+                                 calculation_type: null,
+                                 amount: 10.0,
+                                 percentage: 10.0,
+                                 number_of_units: 10.0)
+```
+
+

data/docs/payroll_au/DeductionType.md

@@ -0,0 +1,33 @@
+# XeroRuby::PayrollAu::DeductionType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the earnings rate (max length = 100) | [optional] 
+**account_code** | **String** | See Accounts | [optional] 
+**reduces_tax** | **Boolean** | Indicates that this is a pre-tax deduction that will reduce the amount of tax you withhold from an employee. | [optional] 
+**reduces_super** | **Boolean** | Most deductions don’t reduce your superannuation guarantee contribution liability, so typically you will not set any value for this. | [optional] 
+**is_exempt_from_w1** | **Boolean** | Boolean to determine if the deduction type is reportable or exempt from W1 | [optional] 
+**deduction_type_id** | **String** | Xero identifier | [optional] 
+**updated_date_utc** | **DateTime** | Last modified timestamp | [optional] 
+**deduction_category** | **String** |  | [optional] 
+**current_record** | **Boolean** | Is the current record | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::DeductionType.new(name: PTO,
+                                 account_code: 720,
+                                 reduces_tax: false,
+                                 reduces_super: false,
+                                 is_exempt_from_w1: false,
+                                 deduction_type_id: e0eb6747-7c17-4075-b804-989f8d4e5d39,
+                                 updated_date_utc: /Date(1583967733054+0000)/,
+                                 deduction_category: null,
+                                 current_record: true)
+```
+
+

data/docs/payroll_au/DeductionTypeCalculationType.md

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

data/docs/payroll_au/EarningsLine.md

@@ -0,0 +1,33 @@
+# XeroRuby::PayrollAu::EarningsLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**earnings_rate_id** | **String** | Xero unique id for earnings rate | 
+**calculation_type** | [**EarningsRateCalculationType**](EarningsRateCalculationType.md) |  | [optional] 
+**annual_salary** | **BigDecimal** | Annual salary for earnings line | [optional] 
+**number_of_units_per_week** | **BigDecimal** | number of units for earning line | [optional] 
+**rate_per_unit** | **BigDecimal** | Rate per unit of the EarningsLine. | [optional] 
+**normal_number_of_units** | **BigDecimal** | Normal number of units for EarningsLine. Applicable when RateType is \"MULTIPLE\" | [optional] 
+**amount** | **BigDecimal** | Earnings rate amount | [optional] 
+**number_of_units** | **BigDecimal** | Earnings rate number of units. | [optional] 
+**fixed_amount** | **BigDecimal** | Earnings rate amount. Only applicable if the EarningsRate RateType is Fixed | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::EarningsLine.new(earnings_rate_id: 72e962d1-fcac-4083-8a71-742bb3e7ae14,
+                                 calculation_type: null,
+                                 annual_salary: 40000.0,
+                                 number_of_units_per_week: 38.0,
+                                 rate_per_unit: 38.0,
+                                 normal_number_of_units: 38.0,
+                                 amount: 38.0,
+                                 number_of_units: 2.5,
+                                 fixed_amount: 2.5)
+```
+
+

data/docs/payroll_au/EarningsRate.md

@@ -0,0 +1,49 @@
+# XeroRuby::PayrollAu::EarningsRate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the earnings rate (max length = 100) | [optional] 
+**account_code** | **String** | See Accounts | [optional] 
+**type_of_units** | **String** | Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT | [optional] 
+**is_exempt_from_tax** | **Boolean** | Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholding | [optional] 
+**is_exempt_from_super** | **Boolean** | See the ATO website for details of which payments are exempt from SGC | [optional] 
+**is_reportable_as_w1** | **Boolean** | Boolean to determine if the earnings rate is reportable or exempt from W1 | [optional] 
+**earnings_type** | [**EarningsType**](EarningsType.md) |  | [optional] 
+**earnings_rate_id** | **String** | Xero identifier | [optional] 
+**rate_type** | [**RateType**](RateType.md) |  | [optional] 
+**rate_per_unit** | **String** | Default rate per unit (optional). Only applicable if RateType is RATEPERUNIT. | [optional] 
+**multiplier** | **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 MULTIPLE | [optional] 
+**accrue_leave** | **Boolean** | Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE | [optional] 
+**amount** | **BigDecimal** | Optional Amount for FIXEDAMOUNT RateType EarningsRate | [optional] 
+**employment_termination_payment_type** | [**EmploymentTerminationPaymentType**](EmploymentTerminationPaymentType.md) |  | [optional] 
+**updated_date_utc** | **DateTime** | Last modified timestamp | [optional] 
+**current_record** | **Boolean** | Is the current record | [optional] 
+**allowance_type** | [**AllowanceType**](AllowanceType.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::EarningsRate.new(name: PTO,
+                                 account_code: 720,
+                                 type_of_units: Fixed,
+                                 is_exempt_from_tax: false,
+                                 is_exempt_from_super: false,
+                                 is_reportable_as_w1: false,
+                                 earnings_type: null,
+                                 earnings_rate_id: e0eb6747-7c17-4075-b804-989f8d4e5d39,
+                                 rate_type: null,
+                                 rate_per_unit: 10,
+                                 multiplier: 1.5,
+                                 accrue_leave: false,
+                                 amount: 50.3,
+                                 employment_termination_payment_type: null,
+                                 updated_date_utc: /Date(1583967733054+0000)/,
+                                 current_record: true,
+                                 allowance_type: null)
+```
+
+

data/docs/payroll_au/EarningsRateCalculationType.md

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

data/docs/payroll_au/EarningsType.md

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