xero-node 4.15.0 → 4.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (214) hide show
  1. package/README.md +2 -1
  2. package/dist/XeroClient.d.ts +1 -0
  3. package/dist/XeroClient.js +2 -0
  4. package/dist/XeroClient.js.map +1 -1
  5. package/dist/gen/api/accountingApi.d.ts +7 -4
  6. package/dist/gen/api/accountingApi.js +17 -5
  7. package/dist/gen/api/accountingApi.js.map +1 -1
  8. package/dist/gen/api/apis.d.ts +3 -1
  9. package/dist/gen/api/apis.js +3 -1
  10. package/dist/gen/api/apis.js.map +1 -1
  11. package/dist/gen/api/appStoreApi.d.ts +1 -1
  12. package/dist/gen/api/appStoreApi.js +2 -2
  13. package/dist/gen/api/assetApi.d.ts +1 -1
  14. package/dist/gen/api/assetApi.js +2 -2
  15. package/dist/gen/api/bankfeedsApi.d.ts +1 -1
  16. package/dist/gen/api/bankfeedsApi.js +2 -2
  17. package/dist/gen/api/filesApi.d.ts +1 -1
  18. package/dist/gen/api/filesApi.js +2 -2
  19. package/dist/gen/api/financeApi.d.ts +209 -0
  20. package/dist/gen/api/financeApi.js +789 -0
  21. package/dist/gen/api/financeApi.js.map +1 -0
  22. package/dist/gen/api/payrollAUApi.d.ts +8 -8
  23. package/dist/gen/api/payrollAUApi.js +9 -9
  24. package/dist/gen/api/payrollAUApi.js.map +1 -1
  25. package/dist/gen/api/payrollNZApi.d.ts +9 -7
  26. package/dist/gen/api/payrollNZApi.js +25 -17
  27. package/dist/gen/api/payrollNZApi.js.map +1 -1
  28. package/dist/gen/api/payrollUKApi.d.ts +7 -3
  29. package/dist/gen/api/payrollUKApi.js +20 -4
  30. package/dist/gen/api/payrollUKApi.js.map +1 -1
  31. package/dist/gen/api/projectApi.d.ts +1 -1
  32. package/dist/gen/api/projectApi.js +2 -2
  33. package/dist/gen/model/accounting/bankTransfer.d.ts +12 -0
  34. package/dist/gen/model/accounting/bankTransfer.js +15 -0
  35. package/dist/gen/model/accounting/bankTransfer.js.map +1 -1
  36. package/dist/gen/model/accounting/contact.d.ts +26 -0
  37. package/dist/gen/model/accounting/contact.js +32 -0
  38. package/dist/gen/model/accounting/contact.js.map +1 -1
  39. package/dist/gen/model/accounting/models.js +2 -0
  40. package/dist/gen/model/accounting/models.js.map +1 -1
  41. package/dist/gen/model/appstore/models.js +2 -0
  42. package/dist/gen/model/appstore/models.js.map +1 -1
  43. package/dist/gen/model/appstore/plan.d.ts +2 -1
  44. package/dist/gen/model/appstore/plan.js +1 -0
  45. package/dist/gen/model/appstore/plan.js.map +1 -1
  46. package/dist/gen/model/appstore/product.d.ts +4 -0
  47. package/dist/gen/model/appstore/product.js +5 -0
  48. package/dist/gen/model/appstore/product.js.map +1 -1
  49. package/dist/gen/model/appstore/subscription.d.ts +8 -1
  50. package/dist/gen/model/appstore/subscription.js +9 -1
  51. package/dist/gen/model/appstore/subscription.js.map +1 -1
  52. package/dist/gen/model/appstore/subscriptionItem.d.ts +11 -0
  53. package/dist/gen/model/appstore/subscriptionItem.js +13 -0
  54. package/dist/gen/model/appstore/subscriptionItem.js.map +1 -1
  55. package/dist/gen/model/files/objectGroup.d.ts +1 -0
  56. package/dist/gen/model/files/objectGroup.js +1 -0
  57. package/dist/gen/model/files/objectGroup.js.map +1 -1
  58. package/dist/gen/model/files/objectType.d.ts +2 -1
  59. package/dist/gen/model/files/objectType.js +1 -0
  60. package/dist/gen/model/files/objectType.js.map +1 -1
  61. package/dist/gen/model/finance/accountUsage.d.ts +65 -0
  62. package/dist/gen/model/finance/accountUsage.js +78 -0
  63. package/dist/gen/model/finance/accountUsage.js.map +1 -0
  64. package/dist/gen/model/finance/accountUsageResponse.d.ts +27 -0
  65. package/dist/gen/model/finance/accountUsageResponse.js +33 -0
  66. package/dist/gen/model/finance/accountUsageResponse.js.map +1 -0
  67. package/dist/gen/model/finance/balanceSheetAccountDetail.d.ts +33 -0
  68. package/dist/gen/model/finance/balanceSheetAccountDetail.js +38 -0
  69. package/dist/gen/model/finance/balanceSheetAccountDetail.js.map +1 -0
  70. package/dist/gen/model/finance/balanceSheetAccountGroup.d.ts +19 -0
  71. package/dist/gen/model/finance/balanceSheetAccountGroup.js +23 -0
  72. package/dist/gen/model/finance/balanceSheetAccountGroup.js.map +1 -0
  73. package/dist/gen/model/finance/balanceSheetAccountType.d.ts +26 -0
  74. package/dist/gen/model/finance/balanceSheetAccountType.js +28 -0
  75. package/dist/gen/model/finance/balanceSheetAccountType.js.map +1 -0
  76. package/dist/gen/model/finance/balanceSheetResponse.d.ts +21 -0
  77. package/dist/gen/model/finance/balanceSheetResponse.js +33 -0
  78. package/dist/gen/model/finance/balanceSheetResponse.js.map +1 -0
  79. package/dist/gen/model/finance/bankStatementResponse.d.ts +17 -0
  80. package/dist/gen/model/finance/bankStatementResponse.js +23 -0
  81. package/dist/gen/model/finance/bankStatementResponse.js.map +1 -0
  82. package/dist/gen/model/finance/cashAccountResponse.d.ts +33 -0
  83. package/dist/gen/model/finance/cashAccountResponse.js +38 -0
  84. package/dist/gen/model/finance/cashAccountResponse.js.map +1 -0
  85. package/dist/gen/model/finance/cashBalance.d.ts +25 -0
  86. package/dist/gen/model/finance/cashBalance.js +28 -0
  87. package/dist/gen/model/finance/cashBalance.js.map +1 -0
  88. package/dist/gen/model/finance/cashValidationResponse.d.ts +27 -0
  89. package/dist/gen/model/finance/cashValidationResponse.js +38 -0
  90. package/dist/gen/model/finance/cashValidationResponse.js.map +1 -0
  91. package/dist/gen/model/finance/cashflowAccount.d.ts +41 -0
  92. package/dist/gen/model/finance/cashflowAccount.js +48 -0
  93. package/dist/gen/model/finance/cashflowAccount.js.map +1 -0
  94. package/dist/gen/model/finance/cashflowActivity.d.ts +23 -0
  95. package/dist/gen/model/finance/cashflowActivity.js +28 -0
  96. package/dist/gen/model/finance/cashflowActivity.js.map +1 -0
  97. package/dist/gen/model/finance/cashflowResponse.d.ts +28 -0
  98. package/dist/gen/model/finance/cashflowResponse.js +33 -0
  99. package/dist/gen/model/finance/cashflowResponse.js.map +1 -0
  100. package/dist/gen/model/finance/cashflowType.d.ts +26 -0
  101. package/dist/gen/model/finance/cashflowType.js +28 -0
  102. package/dist/gen/model/finance/cashflowType.js.map +1 -0
  103. package/dist/gen/model/finance/contactDetail.d.ts +33 -0
  104. package/dist/gen/model/finance/contactDetail.js +43 -0
  105. package/dist/gen/model/finance/contactDetail.js.map +1 -0
  106. package/dist/gen/model/finance/contactTotalDetail.d.ts +25 -0
  107. package/dist/gen/model/finance/contactTotalDetail.js +28 -0
  108. package/dist/gen/model/finance/contactTotalDetail.js.map +1 -0
  109. package/dist/gen/model/finance/contactTotalOther.d.ts +29 -0
  110. package/dist/gen/model/finance/contactTotalOther.js +33 -0
  111. package/dist/gen/model/finance/contactTotalOther.js.map +1 -0
  112. package/dist/gen/model/finance/currentStatementResponse.d.ts +37 -0
  113. package/dist/gen/model/finance/currentStatementResponse.js +43 -0
  114. package/dist/gen/model/finance/currentStatementResponse.js.map +1 -0
  115. package/dist/gen/model/finance/dataSourceResponse.d.ts +73 -0
  116. package/dist/gen/model/finance/dataSourceResponse.js +88 -0
  117. package/dist/gen/model/finance/dataSourceResponse.js.map +1 -0
  118. package/dist/gen/model/finance/historyRecordResponse.d.ts +33 -0
  119. package/dist/gen/model/finance/historyRecordResponse.js +38 -0
  120. package/dist/gen/model/finance/historyRecordResponse.js.map +1 -0
  121. package/dist/gen/model/finance/incomeByContactResponse.d.ts +33 -0
  122. package/dist/gen/model/finance/incomeByContactResponse.js +48 -0
  123. package/dist/gen/model/finance/incomeByContactResponse.js.map +1 -0
  124. package/dist/gen/model/finance/lockHistoryModel.d.ts +25 -0
  125. package/dist/gen/model/finance/lockHistoryModel.js +28 -0
  126. package/dist/gen/model/finance/lockHistoryModel.js.map +1 -0
  127. package/dist/gen/model/finance/lockHistoryResponse.d.ts +23 -0
  128. package/dist/gen/model/finance/lockHistoryResponse.js +28 -0
  129. package/dist/gen/model/finance/lockHistoryResponse.js.map +1 -0
  130. package/dist/gen/model/finance/manualJournalTotal.d.ts +17 -0
  131. package/dist/gen/model/finance/manualJournalTotal.js +18 -0
  132. package/dist/gen/model/finance/manualJournalTotal.js.map +1 -0
  133. package/dist/gen/model/finance/models.d.ts +77 -0
  134. package/dist/gen/model/finance/models.js +348 -0
  135. package/dist/gen/model/finance/models.js.map +1 -0
  136. package/dist/gen/model/finance/pnlAccount.d.ts +37 -0
  137. package/dist/gen/model/finance/pnlAccount.js +43 -0
  138. package/dist/gen/model/finance/pnlAccount.js.map +1 -0
  139. package/dist/gen/model/finance/pnlAccountClass.d.ts +22 -0
  140. package/dist/gen/model/finance/pnlAccountClass.js +23 -0
  141. package/dist/gen/model/finance/pnlAccountClass.js.map +1 -0
  142. package/dist/gen/model/finance/pnlAccountType.d.ts +26 -0
  143. package/dist/gen/model/finance/pnlAccountType.js +28 -0
  144. package/dist/gen/model/finance/pnlAccountType.js.map +1 -0
  145. package/dist/gen/model/finance/practiceResponse.d.ts +33 -0
  146. package/dist/gen/model/finance/practiceResponse.js +38 -0
  147. package/dist/gen/model/finance/practiceResponse.js.map +1 -0
  148. package/dist/gen/model/finance/problem.d.ts +18 -0
  149. package/dist/gen/model/finance/problem.js +33 -0
  150. package/dist/gen/model/finance/problem.js.map +1 -0
  151. package/dist/gen/model/finance/problemType.d.ts +7 -0
  152. package/dist/gen/model/finance/problemType.js +12 -0
  153. package/dist/gen/model/finance/problemType.js.map +1 -0
  154. package/dist/gen/model/finance/profitAndLossResponse.d.ts +28 -0
  155. package/dist/gen/model/finance/profitAndLossResponse.js +38 -0
  156. package/dist/gen/model/finance/profitAndLossResponse.js.map +1 -0
  157. package/dist/gen/model/finance/reportHistoryModel.d.ts +25 -0
  158. package/dist/gen/model/finance/reportHistoryModel.js +28 -0
  159. package/dist/gen/model/finance/reportHistoryModel.js.map +1 -0
  160. package/dist/gen/model/finance/reportHistoryResponse.d.ts +23 -0
  161. package/dist/gen/model/finance/reportHistoryResponse.js +28 -0
  162. package/dist/gen/model/finance/reportHistoryResponse.js.map +1 -0
  163. package/dist/gen/model/finance/statementBalanceResponse.d.ts +21 -0
  164. package/dist/gen/model/finance/statementBalanceResponse.js +23 -0
  165. package/dist/gen/model/finance/statementBalanceResponse.js.map +1 -0
  166. package/dist/gen/model/finance/statementLinesResponse.d.ts +79 -0
  167. package/dist/gen/model/finance/statementLinesResponse.js +98 -0
  168. package/dist/gen/model/finance/statementLinesResponse.js.map +1 -0
  169. package/dist/gen/model/finance/totalDetail.d.ts +25 -0
  170. package/dist/gen/model/finance/totalDetail.js +28 -0
  171. package/dist/gen/model/finance/totalDetail.js.map +1 -0
  172. package/dist/gen/model/finance/totalOther.d.ts +25 -0
  173. package/dist/gen/model/finance/totalOther.js +28 -0
  174. package/dist/gen/model/finance/totalOther.js.map +1 -0
  175. package/dist/gen/model/finance/trialBalanceAccount.d.ts +49 -0
  176. package/dist/gen/model/finance/trialBalanceAccount.js +63 -0
  177. package/dist/gen/model/finance/trialBalanceAccount.js.map +1 -0
  178. package/dist/gen/model/finance/trialBalanceEntry.d.ts +21 -0
  179. package/dist/gen/model/finance/trialBalanceEntry.js +23 -0
  180. package/dist/gen/model/finance/trialBalanceEntry.js.map +1 -0
  181. package/dist/gen/model/finance/trialBalanceMovement.d.ts +27 -0
  182. package/dist/gen/model/finance/trialBalanceMovement.js +33 -0
  183. package/dist/gen/model/finance/trialBalanceMovement.js.map +1 -0
  184. package/dist/gen/model/finance/trialBalanceResponse.d.ts +26 -0
  185. package/dist/gen/model/finance/trialBalanceResponse.js +28 -0
  186. package/dist/gen/model/finance/trialBalanceResponse.js.map +1 -0
  187. package/dist/gen/model/finance/userActivitiesResponse.d.ts +23 -0
  188. package/dist/gen/model/finance/userActivitiesResponse.js +28 -0
  189. package/dist/gen/model/finance/userActivitiesResponse.js.map +1 -0
  190. package/dist/gen/model/finance/userResponse.d.ts +57 -0
  191. package/dist/gen/model/finance/userResponse.js +73 -0
  192. package/dist/gen/model/finance/userResponse.js.map +1 -0
  193. package/dist/gen/model/payroll-au/allowanceCategory.d.ts +9 -0
  194. package/dist/gen/model/payroll-au/allowanceCategory.js +14 -0
  195. package/dist/gen/model/payroll-au/allowanceCategory.js.map +1 -0
  196. package/dist/gen/model/payroll-au/allowanceType.d.ts +5 -2
  197. package/dist/gen/model/payroll-au/allowanceType.js +5 -2
  198. package/dist/gen/model/payroll-au/allowanceType.js.map +1 -1
  199. package/dist/gen/model/payroll-au/earningsRate.d.ts +2 -0
  200. package/dist/gen/model/payroll-au/earningsRate.js +5 -0
  201. package/dist/gen/model/payroll-au/earningsRate.js.map +1 -1
  202. package/dist/gen/model/payroll-au/earningsType.d.ts +3 -1
  203. package/dist/gen/model/payroll-au/earningsType.js +2 -0
  204. package/dist/gen/model/payroll-au/earningsType.js.map +1 -1
  205. package/dist/gen/model/payroll-au/manualTaxType.d.ts +2 -1
  206. package/dist/gen/model/payroll-au/manualTaxType.js +1 -0
  207. package/dist/gen/model/payroll-au/manualTaxType.js.map +1 -1
  208. package/dist/gen/model/payroll-au/models.d.ts +1 -0
  209. package/dist/gen/model/payroll-au/models.js +3 -0
  210. package/dist/gen/model/payroll-au/models.js.map +1 -1
  211. package/dist/gen/model/payroll-uk/earningsRate.d.ts +1 -1
  212. package/dist/gen/model/payroll-uk/earningsRate.js +2 -2
  213. package/dist/gen/model/payroll-uk/earningsRate.js.map +1 -1
  214. package/package.json +1 -1
