Skip to content

Commit

Permalink
Merge pull request #321 from XeroAPI/update-to-XeroAPI-v2_28
Browse files Browse the repository at this point in the history 
Update to xero api v2 28
  • Loading branch information
@rdemarco-xero
rdemarco-xero authored Sep 1, 2022
2 parents c0b1e90 + 4a14532 commit a4bdf13
Show file tree
Hide file tree
Showing 24 changed files with 466 additions and 43 deletions.
141 changes: 138 additions & 3 deletions docs/v4/accounting/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4052,7 +4052,7 @@
"Class" : {
"type" : "string",
"description" : "Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)",
"enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE" ]
"enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE", "LITE" ]
},
"Edition" : {
"type" : "string",
Expand Down Expand Up @@ -6065,7 +6065,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>4.20.0</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.21.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 @@ -6319,6 +6319,9 @@
<li data-group="Accounting" data-name="getBankTransfers" class="">
<a href="#api-Accounting-getBankTransfers">getBankTransfers</a>
</li>
<li data-group="Accounting" data-name="getBatchPayment" class="">
<a href="#api-Accounting-getBatchPayment">getBatchPayment</a>
</li>
<li data-group="Accounting" data-name="getBatchPaymentHistory" class="">
<a href="#api-Accounting-getBatchPaymentHistory">getBatchPaymentHistory</a>
</li>
Expand Down Expand Up @@ -20848,6 +20851,138 @@ <h2>Parameters</h2>
</div>
</div>
</td>
</tr>

</table>
</article>
</div>
<hr>
<div id="api-Accounting-getBatchPayment">
<article id="api-Accounting-getBatchPayment-0" data-group="User" data-name="getBatchPayment" data-version="0">
<div class="pull-left">
<h1>getBatchPayment</h1>
<p>Retrieves a specific batch payment using a unique batch payment Id</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="get"><code><span class="pln">/BatchPayments/{BatchPaymentID}</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class=""><a href="#examples-Accounting-getBatchPayment-0-java">Java</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane" id="examples-Accounting-getBatchPayment-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.*;
import org.openapitools.client.api.client.AccountingApi;
import org.openapitools.client.models.accounting.*;

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

public class AccountingApiExample {
private AccountingApi apiInstance;

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

apiInstance = AccountingApi.getInstance(defaultClient);
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
UUID batchPaymentID = UUID.fromString("00000000-0000-0000-0000-000000000000");
UUID batchPaymentID = '00000000-0000-0000-0000-000000000000';

try {
BatchPayments result = apiInstance.getBatchPayment(accessToken, xeroTenantId, batchPaymentID);
System.out.println(result);
} catch (XeroException e) {
System.err.println("Exception when calling AccountingApi#getBatchPayment");
e.printStackTrace();
}
}
}</code></pre>
</div>
</div>
<h2>Scopes</h2>
<table>

<tr>
<td>accounting.transactions</td>
<td>Grant read-write access to bank transactions, credit notes, invoices, repeating invoices</td>
</tr>

<tr>
<td>accounting.transactions.read</td>
<td>Grant read-only access to invoices</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;">BatchPaymentID<span style="color:red;">*</span></td>
<td>


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

<div class="inner description marked">
Unique identifier for BatchPayment
</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_getBatchPayment_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>

</table>
Expand Down Expand Up @@ -23199,7 +23334,7 @@ <h3>Usage and SDK Samples</h3>
Integer page = 1;
Boolean includeArchived = true;
Boolean summaryOnly = true;
String searchTerm = 'searchTerm=Joe Bloggs';
String searchTerm = 'Joe Bloggs';

try {
Contacts result = apiInstance.getContacts(accessToken, xeroTenantId, ifModifiedSince, where, order, iDs, page, includeArchived, summaryOnly, searchTerm);
Expand Down
2 changes: 1 addition & 1 deletion docs/v4/appstore/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1137,7 +1137,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>4.20.0</li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.21.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
2 changes: 1 addition & 1 deletion docs/v4/assets/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1388,7 +1388,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>4.20.0</li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.21.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
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1129,7 +1129,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>4.20.0</li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>4.21.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
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2714,7 +2714,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>4.20.0</li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.21.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
19 changes: 17 additions & 2 deletions docs/v4/payroll-au/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1292,7 +1292,7 @@
},
"Gender" : {
"type" : "string",
"description" : "The employee’s gender. See Employee Gender",
"description" : "The employee’s gender. See Employee Gender",
"example" : "F",
"enum" : [ "N", "M", "F", "I" ]
},
Expand Down Expand Up @@ -1626,6 +1626,13 @@
}
},
"description" : ""
};
defs["LeaveCategoryCode"] = {
"title" : "",
"type" : "string",
"description" : "Code used to identify the Leave Category",
"example" : "ANNUALLEAVE",
"enum" : [ "ANNUALLEAVE", "LONGSERVICELEAVE", "PERSONALCARERSLEAVE", "ROSTEREDDAYOFF", "TIMEOFFINLIEU", "COMPASSIONATEANDBEREAVEMENTLEAVE", "STUDYLEAVE", "FAMILYANDDOMESTICVIOLENCELEAVE", "SPECIALPAIDLEAVE", "COMMUNITYSERVICELEAVE", "JURYDUTYLEAVE", "DEFENCERESERVELEAVE" ]
};
defs["LeaveEarningsLine"] = {
"title" : "",
Expand Down Expand Up @@ -1811,6 +1818,14 @@
"type" : "boolean",
"description" : "Is the current record",
"example" : true
},
"LeaveCategoryCode" : {
"$ref" : "#/components/schemas/LeaveCategoryCode"
},
"SGCExempt" : {
"type" : "boolean",
"description" : "Set this to indicate that the leave type is exempt from superannuation guarantee contribution",
"example" : true
}
},
"description" : ""
Expand Down Expand Up @@ -3258,7 +3273,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>4.20.0</li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>4.21.0</li>
<li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
<li data-group="PayrollAu" data-name="createEmployee" class="">
<a href="#api-PayrollAu-createEmployee">createEmployee</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/v4/payroll-nz/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3834,7 +3834,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>4.20.0</li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>4.21.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
2 changes: 1 addition & 1 deletion docs/v4/payroll-uk/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3506,7 +3506,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>4.20.0</li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>4.21.0</li>
<li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
<li data-group="PayrollUk" data-name="approveTimesheet" class="">
<a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<artifactId>xero-java</artifactId>
<packaging>jar</packaging>
<name>xero-java</name>
<version>4.20.0</version>
<version>4.21.0</version>
<url>https://github.com/XeroAPI/Xero-Java</url>
<description>This is the official Java SDK for Xero API</description>
<licenses>
Expand Down
Loading

0 comments on commit a4bdf13

Please sign in to comment.