Skip to content

Commit bccd0b0

Browse files
actions-useractions-user
committed
chore: release new SDK versions based on update OpenAPI Spec (#397)
1 parent b04770e commit bccd0b0

File tree

576 files changed

+2448
-2935
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

576 files changed

+2448
-2935
lines changed

‎docs/v1/accounting/index.html‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2104,6 +2104,11 @@
21042104
"type" : "string",
21052105
"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)"
21062106
},
2107+
"TaxNumberType" : {
2108+
"type" : "string",
2109+
"description" : "Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers",
2110+
"enum" : [ "SSN", "EIN", "ITIN", "ATIN" ]
2111+
},
21072112
"AccountsReceivableTaxType" : {
21082113
"type" : "string",
21092114
"description" : "The tax type from TaxRates"
@@ -6339,7 +6344,7 @@
63396344
<nav id="scrollingNav">
63406345
<ul class="sidenav nav nav-list">
63416346
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
6342-
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>9.1.0</li>
6347+
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>9.2.0</li>
63436348
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
63446349
<li data-group="Accounting" data-name="createAccount" class="">
63456350
<a href="#api-Accounting-createAccount">createAccount</a>
@@ -23930,7 +23935,7 @@ <h2>Scopes</h2>
2393023935

2393123936
<tr>
2393223937
<td>accounting.budgets.read</td>
23933-
<td></td>
23938+
<td>Grant read-only access to read budgets</td>
2393423939
</tr>
2393523940

2393623941
</table>
@@ -24109,7 +24114,7 @@ <h2>Scopes</h2>
2410924114

2411024115
<tr>
2411124116
<td>accounting.budgets.read</td>
24112-
<td></td>
24117+
<td>Grant read-only access to read budgets</td>
2411324118
</tr>
2411424119

2411524120
</table>

‎docs/v1/appstore/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1241,7 +1241,7 @@
12411241
<nav id="scrollingNav">
12421242
<ul class="sidenav nav nav-list">
12431243
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
1244-
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>9.1.0</li>
1244+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>9.2.0</li>
12451245
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
12461246
<li data-group="AppStore" data-name="getSubscription" class="">
12471247
<a href="#api-AppStore-getSubscription">getSubscription</a>

‎docs/v1/assets/index.html‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1077,6 +1077,35 @@
10771077
"format" : "double",
10781078
"example" : 5.0,
10791079
"x-is-money" : true
1080+
},
1081+
"businessUseCapitalGain" : {
1082+
"type" : "number",
1083+
"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.",
1084+
"format" : "decimal",
1085+
"x-is-money" : true
1086+
},
1087+
"businessUseCurrentGainLoss" : {
1088+
"type" : "number",
1089+
"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.",
1090+
"format" : "decimal",
1091+
"x-is-money" : true
1092+
},
1093+
"privateUseCapitalGain" : {
1094+
"type" : "number",
1095+
"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.",
1096+
"format" : "decimal",
1097+
"x-is-money" : true
1098+
},
1099+
"privateUseCurrentGainLoss" : {
1100+
"type" : "number",
1101+
"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.",
1102+
"format" : "decimal",
1103+
"x-is-money" : true
1104+
},
1105+
"initialDeductionPercentage" : {
1106+
"type" : "number",
1107+
"description" : "(New Zealand Orgs Only) The Investment Boost deduction percentage.",
1108+
"format" : "decimal"
10801109
}
10811110
},
10821111
"description" : ""
@@ -1390,7 +1419,7 @@
13901419
<nav id="scrollingNav">
13911420
<ul class="sidenav nav nav-list">
13921421
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
1393-
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>9.1.0</li>
1422+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>9.2.0</li>
13941423
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
13951424
<li data-group="Asset" data-name="createAsset" class="">
13961425
<a href="#api-Asset-createAsset">createAsset</a>

‎docs/v1/files/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1170,7 +1170,7 @@
11701170
<nav id="scrollingNav">
11711171
<ul class="sidenav nav nav-list">
11721172
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
1173-
<li class="nav-header" data-group="Files"><strong>VSN: </strong>9.1.0</li>
1173+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>9.2.0</li>
11741174
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
11751175
<li data-group="Files" data-name="createFileAssociation" class="">
11761176
<a href="#api-Files-createFileAssociation">createFileAssociation</a>

