Skip to content

Commit 487d7cb

Browse files
rdemarco-xerordemarco-xero
authored
Merge pull request #310 from XeroAPI/minor-spec-updates
minor updates to finance, payrollUK, and appStore apis
2 parents b702661 + ebf902b commit 487d7cb

File tree

25 files changed

+550
-83
lines changed

25 files changed

+550
-83
lines changed

‎docs/v4/accounting/index.html

Lines changed: 128 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6004,7 +6004,7 @@
60046004
<nav id="scrollingNav">
60056005
<ul class="sidenav nav nav-list">
60066006
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
6007-
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.15.1</li>
6007+
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.16.0</li>
60086008
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
60096009
<li data-group="Accounting" data-name="createAccount" class="">
60106010
<a href="#api-Accounting-createAccount">createAccount</a>
@@ -6375,6 +6375,9 @@
63756375
<li data-group="Accounting" data-name="getJournal" class="">
63766376
<a href="#api-Accounting-getJournal">getJournal</a>
63776377
</li>
6378+
<li data-group="Accounting" data-name="getJournalByNumber" class="">
6379+
<a href="#api-Accounting-getJournalByNumber">getJournalByNumber</a>
6380+
</li>
63786381
<li data-group="Accounting" data-name="getJournals" class="">
63796382
<a href="#api-Accounting-getJournals">getJournals</a>
63806383
</li>
@@ -9419,7 +9422,7 @@ <h2>Parameters</h2>
94199422
"schema" : {
94209423
"$ref" : "#/components/schemas/Contacts"
94219424
},
9422-
"example" : "{ \"Id\": \"e997d6d7-6dad-4458-beb8-d9c1bf7f2edf\", \"Status\": \"OK\", \"ProviderName\": \"Xero API Partner\", \"DateTimeUTC\": \"/Date(1551399321121)/\", \"Contacts\": [ { \"ContactID\": \"3ff6d40c-af9a-40a3-89ce-3c1556a25591\", \"ContactStatus\": \"ACTIVE\", \"Name\": \"Foo9987\", \"EmailAddress\": \"[email protected]\", \"BankAccountDetails\": \"\", \"Addresses\": [ { \"AddressType\": \"STREET\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" }, { \"AddressType\": \"POBOX\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" } ], \"Phones\": [ { \"PhoneType\": \"DEFAULT\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"DDI\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"FAX\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"MOBILE\", \"PhoneNumber\": \"555-1212\", \"PhoneAreaCode\": \"415\", \"PhoneCountryCode\": \"\" } ], \"UpdatedDateUTC\": \"/Date(1551399321043+0000)/\", \"ContactGroups\": [], \"IsSupplier\": false, \"IsCustomer\": false, \"SalesTrackingCategories\": [], \"PurchasesTrackingCategories\": [], \"PaymentTerms\": { \"Bills\": { \"Day\": 15, \"Type\": \"OFCURRENTMONTH\" }, \"Sales\": { \"Day\": 10, \"Type\": \"DAYSAFTERBILLMONTH\" } }, \"ContactPersons\": [], \"HasValidationErrors\": false } ] }"
9425+
"example" : "{ \"Contacts\": [ { \"ContactID\": \"3ff6d40c-af9a-40a3-89ce-3c1556a25591\", \"ContactStatus\": \"ACTIVE\", \"Name\": \"Foo9987\", \"EmailAddress\": \"[email protected]\", \"BankAccountDetails\": \"\", \"Addresses\": [ { \"AddressType\": \"STREET\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" }, { \"AddressType\": \"POBOX\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" } ], \"Phones\": [ { \"PhoneType\": \"DEFAULT\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"DDI\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"FAX\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"MOBILE\", \"PhoneNumber\": \"555-1212\", \"PhoneAreaCode\": \"415\", \"PhoneCountryCode\": \"\" } ], \"UpdatedDateUTC\": \"/Date(1551399321043+0000)/\", \"ContactGroups\": [], \"IsSupplier\": false, \"IsCustomer\": false, \"SalesTrackingCategories\": [], \"PurchasesTrackingCategories\": [], \"PaymentTerms\": { \"Bills\": { \"Day\": 15, \"Type\": \"OFCURRENTMONTH\" }, \"Sales\": { \"Day\": 10, \"Type\": \"DAYSAFTERBILLMONTH\" } }, \"ContactPersons\": [] } ] }"
94239426
}
94249427
},
94259428
"required" : true
@@ -26824,6 +26827,129 @@ <h2>Parameters</h2>
2682426827
</div>
2682526828
</div>
2682626829
</td>
26830+
</tr>
26831+
26832+
</table>
26833+
</article>
26834+
</div>
26835+
<hr>
26836+
<div id="api-Accounting-getJournalByNumber">
26837+
<article id="api-Accounting-getJournalByNumber-0" data-group="User" data-name="getJournalByNumber" data-version="0">
26838+
<div class="pull-left">
26839+
<h1>getJournalByNumber</h1>
26840+
<p>Retrieves a specific journal using a unique journal number.</p>
26841+
</div>
26842+
<div class="pull-right"></div>
26843+
<div class="clearfix"></div>
26844+
<p></p>
26845+
<p class="marked"></p>
26846+
<p></p>
26847+
<br />
26848+
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Journals/{JournalNumber}</span></code></pre>
26849+
<p>
26850+
<h3>Usage and SDK Samples</h3>
26851+
</p>
26852+
<ul class="nav nav-tabs nav-tabs-examples">
26853+
<li class=""><a href="#examples-Accounting-getJournalByNumber-0-java">Java</a></li>
26854+
</ul>
26855+
<div class="tab-content">
26856+
<div class="tab-pane" id="examples-Accounting-getJournalByNumber-0-java">
26857+
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.*;
26858+
import org.openapitools.client.api.client.AccountingApi;
26859+
import org.openapitools.client.models.accounting.*;
26860+
26861+
import java.io.File;
26862+
import java.util.*;
26863+
26864+
public class AccountingApiExample {
26865+
private AccountingApi apiInstance;
26866+
26867+
public static void main(String[] args) {
26868+
String accessToken = "YOUR_ACCESS_TOKEN";
26869+
ApiClient defaultClient = new ApiClient();
26870+
26871+
apiInstance = AccountingApi.getInstance(defaultClient);
26872+
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
26873+
Integer journalNumber = 1000;
26874+
26875+
try {
26876+
Journals result = apiInstance.getJournalByNumber(accessToken, xeroTenantId, journalNumber);
26877+
System.out.println(result);
26878+
} catch (XeroException e) {
26879+
System.err.println("Exception when calling AccountingApi#getJournalByNumber");
26880+
e.printStackTrace();
26881+
}
26882+
}
26883+
}</code></pre>
26884+
</div>
26885+
</div>
26886+
<h2>Scopes</h2>
26887+
<table>
26888+
26889+
<tr>
26890+
<td>accounting.journals.read</td>
26891+
<td>Grant read-only access to journals</td>
26892+
</tr>
26893+
26894+
</table>
26895+
<h2>Parameters</h2>
26896+
<div class="methodsubtabletitle">Path parameters</div>
26897+
<table id="methodsubtable">
26898+
<tr>
26899+
<th width="150px">Name</th>
26900+
<th>Description</th>
26901+
</tr>
26902+
<tr><td style="width:150px;">JournalNumber<span style="color:red;">*</span></td>
26903+
<td>
26904+
26905+
26906+
<div id="d2e199_getJournalByNumber_journalNumber">
26907+
<div class="json-schema-view">
26908+
<div class="primitive">
26909+
<span class="type">
26910+
Integer
26911+
</span>
26912+
26913+
<div class="inner description marked">
26914+
Number of a Journal
26915+
</div>
26916+
</div>
26917+
<div class="inner required">
26918+
Required
26919+
</div>
26920+
</div>
26921+
</div>
26922+
</td>
26923+
</tr>
26924+
26925+
</table>
26926+
<div class="methodsubtabletitle">Header parameters</div>
26927+
<table id="methodsubtable">
26928+
<tr>
26929+
<th width="150px">Name</th>
26930+
<th>Description</th>
26931+
</tr>
26932+
<tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td>
26933+
<td>
26934+
26935+
26936+
<div id="d2e199_getJournalByNumber_xeroTenantId">
26937+
<div class="json-schema-view">
26938+
<div class="primitive">
26939+
<span class="type">
26940+
String
26941+
</span>
26942+
26943+
<div class="inner description marked">
26944+
Xero identifier for Tenant
26945+
</div>
26946+
</div>
26947+
<div class="inner required">
26948+
Required
26949+
</div>
26950+
</div>
26951+
</div>
26952+
</td>
2682726953
</tr>
2682826954

