-
Notifications
You must be signed in to change notification settings - Fork 89
/
Copy pathFinanceApi.java
1974 lines (1927 loc) · 85.8 KB
/
FinanceApi.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Xero Finance API
* The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
*
* The version of the OpenAPI document: 6.3.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.xero.api.client;
import com.fasterxml.jackson.core.type.TypeReference;
import com.google.api.client.auth.oauth2.BearerToken;
import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.http.GenericUrl;
import com.google.api.client.http.HttpContent;
import com.google.api.client.http.HttpHeaders;
import com.google.api.client.http.HttpMethods;
import com.google.api.client.http.HttpRequestFactory;
import com.google.api.client.http.HttpResponse;
import com.google.api.client.http.HttpResponseException;
import com.google.api.client.http.HttpTransport;
import com.xero.api.ApiClient;
import com.xero.api.XeroApiExceptionHandler;
import com.xero.models.finance.AccountUsageResponse;
import com.xero.models.finance.BalanceSheetResponse;
import com.xero.models.finance.BankStatementAccountingResponse;
import com.xero.models.finance.CashValidationResponse;
import com.xero.models.finance.CashflowResponse;
import com.xero.models.finance.IncomeByContactResponse;
import com.xero.models.finance.LockHistoryResponse;
import com.xero.models.finance.ProfitAndLossResponse;
import com.xero.models.finance.ReportHistoryResponse;
import com.xero.models.finance.TrialBalanceResponse;
import com.xero.models.finance.UserActivitiesResponse;
import jakarta.ws.rs.core.UriBuilder;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.UUID;
import org.apache.commons.io.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/** FinanceApi has methods for interacting with all endpoints in the API set */
public class FinanceApi {
private ApiClient apiClient;
private static FinanceApi instance = null;
private String userAgent = "Default";
private String version = "8.3.0";
static final Logger logger = LoggerFactory.getLogger(FinanceApi.class);
/** FinanceApi */
public FinanceApi() {
this(new ApiClient());
}
/**
* FinanceApi getInstance
*
* @param apiClient ApiClient pass into the new instance of this class
* @return instance of this class
*/
public static FinanceApi getInstance(ApiClient apiClient) {
if (instance == null) {
instance = new FinanceApi(apiClient);
}
return instance;
}
/**
* FinanceApi
*
* @param apiClient ApiClient pass into the new instance of this class
*/
public FinanceApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* get ApiClient
*
* @return apiClient the current ApiClient
*/
public ApiClient getApiClient() {
return apiClient;
}
/**
* set ApiClient
*
* @param apiClient ApiClient pass into the new instance of this class
*/
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* set user agent
*
* @param userAgent string to override the user agent
*/
public void setUserAgent(String userAgent) {
this.userAgent = userAgent;
}
/**
* get user agent
*
* @return String of user agent
*/
public String getUserAgent() {
return this.userAgent + " [Xero-Java-" + this.version + "]";
}
/**
* Get account usage A summary of how each account is being transacted on exposing the level of
* detail and amounts attributable to manual adjustments.
*
* <p><b>200</b> - Success
*
* <p><b>400</b> - BadRequest
*
* @param xeroTenantId Xero identifier for Tenant
* @param startMonth date, yyyy-MM If no parameter is provided, the month 12 months prior to the
* end month will be used. Account usage for up to 12 months from this date will be returned.
* @param endMonth date, yyyy-MM If no parameter is provided, the current month will be used.
* Account usage for up to 12 months prior to this date will be returned.
* @param accessToken Authorization token for user set in header of each request
* @return AccountUsageResponse
* @throws IOException if an error occurs while attempting to invoke the API *
*/
public AccountUsageResponse getAccountingActivityAccountUsage(
String accessToken, String xeroTenantId, String startMonth, String endMonth)
throws IOException {
try {
TypeReference<AccountUsageResponse> typeRef = new TypeReference<AccountUsageResponse>() {};
HttpResponse response =
getAccountingActivityAccountUsageForHttpResponse(
accessToken, xeroTenantId, startMonth, endMonth);
return apiClient.getObjectMapper().readValue(response.getContent(), typeRef);
} catch (HttpResponseException e) {
if (logger.isDebugEnabled()) {
logger.debug(
"------------------ HttpResponseException "
+ e.getStatusCode()
+ " : getAccountingActivityAccountUsage -------------------");
logger.debug(e.toString());
}
XeroApiExceptionHandler handler = new XeroApiExceptionHandler();
handler.execute(e);
} catch (IOException ioe) {
throw ioe;
}
return null;
}
/**
* Get account usage A summary of how each account is being transacted on exposing the level of
* detail and amounts attributable to manual adjustments.
*
* <p><b>200</b> - Success
*
* <p><b>400</b> - BadRequest
*
* @param xeroTenantId Xero identifier for Tenant
* @param startMonth date, yyyy-MM If no parameter is provided, the month 12 months prior to the
* end month will be used. Account usage for up to 12 months from this date will be returned.
* @param endMonth date, yyyy-MM If no parameter is provided, the current month will be used.
* Account usage for up to 12 months prior to this date will be returned.
* @param accessToken Authorization token for user set in header of each request
* @return HttpResponse
* @throws IOException if an error occurs while attempting to invoke the API
*/
public HttpResponse getAccountingActivityAccountUsageForHttpResponse(
String accessToken, String xeroTenantId, String startMonth, String endMonth)
throws IOException {
// verify the required parameter 'xeroTenantId' is set
if (xeroTenantId == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'xeroTenantId' when calling"
+ " getAccountingActivityAccountUsage");
}
if (accessToken == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'accessToken' when calling"
+ " getAccountingActivityAccountUsage");
}
HttpHeaders headers = new HttpHeaders();
headers.set("xero-tenant-id", xeroTenantId);
headers.setAccept("application/json");
headers.setUserAgent(this.getUserAgent());
UriBuilder uriBuilder =
UriBuilder.fromUri(apiClient.getBasePath() + "/AccountingActivities/AccountUsage");
if (startMonth != null) {
String key = "startMonth";
Object value = startMonth;
if (value instanceof Collection) {
List valueList = new ArrayList<>((Collection) value);
if (!valueList.isEmpty() && valueList.get(0) instanceof UUID) {
List<String> list = new ArrayList<String>();
for (int i = 0; i < valueList.size(); i++) {
list.add(valueList.get(i).toString());
}
uriBuilder = uriBuilder.queryParam(key, String.join(",", list));
} else {
uriBuilder = uriBuilder.queryParam(key, String.join(",", valueList));
}
} else if (value instanceof Object[]) {
uriBuilder = uriBuilder.queryParam(key, (Object[]) value);
} else {
uriBuilder = uriBuilder.queryParam(key, value);
}
}
if (endMonth != null) {
String key = "endMonth";
Object value = endMonth;
if (value instanceof Collection) {
List valueList = new ArrayList<>((Collection) value);
if (!valueList.isEmpty() && valueList.get(0) instanceof UUID) {
List<String> list = new ArrayList<String>();
for (int i = 0; i < valueList.size(); i++) {
list.add(valueList.get(i).toString());
}
uriBuilder = uriBuilder.queryParam(key, String.join(",", list));
} else {
uriBuilder = uriBuilder.queryParam(key, String.join(",", valueList));
}
} else if (value instanceof Object[]) {
uriBuilder = uriBuilder.queryParam(key, (Object[]) value);
} else {
uriBuilder = uriBuilder.queryParam(key, value);
}
}
String url = uriBuilder.build().toString();
GenericUrl genericUrl = new GenericUrl(url);
if (logger.isDebugEnabled()) {
logger.debug("GET " + genericUrl.toString());
}
HttpContent content = null;
Credential credential =
new Credential(BearerToken.authorizationHeaderAccessMethod()).setAccessToken(accessToken);
HttpTransport transport = apiClient.getHttpTransport();
HttpRequestFactory requestFactory = transport.createRequestFactory(credential);
return requestFactory
.buildRequest(HttpMethods.GET, genericUrl, content)
.setHeaders(headers)
.setConnectTimeout(apiClient.getConnectionTimeout())
.setReadTimeout(apiClient.getReadTimeout())
.execute();
}
/**
* Get lock history Provides a history of locking of accounting books. Locking may be an indicator
* of good accounting practices that could reduce the risk of changes to accounting records in
* prior periods.
*
* <p><b>200</b> - Success
*
* <p><b>400</b> - BadRequest
*
* @param xeroTenantId Xero identifier for Tenant
* @param endDate date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any
* changes to hard or soft lock dates that were made within the period up to 12 months before
* this date will be returned. Please be aware that there may be a delay of up to 3 days
* before a change is visible from this API.
* @param accessToken Authorization token for user set in header of each request
* @return LockHistoryResponse
* @throws IOException if an error occurs while attempting to invoke the API *
*/
public LockHistoryResponse getAccountingActivityLockHistory(
String accessToken, String xeroTenantId, String endDate) throws IOException {
try {
TypeReference<LockHistoryResponse> typeRef = new TypeReference<LockHistoryResponse>() {};
HttpResponse response =
getAccountingActivityLockHistoryForHttpResponse(accessToken, xeroTenantId, endDate);
return apiClient.getObjectMapper().readValue(response.getContent(), typeRef);
} catch (HttpResponseException e) {
if (logger.isDebugEnabled()) {
logger.debug(
"------------------ HttpResponseException "
+ e.getStatusCode()
+ " : getAccountingActivityLockHistory -------------------");
logger.debug(e.toString());
}
XeroApiExceptionHandler handler = new XeroApiExceptionHandler();
handler.execute(e);
} catch (IOException ioe) {
throw ioe;
}
return null;
}
/**
* Get lock history Provides a history of locking of accounting books. Locking may be an indicator
* of good accounting practices that could reduce the risk of changes to accounting records in
* prior periods.
*
* <p><b>200</b> - Success
*
* <p><b>400</b> - BadRequest
*
* @param xeroTenantId Xero identifier for Tenant
* @param endDate date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any
* changes to hard or soft lock dates that were made within the period up to 12 months before
* this date will be returned. Please be aware that there may be a delay of up to 3 days
* before a change is visible from this API.
* @param accessToken Authorization token for user set in header of each request
* @return HttpResponse
* @throws IOException if an error occurs while attempting to invoke the API
*/
public HttpResponse getAccountingActivityLockHistoryForHttpResponse(
String accessToken, String xeroTenantId, String endDate) throws IOException {
// verify the required parameter 'xeroTenantId' is set
if (xeroTenantId == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'xeroTenantId' when calling"
+ " getAccountingActivityLockHistory");
}
if (accessToken == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'accessToken' when calling"
+ " getAccountingActivityLockHistory");
}
HttpHeaders headers = new HttpHeaders();
headers.set("xero-tenant-id", xeroTenantId);
headers.setAccept("application/json");
headers.setUserAgent(this.getUserAgent());
UriBuilder uriBuilder =
UriBuilder.fromUri(apiClient.getBasePath() + "/AccountingActivities/LockHistory");
if (endDate != null) {
String key = "endDate";
Object value = endDate;
if (value instanceof Collection) {
List valueList = new ArrayList<>((Collection) value);
if (!valueList.isEmpty() && valueList.get(0) instanceof UUID) {
List<String> list = new ArrayList<String>();
for (int i = 0; i < valueList.size(); i++) {
list.add(valueList.get(i).toString());
}
uriBuilder = uriBuilder.queryParam(key, String.join(",", list));
} else {
uriBuilder = uriBuilder.queryParam(key, String.join(",", valueList));
}
} else if (value instanceof Object[]) {
uriBuilder = uriBuilder.queryParam(key, (Object[]) value);
} else {
uriBuilder = uriBuilder.queryParam(key, value);
}
}
String url = uriBuilder.build().toString();
GenericUrl genericUrl = new GenericUrl(url);
if (logger.isDebugEnabled()) {
logger.debug("GET " + genericUrl.toString());
}
HttpContent content = null;
Credential credential =
new Credential(BearerToken.authorizationHeaderAccessMethod()).setAccessToken(accessToken);
HttpTransport transport = apiClient.getHttpTransport();
HttpRequestFactory requestFactory = transport.createRequestFactory(credential);
return requestFactory
.buildRequest(HttpMethods.GET, genericUrl, content)
.setHeaders(headers)
.setConnectTimeout(apiClient.getConnectionTimeout())
.setReadTimeout(apiClient.getReadTimeout())
.execute();
}
/**
* Get report history For a specified organisation, provides a summary of all the reports
* published within a given period, which may be an indicator for good business management and
* oversight.
*
* <p><b>200</b> - Success
*
* <p><b>400</b> - BadRequest
*
* @param xeroTenantId Xero identifier for Tenant
* @param endDate date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any
* reports that were published within the period up to 12 months before this date will be
* returned. Please be aware that there may be a delay of up to 3 days before a published
* report is visible from this API.
* @param accessToken Authorization token for user set in header of each request
* @return ReportHistoryResponse
* @throws IOException if an error occurs while attempting to invoke the API *
*/
public ReportHistoryResponse getAccountingActivityReportHistory(
String accessToken, String xeroTenantId, String endDate) throws IOException {
try {
TypeReference<ReportHistoryResponse> typeRef = new TypeReference<ReportHistoryResponse>() {};
HttpResponse response =
getAccountingActivityReportHistoryForHttpResponse(accessToken, xeroTenantId, endDate);
return apiClient.getObjectMapper().readValue(response.getContent(), typeRef);
} catch (HttpResponseException e) {
if (logger.isDebugEnabled()) {
logger.debug(
"------------------ HttpResponseException "
+ e.getStatusCode()
+ " : getAccountingActivityReportHistory -------------------");
logger.debug(e.toString());
}
XeroApiExceptionHandler handler = new XeroApiExceptionHandler();
handler.execute(e);
} catch (IOException ioe) {
throw ioe;
}
return null;
}
/**
* Get report history For a specified organisation, provides a summary of all the reports
* published within a given period, which may be an indicator for good business management and
* oversight.
*
* <p><b>200</b> - Success
*
* <p><b>400</b> - BadRequest
*
* @param xeroTenantId Xero identifier for Tenant
* @param endDate date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any
* reports that were published within the period up to 12 months before this date will be
* returned. Please be aware that there may be a delay of up to 3 days before a published
* report is visible from this API.
* @param accessToken Authorization token for user set in header of each request
* @return HttpResponse
* @throws IOException if an error occurs while attempting to invoke the API
*/
public HttpResponse getAccountingActivityReportHistoryForHttpResponse(
String accessToken, String xeroTenantId, String endDate) throws IOException {
// verify the required parameter 'xeroTenantId' is set
if (xeroTenantId == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'xeroTenantId' when calling"
+ " getAccountingActivityReportHistory");
}
if (accessToken == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'accessToken' when calling"
+ " getAccountingActivityReportHistory");
}
HttpHeaders headers = new HttpHeaders();
headers.set("xero-tenant-id", xeroTenantId);
headers.setAccept("application/json");
headers.setUserAgent(this.getUserAgent());
UriBuilder uriBuilder =
UriBuilder.fromUri(apiClient.getBasePath() + "/AccountingActivities/ReportHistory");
if (endDate != null) {
String key = "endDate";
Object value = endDate;
if (value instanceof Collection) {
List valueList = new ArrayList<>((Collection) value);
if (!valueList.isEmpty() && valueList.get(0) instanceof UUID) {
List<String> list = new ArrayList<String>();
for (int i = 0; i < valueList.size(); i++) {
list.add(valueList.get(i).toString());
}
uriBuilder = uriBuilder.queryParam(key, String.join(",", list));
} else {
uriBuilder = uriBuilder.queryParam(key, String.join(",", valueList));
}
} else if (value instanceof Object[]) {
uriBuilder = uriBuilder.queryParam(key, (Object[]) value);
} else {
uriBuilder = uriBuilder.queryParam(key, value);
}
}
String url = uriBuilder.build().toString();
GenericUrl genericUrl = new GenericUrl(url);
if (logger.isDebugEnabled()) {
logger.debug("GET " + genericUrl.toString());
}
HttpContent content = null;
Credential credential =
new Credential(BearerToken.authorizationHeaderAccessMethod()).setAccessToken(accessToken);
HttpTransport transport = apiClient.getHttpTransport();
HttpRequestFactory requestFactory = transport.createRequestFactory(credential);
return requestFactory
.buildRequest(HttpMethods.GET, genericUrl, content)
.setHeaders(headers)
.setConnectTimeout(apiClient.getConnectionTimeout())
.setReadTimeout(apiClient.getReadTimeout())
.execute();
}
/**
* Get user activities For a specified organisation, provides a list of all the users registered,
* and a history of their accounting transactions. Also identifies the existence of an external
* accounting advisor and the level of interaction.
*
* <p><b>200</b> - Success
*
* <p><b>400</b> - BadRequest
*
* @param xeroTenantId Xero identifier for Tenant
* @param dataMonth date, yyyy-MM The specified month must be complete (in the past); The current
* month cannot be specified since it is not complete. If no parameter is provided, the month
* immediately previous to the current month will be used. Any user activities occurring
* within the specified month will be returned. Please be aware that there may be a delay of
* up to 3 days before a user activity is visible from this API.
* @param accessToken Authorization token for user set in header of each request
* @return UserActivitiesResponse
* @throws IOException if an error occurs while attempting to invoke the API *
*/
public UserActivitiesResponse getAccountingActivityUserActivities(
String accessToken, String xeroTenantId, String dataMonth) throws IOException {
try {
TypeReference<UserActivitiesResponse> typeRef =
new TypeReference<UserActivitiesResponse>() {};
HttpResponse response =
getAccountingActivityUserActivitiesForHttpResponse(accessToken, xeroTenantId, dataMonth);
return apiClient.getObjectMapper().readValue(response.getContent(), typeRef);
} catch (HttpResponseException e) {
if (logger.isDebugEnabled()) {
logger.debug(
"------------------ HttpResponseException "
+ e.getStatusCode()
+ " : getAccountingActivityUserActivities -------------------");
logger.debug(e.toString());
}
XeroApiExceptionHandler handler = new XeroApiExceptionHandler();
handler.execute(e);
} catch (IOException ioe) {
throw ioe;
}
return null;
}
/**
* Get user activities For a specified organisation, provides a list of all the users registered,
* and a history of their accounting transactions. Also identifies the existence of an external
* accounting advisor and the level of interaction.
*
* <p><b>200</b> - Success
*
* <p><b>400</b> - BadRequest
*
* @param xeroTenantId Xero identifier for Tenant
* @param dataMonth date, yyyy-MM The specified month must be complete (in the past); The current
* month cannot be specified since it is not complete. If no parameter is provided, the month
* immediately previous to the current month will be used. Any user activities occurring
* within the specified month will be returned. Please be aware that there may be a delay of
* up to 3 days before a user activity is visible from this API.
* @param accessToken Authorization token for user set in header of each request
* @return HttpResponse
* @throws IOException if an error occurs while attempting to invoke the API
*/
public HttpResponse getAccountingActivityUserActivitiesForHttpResponse(
String accessToken, String xeroTenantId, String dataMonth) throws IOException {
// verify the required parameter 'xeroTenantId' is set
if (xeroTenantId == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'xeroTenantId' when calling"
+ " getAccountingActivityUserActivities");
}
if (accessToken == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'accessToken' when calling"
+ " getAccountingActivityUserActivities");
}
HttpHeaders headers = new HttpHeaders();
headers.set("xero-tenant-id", xeroTenantId);
headers.setAccept("application/json");
headers.setUserAgent(this.getUserAgent());
UriBuilder uriBuilder =
UriBuilder.fromUri(apiClient.getBasePath() + "/AccountingActivities/UserActivities");
if (dataMonth != null) {
String key = "dataMonth";
Object value = dataMonth;
if (value instanceof Collection) {
List valueList = new ArrayList<>((Collection) value);
if (!valueList.isEmpty() && valueList.get(0) instanceof UUID) {
List<String> list = new ArrayList<String>();
for (int i = 0; i < valueList.size(); i++) {
list.add(valueList.get(i).toString());
}
uriBuilder = uriBuilder.queryParam(key, String.join(",", list));
} else {
uriBuilder = uriBuilder.queryParam(key, String.join(",", valueList));
}
} else if (value instanceof Object[]) {
uriBuilder = uriBuilder.queryParam(key, (Object[]) value);
} else {
uriBuilder = uriBuilder.queryParam(key, value);
}
}
String url = uriBuilder.build().toString();
GenericUrl genericUrl = new GenericUrl(url);
if (logger.isDebugEnabled()) {
logger.debug("GET " + genericUrl.toString());
}
HttpContent content = null;
Credential credential =
new Credential(BearerToken.authorizationHeaderAccessMethod()).setAccessToken(accessToken);
HttpTransport transport = apiClient.getHttpTransport();
HttpRequestFactory requestFactory = transport.createRequestFactory(credential);
return requestFactory
.buildRequest(HttpMethods.GET, genericUrl, content)
.setHeaders(headers)
.setConnectTimeout(apiClient.getConnectionTimeout())
.setReadTimeout(apiClient.getReadTimeout())
.execute();
}
/**
* Get Bank Statement Accounting For lenders that prefer using bank statement data as the source
* of truth. We provide a data point that will allow access to customer bank statements, plus for
* reconciled bank transactions the matching accounting, invoice and billing data as well. As
* customers reconcile bank statements to invoices and bills, this transaction detail will provide
* valuable insight for lender's assessment measures.
*
* <p><b>200</b> - Success
*
* <p><b>400</b> - BadRequest
*
* @param xeroTenantId Xero identifier for Tenant
* @param bankAccountID string, GUID Bank account Id
* @param fromDate date, yyyy-MM-dd Specifies the start date of the query period. The maximum
* range of the query period is 12 months. If the specified query period is more than 12
* months the request will be rejected.
* @param toDate date, yyyy-MM-dd Specifies the end date of the query period. If the end date is a
* future date, the request will be rejected.
* @param summaryOnly boolean, true/false The default value is true if no parameter is provided.
* In summary mode, the response will exclude the computation-heavy LineItems fields from bank
* transaction, invoice, credit note, prepayment and overpayment data, making the API calls
* quicker and more efficient.
* @param accessToken Authorization token for user set in header of each request
* @return BankStatementAccountingResponse
* @throws IOException if an error occurs while attempting to invoke the API *
*/
public BankStatementAccountingResponse getBankStatementAccounting(
String accessToken,
String xeroTenantId,
UUID bankAccountID,
String fromDate,
String toDate,
Boolean summaryOnly)
throws IOException {
try {
TypeReference<BankStatementAccountingResponse> typeRef =
new TypeReference<BankStatementAccountingResponse>() {};
HttpResponse response =
getBankStatementAccountingForHttpResponse(
accessToken, xeroTenantId, bankAccountID, fromDate, toDate, summaryOnly);
return apiClient.getObjectMapper().readValue(response.getContent(), typeRef);
} catch (HttpResponseException e) {
if (logger.isDebugEnabled()) {
logger.debug(
"------------------ HttpResponseException "
+ e.getStatusCode()
+ " : getBankStatementAccounting -------------------");
logger.debug(e.toString());
}
XeroApiExceptionHandler handler = new XeroApiExceptionHandler();
handler.execute(e);
} catch (IOException ioe) {
throw ioe;
}
return null;
}
/**
* Get Bank Statement Accounting For lenders that prefer using bank statement data as the source
* of truth. We provide a data point that will allow access to customer bank statements, plus for
* reconciled bank transactions the matching accounting, invoice and billing data as well. As
* customers reconcile bank statements to invoices and bills, this transaction detail will provide
* valuable insight for lender's assessment measures.
*
* <p><b>200</b> - Success
*
* <p><b>400</b> - BadRequest
*
* @param xeroTenantId Xero identifier for Tenant
* @param bankAccountID string, GUID Bank account Id
* @param fromDate date, yyyy-MM-dd Specifies the start date of the query period. The maximum
* range of the query period is 12 months. If the specified query period is more than 12
* months the request will be rejected.
* @param toDate date, yyyy-MM-dd Specifies the end date of the query period. If the end date is a
* future date, the request will be rejected.
* @param summaryOnly boolean, true/false The default value is true if no parameter is provided.
* In summary mode, the response will exclude the computation-heavy LineItems fields from bank
* transaction, invoice, credit note, prepayment and overpayment data, making the API calls
* quicker and more efficient.
* @param accessToken Authorization token for user set in header of each request
* @return HttpResponse
* @throws IOException if an error occurs while attempting to invoke the API
*/
public HttpResponse getBankStatementAccountingForHttpResponse(
String accessToken,
String xeroTenantId,
UUID bankAccountID,
String fromDate,
String toDate,
Boolean summaryOnly)
throws IOException {
// verify the required parameter 'xeroTenantId' is set
if (xeroTenantId == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'xeroTenantId' when calling getBankStatementAccounting");
} // verify the required parameter 'bankAccountID' is set
if (bankAccountID == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'bankAccountID' when calling getBankStatementAccounting");
} // verify the required parameter 'fromDate' is set
if (fromDate == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'fromDate' when calling getBankStatementAccounting");
} // verify the required parameter 'toDate' is set
if (toDate == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'toDate' when calling getBankStatementAccounting");
}
if (accessToken == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'accessToken' when calling getBankStatementAccounting");
}
HttpHeaders headers = new HttpHeaders();
headers.set("xero-tenant-id", xeroTenantId);
headers.setAccept("application/json");
headers.setUserAgent(this.getUserAgent());
UriBuilder uriBuilder =
UriBuilder.fromUri(apiClient.getBasePath() + "/BankStatementsPlus/statements");
if (bankAccountID != null) {
String key = "BankAccountID";
Object value = bankAccountID;
if (value instanceof Collection) {
List valueList = new ArrayList<>((Collection) value);
if (!valueList.isEmpty() && valueList.get(0) instanceof UUID) {
List<String> list = new ArrayList<String>();
for (int i = 0; i < valueList.size(); i++) {
list.add(valueList.get(i).toString());
}
uriBuilder = uriBuilder.queryParam(key, String.join(",", list));
} else {
uriBuilder = uriBuilder.queryParam(key, String.join(",", valueList));
}
} else if (value instanceof Object[]) {
uriBuilder = uriBuilder.queryParam(key, (Object[]) value);
} else {
uriBuilder = uriBuilder.queryParam(key, value);
}
}
if (fromDate != null) {
String key = "FromDate";
Object value = fromDate;
if (value instanceof Collection) {
List valueList = new ArrayList<>((Collection) value);
if (!valueList.isEmpty() && valueList.get(0) instanceof UUID) {
List<String> list = new ArrayList<String>();
for (int i = 0; i < valueList.size(); i++) {
list.add(valueList.get(i).toString());
}
uriBuilder = uriBuilder.queryParam(key, String.join(",", list));
} else {
uriBuilder = uriBuilder.queryParam(key, String.join(",", valueList));
}
} else if (value instanceof Object[]) {
uriBuilder = uriBuilder.queryParam(key, (Object[]) value);
} else {
uriBuilder = uriBuilder.queryParam(key, value);
}
}
if (toDate != null) {
String key = "ToDate";
Object value = toDate;
if (value instanceof Collection) {
List valueList = new ArrayList<>((Collection) value);
if (!valueList.isEmpty() && valueList.get(0) instanceof UUID) {
List<String> list = new ArrayList<String>();
for (int i = 0; i < valueList.size(); i++) {
list.add(valueList.get(i).toString());
}
uriBuilder = uriBuilder.queryParam(key, String.join(",", list));
} else {
uriBuilder = uriBuilder.queryParam(key, String.join(",", valueList));
}
} else if (value instanceof Object[]) {
uriBuilder = uriBuilder.queryParam(key, (Object[]) value);
} else {
uriBuilder = uriBuilder.queryParam(key, value);
}
}
if (summaryOnly != null) {
String key = "SummaryOnly";
Object value = summaryOnly;
if (value instanceof Collection) {
List valueList = new ArrayList<>((Collection) value);
if (!valueList.isEmpty() && valueList.get(0) instanceof UUID) {
List<String> list = new ArrayList<String>();
for (int i = 0; i < valueList.size(); i++) {
list.add(valueList.get(i).toString());
}
uriBuilder = uriBuilder.queryParam(key, String.join(",", list));
} else {
uriBuilder = uriBuilder.queryParam(key, String.join(",", valueList));
}
} else if (value instanceof Object[]) {
uriBuilder = uriBuilder.queryParam(key, (Object[]) value);
} else {
uriBuilder = uriBuilder.queryParam(key, value);
}
}
String url = uriBuilder.build().toString();
GenericUrl genericUrl = new GenericUrl(url);
if (logger.isDebugEnabled()) {
logger.debug("GET " + genericUrl.toString());
}
HttpContent content = null;
Credential credential =
new Credential(BearerToken.authorizationHeaderAccessMethod()).setAccessToken(accessToken);
HttpTransport transport = apiClient.getHttpTransport();
HttpRequestFactory requestFactory = transport.createRequestFactory(credential);
return requestFactory
.buildRequest(HttpMethods.GET, genericUrl, content)
.setHeaders(headers)
.setConnectTimeout(apiClient.getConnectionTimeout())
.setReadTimeout(apiClient.getReadTimeout())
.execute();
}
/**
* Get cash validation Summarizes the total cash position for each account for an org
*
* <p><b>200</b> - Success
*
* <p><b>400</b> - BadRequest
*
* @param xeroTenantId Xero identifier for Tenant
* @param balanceDate date, yyyy-MM-dd If no parameter is provided, the current date will be used.
* The ‘balance date’ will return transactions based on the accounting date entered by the
* user. Transactions before the balanceDate will be included. The user has discretion as to
* which accounting period the transaction relates to. The ‘balance date’ will control the
* latest maximum date of transactions included in the aggregate numbers. Balance date does
* not affect the CurrentStatement object, as this will always return the most recent
* statement before asAtSystemDate (if specified)
* @param asAtSystemDate date, yyyy-MM-dd If no parameter is provided, the current date will be
* used. The ‘as at’ date will return transactions based on the creation date. It reflects the
* date the transactions were entered into Xero, not the accounting date. The ‘as at’ date can
* not be overridden by the user. This can be used to estimate a ‘historical frequency of
* reconciliation’. The ‘as at’ date will affect the current statement in the response, as any
* candidate statements created after this date will be filtered out. Thus the current
* statement returned will be the most recent statement prior to the specified ‘as at’ date.
* Be aware that neither the begin date, nor the balance date, will affect the current
* statement. Note; information is only presented when system architecture allows, meaning
* historical cash validation information will be an estimate. In addition, delete events are
* not aware of the ‘as at’ functionality in this endpoint, meaning that transactions deleted
* at the time the API is accessed will be considered to always have been deleted.
* @param beginDate date, yyyy-MM-dd If no parameter is provided, the aggregate results will be
* drawn from the user’s total history. The ‘begin date’ will return transactions based on the
* accounting date entered by the user. Transactions after the beginDate will be included. The
* user has discretion as to which accounting period the transaction relates to.
* @param accessToken Authorization token for user set in header of each request
* @return List<CashValidationResponse>
* @throws IOException if an error occurs while attempting to invoke the API *
*/
public List<CashValidationResponse> getCashValidation(
String accessToken,
String xeroTenantId,
String balanceDate,
String asAtSystemDate,
String beginDate)
throws IOException {
try {
TypeReference<List<CashValidationResponse>> typeRef =
new TypeReference<List<CashValidationResponse>>() {};
HttpResponse response =
getCashValidationForHttpResponse(
accessToken, xeroTenantId, balanceDate, asAtSystemDate, beginDate);
return apiClient.getObjectMapper().readValue(response.getContent(), typeRef);
} catch (HttpResponseException e) {
if (logger.isDebugEnabled()) {
logger.debug(
"------------------ HttpResponseException "
+ e.getStatusCode()
+ " : getCashValidation -------------------");
logger.debug(e.toString());
}
XeroApiExceptionHandler handler = new XeroApiExceptionHandler();
handler.execute(e);
} catch (IOException ioe) {
throw ioe;
}
return null;
}
/**
* Get cash validation Summarizes the total cash position for each account for an org
*
* <p><b>200</b> - Success
*
* <p><b>400</b> - BadRequest
*
* @param xeroTenantId Xero identifier for Tenant
* @param balanceDate date, yyyy-MM-dd If no parameter is provided, the current date will be used.
* The ‘balance date’ will return transactions based on the accounting date entered by the
* user. Transactions before the balanceDate will be included. The user has discretion as to
* which accounting period the transaction relates to. The ‘balance date’ will control the
* latest maximum date of transactions included in the aggregate numbers. Balance date does
* not affect the CurrentStatement object, as this will always return the most recent
* statement before asAtSystemDate (if specified)
* @param asAtSystemDate date, yyyy-MM-dd If no parameter is provided, the current date will be
* used. The ‘as at’ date will return transactions based on the creation date. It reflects the
* date the transactions were entered into Xero, not the accounting date. The ‘as at’ date can
* not be overridden by the user. This can be used to estimate a ‘historical frequency of
* reconciliation’. The ‘as at’ date will affect the current statement in the response, as any
* candidate statements created after this date will be filtered out. Thus the current
* statement returned will be the most recent statement prior to the specified ‘as at’ date.
* Be aware that neither the begin date, nor the balance date, will affect the current
* statement. Note; information is only presented when system architecture allows, meaning
* historical cash validation information will be an estimate. In addition, delete events are
* not aware of the ‘as at’ functionality in this endpoint, meaning that transactions deleted
* at the time the API is accessed will be considered to always have been deleted.
* @param beginDate date, yyyy-MM-dd If no parameter is provided, the aggregate results will be
* drawn from the user’s total history. The ‘begin date’ will return transactions based on the
* accounting date entered by the user. Transactions after the beginDate will be included. The
* user has discretion as to which accounting period the transaction relates to.
* @param accessToken Authorization token for user set in header of each request
* @return HttpResponse
* @throws IOException if an error occurs while attempting to invoke the API
*/
public HttpResponse getCashValidationForHttpResponse(
String accessToken,
String xeroTenantId,
String balanceDate,
String asAtSystemDate,
String beginDate)
throws IOException {
// verify the required parameter 'xeroTenantId' is set
if (xeroTenantId == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'xeroTenantId' when calling getCashValidation");
}
if (accessToken == null) {
throw new IllegalArgumentException(
"Missing the required parameter 'accessToken' when calling getCashValidation");
}
HttpHeaders headers = new HttpHeaders();
headers.set("xero-tenant-id", xeroTenantId);
headers.setAccept("application/json");
headers.setUserAgent(this.getUserAgent());
UriBuilder uriBuilder = UriBuilder.fromUri(apiClient.getBasePath() + "/CashValidation");
if (balanceDate != null) {
String key = "balanceDate";
Object value = balanceDate;
if (value instanceof Collection) {
List valueList = new ArrayList<>((Collection) value);
if (!valueList.isEmpty() && valueList.get(0) instanceof UUID) {
List<String> list = new ArrayList<String>();
for (int i = 0; i < valueList.size(); i++) {
list.add(valueList.get(i).toString());
}
uriBuilder = uriBuilder.queryParam(key, String.join(",", list));
} else {
uriBuilder = uriBuilder.queryParam(key, String.join(",", valueList));
}
} else if (value instanceof Object[]) {
uriBuilder = uriBuilder.queryParam(key, (Object[]) value);
} else {
uriBuilder = uriBuilder.queryParam(key, value);
}
}
if (asAtSystemDate != null) {
String key = "asAtSystemDate";
Object value = asAtSystemDate;
if (value instanceof Collection) {
List valueList = new ArrayList<>((Collection) value);
if (!valueList.isEmpty() && valueList.get(0) instanceof UUID) {
List<String> list = new ArrayList<String>();
for (int i = 0; i < valueList.size(); i++) {
list.add(valueList.get(i).toString());
}
uriBuilder = uriBuilder.queryParam(key, String.join(",", list));
} else {
uriBuilder = uriBuilder.queryParam(key, String.join(",", valueList));
}
} else if (value instanceof Object[]) {
uriBuilder = uriBuilder.queryParam(key, (Object[]) value);
} else {
uriBuilder = uriBuilder.queryParam(key, value);
}
}
if (beginDate != null) {
String key = "beginDate";
Object value = beginDate;
if (value instanceof Collection) {
List valueList = new ArrayList<>((Collection) value);
if (!valueList.isEmpty() && valueList.get(0) instanceof UUID) {
List<String> list = new ArrayList<String>();
for (int i = 0; i < valueList.size(); i++) {
list.add(valueList.get(i).toString());