Skip to content

Commit 4970e9e

Browse files
Merge pull request #424 from XeroAPI/12.2.0
Build for version - 12.2.0
2 parents 0df1d6f + dce95d4 commit 4970e9e

File tree

22 files changed

+442
-654
lines changed

22 files changed

+442
-654
lines changed

docs/v4/accounting/index.html

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2102,6 +2102,11 @@
21022102
"type" : "string",
21032103
"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)"
21042104
},
2105+
"TaxNumberType" : {
2106+
"type" : "string",
2107+
"description" : "Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers",
2108+
"enum" : [ "SSN", "EIN", "ITIN", "ATIN" ]
2109+
},
21052110
"AccountsReceivableTaxType" : {
21062111
"type" : "string",
21072112
"description" : "The tax type from TaxRates"
@@ -6335,7 +6340,7 @@
63356340
<nav id="scrollingNav">
63366341
<ul class="sidenav nav nav-list">
63376342
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
6338-
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>12.1.0</li>
6343+
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>12.2.0</li>
63396344
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
63406345
<li data-group="Accounting" data-name="createAccount" class="">
63416346
<a href="#api-Accounting-createAccount">createAccount</a>
@@ -24209,6 +24214,11 @@ <h3>Usage and SDK Samples</h3>
2420924214
<h2>Scopes</h2>
2421024215
<table>
2421124216

24217+
<tr>
24218+
<td>accounting.budgets.read</td>
24219+
<td>Grant read-only access to read budgets</td>
24220+
</tr>
24221+
2421224222
</table>
2421324223
<h2>Parameters</h2>
2421424224
<div class="methodsubtabletitle">Path parameters</div>
@@ -24385,6 +24395,11 @@ <h3>Usage and SDK Samples</h3>
2438524395
<h2>Scopes</h2>
2438624396
<table>
2438724397

24398+
<tr>
24399+
<td>accounting.budgets.read</td>
24400+
<td>Grant read-only access to read budgets</td>
24401+
</tr>
24402+
2438824403
</table>
2438924404
<h2>Parameters</h2>
2439024405
<div class="methodsubtabletitle">Header parameters</div>

docs/v4/appstore/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1237,7 +1237,7 @@
12371237
<nav id="scrollingNav">
12381238
<ul class="sidenav nav nav-list">
12391239
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
1240-
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>12.1.0</li>
1240+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>12.2.0</li>
12411241
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
12421242
<li data-group="AppStore" data-name="getSubscription" class="">
12431243
<a href="#api-AppStore-getSubscription">getSubscription</a>

docs/v4/assets/index.html

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1075,6 +1075,35 @@
10751075
"format" : "double",
10761076
"example" : 5.0,
10771077
"x-is-money" : true
1078+
},
1079+
"businessUseCapitalGain" : {
1080+
"type" : "number",
1081+
"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.",
1082+
"format" : "decimal",
1083+
"x-is-money" : true
1084+
},
1085+
"businessUseCurrentGainLoss" : {
1086+
"type" : "number",
1087+
"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.",
1088+
"format" : "decimal",
1089+
"x-is-money" : true
1090+
},
1091+
"privateUseCapitalGain" : {
1092+
"type" : "number",
1093+
"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.",
1094+
"format" : "decimal",
1095+
"x-is-money" : true
1096+
},
1097+
"privateUseCurrentGainLoss" : {
1098+
"type" : "number",
1099+
"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.",
1100+
"format" : "decimal",
1101+
"x-is-money" : true
1102+
},
1103+
"initialDeductionPercentage" : {
1104+
"type" : "number",
1105+
"description" : "(New Zealand Orgs Only) The Investment Boost deduction percentage.",
1106+
"format" : "decimal"
10781107
}
10791108
},
10801109
"description" : ""
@@ -1386,7 +1415,7 @@
13861415
<nav id="scrollingNav">
13871416
<ul class="sidenav nav nav-list">
13881417
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
1389-
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>12.1.0</li>
1418+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>12.2.0</li>
13901419
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
13911420
<li data-group="Asset" data-name="createAsset" class="">
13921421
<a href="#api-Asset-createAsset">createAsset</a>

docs/v4/files/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1144,7 +1144,7 @@
11441144
<nav id="scrollingNav">
11451145
<ul class="sidenav nav nav-list">
11461146
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
1147-
<li class="nav-header" data-group="Files"><strong>VSN: </strong>12.1.0</li>
1147+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>12.2.0</li>
11481148
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
11491149
<li data-group="Files" data-name="createFileAssociation" class="">
11501150
<a href="#api-Files-createFileAssociation">createFileAssociation</a>