2682926955
</table>

‎docs/v4/appstore/index.html

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -949,14 +949,18 @@
949949
"type" : "string",
950950
"description" : "The name of the product"
951951
},
952+
"seatUnit" : {
953+
"type" : "string",
954+
"description" : "The unit of the per seat product. e.g. \"user\", \"organisation\", \"SMS\", etc"
955+
},
952956
"type" : {
953957
"type" : "string",
954-
"description" : "The pricing model of the product:\n* FIXED: Customers are charged a fixed amount for each billing period\n* PER_SEAT: Customers are charged based on the number of units they purchase\n",
955-
"enum" : [ "FIXED", "PER_SEAT" ]
958+
"description" : "The pricing model of the product:\n* FIXED: Customers are charged a fixed amount for each billing period\n* PER_SEAT: Customers are charged based on the number of units they purchase\n* METERED: Customers are charged per use of this product\n",
959+
"enum" : [ "FIXED", "PER_SEAT", "METERED" ]
956960
},
957-
"seatUnit" : {
961+
"usageUnit" : {
958962
"type" : "string",
959-
"description" : "The unit of the per seat product. e.g. \"user\", \"organisation\", \"SMS\", etc"
963+
"description" : "The unit of the usage product. e.g. \"user\", \"minutes\", \"SMS\", etc"
960964
}
961965
},
962966
"description" : ""
@@ -1031,6 +1035,10 @@
10311035
"product" : {
10321036
"$ref" : "#/components/schemas/Product"
10331037
},
1038+
"quantity" : {
1039+
"type" : "integer",
1040+
"description" : "The quantity of the item. For a fixed product, it is 1. For a per-seat product, it is a positive integer. For metered products, it is always null."
1041+
},
10341042
"startDate" : {
10351043
"type" : "string",
10361044
"description" : "Date the subscription started, or will start. Note: this could be in\nthe future for downgrades or reduced number of seats that haven't taken effect yet.\n",
@@ -1129,7 +1137,7 @@
11291137
<nav id="scrollingNav">
11301138
<ul class="sidenav nav nav-list">
11311139
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
1132-
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.15.1</li>
1140+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.16.0</li>
11331141
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
11341142
<li data-group="AppStore" data-name="getSubscription" class="">
11351143
<a href="#api-AppStore-getSubscription">getSubscription</a>

‎docs/v4/assets/index.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1007,7 +1007,8 @@
10071007
"example" : 33
10081008
}
10091009
},
1010-
"description" : ""
1010+
"description" : "",
1011+
"x-snake" : "asset_type"
10111012
};
10121013
defs["Assets"] = {
10131014
"title" : "",
@@ -1387,7 +1388,7 @@
13871388
<nav id="scrollingNav">
13881389
<ul class="sidenav nav nav-list">
13891390
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
1390-
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.15.1</li>
1391+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.16.0</li>
13911392
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
13921393
<li data-group="Asset" data-name="createAsset" class="">
13931394
<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
@@ -1151,7 +1151,7 @@
11511151
<nav id="scrollingNav">
11521152
<ul class="sidenav nav nav-list">
11531153
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
1154-
<li class="nav-header" data-group="Files"><strong>VSN: </strong>4.15.1</li>
1154+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>4.16.0</li>
11551155
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
11561156
<li data-group="Files" data-name="createFileAssociation" class="">
11571157
<a href="#api-Files-createFileAssociation">createFileAssociation</a>

‎docs/v4/finance/index.html

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2343,7 +2343,19 @@
23432343
},
23442344
"importSource" : {
23452345
"type" : "string",
2346-
"description" : "Import source of statement (STMTIMPORTSRC/MANUAL, STMTIMPORTSRC/CSV, STMTIMPORTSRC/QIF, STMTIMPORTSRC/OFX, XeroApi)"
2346+
"description" : "Indicates the source of the statement data. Either imported from 1) direct bank feed OR 2) manual customer entry or upload. Manual import sources are STMTIMPORTSRC/MANUAL, STMTIMPORTSRC/CSV, STMTIMPORTSRC/OFX, Ofx or STMTIMPORTSRC/QIF. All other import sources are direct and, depending on the direct solution, may contain the name of the financial institution."
2347+
},
2348+
"startBalance" : {
2349+
"type" : "number",
2350+
"description" : "Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied.",
2351+
"format" : "double",
2352+
"x-is-money" : true
2353+
},
2354+
"endBalance" : {
2355+
"type" : "number",
2356+
"description" : "Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied.",
2357+
"format" : "double",
2358+
"x-is-money" : true
23472359
},
23482360
"statementLines" : {
23492361
"type" : "array",
@@ -2702,7 +2714,7 @@
27022714
<nav id="scrollingNav">
27032715
<ul class="sidenav nav nav-list">
27042716
<li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
2705-
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.15.1</li>
2717+
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.16.0</li>
27062718
<li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
27072719
<li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
27082720
<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
@@ -3250,7 +3250,7 @@
32503250
<nav id="scrollingNav">
32513251
<ul class="sidenav nav nav-list">
32523252
<li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
3253-
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>4.15.1</li>
3253+
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>4.16.0</li>
32543254
<li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
32553255
<li data-group="PayrollAu" data-name="createEmployee" class="">
32563256
<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.15.1</li>
3837+
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>4.16.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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2276,7 +2276,7 @@
22762276
"type" : "string",
22772277
"description" : "The NI Category of the employee",
22782278
"example" : "A",
2279-
"enum" : [ "A", "B", "C", "H", "J", "M", "Z", "X" ]
2279+
"enum" : [ "A", "B", "C", "F", "H", "I", "J", "L", "M", "S", "V", "X", "Z" ]
22802280
}
22812281
},
22822282
"description" : ""
@@ -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.15.1</li>
3509+
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>4.16.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.15.1</version>
8+
<version>4.16.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)