Skip to content

Commit a4bdf13

Browse files
rdemarco-xerordemarco-xero
authored
Merge pull request #321 from XeroAPI/update-to-XeroAPI-v2_28
Update to xero api v2 28
2 parents c0b1e90 + 4a14532 commit a4bdf13

File tree

24 files changed

+466
-43
lines changed

24 files changed

+466
-43
lines changed

‎docs/v4/accounting/index.html

Lines changed: 138 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4052,7 +4052,7 @@
40524052
"Class" : {
40534053
"type" : "string",
40544054
"description" : "Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)",
4055-
"enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE" ]
4055+
"enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE", "LITE" ]
40564056
},
40574057
"Edition" : {
40584058
"type" : "string",
@@ -6065,7 +6065,7 @@
60656065
<nav id="scrollingNav">
60666066
<ul class="sidenav nav nav-list">
60676067
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
6068-
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.20.0</li>
6068+
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.21.0</li>
60696069
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
60706070
<li data-group="Accounting" data-name="createAccount" class="">
60716071
<a href="#api-Accounting-createAccount">createAccount</a>
@@ -6319,6 +6319,9 @@
63196319
<li data-group="Accounting" data-name="getBankTransfers" class="">
63206320
<a href="#api-Accounting-getBankTransfers">getBankTransfers</a>
63216321
</li>
6322+
<li data-group="Accounting" data-name="getBatchPayment" class="">
6323+
<a href="#api-Accounting-getBatchPayment">getBatchPayment</a>
6324+
</li>
63226325
<li data-group="Accounting" data-name="getBatchPaymentHistory" class="">
63236326
<a href="#api-Accounting-getBatchPaymentHistory">getBatchPaymentHistory</a>
63246327
</li>
@@ -20848,6 +20851,138 @@ <h2>Parameters</h2>
2084820851
</div>
2084920852
</div>
2085020853
</td>
20854+
</tr>
20855+
20856+
</table>
20857+
</article>
20858+
</div>
20859+
<hr>
20860+
<div id="api-Accounting-getBatchPayment">
20861+
<article id="api-Accounting-getBatchPayment-0" data-group="User" data-name="getBatchPayment" data-version="0">
20862+
<div class="pull-left">
20863+
<h1>getBatchPayment</h1>
20864+
<p>Retrieves a specific batch payment using a unique batch payment Id</p>
20865+
</div>
20866+
<div class="pull-right"></div>
20867+
<div class="clearfix"></div>
20868+
<p></p>
20869+
<p class="marked"></p>
20870+
<p></p>
20871+
<br />
20872+
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/BatchPayments/{BatchPaymentID}</span></code></pre>
20873+
<p>
20874+
<h3>Usage and SDK Samples</h3>
20875+
</p>
20876+
<ul class="nav nav-tabs nav-tabs-examples">
20877+
<li class=""><a href="#examples-Accounting-getBatchPayment-0-java">Java</a></li>
20878+
</ul>
20879+
<div class="tab-content">
20880+
<div class="tab-pane" id="examples-Accounting-getBatchPayment-0-java">
20881+
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.*;
20882+
import org.openapitools.client.api.client.AccountingApi;
20883+
import org.openapitools.client.models.accounting.*;
20884+
20885+
import java.io.File;
20886+
import java.util.*;
20887+
20888+
public class AccountingApiExample {
20889+
private AccountingApi apiInstance;
20890+
20891+
public static void main(String[] args) {
20892+
String accessToken = "YOUR_ACCESS_TOKEN";
20893+
ApiClient defaultClient = new ApiClient();
20894+
20895+
apiInstance = AccountingApi.getInstance(defaultClient);
20896+
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
20897+
UUID batchPaymentID = UUID.fromString("00000000-0000-0000-0000-000000000000");
20898+
UUID batchPaymentID = '00000000-0000-0000-0000-000000000000';
20899+
20900+
try {
20901+
BatchPayments result = apiInstance.getBatchPayment(accessToken, xeroTenantId, batchPaymentID);
20902+
System.out.println(result);
20903+
} catch (XeroException e) {
20904+
System.err.println("Exception when calling AccountingApi#getBatchPayment");
20905+
e.printStackTrace();
20906+
}
20907+
}
20908+
}</code></pre>
20909+
</div>
20910+
</div>
20911+
<h2>Scopes</h2>
20912+
<table>
20913+
20914+
<tr>
20915+
<td>accounting.transactions</td>
20916+
<td>Grant read-write access to bank transactions, credit notes, invoices, repeating invoices</td>
20917+
</tr>
20918+
20919+
<tr>
20920+
<td>accounting.transactions.read</td>
20921+
<td>Grant read-only access to invoices</td>
20922+
</tr>
20923+
20924+
</table>
20925+
<h2>Parameters</h2>
20926+
<div class="methodsubtabletitle">Path parameters</div>
20927+
<table id="methodsubtable">
20928+
<tr>
20929+
<th width="150px">Name</th>
20930+
<th>Description</th>
20931+
</tr>
20932+
<tr><td style="width:150px;">BatchPaymentID<span style="color:red;">*</span></td>
20933+
<td>
20934+
20935+
20936+
<div id="d2e199_getBatchPayment_batchPaymentID">
20937+
<div class="json-schema-view">
20938+
<div class="primitive">
20939+
<span class="type">
20940+
UUID
20941+
</span>
20942+
<span class="format">
20943+
(uuid)
20944+
</span>
20945+
20946+
<div class="inner description marked">
20947+
Unique identifier for BatchPayment
20948+
</div>
20949+
</div>
20950+
<div class="inner required">
20951+
Required
20952+
</div>
20953+
</div>
20954+
</div>
20955+
</td>
20956+
</tr>
20957+
20958+
</table>
20959+
<div class="methodsubtabletitle">Header parameters</div>
20960+
<table id="methodsubtable">
20961+
<tr>
20962+
<th width="150px">Name</th>
20963+
<th>Description</th>
20964+
</tr>
20965+
<tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td>
20966+
<td>
20967+
20968+
20969+
<div id="d2e199_getBatchPayment_xeroTenantId">
20970+
<div class="json-schema-view">
20971+
<div class="primitive">
20972+
<span class="type">
20973+
String
20974+
</span>
20975+
20976+
<div class="inner description marked">
20977+
Xero identifier for Tenant
20978+
</div>
20979+
</div>
20980+
<div class="inner required">
20981+
Required
20982+
</div>
20983+
</div>
20984+
</div>
20985+
</td>
2085120986
</tr>
2085220987

2085320988
</table>
@@ -23199,7 +23334,7 @@ <h3>Usage and SDK Samples</h3>
2319923334
Integer page = 1;
2320023335
Boolean includeArchived = true;
2320123336
Boolean summaryOnly = true;
23202-
String searchTerm = 'searchTerm=Joe Bloggs';
23337+
String searchTerm = 'Joe Bloggs';
2320323338

2320423339
try {
2320523340
Contacts result = apiInstance.getContacts(accessToken, xeroTenantId, ifModifiedSince, where, order, iDs, page, includeArchived, summaryOnly, searchTerm);

‎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.20.0</li>
1140+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.21.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.20.0</li>
1391+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.21.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.20.0</li>
1132+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>4.21.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>

‎docs/v4/finance/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2714,7 +2714,7 @@
27142714
<nav id="scrollingNav">
27152715
<ul class="sidenav nav nav-list">
27162716
<li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
2717-
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.20.0</li>
2717+
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.21.0</li>
27182718
<li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
27192719
<li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
27202720
<a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>

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

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1292,7 +1292,7 @@
12921292
},
12931293
"Gender" : {
12941294
"type" : "string",
1295-
"description" : "The employee’s gender. See Employee Gender",
1295+
"description" : "The employee’s gender. See Employee Gender",
12961296
"example" : "F",
12971297
"enum" : [ "N", "M", "F", "I" ]
12981298
},
@@ -1626,6 +1626,13 @@
16261626
}
16271627
},
16281628
"description" : ""
1629+
};
1630+
defs["LeaveCategoryCode"] = {
1631+
"title" : "",
1632+
"type" : "string",
1633+
"description" : "Code used to identify the Leave Category",
1634+
"example" : "ANNUALLEAVE",
1635+
"enum" : [ "ANNUALLEAVE", "LONGSERVICELEAVE", "PERSONALCARERSLEAVE", "ROSTEREDDAYOFF", "TIMEOFFINLIEU", "COMPASSIONATEANDBEREAVEMENTLEAVE", "STUDYLEAVE", "FAMILYANDDOMESTICVIOLENCELEAVE", "SPECIALPAIDLEAVE", "COMMUNITYSERVICELEAVE", "JURYDUTYLEAVE", "DEFENCERESERVELEAVE" ]
16291636
};
16301637
defs["LeaveEarningsLine"] = {
16311638
"title" : "",
@@ -1811,6 +1818,14 @@
18111818
"type" : "boolean",
18121819
"description" : "Is the current record",
18131820
"example" : true
1821+
},
1822+
"LeaveCategoryCode" : {
1823+
"$ref" : "#/components/schemas/LeaveCategoryCode"
1824+
},
1825+
"SGCExempt" : {
1826+
"type" : "boolean",
1827+
"description" : "Set this to indicate that the leave type is exempt from superannuation guarantee contribution",
1828+
"example" : true
18141829
}
18151830
},
18161831
"description" : ""
@@ -3258,7 +3273,7 @@
32583273
<nav id="scrollingNav">
32593274
<ul class="sidenav nav nav-list">
32603275
<li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
3261-
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>4.20.0</li>
3276+
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>4.21.0</li>
32623277
<li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
32633278
<li data-group="PayrollAu" data-name="createEmployee" class="">
32643279
<a href="#api-PayrollAu-createEmployee">createEmployee</a>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3834,7 +3834,7 @@
38343834
<nav id="scrollingNav">
38353835
<ul class="sidenav nav nav-list">
38363836
<li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
3837-
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>4.20.0</li>
3837+
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>4.21.0</li>
38383838
<li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
38393839
<li data-group="PayrollNz" data-name="approveTimesheet" class="">
38403840
<a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>

‎docs/v4/payroll-uk/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3506,7 +3506,7 @@
35063506
<nav id="scrollingNav">
35073507
<ul class="sidenav nav nav-list">
35083508
<li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
3509-
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>4.20.0</li>
3509+
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>4.21.0</li>
35103510
<li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
35113511
<li data-group="PayrollUk" data-name="approveTimesheet" class="">
35123512
<a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>

‎pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<artifactId>xero-java</artifactId>
66
<packaging>jar</packaging>
77
<name>xero-java</name>
8-
<version>4.20.0</version>
8+
<version>4.21.0</version>
99
<url>https://github.com/XeroAPI/Xero-Java</url>
1010
<description>This is the official Java SDK for Xero API</description>
1111
<licenses>

0 commit comments

Comments
 (0)