Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/accounting/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6304,6 +6304,7 @@
<option data-url="https://xeroapi.github.io/xero-ruby/files/index.html" value="Files">Files</option>
<option data-url="https://xeroapi.github.io/xero-ruby/projects/index.html" value="Project">Projects</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_au/index.html" value="PayrollAu">Payroll (AU)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_au_v2/index.html" value="PayrollAuV2">Payroll (AU) V2</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_uk/index.html" value="PayrollUk">Payroll (UK)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_nz/index.html" value="PayrollNz">Payroll (NZ)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/app_store/index.html" value="AppStore">App Store</option>
Expand Down Expand Up @@ -6349,7 +6350,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>12.4.0</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>13.0.0</li>
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
<li data-group="Accounting" data-name="createAccount" class="">
<a href="#api-Accounting-createAccount">createAccount</a>
Expand Down
3 changes: 2 additions & 1 deletion docs/app_store/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1196,6 +1196,7 @@
<option data-url="https://xeroapi.github.io/xero-ruby/files/index.html" value="Files">Files</option>
<option data-url="https://xeroapi.github.io/xero-ruby/projects/index.html" value="Project">Projects</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_au/index.html" value="PayrollAu">Payroll (AU)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_au_v2/index.html" value="PayrollAuV2">Payroll (AU) V2</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_uk/index.html" value="PayrollUk">Payroll (UK)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_nz/index.html" value="PayrollNz">Payroll (NZ)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/app_store/index.html" value="AppStore">App Store</option>
Expand Down Expand Up @@ -1241,7 +1242,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>12.4.0</li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>13.0.0</li>
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
<li data-group="AppStore" data-name="getSubscription" class="">
<a href="#api-AppStore-getSubscription">getSubscription</a>
Expand Down
3 changes: 2 additions & 1 deletion docs/assets/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1374,6 +1374,7 @@
<option data-url="https://xeroapi.github.io/xero-ruby/files/index.html" value="Files">Files</option>
<option data-url="https://xeroapi.github.io/xero-ruby/projects/index.html" value="Project">Projects</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_au/index.html" value="PayrollAu">Payroll (AU)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_au_v2/index.html" value="PayrollAuV2">Payroll (AU) V2</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_uk/index.html" value="PayrollUk">Payroll (UK)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_nz/index.html" value="PayrollNz">Payroll (NZ)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/app_store/index.html" value="AppStore">App Store</option>
Expand Down Expand Up @@ -1419,7 +1420,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>12.4.0</li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>13.0.0</li>
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
<li data-group="Asset" data-name="createAsset" class="">
<a href="#api-Asset-createAsset">createAsset</a>
Expand Down
3 changes: 2 additions & 1 deletion docs/files/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1125,6 +1125,7 @@
<option data-url="https://xeroapi.github.io/xero-ruby/files/index.html" value="Files">Files</option>
<option data-url="https://xeroapi.github.io/xero-ruby/projects/index.html" value="Project">Projects</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_au/index.html" value="PayrollAu">Payroll (AU)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_au_v2/index.html" value="PayrollAuV2">Payroll (AU) V2</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_uk/index.html" value="PayrollUk">Payroll (UK)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_nz/index.html" value="PayrollNz">Payroll (NZ)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/app_store/index.html" value="AppStore">App Store</option>
Expand Down Expand Up @@ -1170,7 +1171,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>12.4.0</li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>13.0.0</li>
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
<li data-group="Files" data-name="createFileAssociation" class="">
<a href="#api-Files-createFileAssociation">createFileAssociation</a>
Expand Down
64 changes: 3 additions & 61 deletions docs/finance/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1504,35 +1504,6 @@
},
"additionalProperties" : false,
"description" : ""
};
defs["HistoryRecordResponse"] = {
"title" : "",
"type" : "object",
"properties" : {
"changes" : {
"type" : "string",
"description" : "The type of change recorded against the document"
},
"dateUTCString" : {
"type" : "string",
"description" : "UTC date that the history record was created"
},
"dateUTC" : {
"type" : "string",
"description" : "UTC date that the history record was created",
"format" : "date-time"
},
"user" : {
"type" : "string",
"description" : "The users first and last name"
},
"details" : {
"type" : "string",
"description" : "Description of the change event or transaction"
}
},
"additionalProperties" : false,
"description" : ""
};
defs["IncomeByContactResponse"] = {
"title" : "",
Expand Down Expand Up @@ -1804,36 +1775,6 @@
},
"additionalProperties" : false,
"description" : ""
};
defs["PracticeResponse"] = {
"title" : "",
"type" : "object",
"properties" : {
"xeroPartnerSince" : {
"type" : "integer",
"description" : "Year of becoming a partner.",
"format" : "int32"
},
"tier" : {
"type" : "string",
"description" : "Customer tier e.g. Silver"
},
"location" : {
"type" : "string",
"description" : "Country of location."
},
"organisationCount" : {
"type" : "integer",
"description" : "Organisation count.",
"format" : "int32"
},
"staffCertified" : {
"type" : "boolean",
"description" : "Staff certified (true/false)."
}
},
"additionalProperties" : false,
"description" : ""
};
defs["PrepaymentResponse"] = {
"title" : "",
Expand Down Expand Up @@ -2351,7 +2292,7 @@
"additionalProperties" : false,
"description" : ""
};