@@ -3,7 +3,7 @@
3
3
  * Xero Payroll NZ
4
4
  * This is the Xero Payroll API for orgs in the NZ region.
5
5
  *
6
- * The version of the OpenAPI document: 2.15.0
6
+ * The version of the OpenAPI document: 2.17.4
7
7
  * Contact: api@xero.com
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -34,7 +34,7 @@ var PayrollNzApiApiKeys;
34
34
  class PayrollNzApi {
35
35
  constructor(basePathOrUsername, password, basePath) {
36
36
  this._basePath = defaultBasePath;
37
- this.defaultHeaders = { 'user-agent': 'xero-node-4.15.0' };
37
+ this.defaultHeaders = { 'user-agent': 'xero-node-4.17.1' };
38
38
  this._useQuerystring = false;
39
39
  this.binaryHeaders = {};
40
40
  this.authentications = {
@@ -2692,11 +2692,10 @@ class PayrollNzApi {
2692
2692
  *
2693
2693
  * @summary Retrieves employees
2694
2694
  * @param xeroTenantId Xero identifier for Tenant
2695
- * @param firstName Filter by first name
2696
- * @param lastName Filter by last name
2695
+ * @param filter Filter by first name and/or lastname
2697
2696
  * @param page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
2698
2697
  */
2699
- getEmployees(xeroTenantId, firstName, lastName, page, options = { headers: {} }) {
2698
+ getEmployees(xeroTenantId, filter, page, options = { headers: {} }) {
2700
2699
  return __awaiter(this, void 0, void 0, function* () {
2701
2700
  const localVarPath = this.basePath + '/Employees';
2702
2701
  let localVarQueryParameters = {};
@@ -2706,11 +2705,8 @@ class PayrollNzApi {
2706
2705
  if (xeroTenantId === null || xeroTenantId === undefined) {
2707
2706
  throw new Error('Required parameter xeroTenantId was null or undefined when calling getEmployees.');
2708
2707
  }
2709
- if (firstName !== undefined) {
2710
- localVarQueryParameters['firstName'] = models_1.ObjectSerializer.serialize(firstName, "string");
2711
- }
2712
- if (lastName !== undefined) {
2713
- localVarQueryParameters['lastName'] = models_1.ObjectSerializer.serialize(lastName, "string");
2708
+ if (filter !== undefined) {
2709
+ localVarQueryParameters['filter'] = models_1.ObjectSerializer.serialize(filter, "string");
2714
2710
  }
2715
2711
  if (page !== undefined) {
2716
2712
  localVarQueryParameters['page'] = models_1.ObjectSerializer.serialize(page, "number");
@@ -3766,10 +3762,13 @@ class PayrollNzApi {
3766
3762
  * @summary Retrieves timesheets
3767
3763
  * @param xeroTenantId Xero identifier for Tenant
3768
3764
  * @param page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
3769
- * @param employeeId By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeID} to get only the timesheets of a particular employee.
3770
- * @param payrollCalendarId By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id
3765
+ * @param filter Filter by employeeId and/or payrollCalendarId
3766
+ * @param status filter results by any timesheets with a matching timesheet status
3767
+ * @param startDate filter results by any timesheets with a startDate on or after the provided date
3768
+ * @param endDate filter results by any timesheets with a endDate on or before the provided date
3769
+ * @param sort sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest.
3771
3770
  */
3772
- getTimesheets(xeroTenantId, page, employeeId, payrollCalendarId, options = { headers: {} }) {
3771
+ getTimesheets(xeroTenantId, page, filter, status, startDate, endDate, sort, options = { headers: {} }) {
3773
3772
  return __awaiter(this, void 0, void 0, function* () {
3774
3773
  const localVarPath = this.basePath + '/Timesheets';
3775
3774
  let localVarQueryParameters = {};
@@ -3782,11 +3781,20 @@ class PayrollNzApi {
3782
3781
  if (page !== undefined) {
3783
3782
  localVarQueryParameters['page'] = models_1.ObjectSerializer.serialize(page, "number");
3784
3783
  }
3785
- if (employeeId !== undefined) {
3786
- localVarQueryParameters['employeeId'] = models_1.ObjectSerializer.serialize(employeeId, "string");
3784
+ if (filter !== undefined) {
3785
+ localVarQueryParameters['filter'] = models_1.ObjectSerializer.serialize(filter, "string");
3786
+ }
3787
+ if (status !== undefined) {
3788
+ localVarQueryParameters['status'] = models_1.ObjectSerializer.serialize(status, "string");
3789
+ }
3790
+ if (startDate !== undefined) {
3791
+ localVarQueryParameters['startDate'] = models_1.ObjectSerializer.serialize(startDate, "string");
3792
+ }
3793
+ if (endDate !== undefined) {
3794
+ localVarQueryParameters['endDate'] = models_1.ObjectSerializer.serialize(endDate, "string");
3787
3795
  }
3788
- if (payrollCalendarId !== undefined) {
3789
- localVarQueryParameters['payrollCalendarId'] = models_1.ObjectSerializer.serialize(payrollCalendarId, "string");
3796
+ if (sort !== undefined) {
3797
+ localVarQueryParameters['sort'] = models_1.ObjectSerializer.serialize(sort, "string");
3790
3798
  }
3791
3799
  localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
3792
3800
  Object.assign(localVarHeaderParams, options.headers);