‎docs/v1/finance/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2716,7 +2716,7 @@
27162716
<nav id="scrollingNav">
27172717
<ul class="sidenav nav nav-list">
27182718
<li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
2719-
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>9.1.0</li>
2719+
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>9.2.0</li>
27202720
<li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
27212721
<li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
27222722
<a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>

‎docs/v1/payroll-au/index.html‎

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

‎docs/v1/payroll-nz/index.html‎

Lines changed: 1 addition & 194 deletions
Original file line numberDiff line numberDiff line change
@@ -4087,7 +4087,7 @@
40874087
<nav id="scrollingNav">
40884088
<ul class="sidenav nav nav-list">
40894089
<li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
4090-
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>9.1.0</li>
4090+
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>9.2.0</li>
40914091
<li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
40924092
<li data-group="PayrollNz" data-name="approveTimesheet" class="">
40934093
<a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>
@@ -4296,9 +4296,6 @@
42964296
<li data-group="PayrollNz" data-name="updateEmployeeTax" class="">
42974297
<a href="#api-PayrollNz-updateEmployeeTax">updateEmployeeTax</a>
42984298
</li>
4299-
<li data-group="PayrollNz" data-name="updatePayRun" class="">
4300-
<a href="#api-PayrollNz-updatePayRun">updatePayRun</a>
4301-
</li>
43024299
<li data-group="PayrollNz" data-name="updatePaySlipLineItems" class="">
43034300
<a href="#api-PayrollNz-updatePaySlipLineItems">updatePaySlipLineItems</a>
43044301
</li>
@@ -15022,196 +15019,6 @@ <h2>Parameters</h2>
1502215019
}
1502315020
},
1502415021
"required" : true
15025-
}
15026-
</script>
15027-
</table>
15028-
</article>
15029-
</div>
15030-
<hr>
15031-
<div id="api-PayrollNz-updatePayRun">
15032-
<article id="api-PayrollNz-updatePayRun-0" data-group="User" data-name="updatePayRun" data-version="0">
15033-
<div class="pull-left">
15034-
<h1>updatePayRun</h1>
15035-
<p>Updates a pay run</p>
15036-
</div>
15037-
<div class="pull-right"></div>
15038-
<div class="clearfix"></div>
15039-
<p></p>
15040-
<p class="marked"></p>
15041-
<p></p>
15042-
<br />
15043-
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/PayRuns/{PayRunID}</span></code></pre>
15044-
<p>
15045-
<h3>Usage and SDK Samples</h3>
15046-
</p>
15047-
<ul class="nav nav-tabs nav-tabs-examples">
15048-
<!-- *****REPLACE***** comment out the other languages <li> -->
15049-
<li class=""><a href="#examples-PayrollNz-updatePayRun-0-python">Python</a></li>
15050-
</ul>
15051-
<div class="tab-content">
15052-
<!-- *****REPLACE***** comment out the other languages tab-pane -->
15053-
<div class="tab-pane" id="examples-PayrollNz-updatePayRun-0-python">
15054-
<pre class="prettyprint"><code class="language-python"># configure api_client for use with xero-python sdk client
15055-
api_client = ApiClient(
15056-
Configuration(
15057-
debug=false,
15058-
oauth2_token=OAuth2Token(
15059-
client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
15060-
),
15061-
),
15062-
pool_threads=1,
15063-
)
15064-
15065-
api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
15066-
15067-
def accounting_update_pay_run():
15068-
api_instance = PayrollNzApi(api_client)
15069-
xero_tenant_id = 'xeroTenantId_example'
15070-
pay_run_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
15071-
idempotency_key = 'KEY_VALUE'
15072-
start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
15073-
payment_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
15074-
15075-
pay_run_calendar = PayRunCalendar(
15076-
calendar_type = calendar_type.WEEKLY,
15077-
period_start_date = start_date,
15078-
payment_date = payment_date)
15079-
15080-
try:
15081-
api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, payRun, idempotency_key)
15082-
print(api_response)
15083-
except AccountingBadRequestException as e:
15084-
print("Exception when calling PayrollNzApi->updatePayRun: %s\n" % e)</code></pre>
15085-
</div>
15086-
</div>
15087-
<h2>Scopes</h2>
15088-
<table>
15089-
15090-
<tr>
15091-
<td>payroll.payruns</td>
15092-
<td>Grant read-write access to payroll payruns</td>
15093-
</tr>
15094-
15095-
</table>
15096-
<h2>Parameters</h2>
15097-
<div class="methodsubtabletitle">Path parameters</div>
15098-
<table id="methodsubtable">
15099-
<tr>
15100-
<th width="150px">Name</th>
15101-
<th>Description</th>
15102-
</tr>
15103-
<tr><td style="width:150px;">PayRunID<span style="color:red;">*</span></td>
15104-
<td>
15105-
15106-
15107-
<div id="d2e199_updatePayRun_payRunID">
15108-
<div class="json-schema-view">
15109-
<div class="primitive">
15110-
<span class="type">
15111-
UUID
15112-
</span>
15113-
<span class="format">
15114-
(uuid)
15115-
</span>
15116-
15117-
<div class="inner description marked">
15118-
Identifier for the pay run
15119-
</div>
15120-
</div>
15121-
<div class="inner required">
15122-
Required
15123-
</div>
15124-
</div>
15125-
</div>
15126-
</td>
15127-
</tr>
15128-
15129-
</table>
15130-
<div class="methodsubtabletitle">Header parameters</div>
15131-
<table id="methodsubtable">
15132-
<tr>
15133-
<th width="150px">Name</th>
15134-
<th>Description</th>
15135-
</tr>
15136-
<tr><td style="width:150px;">Xero-Tenant-Id<span style="color:red;">*</span></td>
15137-
<td>
15138-
15139-
15140-
<div id="d2e199_updatePayRun_xeroTenantId">
15141-
<div class="json-schema-view">
15142-
<div class="primitive">
15143-
<span class="type">
15144-
String
15145-
</span>
15146-
15147-
<div class="inner description marked">
15148-
Xero identifier for Tenant
15149-
</div>
15150-
</div>
15151-
<div class="inner required">
15152-
Required
15153-
</div>
15154-
</div>
15155-
</div>
15156-
</td>
15157-
</tr>
15158-
15159-
<tr><td style="width:150px;">Idempotency-Key</td>
15160-
<td>
15161-
15162-
15163-
<div id="d2e199_updatePayRun_idempotencyKey">
15164-
<div class="json-schema-view">
15165-
<div class="primitive">
15166-
<span class="type">
15167-
String
15168-
</span>
15169-
15170-
<div class="inner description marked">
15171-
This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
15172-
</div>
15173-
</div>
15174-
</div>
15175-
</div>
15176-
</td>
15177-
</tr>
15178-
15179-
</table>
15180-
<div class="methodsubtabletitle">Body parameters</div>
15181-
<table id="methodsubtable">
15182-
<tr>
15183-
<th width="150px">Name</th>
15184-
<th>Description</th>
15185-
</tr>
15186-
<tr>
15187-
<td style="width:150px;">payRun <span style="color:red;">*</span></td>
15188-
<td>
15189-
<div class="json-schema-view">
15190-
<div class="primitive">
15191-
<span class="type">
15192-
PayRun
15193-
</span>
15194-
<div class="inner description marked">
15195-
15196-
</div>
15197-
</div>
15198-
<div class="inner required">
15199-
Required
15200-
</div>
15201-
</div>
15202-
<script type="application/ld+json">
15203-
{
15204-
"content" : {
15205-
"application/json" : {
15206-
"schema" : {
15207-
"$ref" : "#/components/schemas/PayRun"
15208-
},
15209-
"example" : {
15210-
"paymentDate" : "2019-07-01"
15211-
}
15212-
}
15213-
},
15214-
"required" : true
1521515022
}
1521615023
</script>
1521715024
</table>

0 commit comments

Comments
 (0)