var errs = {};

function routeDocs(event) {
Expand Down Expand Up @@ -2389,6 +2330,7 @@
<option data-url="https://xeroapi.github.io/xero-ruby/files/index.html" value="Files">Files</option>
<option data-url="https://xeroapi.github.io/xero-ruby/projects/index.html" value="Project">Projects</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_au/index.html" value="PayrollAu">Payroll (AU)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_au_v2/index.html" value="PayrollAuV2">Payroll (AU) V2</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_uk/index.html" value="PayrollUk">Payroll (UK)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/payroll_nz/index.html" value="PayrollNz">Payroll (NZ)</option>
<option data-url="https://xeroapi.github.io/xero-ruby/app_store/index.html" value="AppStore">App Store</option>
Expand Down Expand Up @@ -2434,7 +2376,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>12.4.0</li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>13.0.0</li>
<li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
<li data-group="Finance" data-name="getBankStatementAccounting" class="">
<a href="#api-Finance-getBankStatementAccounting">getBankStatementAccounting</a>
Expand Down
2 changes: 2 additions & 0 deletions docs/payroll_au/EarningsRate.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**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]
**is_qualifying_earnings** | **Boolean** | Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings | [optional]
**allowance_contributes_to_annual_leave_rate** | **Boolean** | Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT | [optional]
**allowance_contributes_to_overtime_rate** | **Boolean** | Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT | [optional]
**earnings_type** | [**EarningsType**](EarningsType.md) | | [optional]
Expand All @@ -36,6 +37,7 @@ instance = XeroRuby::PayrollAu::EarningsRate.new(name: PTO,
is_exempt_from_tax: false,
is_exempt_from_super: false,
is_reportable_as_w1: false,
is_qualifying_earnings: true,
allowance_contributes_to_annual_leave_rate: false,
allowance_contributes_to_overtime_rate: false,
earnings_type: null,
Expand Down
2 changes: 0 additions & 2 deletions docs/payroll_au/Employee.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ Name | Type | Description | Notes
**country_of_residence** | [**CountryOfResidence**](CountryOfResidence.md) | | [optional]
**is_stp2_qualified** | **Boolean** | Indicates if the employee has been updated for STP Phase 2 compliance. Doesn&#39;t indicate that the employee is payable. | [optional]
**leave_balances** | [**Array&lt;LeaveBalance&gt;**](LeaveBalance.md) | | [optional]
**leave_lines** | [**Array&lt;LeaveLine&gt;**](LeaveLine.md) | | [optional]
**super_memberships** | [**Array&lt;SuperMembership&gt;**](SuperMembership.md) | | [optional]
**status** | [**EmployeeStatus**](EmployeeStatus.md) | | [optional]
**updated_date_utc** | **DateTime** | Last modified timestamp | [optional]
Expand Down Expand Up @@ -77,7 +76,6 @@ instance = XeroRuby::PayrollAu::Employee.new(first_name: Karen,
country_of_residence: null,
is_stp2_qualified: true,
leave_balances: null,
leave_lines: null,
super_memberships: null,
status: null,
updated_date_utc: /Date(1583967733054+0000)/,
Expand Down
2 changes: 2 additions & 0 deletions docs/payroll_au/LeaveLine.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Name | Type | Description | Notes
**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]
**is_qualifying_earnings** | **Boolean** | Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on superannuation settings | [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]
Expand All @@ -23,6 +24,7 @@ instance = XeroRuby::PayrollAu::LeaveLine.new(leave_type_id: 742998cb-7584-4ecf-
entitlement_final_pay_payout_type: null,
employment_termination_payment_type: null,
include_superannuation_guarantee_contribution: true,
is_qualifying_earnings: true,
number_of_units: 2.5,
annual_number_of_units: 2.5,
full_time_number_of_units_per_period: 2.5)
Expand Down
4 changes: 3 additions & 1 deletion docs/payroll_au/LeaveType.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Name | Type | Description | Notes
**current_record** | **Boolean** | Is the current record | [optional]
**leave_category_code** | [**LeaveCategoryCode**](LeaveCategoryCode.md) | | [optional]
**sgc_exempt** | **Boolean** | Set this to indicate that the leave type is exempt from superannuation guarantee contribution | [optional]
**is_qualifying_earnings** | **Boolean** | Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings | [optional]

## Code Sample

Expand All @@ -31,7 +32,8 @@ instance = XeroRuby::PayrollAu::LeaveType.new(name: PTO,
show_on_payslip: true,
current_record: true,
leave_category_code: null,
sgc_exempt: true)
sgc_exempt: true,
is_qualifying_earnings: true)
```


19 changes: 19 additions & 0 deletions docs/payroll_au/OpeningBalanceLeaveLine.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# XeroRuby::PayrollAu::OpeningBalanceLeaveLine

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**leave_type_id** | **String** | Xero leave type identifier | [optional]
**number_of_units** | **BigDecimal** | Number of units for leave line. | [optional]

## Code Sample

```ruby
require 'XeroRuby::PayrollAu'

