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
17 changes: 16 additions & 1 deletion docs/v4/accounting/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2102,6 +2102,11 @@
"type" : "string",
"description" : "Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)"
},
"TaxNumberType" : {
"type" : "string",
"description" : "Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers",
"enum" : [ "SSN", "EIN", "ITIN", "ATIN" ]
},
"AccountsReceivableTaxType" : {
"type" : "string",
"description" : "The tax type from TaxRates"
Expand Down Expand Up @@ -6335,7 +6340,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.1.0</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>12.2.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 Expand Up @@ -24209,6 +24214,11 @@ <h3>Usage and SDK Samples</h3>
<h2>Scopes</h2>
<table>

<tr>
<td>accounting.budgets.read</td>
<td>Grant read-only access to read budgets</td>
</tr>

</table>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
Expand Down Expand Up @@ -24385,6 +24395,11 @@ <h3>Usage and SDK Samples</h3>
<h2>Scopes</h2>
<table>

<tr>
<td>accounting.budgets.read</td>
<td>Grant read-only access to read budgets</td>
</tr>

</table>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Header parameters</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/v4/appstore/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1237,7 +1237,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.1.0</li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>12.2.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
31 changes: 30 additions & 1 deletion docs/v4/assets/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1075,6 +1075,35 @@
"format" : "double",
"example" : 5.0,
"x-is-money" : true
},
"businessUseCapitalGain" : {
"type" : "number",
"description" : "(New Zealand Orgs Only) The portion of capital gain realised from the disposal of a fixed asset that is attributable to its business use.",
"format" : "decimal",
"x-is-money" : true
},
"businessUseCurrentGainLoss" : {
"type" : "number",
"description" : "(New Zealand Orgs Only) Represents the gain or loss from the disposal of the business use portion of a fixed asset. This value records the financial result (profit or loss) related specifically to the asset’s business use.",
"format" : "decimal",
"x-is-money" : true
},
"privateUseCapitalGain" : {
"type" : "number",
"description" : "(New Zealand Orgs Only) The portion of capital gain realised from the disposal of a fixed asset that is attributable to its private (non-business) use.",
"format" : "decimal",
"x-is-money" : true
},
"privateUseCurrentGainLoss" : {
"type" : "number",
"description" : "(New Zealand Orgs Only) Represents the gain or loss from the disposal of the private use portion of a fixed asset. This value records the financial result (profit or loss) related specifically to the asset’s private use.",
"format" : "decimal",
"x-is-money" : true
},
"initialDeductionPercentage" : {
"type" : "number",
"description" : "(New Zealand Orgs Only) The Investment Boost deduction percentage.",
"format" : "decimal"
}
},
"description" : ""
Expand Down Expand Up @@ -1386,7 +1415,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.1.0</li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>12.2.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/v4/files/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1144,7 +1144,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.1.0</li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>12.2.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/v4/finance/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2712,7 +2712,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.1.0</li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>12.2.0</li>
<li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
<li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
<a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/v4/payroll-au/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3411,7 +3411,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>12.1.0</li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>12.2.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
198 changes: 1 addition & 197 deletions docs/v4/payroll-nz/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4083,7 +4083,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>12.1.0</li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>12.2.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 @@ -4292,9 +4292,6 @@
<li data-group="PayrollNz" data-name="updateEmployeeTax" class="">
<a href="#api-PayrollNz-updateEmployeeTax">updateEmployeeTax</a>
</li>
<li data-group="PayrollNz" data-name="updatePayRun" class="">
<a href="#api-PayrollNz-updatePayRun">updatePayRun</a>
</li>
<li data-group="PayrollNz" data-name="updatePaySlipLineItems" class="">
<a href="#api-PayrollNz-updatePaySlipLineItems">updatePaySlipLineItems</a>
</li>
Expand Down Expand Up @@ -15226,199 +15223,6 @@ <h2>Parameters</h2>
}
},
"required" : true
}
</script>
</table>
</article>
</div>
<hr>
<div id="api-PayrollNz-updatePayRun">
<article id="api-PayrollNz-updatePayRun-0" data-group="User" data-name="updatePayRun" data-version="0">
<div class="pull-left">
<h1>updatePayRun</h1>
<p>Updates a pay run</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked"></p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/PayRuns/{PayRunID}</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class=""><a href="#examples-PayrollNz-updatePayRun-0-java">Java</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane" id="examples-PayrollNz-updatePayRun-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.*;
import org.openapitools.client.api.client.PayrollNzApi;
import org.openapitools.client.models.payrollNz.*;

import java.io.File;
import java.util.*;

public class PayrollNzApiExample {
private PayrollNzApi apiInstance;

public static void main(String[] args) {
String accessToken = "YOUR_ACCESS_TOKEN";
ApiClient defaultClient = new ApiClient();

apiInstance = AccountingApi.getInstance(defaultClient);
String xeroTenantId = 'xeroTenantId_example';
UUID payRunID = UUID.fromString("38400000-8cf0-11bd-b23e-10b96e4ef00d");
UUID payRunID = '38400000-8cf0-11bd-b23e-10b96e4ef00d';
String idempotencyKey = 'KEY_VALUE';
LocalDate startDate = LocalDate.of(2020, Month.OCTOBER, 28);
LocalDate paymentDate = LocalDate.of(2020, Month.OCTOBER, 30);

PayRunCalendar payRunCalendar = new PayRunCalendar();
payRunCalendar.setCalendarType(com.xero.models.payrollnz.CalendarType.WEEKLY);
payRunCalendar.setPeriodStartDate(startDate);
payRunCalendar.setPaymentDate(paymentDate);

try {
PayRunObject result = apiInstance.updatePayRun(accessToken, xeroTenantId, payRunID, payRun, idempotencyKey);
System.out.println(result);
} catch (XeroException e) {
System.err.println("Exception when calling PayrollNzApi#updatePayRun");
e.printStackTrace();
}
}
}</code></pre>
</div>
</div>
<h2>Scopes</h2>
<table>

<tr>
<td>payroll.payruns</td>
<td>Grant read-write access to payroll payruns</td>
</tr>

</table>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">PayRunID<span style="color:red;">*</span></td>
<td>


<div id="d2e199_updatePayRun_payRunID">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
UUID
</span>
<span class="format">
(uuid)
</span>

<div class="inner description marked">
Identifier for the pay run
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>

</table>
<div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">Xero-Tenant-Id<span style="color:red;">*</span></td>
<td>


<div id="d2e199_updatePayRun_xeroTenantId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>

<div class="inner description marked">
Xero identifier for Tenant
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>

<tr><td style="width:150px;">Idempotency-Key</td>
<td>


<div id="d2e199_updatePayRun_idempotencyKey">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>

<div class="inner description marked">
This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
</div>
</div>
</div>
</div>
</td>
</tr>

</table>
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr>
<td style="width:150px;">payRun <span style="color:red;">*</span></td>
<td>
<div class="json-schema-view">
<div class="primitive">
<span class="type">
PayRun
</span>
<div class="inner description marked">

</div>
</div>
<div class="inner required">
Required
</div>
</div>
<script type="application/ld+json">
{
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PayRun"
},
"example" : {
"paymentDate" : "2019-07-01"
}
}
},
"required" : true
}
</script>
</table>
Expand Down
Loading