docs/v4/finance/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2712,7 +2712,7 @@
27122712
<nav id="scrollingNav">
27132713
<ul class="sidenav nav nav-list">
27142714
<li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
2715-
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>12.1.0</li>
2715+
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>12.2.0</li>
27162716
<li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
27172717
<li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
27182718
<a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>

docs/v4/payroll-au/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3411,7 +3411,7 @@
34113411
<nav id="scrollingNav">
34123412
<ul class="sidenav nav nav-list">
34133413
<li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
3414-
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>12.1.0</li>
3414+
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>12.2.0</li>
34153415
<li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
34163416
<li data-group="PayrollAu" data-name="approveLeaveApplication" class="">
34173417
<a href="#api-PayrollAu-approveLeaveApplication">approveLeaveApplication</a>

docs/v4/payroll-nz/index.html

Lines changed: 1 addition & 197 deletions
Original file line numberDiff line numberDiff line change
@@ -4083,7 +4083,7 @@
40834083
<nav id="scrollingNav">
40844084
<ul class="sidenav nav nav-list">
40854085
<li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
4086-
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>12.1.0</li>
4086+
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>12.2.0</li>
40874087
<li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
40884088
<li data-group="PayrollNz" data-name="approveTimesheet" class="">
40894089
<a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>
@@ -4292,9 +4292,6 @@
42924292
<li data-group="PayrollNz" data-name="updateEmployeeTax" class="">
42934293
<a href="#api-PayrollNz-updateEmployeeTax">updateEmployeeTax</a>
42944294
</li>
4295-
<li data-group="PayrollNz" data-name="updatePayRun" class="">
4296-
<a href="#api-PayrollNz-updatePayRun">updatePayRun</a>
4297-
</li>
42984295
<li data-group="PayrollNz" data-name="updatePaySlipLineItems" class="">
42994296
<a href="#api-PayrollNz-updatePaySlipLineItems">updatePaySlipLineItems</a>
43004297
</li>
@@ -15226,199 +15223,6 @@ <h2>Parameters</h2>
1522615223
}
1522715224
},
1522815225
"required" : true
15229-
}
15230-
</script>
15231-
</table>
15232-
</article>
15233-
</div>
15234-
<hr>
15235-
<div id="api-PayrollNz-updatePayRun">
15236-
<article id="api-PayrollNz-updatePayRun-0" data-group="User" data-name="updatePayRun" data-version="0">
15237-
<div class="pull-left">
15238-
<h1>updatePayRun</h1>
15239-
<p>Updates a pay run</p>
15240-
</div>
15241-
<div class="pull-right"></div>
15242-
<div class="clearfix"></div>
15243-
<p></p>
15244-
<p class="marked"></p>
15245-
<p></p>
15246-
<br />
15247-
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/PayRuns/{PayRunID}</span></code></pre>
15248-
<p>
15249-
<h3>Usage and SDK Samples</h3>
15250-
</p>
15251-
<ul class="nav nav-tabs nav-tabs-examples">
15252-
<li class=""><a href="#examples-PayrollNz-updatePayRun-0-java">Java</a></li>
15253-
</ul>
15254-
<div class="tab-content">
15255-
<div class="tab-pane" id="examples-PayrollNz-updatePayRun-0-java">
15256-
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.*;
15257-
import org.openapitools.client.api.client.PayrollNzApi;
15258-
import org.openapitools.client.models.payrollNz.*;
15259-
15260-
import java.io.File;
15261-
import java.util.*;
15262-
15263-
public class PayrollNzApiExample {
15264-
private PayrollNzApi apiInstance;
15265-
15266-
public static void main(String[] args) {
15267-
String accessToken = "YOUR_ACCESS_TOKEN";
15268-
ApiClient defaultClient = new ApiClient();
15269-
15270-
apiInstance = AccountingApi.getInstance(defaultClient);
15271-
String xeroTenantId = 'xeroTenantId_example';
15272-
UUID payRunID = UUID.fromString("38400000-8cf0-11bd-b23e-10b96e4ef00d");
15273-
UUID payRunID = '38400000-8cf0-11bd-b23e-10b96e4ef00d';
15274-
String idempotencyKey = 'KEY_VALUE';
15275-
LocalDate startDate = LocalDate.of(2020, Month.OCTOBER, 28);
15276-
LocalDate paymentDate = LocalDate.of(2020, Month.OCTOBER, 30);
15277-
15278-
PayRunCalendar payRunCalendar = new PayRunCalendar();
15279-
payRunCalendar.setCalendarType(com.xero.models.payrollnz.CalendarType.WEEKLY);
15280-
payRunCalendar.setPeriodStartDate(startDate);
15281-
payRunCalendar.setPaymentDate(paymentDate);
15282-
15283-
try {
15284-
PayRunObject result = apiInstance.updatePayRun(accessToken, xeroTenantId, payRunID, payRun, idempotencyKey);
15285-
System.out.println(result);
15286-
} catch (XeroException e) {
15287-
System.err.println("Exception when calling PayrollNzApi#updatePayRun");
15288-
e.printStackTrace();
15289-
}
15290-
}
15291-
}</code></pre>
15292-
</div>
15293-
</div>
15294-
<h2>Scopes</h2>
15295-
<table>
15296-
15297-
<tr>
15298-
<td>payroll.payruns</td>
15299-
<td>Grant read-write access to payroll payruns</td>
15300-
</tr>
15301-
15302-
</table>
15303-
<h2>Parameters</h2>
15304-
<div class="methodsubtabletitle">Path parameters</div>
15305-
<table id="methodsubtable">
15306-
<tr>
15307-
<th width="150px">Name</th>
15308-
<th>Description</th>
15309-
</tr>
15310-
<tr><td style="width:150px;">PayRunID<span style="color:red;">*</span></td>
15311-
<td>
15312-
15313-
15314-
<div id="d2e199_updatePayRun_payRunID">
15315-
<div class="json-schema-view">
15316-
<div class="primitive">
15317-
<span class="type">
15318-
UUID
15319-
</span>
15320-
<span class="format">
15321-
(uuid)
15322-
</span>
15323-
15324-
<div class="inner description marked">
15325-
Identifier for the pay run
15326-
</div>
15327-
</div>
15328-
<div class="inner required">
15329-
Required
15330-
</div>
15331-
</div>
15332-
</div>
15333-
</td>
15334-
</tr>
15335-
15336-
</table>
15337-
<div class="methodsubtabletitle">Header parameters</div>
15338-
<table id="methodsubtable">
15339-
<tr>
15340-
<th width="150px">Name</th>
15341-
<th>Description</th>
15342-
</tr>
15343-
<tr><td style="width:150px;">Xero-Tenant-Id<span style="color:red;">*</span></td>
15344-
<td>
15345-
15346-
15347-
<div id="d2e199_updatePayRun_xeroTenantId">
15348-
<div class="json-schema-view">
15349-
<div class="primitive">
15350-
<span class="type">
15351-
String
15352-
</span>
15353-
15354-
<div class="inner description marked">
15355-
Xero identifier for Tenant
15356-
</div>
15357-
</div>
15358-
<div class="inner required">
15359-
Required
15360-
</div>
15361-
</div>
15362-
</div>
15363-
</td>
15364-
</tr>
15365-
15366-
<tr><td style="width:150px;">Idempotency-Key</td>
15367-
<td>
15368-
15369-
15370-
<div id="d2e199_updatePayRun_idempotencyKey">
15371-
<div class="json-schema-view">
15372-
<div class="primitive">
15373-
<span class="type">
15374-
String
15375-
</span>
15376-
15377-
<div class="inner description marked">
15378-
This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
15379-
</div>
15380-
</div>
15381-
</div>
15382-
</div>
15383-
</td>
15384-
</tr>
15385-
15386-
</table>
15387-
<div class="methodsubtabletitle">Body parameters</div>
15388-
<table id="methodsubtable">
15389-
<tr>
15390-
<th width="150px">Name</th>
15391-
<th>Description</th>
15392-
</tr>
15393-
<tr>
15394-
<td style="width:150px;">payRun <span style="color:red;">*</span></td>
15395-
<td>
15396-
<div class="json-schema-view">
15397-
<div class="primitive">
15398-
<span class="type">
15399-
PayRun
15400-
</span>
15401-
<div class="inner description marked">
15402-
15403-
</div>
15404-
</div>
15405-
<div class="inner required">
15406-
Required
15407-
</div>
15408-
</div>
15409-
<script type="application/ld+json">
15410-
{
15411-
"content" : {
15412-
"application/json" : {
15413-
"schema" : {
15414-
"$ref" : "#/components/schemas/PayRun"
15415-
},
15416-
"example" : {
15417-
"paymentDate" : "2019-07-01"
15418-
}
15419-
}
15420-
},
15421-
"required" : true
1542215226
}
1542315227
</script>
1542415228
</table>

0 commit comments

Comments
 (0)