instance = XeroRuby::PayrollAu::OpeningBalanceLeaveLine.new(leave_type_id: 742998cb-7584-4ecf-aa88-d694f59c50f9,
number_of_units: 2.5)
```


2 changes: 1 addition & 1 deletion docs/payroll_au/OpeningBalances.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**deduction_lines** | [**Array&lt;DeductionLine&gt;**](DeductionLine.md) | | [optional]
**super_lines** | [**Array&lt;SuperLine&gt;**](SuperLine.md) | | [optional]
**reimbursement_lines** | [**Array&lt;ReimbursementLine&gt;**](ReimbursementLine.md) | | [optional]
**leave_lines** | [**Array&lt;LeaveLine&gt;**](LeaveLine.md) | | [optional]
**leave_lines** | [**Array&lt;OpeningBalanceLeaveLine&gt;**](OpeningBalanceLeaveLine.md) | | [optional]
**paid_leave_earnings_lines** | [**Array&lt;PaidLeaveEarningsLine&gt;**](PaidLeaveEarningsLine.md) | | [optional]

## Code Sample
Expand Down
2 changes: 1 addition & 1 deletion docs/payroll_au/PayrollAuApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ api_instance = xero_client.<api_set>


xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
pay_item = {"EarningsRates":[{"Name":"MyRate","AccountCode":"400","TypeOfUnits":"4.00","IsExemptFromTax":true,"IsExemptFromSuper":true,"IsReportableAsW1":false,"AllowanceContributesToAnnualLeaveRate":false,"AllowanceContributesToOvertimeRate":false,"EarningsType":"ORDINARYTIMEEARNINGS","EarningsRateID":"1fa4e226-b711-46ba-a8a7-4344c9c5fb87","RateType":"MULTIPLE","RatePerUnit":"10.0","Multiplier":1.5,"Amount":5,"EmploymentTerminationPaymentType":"O"}]} # PayItem |
pay_item = {"EarningsRates":[{"Name":"MyRate","AccountCode":"400","TypeOfUnits":"4.00","IsExemptFromTax":false,"IsExemptFromSuper":true,"IsReportableAsW1":false,"IsQualifyingEarnings":true,"AllowanceContributesToAnnualLeaveRate":false,"AllowanceContributesToOvertimeRate":false,"EarningsType":"ORDINARYTIMEEARNINGS","EarningsRateID":"1fa4e226-b711-46ba-a8a7-4344c9c5fb87","RateType":"MULTIPLE","RatePerUnit":"10.0","Multiplier":1.5,"Amount":5,"EmploymentTerminationPaymentType":"O"}]} # PayItem |
opts = {
idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
}
Expand Down
4 changes: 3 additions & 1 deletion docs/payroll_au/TaxDeclaration.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Name | Type | Description | Notes
**has_student_startup_loan** | **Boolean** | If the employee is eligible for student startup loan rules | [optional]
**has_loan_or_student_debt** | **Boolean** | If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL) | [optional]
**updated_date_utc** | **DateTime** | Last modified timestamp | [optional]
**include_leave_loading_in_qualifying_earnings** | **Boolean** | Optional Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations | [optional]

## Code Sample

Expand All @@ -51,7 +52,8 @@ instance = XeroRuby::PayrollAu::TaxDeclaration.new(employee_id: null,
approved_withholding_variation_percentage: 75,
has_student_startup_loan: true,
has_loan_or_student_debt: true,
updated_date_utc: /Date(1583967733054+0000)/)
updated_date_utc: /Date(1583967733054+0000)/,
include_leave_loading_in_qualifying_earnings: true)
```


Loading