Skip to content

Commit c6e87bd

Browse files
rdemarco-xerordemarco-xero
authored
Merge pull request #315 from XeroAPI/update-to-XeroAPI-v2_23
update sdk to latest spec version
2 parents 7c74dba + 09917cb commit c6e87bd

File tree

25 files changed

+767
-133
lines changed

25 files changed

+767
-133
lines changed

‎docs/v4/accounting/index.html

Lines changed: 173 additions & 13 deletions
Large diffs are not rendered by default.

‎docs/v4/appstore/index.html

Lines changed: 2 additions & 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.17.0</li>
1140+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.18.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>
@@ -1197,6 +1197,7 @@ <h3>Usage and SDK Samples</h3>
11971197

11981198
apiInstance = AccountingApi.getInstance(defaultClient);
11991199
UUID subscriptionId = UUID.fromString("00000000-0000-0000-0000-000000000000");
1200+
UUID subscriptionId = '00000000-0000-0000-0000-000000000000';
12001201

12011202
try {
12021203
Subscription result = apiInstance.getSubscription(accessToken, subscriptionId);

‎docs/v4/assets/index.html

Lines changed: 2 additions & 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.17.0</li>
1391+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.18.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>
@@ -1737,6 +1737,7 @@ <h3>Usage and SDK Samples</h3>
17371737
apiInstance = AccountingApi.getInstance(defaultClient);
17381738
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
17391739
UUID id = UUID.fromString("00000000-0000-0000-0000-000000000000");
1740+
UUID id = '00000000-0000-0000-0000-000000000000';
17401741

17411742
try {
17421743
Asset result = apiInstance.getAssetById(accessToken, xeroTenantId, id);

‎docs/v4/files/index.html

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1013,28 +1013,6 @@
10131013
"type" : "string",
10141014
"description" : "The Object Type",
10151015
"enum" : [ "Unknown", "Accpay", "AccPayCredit", "AccPayPayment", "AccRec", "AccRecCredit", "AccRecPayment", "Adjustment", "ApCreditPayment", "ApOverPayment", "ApOverPaymentPayment", "ApOverPaymentSourcePayment", "ApPrepayment", "ApPrepaymentPayment", "ApPrepaymentSourcePayment", "ArCreditPayment", "ArOverPayment", "ArOverpaymentPayment", "ArOverpaymentSourcePayment", "ArPrepayment", "ArPrepaymentPayment", "ArPrepaymentSourcePayment", "CashPaid", "CashRec", "ExpPayment", "ManJournal", "PurchaseOrder", "Receipt", "Transfer", "Account", "Contact", "Business", "Employee", "Person", "User", "Org", "FixedAsset", "PayRun", "PriceListItem", "Bank", "Current", "Equity", "Expense", "Fixed", "Liability", "Prepayment", "Revenue", "Sales", "Overheads", "Depreciatn", "OtherIncome", "DirectCosts", "Currliab", "Termliab", "NonCurrent", "SalesQuote" ]
1016-
};
1017-
defs["UploadObject"] = {
1018-
"title" : "",
1019-
"required" : [ "body", "filename", "name" ],
1020-
"type" : "object",
1021-
"properties" : {
1022-
"body" : {
1023-
"type" : "string",
1024-
"format" : "byte"
1025-
},
1026-
"name" : {
1027-
"type" : "string",
1028-
"description" : "exact name of the file you are uploading"
1029-
},
1030-
"filename" : {
1031-
"type" : "string"
1032-
},
1033-
"mimeType" : {
1034-
"type" : "string"
1035-
}
1036-
},
1037-
"description" : ""
10381016
};
10391017
defs["User"] = {
10401018
"title" : "",
@@ -1151,7 +1129,7 @@
11511129
<nav id="scrollingNav">
11521130
<ul class="sidenav nav nav-list">
11531131
<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.17.0</li>
1132+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>4.18.0</li>
11551133
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
11561134
<li data-group="Files" data-name="createFileAssociation" class="">
11571135
<a href="#api-Files-createFileAssociation">createFileAssociation</a>
@@ -1260,6 +1238,7 @@ <h3>Usage and SDK Samples</h3>
12601238
apiInstance = AccountingApi.getInstance(defaultClient);
12611239
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
12621240
UUID fileId = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
1241+
UUID fileId = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
12631242

12641243
try {
12651244
Association result = apiInstance.createFileAssociation(accessToken, xeroTenantId, fileId, association);
@@ -1542,6 +1521,7 @@ <h3>Usage and SDK Samples</h3>
15421521
apiInstance = AccountingApi.getInstance(defaultClient);
15431522
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
15441523
UUID fileId = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
1524+
UUID fileId = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
15451525

15461526
try {
15471527
result = apiInstance.deleteFile(accessToken, xeroTenantId, fileId);
@@ -1667,7 +1647,9 @@ <h3>Usage and SDK Samples</h3>
16671647
apiInstance = AccountingApi.getInstance(defaultClient);
16681648
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
16691649
UUID fileId = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
1650+
UUID fileId = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
16701651
UUID objectId = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
1652+
UUID objectId = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
16711653

16721654
try {
16731655
result = apiInstance.deleteFileAssociation(accessToken, xeroTenantId, fileId, objectId);
@@ -1819,6 +1801,7 @@ <h3>Usage and SDK Samples</h3>
18191801
apiInstance = AccountingApi.getInstance(defaultClient);
18201802
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
18211803
UUID folderId = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
1804+
UUID folderId = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
18221805

18231806
try {
18241807
result = apiInstance.deleteFolder(accessToken, xeroTenantId, folderId);
@@ -1944,6 +1927,7 @@ <h3>Usage and SDK Samples</h3>
19441927
apiInstance = AccountingApi.getInstance(defaultClient);
19451928
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
19461929
UUID objectId = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
1930+
UUID objectId = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
19471931

19481932
try {
19491933
array[Association] result = apiInstance.getAssociationsByObject(accessToken, xeroTenantId, objectId);
@@ -2075,6 +2059,7 @@ <h3>Usage and SDK Samples</h3>
20752059
apiInstance = AccountingApi.getInstance(defaultClient);
20762060
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
20772061
UUID fileId = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
2062+
UUID fileId = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
20782063

20792064
try {
20802065
FileObject result = apiInstance.getFile(accessToken, xeroTenantId, fileId);
@@ -2206,6 +2191,7 @@ <h3>Usage and SDK Samples</h3>
22062191
apiInstance = AccountingApi.getInstance(defaultClient);
22072192
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
22082193
UUID fileId = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
2194+
UUID fileId = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
22092195

22102196
try {
22112197
array[Association] result = apiInstance.getFileAssociations(accessToken, xeroTenantId, fileId);
@@ -2337,6 +2323,7 @@ <h3>Usage and SDK Samples</h3>
23372323
apiInstance = AccountingApi.getInstance(defaultClient);
23382324
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
23392325
UUID fileId = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
2326+
UUID fileId = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
23402327

23412328
try {
23422329
ByteArrayInputStream result = apiInstance.getFileContent(accessToken, xeroTenantId, fileId);
@@ -2635,6 +2622,7 @@ <h3>Usage and SDK Samples</h3>
26352622
apiInstance = AccountingApi.getInstance(defaultClient);
26362623
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
26372624
UUID folderId = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
2625+
UUID folderId = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
26382626

26392627
try {
26402628
Folder result = apiInstance.getFolder(accessToken, xeroTenantId, folderId);
@@ -2988,6 +2976,7 @@ <h3>Usage and SDK Samples</h3>
29882976
apiInstance = AccountingApi.getInstance(defaultClient);
29892977
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
29902978
UUID fileId = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
2979+
UUID fileId = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
29912980

29922981
try {
29932982
FileObject result = apiInstance.updateFile(accessToken, xeroTenantId, fileId, fileObject);
@@ -3146,6 +3135,7 @@ <h3>Usage and SDK Samples</h3>
31463135
apiInstance = AccountingApi.getInstance(defaultClient);
31473136
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
31483137
UUID folderId = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
3138+
UUID folderId = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
31493139

31503140
try {
31513141
Folder result = apiInstance.updateFolder(accessToken, xeroTenantId, folderId, folder);
@@ -3503,6 +3493,7 @@ <h3>Usage and SDK Samples</h3>
35033493
apiInstance = AccountingApi.getInstance(defaultClient);
35043494
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
35053495
UUID folderId = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
3496+
UUID folderId = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
35063497
byte[] body = BYTE_ARRAY_DATA_HERE;
35073498
String name = 'name_example';
35083499
String filename = 'filename_example';

‎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.17.0</li>
2717+
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.18.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 & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2572,6 +2572,7 @@
25722572
};
25732573
defs["Settings_TrackingCategories"] = {
25742574
"title" : "",
2575+
"type" : "object",
25752576
"properties" : {
25762577
"EmployeeGroups" : {
25772578
"$ref" : "#/components/schemas/Settings_TrackingCategories_EmployeeGroups"
@@ -2584,6 +2585,7 @@
25842585
};
25852586
defs["Settings_TrackingCategories_EmployeeGroups"] = {
25862587
"title" : "",
2588+
"type" : "object",
25872589
"properties" : {
25882590
"TrackingCategoryID" : {
25892591
"type" : "string",
@@ -2600,6 +2602,7 @@
26002602
};
26012603
defs["Settings_TrackingCategories_TimesheetCategories"] = {
26022604
"title" : "",
2605+
"type" : "object",
26032606
"properties" : {
26042607
"TrackingCategoryID" : {
26052608
"type" : "string",
@@ -3250,7 +3253,7 @@
32503253
<nav id="scrollingNav">
32513254
<ul class="sidenav nav nav-list">
32523255
<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.17.0</li>
3256+
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>4.18.0</li>
32543257
<li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
32553258
<li data-group="PayrollAu" data-name="createEmployee" class="">
32563259
<a href="#api-PayrollAu-createEmployee">createEmployee</a>
@@ -4398,6 +4401,7 @@ <h3>Usage and SDK Samples</h3>
43984401
apiInstance = AccountingApi.getInstance(defaultClient);
43994402
String xeroTenantId = 'xeroTenantId_example';
44004403
UUID employeeID = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
4404+
UUID employeeID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
44014405

44024406
try {
44034407
Employees result = apiInstance.getEmployee(accessToken, xeroTenantId, employeeID);
@@ -4721,6 +4725,7 @@ <h3>Usage and SDK Samples</h3>
47214725
apiInstance = AccountingApi.getInstance(defaultClient);
47224726
String xeroTenantId = 'xeroTenantId_example';
47234727
UUID leaveApplicationID = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
4728+
UUID leaveApplicationID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
47244729

47254730
try {
47264731
LeaveApplications result = apiInstance.getLeaveApplication(accessToken, xeroTenantId, leaveApplicationID);
@@ -5236,6 +5241,7 @@ <h3>Usage and SDK Samples</h3>
52365241
apiInstance = AccountingApi.getInstance(defaultClient);
52375242
String xeroTenantId = 'xeroTenantId_example';
52385243
UUID payRunID = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
5244+
UUID payRunID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
52395245

52405246
try {
52415247
PayRuns result = apiInstance.getPayRun(accessToken, xeroTenantId, payRunID);
@@ -5559,6 +5565,7 @@ <h3>Usage and SDK Samples</h3>
55595565
apiInstance = AccountingApi.getInstance(defaultClient);
55605566
String xeroTenantId = 'xeroTenantId_example';
55615567
UUID payrollCalendarID = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
5568+
UUID payrollCalendarID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
55625569

55635570
try {
55645571
PayrollCalendars result = apiInstance.getPayrollCalendar(accessToken, xeroTenantId, payrollCalendarID);
@@ -5882,6 +5889,7 @@ <h3>Usage and SDK Samples</h3>
58825889
apiInstance = AccountingApi.getInstance(defaultClient);
58835890
String xeroTenantId = 'xeroTenantId_example';
58845891
UUID payslipID = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
5892+
UUID payslipID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
58855893

58865894
try {
58875895
PayslipObject result = apiInstance.getPayslip(accessToken, xeroTenantId, payslipID);
@@ -6110,6 +6118,7 @@ <h3>Usage and SDK Samples</h3>
61106118
apiInstance = AccountingApi.getInstance(defaultClient);
61116119
String xeroTenantId = 'xeroTenantId_example';
61126120
UUID superFundID = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
6121+
UUID superFundID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
61136122

61146123
try {
61156124
SuperFunds result = apiInstance.getSuperfund(accessToken, xeroTenantId, superFundID);
@@ -6579,6 +6588,7 @@ <h3>Usage and SDK Samples</h3>
65796588
apiInstance = AccountingApi.getInstance(defaultClient);
65806589
String xeroTenantId = 'xeroTenantId_example';
65816590
UUID timesheetID = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
6591+
UUID timesheetID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
65826592

65836593
try {
65846594
TimesheetObject result = apiInstance.getTimesheet(accessToken, xeroTenantId, timesheetID);
@@ -6902,6 +6912,7 @@ <h3>Usage and SDK Samples</h3>
69026912
apiInstance = AccountingApi.getInstance(defaultClient);
69036913
String xeroTenantId = 'xeroTenantId_example';
69046914
UUID employeeID = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
6915+
UUID employeeID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
69056916
LocalDate dateOfBirth = LocalDate.of(2000, Month.OCTOBER, 28);
69066917

69076918
HomeAddress homeAddress = new HomeAddress();
@@ -7076,6 +7087,7 @@ <h3>Usage and SDK Samples</h3>
70767087
apiInstance = AccountingApi.getInstance(defaultClient);
70777088
String xeroTenantId = 'xeroTenantId_example';
70787089
UUID leaveApplicationID = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
7090+
UUID leaveApplicationID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
70797091
LocalDate startDate = LocalDate.of(2020, Month.OCTOBER, 28);
70807092
LocalDate endDate = LocalDate.of(2020, Month.OCTOBER, 30);
70817093

@@ -7250,6 +7262,7 @@ <h3>Usage and SDK Samples</h3>
72507262
apiInstance = AccountingApi.getInstance(defaultClient);
72517263
String xeroTenantId = 'xeroTenantId_example';
72527264
UUID payRunID = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
7265+
UUID payRunID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
72537266

72547267
PayRun payRun = new PayRun();
72557268
payRun.setPayrollCalendarID(UUID.fromString("00000000-0000-0000-0000-000000000000"));
@@ -7414,6 +7427,7 @@ <h3>Usage and SDK Samples</h3>
74147427
apiInstance = AccountingApi.getInstance(defaultClient);
74157428
String xeroTenantId = 'xeroTenantId_example';
74167429
UUID payslipID = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
7430+
UUID payslipID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
74177431

74187432
EarningsLine earningsLine = new EarningsLine();
74197433
earningsLine.setEarningsRateID(UUID.fromString("00000000-0000-0000-0000-000000000000"));
@@ -7589,6 +7603,7 @@ <h3>Usage and SDK Samples</h3>
75897603
apiInstance = AccountingApi.getInstance(defaultClient);
75907604
String xeroTenantId = 'xeroTenantId_example';
75917605
UUID superFundID = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
7606+
UUID superFundID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
75927607

75937608
SuperFund superFund = new SuperFund();
75947609
superfund.setType(com.xero.models.payrollau.SuperFundType.REGULATED);
@@ -7754,6 +7769,7 @@ <h3>Usage and SDK Samples</h3>
77547769
apiInstance = AccountingApi.getInstance(defaultClient);
77557770
String xeroTenantId = 'xeroTenantId_example';
77567771
UUID timesheetID = UUID.fromString("4ff1e5cc-9835-40d5-bb18-09fdb118db9c");
7772+
UUID timesheetID = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c';
77577773
LocalDate startDate = LocalDate.of(2020, Month.OCTOBER, 23);
77587774
LocalDate endDate = LocalDate.of(2020, Month.OCTOBER, 30);
77597775

0 commit comments

Comments
 (0)