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
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
xero-ruby (18.2.0)
xero-ruby (18.3.0)
faraday (>= 2.0, < 3.0)
json (~> 2.1, >= 2.1.0)
json-jwt (~> 1.16, >= 1.16.3)
Expand Down
2 changes: 2 additions & 0 deletions docs/accounting/Account.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Name | Type | Description | Notes
**reporting_code_name** | **String** | Shown if set | [optional]
**has_attachments** | **Boolean** | boolean to indicate if an account has an attachment (read only) | [optional] [default to false]
**updated_date_utc** | **DateTime** | Last modified date UTC format | [optional]
**created_date_utc** | **DateTime** | Created date UTC format. Only returned by GET Accounts and GET Accounts/{AccountID}, not on POST or PUT responses | [optional]
**add_to_watchlist** | **Boolean** | Boolean – describes whether the account is shown in the watchlist widget on the dashboard | [optional]
**validation_errors** | [**Array&lt;ValidationError&gt;**](ValidationError.md) | Displays array of validation error messages from the API | [optional]

Expand All @@ -48,6 +49,7 @@ instance = XeroRuby::Accounting::Account.new(code: 4400,
reporting_code_name: null,
has_attachments: false,
updated_date_utc: /Date(1573755038314)/,
created_date_utc: /Date(1573755038314)/,
add_to_watchlist: null,
validation_errors: null)
```
Expand Down
9 changes: 8 additions & 1 deletion docs/accounting/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -954,6 +954,13 @@
"example" : "/Date(1573755038314)/",
"x-is-msdate-time" : true
},
"CreatedDateUTC" : {
"type" : "string",
"description" : "Created date UTC format. Only returned by GET Accounts and GET Accounts/{AccountID}, not on POST or PUT responses",
"readOnly" : true,
"example" : "/Date(1573755038314)/",
"x-is-msdate-time" : true
},
"AddToWatchlist" : {
"type" : "boolean",
"description" : "Boolean – describes whether the account is shown in the watchlist widget on the dashboard"
Expand Down Expand Up @@ -6514,7 +6521,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>18.2.0</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>18.3.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
2 changes: 1 addition & 1 deletion docs/app_store/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1242,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>18.2.0</li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>18.3.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
2 changes: 1 addition & 1 deletion docs/assets/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1420,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>18.2.0</li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>18.3.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
2 changes: 1 addition & 1 deletion docs/files/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1181,7 +1181,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>18.2.0</li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>18.3.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
2 changes: 1 addition & 1 deletion docs/finance/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2376,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>18.2.0</li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>18.3.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: 1 addition & 1 deletion docs/payroll_au/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3450,7 +3450,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>18.2.0</li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>18.3.0</li>
<li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
<li data-group="PayrollAu" data-name="approveLeaveApplication" class="">
<a href="#api-PayrollAu-approveLeaveApplication">approveLeaveApplication</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/payroll_au_v2/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1160,7 +1160,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="PayrollAuV2"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="PayrollAuV2"><strong>VSN: </strong>18.2.0</li>
<li class="nav-header" data-group="PayrollAuV2"><strong>VSN: </strong>18.3.0</li>
<li class="nav-header" data-group="PayrollAuV2"><a href="#api-PayrollAuV2">Methods</a></li>
<li data-group="PayrollAuV2" data-name="approveTimesheet" class="">
<a href="#api-PayrollAuV2-approveTimesheet">approveTimesheet</a>
Expand Down
10 changes: 7 additions & 3 deletions docs/payroll_nz/EmployeeTax.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ Name | Type | Description | Notes
**ird_number** | **String** | The IRD Number. | [optional]
**tax_code** | [**TaxCode**](TaxCode.md) | | [optional]
**special_tax_rate_percentage** | **BigDecimal** | Special tax rate percentage. | [optional]
**has_special_student_loan_rate** | **Boolean** | Does the employee has a special student loan rate? | [optional]
**has_special_student_loan_rate** | **Boolean** | Does the employee have a special student loan rate? | [optional]
**special_student_loan_rate_percentage** | **BigDecimal** | The employee student loan rate percentage. | [optional]
**is_eligible_for_kiwi_saver** | **Boolean** | The employee eligibility for KiwiSaver. | [optional]
**is_eligible_for_kiwi_saver** | **Boolean** | The employee eligibility for KiwiSaver. Deprecated, replaced by kiwiSaverStatus. Omit this field from POST requests. | [optional]
**esct_rate_percentage** | **BigDecimal** | Employer superannuation contribution tax rate. | [optional]
**kiwi_saver_contributions** | **String** | Contribution Option which can be &#39;MakeContributions&#39; &#39;OptOut&#39;, &#39;OnAContributionsHoliday&#39;, &#39;OnASavingsSuspension&#39;, &#39;NotCurrentlyAKiwiSaverMember&#39; for employees without a KiwiSaver membership | [optional]
**kiwi_saver_status** | **String** | KiwiSaver eligibility. Required in POST requests for all tax codes except WT and NSW. | [optional]
**kiwi_saver_employee_contribution_rate_percentage** | **BigDecimal** | Employee Contribution percentage. | [optional]
**kiwi_saver_employer_contribution_rate_percentage** | **BigDecimal** | Employer Contribution percentage. | [optional]
**kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage** | **BigDecimal** | Employer Contribution through Salary Sacrifice percentage. | [optional]
Expand All @@ -20,6 +21,7 @@ Name | Type | Description | Notes
**has_student_loan_balance** | **Boolean** | Does the employee have a remaining student loan balance? Set a remaining balance if you have received a letter from IR. | [optional]
**student_loan_balance** | **BigDecimal** | The employee&#39;s student loan balance shown on the letter from IR. | [optional]
**student_loan_as_at** | **Date** | The date of the letter from IR. | [optional]
**registered_for_gst** | **Boolean** | Is the employee registered for GST? Required in POST requests when taxCode is WT. | [optional]

## Code Sample

Expand All @@ -34,14 +36,16 @@ instance = XeroRuby::PayrollNz::EmployeeTax.new(ird_number: 111111111,
is_eligible_for_kiwi_saver: true,
esct_rate_percentage: 1.0,
kiwi_saver_contributions: MakeContributions,
kiwi_saver_status: ActiveKiwiSaverMember,
kiwi_saver_employee_contribution_rate_percentage: 4.0,
kiwi_saver_employer_contribution_rate_percentage: 10.0,
kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage: 2.0,
kiwi_saver_opt_out_date: null,
kiwi_saver_contribution_holiday_end_date: null,
has_student_loan_balance: false,
student_loan_balance: 30.0,
student_loan_as_at: null)
student_loan_as_at: null,
registered_for_gst: true)
```


