Skip to content

Commit c0b1e90

Browse files
rdemarco-xerordemarco-xero
authored
Merge pull request #317 from XeroAPI/update-to-XeroAPI-v2_25
update to latest spec version with updates to batchpayments
2 parents c1a9e57 + 90cd3c7 commit c0b1e90

23 files changed

+881
-31
lines changed

‎docs/v4/accounting/index.html

Lines changed: 339 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1667,6 +1667,43 @@
16671667
"externalDocs" : {
16681668
"url" : "http://developer.xero.com/documentation/api/BatchPayments/"
16691669
}
1670+
};
1671+
defs["BatchPaymentDelete"] = {
1672+
"title" : "",
1673+
"required" : [ "BatchPaymentID", "Status" ],
1674+
"type" : "object",
1675+
"properties" : {
1676+
"BatchPaymentID" : {
1677+
"type" : "string",
1678+
"description" : "The Xero generated unique identifier for the bank transaction (read-only)",
1679+
"format" : "uuid"
1680+
},
1681+
"Status" : {
1682+
"type" : "string",
1683+
"description" : "The status of the batch payment.",
1684+
"default" : "DELETED"
1685+
}
1686+
},
1687+
"description" : "",
1688+
"externalDocs" : {
1689+
"url" : "http://developer.xero.com/documentation/api/accounting/batchpayments"
1690+
}
1691+
};
1692+
defs["BatchPaymentDeleteByUrlParam"] = {
1693+
"title" : "",
1694+
"required" : [ "Status" ],
1695+
"type" : "object",
1696+
"properties" : {
1697+
"Status" : {
1698+
"type" : "string",
1699+
"description" : "The status of the batch payment.",
1700+
"default" : "DELETED"
1701+
}
1702+
},
1703+
"description" : "",
1704+
"externalDocs" : {
1705+
"url" : "http://developer.xero.com/documentation/api/accounting/batchpayments"
1706+
}
16701707
};
16711708
defs["BatchPaymentDetails"] = {
16721709
"title" : "",
@@ -6028,7 +6065,7 @@
60286065
<nav id="scrollingNav">
60296066
<ul class="sidenav nav nav-list">
60306067
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
6031-
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.19.0</li>
6068+
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.20.0</li>
60326069
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
60336070
<li data-group="Accounting" data-name="createAccount" class="">
60346071
<a href="#api-Accounting-createAccount">createAccount</a>
@@ -6201,6 +6238,12 @@
62016238
<li data-group="Accounting" data-name="deleteAccount" class="">
62026239
<a href="#api-Accounting-deleteAccount">deleteAccount</a>
62036240
</li>
6241+
<li data-group="Accounting" data-name="deleteBatchPayment" class="">
6242+
<a href="#api-Accounting-deleteBatchPayment">deleteBatchPayment</a>
6243+
</li>
6244+
<li data-group="Accounting" data-name="deleteBatchPaymentByUrlParam" class="">
6245+
<a href="#api-Accounting-deleteBatchPaymentByUrlParam">deleteBatchPaymentByUrlParam</a>
6246+
</li>
62046247
<li data-group="Accounting" data-name="deleteContactGroupContact" class="">
62056248
<a href="#api-Accounting-deleteContactGroupContact">deleteContactGroupContact</a>
62066249
</li>
@@ -16641,6 +16684,301 @@ <h2>Parameters</h2>
1664116684
</article>
1664216685
</div>
1664316686
<hr>
16687+
<div id="api-Accounting-deleteBatchPayment">
16688+
<article id="api-Accounting-deleteBatchPayment-0" data-group="User" data-name="deleteBatchPayment" data-version="0">
16689+
<div class="pull-left">
16690+
<h1>deleteBatchPayment</h1>
16691+
<p>Updates a specific batch payment for invoices and credit notes</p>
16692+
</div>
16693+
<div class="pull-right"></div>
16694+
<div class="clearfix"></div>
16695+
<p></p>
16696+
<p class="marked"></p>
16697+
<p></p>
16698+
<br />
16699+
<pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/BatchPayments</span></code></pre>
16700+
<p>
16701+
<h3>Usage and SDK Samples</h3>
16702+
</p>
16703+
<ul class="nav nav-tabs nav-tabs-examples">
16704+
<li class=""><a href="#examples-Accounting-deleteBatchPayment-0-java">Java</a></li>
16705+
</ul>
16706+
<div class="tab-content">
16707+
<div class="tab-pane" id="examples-Accounting-deleteBatchPayment-0-java">
16708+
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.*;
16709+
import org.openapitools.client.api.client.AccountingApi;
16710+
import org.openapitools.client.models.accounting.*;
16711+
16712+
import java.io.File;
16713+
import java.util.*;
16714+
16715+
public class AccountingApiExample {
16716+
private AccountingApi apiInstance;
16717+
16718+
public static void main(String[] args) {
16719+
String accessToken = "YOUR_ACCESS_TOKEN";
16720+
ApiClient defaultClient = new ApiClient();
16721+
16722+
apiInstance = AccountingApi.getInstance(defaultClient);
16723+
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
16724+
16725+
BatchPaymentDelete batchPaymentDelete = new BatchPaymentDelete();
16726+
batchPaymentDelete.setStatus("DELETED");
16727+
batchPaymentDelete.setBatchPaymentID(UUID.fromString("00000000-0000-0000-0000-000000000000"));
16728+
16729+
try {
16730+
BatchPayments result = apiInstance.deleteBatchPayment(accessToken, xeroTenantId, batchPaymentDelete);
16731+
System.out.println(result);
16732+
} catch (XeroException e) {
16733+
System.err.println("Exception when calling AccountingApi#deleteBatchPayment");
16734+
e.printStackTrace();
16735+
}
16736+
}
16737+
}</code></pre>
16738+
</div>
16739+
</div>
16740+
<h2>Scopes</h2>
16741+
<table>
16742+
16743+
<tr>
16744+
<td>accounting.transactions</td>
16745+
<td>Grant read-write access to bank transactions, credit notes, invoices, repeating invoices</td>
16746+
</tr>
16747+
16748+
</table>
16749+
<h2>Parameters</h2>
16750+
<div class="methodsubtabletitle">Header parameters</div>
16751+
<table id="methodsubtable">
16752+
<tr>
16753+
<th width="150px">Name</th>
16754+
<th>Description</th>
16755+
</tr>
16756+
<tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td>
16757+
<td>
16758+
16759+
16760+
<div id="d2e199_deleteBatchPayment_xeroTenantId">
16761+
<div class="json-schema-view">
16762+
<div class="primitive">
16763+
<span class="type">
16764+
String
16765+
</span>
16766+
16767+
<div class="inner description marked">
16768+
Xero identifier for Tenant
16769+
</div>
16770+
</div>
16771+
<div class="inner required">
16772+
Required
16773+
</div>
16774+
</div>
16775+
</div>
16776+
</td>
16777+
</tr>
16778+
16779+
</table>
16780+
<div class="methodsubtabletitle">Body parameters</div>
16781+
<table id="methodsubtable">
16782+
<tr>
16783+
<th width="150px">Name</th>
16784+
<th>Description</th>
16785+
</tr>
16786+
<tr>
16787+
<td style="width:150px;">batchPaymentDelete <span style="color:red;">*</span></td>
16788+
<td>
16789+
<div class="json-schema-view">
16790+
<div class="primitive">
16791+
<span class="type">
16792+
BatchPaymentDelete
16793+
</span>
16794+
<div class="inner description marked">
16795+
16796+
</div>
16797+
</div>
16798+
<div class="inner required">
16799+
Required
16800+
</div>
16801+
</div>
16802+
<script type="application/ld+json">
16803+
{
16804+
"content" : {
16805+
"application/json" : {
16806+
"schema" : {
16807+
"$ref" : "#/components/schemas/BatchPaymentDelete"
16808+
},
16809+
"example" : "{ \"BatchPaymentID\": \"9bf296e9-0748-4d29-a3dc-24dde1098030\", \"Status\":\"DELETED\" }"
16810+
}
16811+
},
16812+
"required" : true
16813+
}
16814+
</script>
16815+
</table>
16816+
</article>
16817+
</div>
16818+
<hr>
16819+
<div id="api-Accounting-deleteBatchPaymentByUrlParam">
16820+
<article id="api-Accounting-deleteBatchPaymentByUrlParam-0" data-group="User" data-name="deleteBatchPaymentByUrlParam" data-version="0">
16821+
<div class="pull-left">
16822+
<h1>deleteBatchPaymentByUrlParam</h1>
16823+
<p>Updates a specific batch payment for invoices and credit notes</p>
16824+
</div>
16825+
<div class="pull-right"></div>
16826+
<div class="clearfix"></div>
16827+
<p></p>
16828+
<p class="marked"></p>
16829+
<p></p>
16830+
<br />
16831+
<pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/BatchPayments/{BatchPaymentID}</span></code></pre>
16832+
<p>
16833+
<h3>Usage and SDK Samples</h3>
16834+
</p>
16835+
<ul class="nav nav-tabs nav-tabs-examples">
16836+
<li class=""><a href="#examples-Accounting-deleteBatchPaymentByUrlParam-0-java">Java</a></li>
16837+
</ul>
16838+
<div class="tab-content">
16839+
<div class="tab-pane" id="examples-Accounting-deleteBatchPaymentByUrlParam-0-java">
16840+
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.*;
16841+
import org.openapitools.client.api.client.AccountingApi;
16842+
import org.openapitools.client.models.accounting.*;
16843+
16844+
import java.io.File;
16845+
import java.util.*;
16846+
16847+
public class AccountingApiExample {
16848+
private AccountingApi apiInstance;
16849+
16850+
public static void main(String[] args) {
16851+
String accessToken = "YOUR_ACCESS_TOKEN";
16852+
ApiClient defaultClient = new ApiClient();
16853+
16854+
apiInstance = AccountingApi.getInstance(defaultClient);
16855+
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
16856+
UUID batchPaymentID = UUID.fromString("00000000-0000-0000-0000-000000000000");
16857+
UUID batchPaymentID = '00000000-0000-0000-0000-000000000000';
16858+
16859+
try {
16860+
BatchPayments result = apiInstance.deleteBatchPaymentByUrlParam(accessToken, xeroTenantId, batchPaymentID, batchPaymentDeleteByUrlParam);
16861+
System.out.println(result);
16862+
} catch (XeroException e) {
16863+
System.err.println("Exception when calling AccountingApi#deleteBatchPaymentByUrlParam");
16864+
e.printStackTrace();
16865+
}
16866+
}
16867+
}</code></pre>
16868+
</div>
16869+
</div>
16870+
<h2>Scopes</h2>
16871+
<table>
16872+
16873+
<tr>
16874+
<td>accounting.transactions</td>
16875+
<td>Grant read-write access to bank transactions, credit notes, invoices, repeating invoices</td>
16876+
</tr>
16877+
16878+
</table>
16879+
<h2>Parameters</h2>
16880+
<div class="methodsubtabletitle">Path parameters</div>
16881+
<table id="methodsubtable">
16882+
<tr>
16883+
<th width="150px">Name</th>
16884+
<th>Description</th>
16885+
</tr>
16886+
<tr><td style="width:150px;">BatchPaymentID<span style="color:red;">*</span></td>
16887+
<td>
16888+
16889+
16890+
<div id="d2e199_deleteBatchPaymentByUrlParam_batchPaymentID">
16891+
<div class="json-schema-view">
16892+
<div class="primitive">
16893+
<span class="type">
16894+
UUID
16895+
</span>
16896+
<span class="format">
16897+
(uuid)
16898+
</span>
16899+
16900+
<div class="inner description marked">
16901+
Unique identifier for BatchPayment
16902+
</div>
16903+
</div>
16904+
<div class="inner required">
16905+
Required
16906+
</div>
16907+
</div>
16908+
</div>
16909+
</td>
16910+
</tr>
16911+
16912+
</table>
16913+
<div class="methodsubtabletitle">Header parameters</div>
16914+
<table id="methodsubtable">
16915+
<tr>
16916+
<th width="150px">Name</th>
16917+
<th>Description</th>
16918+
</tr>
16919+
<tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td>
16920+
<td>
16921+
16922+
16923+
<div id="d2e199_deleteBatchPaymentByUrlParam_xeroTenantId">
16924+
<div class="json-schema-view">
16925+
<div class="primitive">
16926+
<span class="type">
16927+
String
16928+
</span>
16929+
16930+
<div class="inner description marked">
16931+
Xero identifier for Tenant
16932+
</div>
16933+
</div>
16934+
<div class="inner required">
16935+
Required
16936+
</div>
16937+
</div>
16938+
</div>
16939+
</td>
16940+
</tr>
16941+
16942+
</table>
16943+
<div class="methodsubtabletitle">Body parameters</div>
16944+
<table id="methodsubtable">
16945+
<tr>
16946+
<th width="150px">Name</th>
16947+
<th>Description</th>
16948+
</tr>
16949+
<tr>
16950+
<td style="width:150px;">batchPaymentDeleteByUrlParam <span style="color:red;">*</span></td>
16951+
<td>
16952+
<div class="json-schema-view">
16953+
<div class="primitive">
16954+
<span class="type">
16955+
BatchPaymentDeleteByUrlParam
16956+
</span>
16957+
<div class="inner description marked">
16958+
16959+
</div>
16960+
</div>
16961+
<div class="inner required">
16962+
Required
16963+
</div>
16964+
</div>
16965+
<script type="application/ld+json">
16966+
{
16967+
"content" : {
16968+
"application/json" : {
16969+
"schema" : {
16970+
"$ref" : "#/components/schemas/BatchPaymentDeleteByUrlParam"
16971+
},
16972+
"example" : "{ \"Status\":\"DELETED\" }"
16973+
}
16974+
},
16975+
"required" : true
16976+
}
16977+
</script>
16978+
</table>
16979+
</article>
16980+
</div>
16981+
<hr>
1664416982
<div id="api-Accounting-deleteContactGroupContact">
1664516983
<article id="api-Accounting-deleteContactGroupContact-0" data-group="User" data-name="deleteContactGroupContact" data-version="0">
1664616984
<div class="pull-left">

‎docs/v4/appstore/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1137,7 +1137,7 @@
11371137
<nav id="scrollingNav">
11381138
<ul class="sidenav nav nav-list">
11391139
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
1140-
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.19.0</li>
1140+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.20.0</li>
11411141
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
11421142
<li data-group="AppStore" data-name="getSubscription" class="">
11431143
<a href="#api-AppStore-getSubscription">getSubscription</a>

‎docs/v4/assets/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1388,7 +1388,7 @@
13881388
<nav id="scrollingNav">
13891389
<ul class="sidenav nav nav-list">
13901390
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
1391-
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.19.0</li>
1391+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.20.0</li>
13921392
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
13931393
<li data-group="Asset" data-name="createAsset" class="">
13941394
<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
@@ -1129,7 +1129,7 @@
11291129
<nav id="scrollingNav">
11301130
<ul class="sidenav nav nav-list">
11311131
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
1132-
<li class="nav-header" data-group="Files"><strong>VSN: </strong>4.19.0</li>
1132+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>4.20.0</li>
11331133
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
11341134
<li data-group="Files" data-name="createFileAssociation" class="">
11351135
<a href="#api-Files-createFileAssociation">createFileAssociation</a>

0 commit comments

Comments
 (0)