4 changes: 3 additions & 1 deletion docs/payroll_nz/PayrollNzApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4684,6 +4684,8 @@ Name | Type | Description | Notes

Updates the tax records for a specific employee

Replaces the entire EmployeeTax record. This is not a partial update. Any field omitted from the request is treated as null and overwrites the stored value. To change individual fields, GET the current record, merge your changes, remove deprecated fields such as isEligibleForKiwiSaver, and POST the complete object.

### Example

```ruby
Expand Down Expand Up @@ -4711,7 +4713,7 @@ api_instance = xero_client.<api_set>

xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
employee_tax = {"irdNumber":"111111111","taxCode":"M","esctRatePercentage":17.5,"isEligibleForKiwiSaver":true,"hasSpecialStudentLoanRate":false,"specialStudentLoanRatePercentage":null,"specialTaxRatePercentage":null,"kiwiSaverContributions":"MakeContributions","kiwiSaverOptOutDate":null,"kiwiSaverContributionHolidayEndDate":null,"kiwiSaverEmployeeContributionRatePercentage":3,"kiwiSaverEmployerContributionRatePercentage":3,"kiwiSaverEmployerSalarySacrificeContributionRatePercentage":0,"hasStudentLoanBalance":false,"studentLoanBalance":null,"studentLoanAsAt":null} # EmployeeTax |
employee_tax = {"irdNumber":"111111111","taxCode":"M","esctRatePercentage":17.5,"hasSpecialStudentLoanRate":false,"specialStudentLoanRatePercentage":null,"specialTaxRatePercentage":null,"kiwiSaverContributions":"MakeContributions","kiwiSaverStatus":"ActiveKiwiSaverMember","kiwiSaverOptOutDate":null,"kiwiSaverContributionHolidayEndDate":null,"kiwiSaverEmployeeContributionRatePercentage":3,"kiwiSaverEmployerContributionRatePercentage":3,"kiwiSaverEmployerSalarySacrificeContributionRatePercentage":0,"hasStudentLoanBalance":false,"studentLoanBalance":null,"studentLoanAsAt":null,"registeredForGST":null} # EmployeeTax |
opts = {
idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
}
Expand Down
29 changes: 21 additions & 8 deletions docs/payroll_nz/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2234,7 +2234,7 @@
},
"hasSpecialStudentLoanRate" : {
"type" : "boolean",
"description" : "Does the employee has a special student loan rate?",
"description" : "Does the employee have a special student loan rate?",
"example" : true
},
"specialStudentLoanRatePercentage" : {
Expand All @@ -2246,8 +2246,9 @@
},
"isEligibleForKiwiSaver" : {
"type" : "boolean",
"description" : "The employee eligibility for KiwiSaver.",
"example" : true
"description" : "The employee eligibility for KiwiSaver. Deprecated, replaced by kiwiSaverStatus. Omit this field from POST requests.",
"example" : true,
"deprecated" : true
},
"esctRatePercentage" : {
"type" : "number",
Expand All @@ -2262,6 +2263,12 @@
"example" : "MakeContributions",
"enum" : [ "MakeContributions", "OptOut", "OnAContributionsHoliday", "OnASavingsSuspension", "NotCurrentlyAKiwiSaverMember" ]
},
"kiwiSaverStatus" : {
"type" : "string",
"description" : "KiwiSaver eligibility. Required in POST requests for all tax codes except WT and NSW.",
"example" : "ActiveKiwiSaverMember",
"enum" : [ "ActiveKiwiSaverMember", "AutomaticallyEnrolledIntoKiwiSaver", "EmployedForLessThan28Days", "NotRequiredToBeAutomaticallyEnrolled", "OptedIntoKiwiSaver", "NotEligibleForKiwiSaver" ]
},
"kiwiSaverEmployeeContributionRatePercentage" : {
"type" : "number",
"description" : "Employee Contribution percentage.",
Expand Down Expand Up @@ -2312,6 +2319,11 @@
"description" : "The date of the letter from IR.",
"format" : "date",
"x-is-date" : true
},
"registeredForGST" : {
"type" : "boolean",
"description" : "Is the employee registered for GST? Required in POST requests when taxCode is WT.",
"example" : true
}
},
"description" : ""
Expand Down Expand Up @@ -4068,7 +4080,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>18.2.0</li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>18.3.0</li>
<li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
<li data-group="PayrollNz" data-name="approveTimesheet" class="">
<a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>
Expand Down Expand Up @@ -14085,7 +14097,7 @@ <h1>updateEmployeeTax</h1>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked"></p>
<p class="marked">Replaces the entire EmployeeTax record. This is not a partial update. Any field omitted from the request is treated as null and overwrites the stored value. To change individual fields, GET the current record, merge your changes, remove deprecated fields such as isEligibleForKiwiSaver, and POST the complete object.</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/Employees/{EmployeeID}/Tax</span></code></pre>
Expand All @@ -14110,9 +14122,9 @@ <h3>Usage and SDK Samples</h3>
ird_number: "111111111",
has_special_student_loan_rate: true,
special_student_loan_rate_percentage: 2,
is_eligible_for_kiwi_saver: true,
esct_rate_percentage: 17.5,
kiwi_saver_contributions: XeroRuby::PayrollNz::EmployeeTax::kiwi_saver_contributions_enum::MAKECONTRIBUTIONS,
kiwi_saver_status: XeroRuby::PayrollNz::EmployeeTax::kiwi_saver_status_enum::ACTIVEKIWISAVERMEMBER,
kiwi_saver_employee_contribution_rate_percentage: 4,
kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage: 2,
tax_code: XeroRuby::PayrollNz::TaxCode::MSL,
Expand Down Expand Up @@ -14256,19 +14268,20 @@ <h2>Parameters</h2>
"irdNumber" : "111111111",
"taxCode" : "M",
"esctRatePercentage" : 17.5,
"isEligibleForKiwiSaver" : true,
"hasSpecialStudentLoanRate" : false,
"specialStudentLoanRatePercentage" : null,
"specialTaxRatePercentage" : null,
"kiwiSaverContributions" : "MakeContributions",
"kiwiSaverStatus" : "ActiveKiwiSaverMember",
"kiwiSaverOptOutDate" : null,
"kiwiSaverContributionHolidayEndDate" : null,
"kiwiSaverEmployeeContributionRatePercentage" : 3,
"kiwiSaverEmployerContributionRatePercentage" : 3,
"kiwiSaverEmployerSalarySacrificeContributionRatePercentage" : 0,
"hasStudentLoanBalance" : false,
"studentLoanBalance" : null,
"studentLoanAsAt" : null
"studentLoanAsAt" : null,
"registeredForGST" : null
}
}
},
Expand Down
2 changes: 1 addition & 1 deletion docs/payroll_uk/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3701,7 +3701,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>18.2.0</li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>18.3.0</li>
<li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
<li data-group="PayrollUk" data-name="approveTimesheet" class="">
<a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/projects/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1463,7 +1463,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Project"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Project"><strong>VSN: </strong>18.2.0</li>
<li class="nav-header" data-group="Project"><strong>VSN: </strong>18.3.0</li>
<li class="nav-header" data-group="Project"><a href="#api-Project">Methods</a></li>
<li data-group="Project" data-name="createProject" class="">
<a href="#api-Project-createProject">createProject</a>
Expand Down
2 changes: 2 additions & 0 deletions lib/xero-ruby/api/payroll_nz_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5392,6 +5392,7 @@ def update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id,
end

# Updates the tax records for a specific employee
# Replaces the entire EmployeeTax record. This is not a partial update. Any field omitted from the request is treated as null and overwrites the stored value. To change individual fields, GET the current record, merge your changes, remove deprecated fields such as isEligibleForKiwiSaver, and POST the complete object.
# @param xero_tenant_id [String] Xero identifier for Tenant
# @param employee_id [String] Employee id for single object
# @param employee_tax [EmployeeTax]
Expand All @@ -5404,6 +5405,7 @@ def update_employee_tax(xero_tenant_id, employee_id, employee_tax, opts = {})
end

# Updates the tax records for a specific employee
# Replaces the entire EmployeeTax record. This is not a partial update. Any field omitted from the request is treated as null and overwrites the stored value. To change individual fields, GET the current record, merge your changes, remove deprecated fields such as isEligibleForKiwiSaver, and POST the complete object.
# @param xero_tenant_id [String] Xero identifier for Tenant
# @param employee_id [String] Employee id for single object
# @param employee_tax [EmployeeTax]
Expand Down
Loading
Loading