xero-ruby 4.0.0 → 4.3.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1008) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +450 -450
  3. data/lib/xero-ruby/api/accounting_api.rb +18858 -18858
  4. data/lib/xero-ruby/api/app_store_api.rb +325 -325
  5. data/lib/xero-ruby/api/asset_api.rb +493 -493
  6. data/lib/xero-ruby/api/files_api.rb +1468 -1390
  7. data/lib/xero-ruby/api/finance_api.rb +961 -961
  8. data/lib/xero-ruby/api/payroll_au_api.rb +2513 -2282
  9. data/lib/xero-ruby/api/payroll_nz_api.rb +5334 -5334
  10. data/lib/xero-ruby/api/payroll_uk_api.rb +5479 -5479
  11. data/lib/xero-ruby/api/project_api.rb +1402 -1402
  12. data/lib/xero-ruby/api_client.rb +675 -675
  13. data/lib/xero-ruby/api_error.rb +57 -57
  14. data/lib/xero-ruby/configuration.rb +282 -282
  15. data/lib/xero-ruby/models/accounting/account.rb +535 -535
  16. data/lib/xero-ruby/models/accounting/account_type.rb +56 -56
  17. data/lib/xero-ruby/models/accounting/accounts.rb +224 -224
  18. data/lib/xero-ruby/models/accounting/accounts_payable.rb +232 -232
  19. data/lib/xero-ruby/models/accounting/accounts_receivable.rb +232 -232
  20. data/lib/xero-ruby/models/accounting/action.rb +268 -268
  21. data/lib/xero-ruby/models/accounting/actions.rb +224 -224
  22. data/lib/xero-ruby/models/accounting/address.rb +483 -483
  23. data/lib/xero-ruby/models/accounting/address_for_organisation.rb +484 -484
  24. data/lib/xero-ruby/models/accounting/allocation.rb +309 -309
  25. data/lib/xero-ruby/models/accounting/allocations.rb +224 -224
  26. data/lib/xero-ruby/models/accounting/attachment.rb +272 -272
  27. data/lib/xero-ruby/models/accounting/attachments.rb +224 -224
  28. data/lib/xero-ruby/models/accounting/balance_details.rb +243 -243
  29. data/lib/xero-ruby/models/accounting/balances.rb +233 -233
  30. data/lib/xero-ruby/models/accounting/bank_transaction.rb +510 -510
  31. data/lib/xero-ruby/models/accounting/bank_transactions.rb +224 -224
  32. data/lib/xero-ruby/models/accounting/bank_transfer.rb +375 -375
  33. data/lib/xero-ruby/models/accounting/bank_transfers.rb +224 -224
  34. data/lib/xero-ruby/models/accounting/batch_payment.rb +496 -496
  35. data/lib/xero-ruby/models/accounting/batch_payment_delete.rb +244 -244
  36. data/lib/xero-ruby/models/accounting/batch_payment_delete_by_url_param.rb +229 -229
  37. data/lib/xero-ruby/models/accounting/batch_payment_details.rb +293 -293
  38. data/lib/xero-ruby/models/accounting/batch_payments.rb +224 -224
  39. data/lib/xero-ruby/models/accounting/bill.rb +232 -232
  40. data/lib/xero-ruby/models/accounting/branding_theme.rb +307 -307
  41. data/lib/xero-ruby/models/accounting/branding_themes.rb +224 -224
  42. data/lib/xero-ruby/models/accounting/budget.rb +327 -327
  43. data/lib/xero-ruby/models/accounting/budget_balance.rb +267 -267
  44. data/lib/xero-ruby/models/accounting/budget_line.rb +244 -244
  45. data/lib/xero-ruby/models/accounting/budgets.rb +224 -224
  46. data/lib/xero-ruby/models/accounting/cis_org_setting.rb +242 -242
  47. data/lib/xero-ruby/models/accounting/cis_org_settings.rb +224 -224
  48. data/lib/xero-ruby/models/accounting/cis_setting.rb +232 -232
  49. data/lib/xero-ruby/models/accounting/cis_settings.rb +224 -224
  50. data/lib/xero-ruby/models/accounting/contact.rb +849 -849
  51. data/lib/xero-ruby/models/accounting/contact_group.rb +290 -290
  52. data/lib/xero-ruby/models/accounting/contact_groups.rb +224 -224
  53. data/lib/xero-ruby/models/accounting/contact_person.rb +252 -252
  54. data/lib/xero-ruby/models/accounting/contacts.rb +224 -224
  55. data/lib/xero-ruby/models/accounting/conversion_balances.rb +245 -245
  56. data/lib/xero-ruby/models/accounting/conversion_date.rb +233 -233
  57. data/lib/xero-ruby/models/accounting/country_code.rb +274 -274
  58. data/lib/xero-ruby/models/accounting/credit_note.rb +580 -580
  59. data/lib/xero-ruby/models/accounting/credit_notes.rb +224 -224
  60. data/lib/xero-ruby/models/accounting/currencies.rb +224 -224
  61. data/lib/xero-ruby/models/accounting/currency.rb +232 -232
  62. data/lib/xero-ruby/models/accounting/currency_code.rb +203 -200
  63. data/lib/xero-ruby/models/accounting/element.rb +294 -294
  64. data/lib/xero-ruby/models/accounting/employee.rb +362 -362
  65. data/lib/xero-ruby/models/accounting/employees.rb +224 -224
  66. data/lib/xero-ruby/models/accounting/error.rb +254 -254
  67. data/lib/xero-ruby/models/accounting/expense_claim.rb +375 -375
  68. data/lib/xero-ruby/models/accounting/expense_claims.rb +224 -224
  69. data/lib/xero-ruby/models/accounting/external_link.rb +281 -281
  70. data/lib/xero-ruby/models/accounting/history_record.rb +252 -252
  71. data/lib/xero-ruby/models/accounting/history_records.rb +224 -224
  72. data/lib/xero-ruby/models/accounting/import_summary.rb +233 -233
  73. data/lib/xero-ruby/models/accounting/import_summary_accounts.rb +303 -303
  74. data/lib/xero-ruby/models/accounting/import_summary_object.rb +222 -222
  75. data/lib/xero-ruby/models/accounting/import_summary_organisation.rb +222 -222
  76. data/lib/xero-ruby/models/accounting/invoice.rb +707 -707
  77. data/lib/xero-ruby/models/accounting/invoice_reminder.rb +222 -222
  78. data/lib/xero-ruby/models/accounting/invoice_reminders.rb +224 -224
  79. data/lib/xero-ruby/models/accounting/invoices.rb +224 -224
  80. data/lib/xero-ruby/models/accounting/item.rb +443 -443
  81. data/lib/xero-ruby/models/accounting/items.rb +224 -224
  82. data/lib/xero-ruby/models/accounting/journal.rb +353 -353
  83. data/lib/xero-ruby/models/accounting/journal_line.rb +334 -334
  84. data/lib/xero-ruby/models/accounting/journals.rb +224 -224
  85. data/lib/xero-ruby/models/accounting/line_amount_types.rb +37 -37
  86. data/lib/xero-ruby/models/accounting/line_item.rb +364 -364
  87. data/lib/xero-ruby/models/accounting/line_item_item.rb +272 -272
  88. data/lib/xero-ruby/models/accounting/line_item_tracking.rb +267 -267
  89. data/lib/xero-ruby/models/accounting/linked_transaction.rb +390 -390
  90. data/lib/xero-ruby/models/accounting/linked_transactions.rb +224 -224
  91. data/lib/xero-ruby/models/accounting/manual_journal.rb +406 -406
  92. data/lib/xero-ruby/models/accounting/manual_journal_line.rb +294 -294
  93. data/lib/xero-ruby/models/accounting/manual_journals.rb +224 -224
  94. data/lib/xero-ruby/models/accounting/online_invoice.rb +222 -222
  95. data/lib/xero-ruby/models/accounting/online_invoices.rb +224 -224
  96. data/lib/xero-ruby/models/accounting/organisation.rb +728 -728
  97. data/lib/xero-ruby/models/accounting/organisations.rb +224 -224
  98. data/lib/xero-ruby/models/accounting/overpayment.rb +464 -464
  99. data/lib/xero-ruby/models/accounting/overpayments.rb +224 -224
  100. data/lib/xero-ruby/models/accounting/payment.rb +544 -544
  101. data/lib/xero-ruby/models/accounting/payment_delete.rb +229 -229
  102. data/lib/xero-ruby/models/accounting/payment_service.rb +274 -274
  103. data/lib/xero-ruby/models/accounting/payment_services.rb +224 -224
  104. data/lib/xero-ruby/models/accounting/payment_term.rb +232 -232
  105. data/lib/xero-ruby/models/accounting/payment_term_type.rb +38 -38
  106. data/lib/xero-ruby/models/accounting/payments.rb +224 -224
  107. data/lib/xero-ruby/models/accounting/phone.rb +336 -336
  108. data/lib/xero-ruby/models/accounting/prepayment.rb +475 -475
  109. data/lib/xero-ruby/models/accounting/prepayments.rb +224 -224
  110. data/lib/xero-ruby/models/accounting/purchase.rb +252 -252
  111. data/lib/xero-ruby/models/accounting/purchase_order.rb +541 -541
  112. data/lib/xero-ruby/models/accounting/purchase_orders.rb +224 -224
  113. data/lib/xero-ruby/models/accounting/quote.rb +531 -531
  114. data/lib/xero-ruby/models/accounting/quote_line_amount_types.rb +37 -37
  115. data/lib/xero-ruby/models/accounting/quote_status_codes.rb +40 -40
  116. data/lib/xero-ruby/models/accounting/quotes.rb +224 -224
  117. data/lib/xero-ruby/models/accounting/receipt.rb +441 -441
  118. data/lib/xero-ruby/models/accounting/receipts.rb +224 -224
  119. data/lib/xero-ruby/models/accounting/repeating_invoice.rb +477 -477
  120. data/lib/xero-ruby/models/accounting/repeating_invoices.rb +224 -224
  121. data/lib/xero-ruby/models/accounting/report.rb +309 -309
  122. data/lib/xero-ruby/models/accounting/report_attribute.rb +232 -232
  123. data/lib/xero-ruby/models/accounting/report_cell.rb +234 -234
  124. data/lib/xero-ruby/models/accounting/report_fields.rb +242 -242
  125. data/lib/xero-ruby/models/accounting/report_row.rb +244 -244
  126. data/lib/xero-ruby/models/accounting/report_rows.rb +256 -256
  127. data/lib/xero-ruby/models/accounting/report_with_row.rb +308 -308
  128. data/lib/xero-ruby/models/accounting/report_with_rows.rb +224 -224
  129. data/lib/xero-ruby/models/accounting/reports.rb +224 -224
  130. data/lib/xero-ruby/models/accounting/request_empty.rb +222 -222
  131. data/lib/xero-ruby/models/accounting/row_type.rb +38 -38
  132. data/lib/xero-ruby/models/accounting/sales_tracking_category.rb +232 -232
  133. data/lib/xero-ruby/models/accounting/schedule.rb +336 -336
  134. data/lib/xero-ruby/models/accounting/setup.rb +246 -246
  135. data/lib/xero-ruby/models/accounting/tax_component.rb +252 -252
  136. data/lib/xero-ruby/models/accounting/tax_rate.rb +481 -476
  137. data/lib/xero-ruby/models/accounting/tax_rates.rb +224 -224
  138. data/lib/xero-ruby/models/accounting/tax_type.rb +130 -116
  139. data/lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb +432 -432
  140. data/lib/xero-ruby/models/accounting/time_zone.rb +175 -175
  141. data/lib/xero-ruby/models/accounting/tracking_categories.rb +224 -224
  142. data/lib/xero-ruby/models/accounting/tracking_category.rb +341 -341
  143. data/lib/xero-ruby/models/accounting/tracking_option.rb +304 -304
  144. data/lib/xero-ruby/models/accounting/tracking_options.rb +224 -224
  145. data/lib/xero-ruby/models/accounting/user.rb +323 -323
  146. data/lib/xero-ruby/models/accounting/users.rb +224 -224
  147. data/lib/xero-ruby/models/accounting/validation_error.rb +222 -222
  148. data/lib/xero-ruby/models/app_store/create_usage_record.rb +243 -243
  149. data/lib/xero-ruby/models/app_store/plan.rb +311 -311
  150. data/lib/xero-ruby/models/app_store/price.rb +257 -257
  151. data/lib/xero-ruby/models/app_store/problem_details.rb +272 -272
  152. data/lib/xero-ruby/models/app_store/product.rb +299 -299
  153. data/lib/xero-ruby/models/app_store/subscription.rb +361 -361
  154. data/lib/xero-ruby/models/app_store/subscription_item.rb +354 -354
  155. data/lib/xero-ruby/models/app_store/update_usage_record.rb +228 -228
  156. data/lib/xero-ruby/models/app_store/usage_record.rb +332 -332
  157. data/lib/xero-ruby/models/app_store/usage_records_list.rb +230 -230
  158. data/lib/xero-ruby/models/assets/asset.rb +377 -377
  159. data/lib/xero-ruby/models/assets/asset_status.rb +37 -37
  160. data/lib/xero-ruby/models/assets/asset_status_query_param.rb +37 -37
  161. data/lib/xero-ruby/models/assets/asset_type.rb +292 -292
  162. data/lib/xero-ruby/models/assets/assets.rb +234 -234
  163. data/lib/xero-ruby/models/assets/book_depreciation_detail.rb +282 -282
  164. data/lib/xero-ruby/models/assets/book_depreciation_setting.rb +361 -361
  165. data/lib/xero-ruby/models/assets/error.rb +266 -266
  166. data/lib/xero-ruby/models/assets/field_validation_errors_element.rb +272 -272
  167. data/lib/xero-ruby/models/assets/pagination.rb +252 -252
  168. data/lib/xero-ruby/models/assets/resource_validation_errors_element.rb +262 -262
  169. data/lib/xero-ruby/models/assets/setting.rb +292 -292
  170. data/lib/xero-ruby/models/files/association.rb +252 -252
  171. data/lib/xero-ruby/models/files/file_object.rb +292 -292
  172. data/lib/xero-ruby/models/files/files.rb +254 -254
  173. data/lib/xero-ruby/models/files/folder.rb +262 -262
  174. data/lib/xero-ruby/models/files/folders.rb +224 -224
  175. data/lib/xero-ruby/models/files/object_group.rb +46 -46
  176. data/lib/xero-ruby/models/files/object_type.rb +90 -90
  177. data/lib/xero-ruby/models/files/upload_object.rb +267 -267
  178. data/lib/xero-ruby/models/files/user.rb +267 -267
  179. data/lib/xero-ruby/models/finance/account_usage.rb +342 -342
  180. data/lib/xero-ruby/models/finance/account_usage_response.rb +254 -254
  181. data/lib/xero-ruby/models/finance/balance_sheet_account_detail.rb +262 -262
  182. data/lib/xero-ruby/models/finance/balance_sheet_account_group.rb +234 -234
  183. data/lib/xero-ruby/models/finance/balance_sheet_account_type.rb +244 -244
  184. data/lib/xero-ruby/models/finance/balance_sheet_response.rb +252 -252
  185. data/lib/xero-ruby/models/finance/bank_statement_accounting_response.rb +254 -254
  186. data/lib/xero-ruby/models/finance/bank_statement_response.rb +232 -232
  187. data/lib/xero-ruby/models/finance/bank_transaction_response.rb +274 -274
  188. data/lib/xero-ruby/models/finance/cash_account_response.rb +262 -262
  189. data/lib/xero-ruby/models/finance/cash_balance.rb +242 -242
  190. data/lib/xero-ruby/models/finance/cash_validation_response.rb +262 -262
  191. data/lib/xero-ruby/models/finance/cashflow_account.rb +282 -282
  192. data/lib/xero-ruby/models/finance/cashflow_activity.rb +244 -244
  193. data/lib/xero-ruby/models/finance/cashflow_response.rb +254 -254
  194. data/lib/xero-ruby/models/finance/cashflow_type.rb +244 -244
  195. data/lib/xero-ruby/models/finance/contact_detail.rb +274 -274
  196. data/lib/xero-ruby/models/finance/contact_response.rb +232 -232
  197. data/lib/xero-ruby/models/finance/contact_total_detail.rb +242 -242
  198. data/lib/xero-ruby/models/finance/contact_total_other.rb +252 -252
  199. data/lib/xero-ruby/models/finance/credit_note_response.rb +254 -254
  200. data/lib/xero-ruby/models/finance/current_statement_response.rb +272 -272
  201. data/lib/xero-ruby/models/finance/data_source_response.rb +362 -362
  202. data/lib/xero-ruby/models/finance/history_record_response.rb +262 -262
  203. data/lib/xero-ruby/models/finance/income_by_contact_response.rb +284 -284
  204. data/lib/xero-ruby/models/finance/invoice_response.rb +254 -254
  205. data/lib/xero-ruby/models/finance/line_item_response.rb +252 -252
  206. data/lib/xero-ruby/models/finance/lock_history_model.rb +242 -242
  207. data/lib/xero-ruby/models/finance/lock_history_response.rb +244 -244
  208. data/lib/xero-ruby/models/finance/manual_journal_total.rb +222 -222
  209. data/lib/xero-ruby/models/finance/overpayment_response.rb +254 -254
  210. data/lib/xero-ruby/models/finance/payment_response.rb +312 -312
  211. data/lib/xero-ruby/models/finance/pnl_account.rb +272 -272
  212. data/lib/xero-ruby/models/finance/pnl_account_class.rb +234 -234
  213. data/lib/xero-ruby/models/finance/pnl_account_type.rb +244 -244
  214. data/lib/xero-ruby/models/finance/practice_response.rb +262 -262
  215. data/lib/xero-ruby/models/finance/prepayment_response.rb +254 -254
  216. data/lib/xero-ruby/models/finance/problem.rb +252 -252
  217. data/lib/xero-ruby/models/finance/problem_type.rb +44 -44
  218. data/lib/xero-ruby/models/finance/profit_and_loss_response.rb +262 -262
  219. data/lib/xero-ruby/models/finance/report_history_model.rb +242 -242
  220. data/lib/xero-ruby/models/finance/report_history_response.rb +244 -244
  221. data/lib/xero-ruby/models/finance/statement_balance_response.rb +232 -232
  222. data/lib/xero-ruby/models/finance/statement_line_response.rb +356 -356
  223. data/lib/xero-ruby/models/finance/statement_lines_response.rb +382 -382
  224. data/lib/xero-ruby/models/finance/statement_response.rb +314 -314
  225. data/lib/xero-ruby/models/finance/total_detail.rb +242 -242
  226. data/lib/xero-ruby/models/finance/total_other.rb +242 -242
  227. data/lib/xero-ruby/models/finance/trial_balance_account.rb +312 -312
  228. data/lib/xero-ruby/models/finance/trial_balance_entry.rb +232 -232
  229. data/lib/xero-ruby/models/finance/trial_balance_movement.rb +252 -252
  230. data/lib/xero-ruby/models/finance/trial_balance_response.rb +244 -244
  231. data/lib/xero-ruby/models/finance/user_activities_response.rb +244 -244
  232. data/lib/xero-ruby/models/finance/user_response.rb +336 -336
  233. data/lib/xero-ruby/models/payroll_au/account.rb +252 -252
  234. data/lib/xero-ruby/models/payroll_au/account_type.rb +57 -57
  235. data/lib/xero-ruby/models/payroll_au/allowance_category.rb +41 -41
  236. data/lib/xero-ruby/models/payroll_au/allowance_type.rb +44 -44
  237. data/lib/xero-ruby/models/payroll_au/api_exception.rb +243 -243
  238. data/lib/xero-ruby/models/payroll_au/bank_account.rb +272 -272
  239. data/lib/xero-ruby/models/payroll_au/calendar_type.rb +40 -40
  240. data/lib/xero-ruby/models/payroll_au/country_of_residence.rb +285 -285
  241. data/lib/xero-ruby/models/payroll_au/deduction_line.rb +267 -267
  242. data/lib/xero-ruby/models/payroll_au/deduction_type.rb +354 -354
  243. data/lib/xero-ruby/models/payroll_au/deduction_type_calculation_type.rb +37 -37
  244. data/lib/xero-ruby/models/payroll_au/earnings_line.rb +307 -307
  245. data/lib/xero-ruby/models/payroll_au/earnings_rate.rb +442 -442
  246. data/lib/xero-ruby/models/payroll_au/earnings_rate_calculation_type.rb +37 -37
  247. data/lib/xero-ruby/models/payroll_au/earnings_type.rb +48 -48
  248. data/lib/xero-ruby/models/payroll_au/employee.rb +654 -654
  249. data/lib/xero-ruby/models/payroll_au/employee_status.rb +36 -36
  250. data/lib/xero-ruby/models/payroll_au/employees.rb +224 -224
  251. data/lib/xero-ruby/models/payroll_au/employment_basis.rb +40 -40
  252. data/lib/xero-ruby/models/payroll_au/employment_termination_payment_type.rb +36 -36
  253. data/lib/xero-ruby/models/payroll_au/employment_type.rb +36 -36
  254. data/lib/xero-ruby/models/payroll_au/entitlement_final_pay_payout_type.rb +36 -36
  255. data/lib/xero-ruby/models/payroll_au/home_address.rb +277 -277
  256. data/lib/xero-ruby/models/payroll_au/income_type.rb +39 -39
  257. data/lib/xero-ruby/models/payroll_au/leave_accrual_line.rb +242 -242
  258. data/lib/xero-ruby/models/payroll_au/leave_application.rb +326 -316
  259. data/lib/xero-ruby/models/payroll_au/leave_applications.rb +224 -224
  260. data/lib/xero-ruby/models/payroll_au/leave_balance.rb +252 -252
  261. data/lib/xero-ruby/models/payroll_au/leave_category_code.rb +46 -46
  262. data/lib/xero-ruby/models/payroll_au/leave_earnings_line.rb +252 -242
  263. data/lib/xero-ruby/models/payroll_au/leave_line.rb +292 -292
  264. data/lib/xero-ruby/models/payroll_au/leave_line_calculation_type.rb +39 -39
  265. data/lib/xero-ruby/models/payroll_au/leave_lines.rb +225 -225
  266. data/lib/xero-ruby/models/payroll_au/leave_period.rb +252 -252
  267. data/lib/xero-ruby/models/payroll_au/leave_period_status.rb +36 -36
  268. data/lib/xero-ruby/models/payroll_au/leave_type.rb +337 -337
  269. data/lib/xero-ruby/models/payroll_au/leave_type_contribution_type.rb +38 -38
  270. data/lib/xero-ruby/models/payroll_au/manual_tax_type.rb +40 -40
  271. data/lib/xero-ruby/models/payroll_au/opening_balances.rb +304 -292
  272. data/lib/xero-ruby/models/payroll_au/paid_leave_earnings_line.rb +272 -0
  273. data/lib/xero-ruby/models/payroll_au/pay_item.rb +260 -260
  274. data/lib/xero-ruby/models/payroll_au/pay_items.rb +222 -222
  275. data/lib/xero-ruby/models/payroll_au/pay_out_type.rb +36 -0
  276. data/lib/xero-ruby/models/payroll_au/pay_run.rb +381 -381
  277. data/lib/xero-ruby/models/payroll_au/pay_run_status.rb +36 -36
  278. data/lib/xero-ruby/models/payroll_au/pay_runs.rb +224 -224
  279. data/lib/xero-ruby/models/payroll_au/pay_template.rb +272 -272
  280. data/lib/xero-ruby/models/payroll_au/payment_frequency_type.rb +41 -41
  281. data/lib/xero-ruby/models/payroll_au/payroll_calendar.rb +294 -294
  282. data/lib/xero-ruby/models/payroll_au/payroll_calendars.rb +224 -224
  283. data/lib/xero-ruby/models/payroll_au/payslip.rb +418 -418
  284. data/lib/xero-ruby/models/payroll_au/payslip_lines.rb +308 -308
  285. data/lib/xero-ruby/models/payroll_au/payslip_object.rb +222 -222
  286. data/lib/xero-ruby/models/payroll_au/payslip_summary.rb +332 -332
  287. data/lib/xero-ruby/models/payroll_au/payslips.rb +224 -224
  288. data/lib/xero-ruby/models/payroll_au/rate_type.rb +37 -37
  289. data/lib/xero-ruby/models/payroll_au/reimbursement_line.rb +267 -267
  290. data/lib/xero-ruby/models/payroll_au/reimbursement_lines.rb +225 -225
  291. data/lib/xero-ruby/models/payroll_au/reimbursement_type.rb +277 -277
  292. data/lib/xero-ruby/models/payroll_au/residency_status.rb +37 -37
  293. data/lib/xero-ruby/models/payroll_au/senior_marital_status.rb +37 -37
  294. data/lib/xero-ruby/models/payroll_au/settings.rb +254 -254
  295. data/lib/xero-ruby/models/payroll_au/settings_object.rb +222 -222
  296. data/lib/xero-ruby/models/payroll_au/settings_tracking_categories.rb +233 -233
  297. data/lib/xero-ruby/models/payroll_au/settings_tracking_categories_employee_groups.rb +233 -233
  298. data/lib/xero-ruby/models/payroll_au/settings_tracking_categories_timesheet_categories.rb +233 -233
  299. data/lib/xero-ruby/models/payroll_au/state.rb +42 -42
  300. data/lib/xero-ruby/models/payroll_au/super_fund.rb +349 -349
  301. data/lib/xero-ruby/models/payroll_au/super_fund_product.rb +252 -252
  302. data/lib/xero-ruby/models/payroll_au/super_fund_products.rb +224 -224
  303. data/lib/xero-ruby/models/payroll_au/super_fund_type.rb +36 -36
  304. data/lib/xero-ruby/models/payroll_au/super_funds.rb +224 -224
  305. data/lib/xero-ruby/models/payroll_au/super_line.rb +292 -292
  306. data/lib/xero-ruby/models/payroll_au/super_membership.rb +252 -252
  307. data/lib/xero-ruby/models/payroll_au/superannuation_calculation_type.rb +37 -37
  308. data/lib/xero-ruby/models/payroll_au/superannuation_contribution_type.rb +38 -38
  309. data/lib/xero-ruby/models/payroll_au/superannuation_line.rb +302 -302
  310. data/lib/xero-ruby/models/payroll_au/tax_declaration.rb +422 -422
  311. data/lib/xero-ruby/models/payroll_au/tax_line.rb +272 -272
  312. data/lib/xero-ruby/models/payroll_au/tax_scale_type.rb +40 -40
  313. data/lib/xero-ruby/models/payroll_au/tfn_exemption_type.rb +38 -38
  314. data/lib/xero-ruby/models/payroll_au/timesheet.rb +321 -321
  315. data/lib/xero-ruby/models/payroll_au/timesheet_line.rb +254 -254
  316. data/lib/xero-ruby/models/payroll_au/timesheet_object.rb +222 -222
  317. data/lib/xero-ruby/models/payroll_au/timesheet_status.rb +39 -39
  318. data/lib/xero-ruby/models/payroll_au/timesheets.rb +224 -224
  319. data/lib/xero-ruby/models/payroll_au/validation_error.rb +222 -222
  320. data/lib/xero-ruby/models/payroll_au/work_condition.rb +37 -37
  321. data/lib/xero-ruby/models/payroll_nz/account.rb +290 -290
  322. data/lib/xero-ruby/models/payroll_nz/accounts.rb +224 -224
  323. data/lib/xero-ruby/models/payroll_nz/address.rb +287 -287
  324. data/lib/xero-ruby/models/payroll_nz/bank_account.rb +343 -343
  325. data/lib/xero-ruby/models/payroll_nz/benefit.rb +383 -383
  326. data/lib/xero-ruby/models/payroll_nz/calendar_type.rb +41 -41
  327. data/lib/xero-ruby/models/payroll_nz/deduction.rb +325 -325
  328. data/lib/xero-ruby/models/payroll_nz/deduction_line.rb +262 -262
  329. data/lib/xero-ruby/models/payroll_nz/deduction_object.rb +242 -242
  330. data/lib/xero-ruby/models/payroll_nz/deductions.rb +244 -244
  331. data/lib/xero-ruby/models/payroll_nz/earnings_line.rb +312 -312
  332. data/lib/xero-ruby/models/payroll_nz/earnings_order.rb +269 -269
  333. data/lib/xero-ruby/models/payroll_nz/earnings_order_object.rb +242 -242
  334. data/lib/xero-ruby/models/payroll_nz/earnings_orders.rb +244 -244
  335. data/lib/xero-ruby/models/payroll_nz/earnings_rate.rb +401 -401
  336. data/lib/xero-ruby/models/payroll_nz/earnings_rate_object.rb +242 -242
  337. data/lib/xero-ruby/models/payroll_nz/earnings_rates.rb +244 -244
  338. data/lib/xero-ruby/models/payroll_nz/earnings_template.rb +272 -272
  339. data/lib/xero-ruby/models/payroll_nz/earnings_template_object.rb +242 -242
  340. data/lib/xero-ruby/models/payroll_nz/employee.rb +388 -388
  341. data/lib/xero-ruby/models/payroll_nz/employee_earnings_templates.rb +244 -244
  342. data/lib/xero-ruby/models/payroll_nz/employee_leave.rb +304 -304
  343. data/lib/xero-ruby/models/payroll_nz/employee_leave_balance.rb +252 -252
  344. data/lib/xero-ruby/models/payroll_nz/employee_leave_balances.rb +244 -244
  345. data/lib/xero-ruby/models/payroll_nz/employee_leave_object.rb +242 -242
  346. data/lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb +282 -282
  347. data/lib/xero-ruby/models/payroll_nz/employee_leave_setup_object.rb +242 -242
  348. data/lib/xero-ruby/models/payroll_nz/employee_leave_type.rb +350 -350
  349. data/lib/xero-ruby/models/payroll_nz/employee_leave_type_object.rb +242 -242
  350. data/lib/xero-ruby/models/payroll_nz/employee_leave_types.rb +244 -244
  351. data/lib/xero-ruby/models/payroll_nz/employee_leaves.rb +244 -244
  352. data/lib/xero-ruby/models/payroll_nz/employee_object.rb +242 -242
  353. data/lib/xero-ruby/models/payroll_nz/employee_opening_balance.rb +252 -252
  354. data/lib/xero-ruby/models/payroll_nz/employee_opening_balances_object.rb +244 -244
  355. data/lib/xero-ruby/models/payroll_nz/employee_pay_template.rb +234 -234
  356. data/lib/xero-ruby/models/payroll_nz/employee_pay_template_object.rb +242 -242
  357. data/lib/xero-ruby/models/payroll_nz/employee_pay_templates.rb +242 -242
  358. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance.rb +294 -294
  359. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance_object.rb +242 -242
  360. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_summary.rb +336 -336
  361. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leaves_summaries.rb +244 -244
  362. data/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave.rb +433 -433
  363. data/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave_object.rb +242 -242
  364. data/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leaves.rb +244 -244
  365. data/lib/xero-ruby/models/payroll_nz/employee_tax.rb +411 -411
  366. data/lib/xero-ruby/models/payroll_nz/employee_tax_object.rb +242 -242
  367. data/lib/xero-ruby/models/payroll_nz/employees.rb +244 -244
  368. data/lib/xero-ruby/models/payroll_nz/employment.rb +242 -242
  369. data/lib/xero-ruby/models/payroll_nz/employment_object.rb +242 -242
  370. data/lib/xero-ruby/models/payroll_nz/gross_earnings_history.rb +232 -232
  371. data/lib/xero-ruby/models/payroll_nz/invalid_field.rb +232 -232
  372. data/lib/xero-ruby/models/payroll_nz/leave_accrual_line.rb +232 -232
  373. data/lib/xero-ruby/models/payroll_nz/leave_earnings_line.rb +312 -312
  374. data/lib/xero-ruby/models/payroll_nz/leave_period.rb +288 -288
  375. data/lib/xero-ruby/models/payroll_nz/leave_periods.rb +244 -244
  376. data/lib/xero-ruby/models/payroll_nz/leave_type.rb +287 -287
  377. data/lib/xero-ruby/models/payroll_nz/leave_type_object.rb +242 -242
  378. data/lib/xero-ruby/models/payroll_nz/leave_types.rb +244 -244
  379. data/lib/xero-ruby/models/payroll_nz/pagination.rb +252 -252
  380. data/lib/xero-ruby/models/payroll_nz/pay_run.rb +385 -385
  381. data/lib/xero-ruby/models/payroll_nz/pay_run_calendar.rb +302 -302
  382. data/lib/xero-ruby/models/payroll_nz/pay_run_calendar_object.rb +242 -242
  383. data/lib/xero-ruby/models/payroll_nz/pay_run_calendars.rb +244 -244
  384. data/lib/xero-ruby/models/payroll_nz/pay_run_object.rb +242 -242
  385. data/lib/xero-ruby/models/payroll_nz/pay_runs.rb +244 -244
  386. data/lib/xero-ruby/models/payroll_nz/pay_slip.rb +571 -571
  387. data/lib/xero-ruby/models/payroll_nz/pay_slip_object.rb +242 -242
  388. data/lib/xero-ruby/models/payroll_nz/pay_slips.rb +244 -244
  389. data/lib/xero-ruby/models/payroll_nz/payment_line.rb +262 -262
  390. data/lib/xero-ruby/models/payroll_nz/payment_method.rb +271 -271
  391. data/lib/xero-ruby/models/payroll_nz/payment_method_object.rb +242 -242
  392. data/lib/xero-ruby/models/payroll_nz/problem.rb +275 -275
  393. data/lib/xero-ruby/models/payroll_nz/reimbursement.rb +378 -378
  394. data/lib/xero-ruby/models/payroll_nz/reimbursement_line.rb +262 -262
  395. data/lib/xero-ruby/models/payroll_nz/reimbursement_object.rb +242 -242
  396. data/lib/xero-ruby/models/payroll_nz/reimbursements.rb +244 -244
  397. data/lib/xero-ruby/models/payroll_nz/salary_and_wage.rb +398 -398
  398. data/lib/xero-ruby/models/payroll_nz/salary_and_wage_object.rb +242 -242
  399. data/lib/xero-ruby/models/payroll_nz/salary_and_wages.rb +244 -244
  400. data/lib/xero-ruby/models/payroll_nz/settings.rb +242 -242
  401. data/lib/xero-ruby/models/payroll_nz/statutory_deduction.rb +262 -262
  402. data/lib/xero-ruby/models/payroll_nz/statutory_deduction_category.rb +45 -45
  403. data/lib/xero-ruby/models/payroll_nz/statutory_deduction_line.rb +252 -252
  404. data/lib/xero-ruby/models/payroll_nz/statutory_deduction_object.rb +242 -242
  405. data/lib/xero-ruby/models/payroll_nz/statutory_deductions.rb +244 -244
  406. data/lib/xero-ruby/models/payroll_nz/superannuation_line.rb +272 -272
  407. data/lib/xero-ruby/models/payroll_nz/superannuation_object.rb +242 -242
  408. data/lib/xero-ruby/models/payroll_nz/superannuations.rb +244 -244
  409. data/lib/xero-ruby/models/payroll_nz/tax_code.rb +53 -53
  410. data/lib/xero-ruby/models/payroll_nz/tax_line.rb +262 -262
  411. data/lib/xero-ruby/models/payroll_nz/tax_settings.rb +308 -308
  412. data/lib/xero-ruby/models/payroll_nz/timesheet.rb +362 -362
  413. data/lib/xero-ruby/models/payroll_nz/timesheet_earnings_line.rb +312 -312
  414. data/lib/xero-ruby/models/payroll_nz/timesheet_line.rb +277 -277
  415. data/lib/xero-ruby/models/payroll_nz/timesheet_line_object.rb +242 -242
  416. data/lib/xero-ruby/models/payroll_nz/timesheet_object.rb +242 -242
  417. data/lib/xero-ruby/models/payroll_nz/timesheets.rb +244 -244
  418. data/lib/xero-ruby/models/payroll_nz/tracking_categories.rb +242 -242
  419. data/lib/xero-ruby/models/payroll_nz/tracking_category.rb +232 -232
  420. data/lib/xero-ruby/models/payroll_uk/account.rb +293 -293
  421. data/lib/xero-ruby/models/payroll_uk/accounts.rb +224 -224
  422. data/lib/xero-ruby/models/payroll_uk/address.rb +277 -277
  423. data/lib/xero-ruby/models/payroll_uk/bank_account.rb +257 -257
  424. data/lib/xero-ruby/models/payroll_uk/benefit.rb +432 -432
  425. data/lib/xero-ruby/models/payroll_uk/benefit_line.rb +262 -262
  426. data/lib/xero-ruby/models/payroll_uk/benefit_object.rb +242 -242
  427. data/lib/xero-ruby/models/payroll_uk/benefits.rb +244 -244
  428. data/lib/xero-ruby/models/payroll_uk/court_order_line.rb +232 -232
  429. data/lib/xero-ruby/models/payroll_uk/deduction.rb +440 -440
  430. data/lib/xero-ruby/models/payroll_uk/deduction_line.rb +252 -252
  431. data/lib/xero-ruby/models/payroll_uk/deduction_object.rb +242 -242
  432. data/lib/xero-ruby/models/payroll_uk/deductions.rb +244 -244
  433. data/lib/xero-ruby/models/payroll_uk/earnings_line.rb +302 -302
  434. data/lib/xero-ruby/models/payroll_uk/earnings_order.rb +269 -269
  435. data/lib/xero-ruby/models/payroll_uk/earnings_order_object.rb +242 -242
  436. data/lib/xero-ruby/models/payroll_uk/earnings_orders.rb +244 -244
  437. data/lib/xero-ruby/models/payroll_uk/earnings_rate.rb +409 -409
  438. data/lib/xero-ruby/models/payroll_uk/earnings_rate_object.rb +242 -242
  439. data/lib/xero-ruby/models/payroll_uk/earnings_rates.rb +244 -244
  440. data/lib/xero-ruby/models/payroll_uk/earnings_template.rb +272 -272
  441. data/lib/xero-ruby/models/payroll_uk/earnings_template_object.rb +242 -242
  442. data/lib/xero-ruby/models/payroll_uk/employee.rb +408 -408
  443. data/lib/xero-ruby/models/payroll_uk/employee_leave.rb +304 -304
  444. data/lib/xero-ruby/models/payroll_uk/employee_leave_balance.rb +252 -252
  445. data/lib/xero-ruby/models/payroll_uk/employee_leave_balances.rb +244 -244
  446. data/lib/xero-ruby/models/payroll_uk/employee_leave_object.rb +242 -242
  447. data/lib/xero-ruby/models/payroll_uk/employee_leave_type.rb +320 -320
  448. data/lib/xero-ruby/models/payroll_uk/employee_leave_type_object.rb +242 -242
  449. data/lib/xero-ruby/models/payroll_uk/employee_leave_types.rb +244 -244
  450. data/lib/xero-ruby/models/payroll_uk/employee_leaves.rb +244 -244
  451. data/lib/xero-ruby/models/payroll_uk/employee_object.rb +242 -242
  452. data/lib/xero-ruby/models/payroll_uk/employee_opening_balances.rb +272 -272
  453. data/lib/xero-ruby/models/payroll_uk/employee_opening_balances_object.rb +242 -242
  454. data/lib/xero-ruby/models/payroll_uk/employee_pay_template.rb +234 -234
  455. data/lib/xero-ruby/models/payroll_uk/employee_pay_template_object.rb +242 -242
  456. data/lib/xero-ruby/models/payroll_uk/employee_pay_templates.rb +244 -244
  457. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance.rb +294 -294
  458. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance_object.rb +242 -242
  459. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_summary.rb +336 -336
  460. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leaves_summaries.rb +244 -244
  461. data/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb +433 -433
  462. data/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave_object.rb +242 -242
  463. data/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leaves.rb +244 -244
  464. data/lib/xero-ruby/models/payroll_uk/employee_tax.rb +322 -322
  465. data/lib/xero-ruby/models/payroll_uk/employee_tax_object.rb +242 -242
  466. data/lib/xero-ruby/models/payroll_uk/employees.rb +244 -244
  467. data/lib/xero-ruby/models/payroll_uk/employment.rb +299 -299
  468. data/lib/xero-ruby/models/payroll_uk/employment_object.rb +242 -242
  469. data/lib/xero-ruby/models/payroll_uk/invalid_field.rb +232 -232
  470. data/lib/xero-ruby/models/payroll_uk/leave_accrual_line.rb +232 -232
  471. data/lib/xero-ruby/models/payroll_uk/leave_earnings_line.rb +272 -272
  472. data/lib/xero-ruby/models/payroll_uk/leave_period.rb +288 -288
  473. data/lib/xero-ruby/models/payroll_uk/leave_periods.rb +244 -244
  474. data/lib/xero-ruby/models/payroll_uk/leave_type.rb +307 -307
  475. data/lib/xero-ruby/models/payroll_uk/leave_type_object.rb +242 -242
  476. data/lib/xero-ruby/models/payroll_uk/leave_types.rb +244 -244
  477. data/lib/xero-ruby/models/payroll_uk/pagination.rb +252 -252
  478. data/lib/xero-ruby/models/payroll_uk/pay_run.rb +403 -403
  479. data/lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb +342 -342
  480. data/lib/xero-ruby/models/payroll_uk/pay_run_calendar_object.rb +242 -242
  481. data/lib/xero-ruby/models/payroll_uk/pay_run_calendars.rb +244 -244
  482. data/lib/xero-ruby/models/payroll_uk/pay_run_object.rb +242 -242
  483. data/lib/xero-ruby/models/payroll_uk/pay_runs.rb +244 -244
  484. data/lib/xero-ruby/models/payroll_uk/payment_line.rb +262 -262
  485. data/lib/xero-ruby/models/payroll_uk/payment_method.rb +276 -276
  486. data/lib/xero-ruby/models/payroll_uk/payment_method_object.rb +242 -242
  487. data/lib/xero-ruby/models/payroll_uk/payslip.rb +551 -551
  488. data/lib/xero-ruby/models/payroll_uk/payslip_object.rb +242 -242
  489. data/lib/xero-ruby/models/payroll_uk/payslips.rb +244 -244
  490. data/lib/xero-ruby/models/payroll_uk/problem.rb +275 -275
  491. data/lib/xero-ruby/models/payroll_uk/reimbursement.rb +262 -262
  492. data/lib/xero-ruby/models/payroll_uk/reimbursement_line.rb +242 -242
  493. data/lib/xero-ruby/models/payroll_uk/reimbursement_object.rb +242 -242
  494. data/lib/xero-ruby/models/payroll_uk/reimbursements.rb +244 -244
  495. data/lib/xero-ruby/models/payroll_uk/salary_and_wage.rb +383 -383
  496. data/lib/xero-ruby/models/payroll_uk/salary_and_wage_object.rb +242 -242
  497. data/lib/xero-ruby/models/payroll_uk/salary_and_wages.rb +244 -244
  498. data/lib/xero-ruby/models/payroll_uk/settings.rb +242 -242
  499. data/lib/xero-ruby/models/payroll_uk/statutory_deduction.rb +262 -262
  500. data/lib/xero-ruby/models/payroll_uk/statutory_deduction_category.rb +48 -48
  501. data/lib/xero-ruby/models/payroll_uk/tax_line.rb +272 -272
  502. data/lib/xero-ruby/models/payroll_uk/timesheet.rb +361 -361
  503. data/lib/xero-ruby/models/payroll_uk/timesheet_earnings_line.rb +272 -272
  504. data/lib/xero-ruby/models/payroll_uk/timesheet_line.rb +277 -277
  505. data/lib/xero-ruby/models/payroll_uk/timesheet_line_object.rb +242 -242
  506. data/lib/xero-ruby/models/payroll_uk/timesheet_object.rb +242 -242
  507. data/lib/xero-ruby/models/payroll_uk/timesheets.rb +244 -244
  508. data/lib/xero-ruby/models/payroll_uk/tracking_categories.rb +242 -242
  509. data/lib/xero-ruby/models/payroll_uk/tracking_category.rb +232 -232
  510. data/lib/xero-ruby/models/projects/amount.rb +232 -232
  511. data/lib/xero-ruby/models/projects/charge_type.rb +37 -37
  512. data/lib/xero-ruby/models/projects/currency_code.rb +198 -198
  513. data/lib/xero-ruby/models/projects/error.rb +232 -232
  514. data/lib/xero-ruby/models/projects/pagination.rb +252 -252
  515. data/lib/xero-ruby/models/projects/project.rb +437 -437
  516. data/lib/xero-ruby/models/projects/project_create_or_update.rb +257 -257
  517. data/lib/xero-ruby/models/projects/project_patch.rb +227 -227
  518. data/lib/xero-ruby/models/projects/project_status.rb +36 -36
  519. data/lib/xero-ruby/models/projects/project_user.rb +242 -242
  520. data/lib/xero-ruby/models/projects/project_users.rb +234 -234
  521. data/lib/xero-ruby/models/projects/projects.rb +234 -234
  522. data/lib/xero-ruby/models/projects/task.rb +399 -399
  523. data/lib/xero-ruby/models/projects/task_create_or_update.rb +267 -267
  524. data/lib/xero-ruby/models/projects/tasks.rb +234 -234
  525. data/lib/xero-ruby/models/projects/time_entries.rb +234 -234
  526. data/lib/xero-ruby/models/projects/time_entry.rb +339 -339
  527. data/lib/xero-ruby/models/projects/time_entry_create_or_update.rb +282 -282
  528. data/lib/xero-ruby/string_serialization.rb +52 -52
  529. data/lib/xero-ruby/version.rb +15 -15
  530. data/lib/xero-ruby/where.rb +67 -67
  531. data/lib/xero-ruby.rb +556 -554
  532. data/spec/accounting/api/accounting_api_spec.rb +2873 -2873
  533. data/spec/accounting/models/account_spec.rb +171 -171
  534. data/spec/accounting/models/account_type_spec.rb +35 -35
  535. data/spec/accounting/models/accounts_payable_spec.rb +47 -47
  536. data/spec/accounting/models/accounts_receivable_spec.rb +47 -47
  537. data/spec/accounting/models/accounts_spec.rb +41 -41
  538. data/spec/accounting/models/address_spec.rb +99 -99
  539. data/spec/accounting/models/allocation_spec.rb +53 -53
  540. data/spec/accounting/models/allocations_spec.rb +41 -41
  541. data/spec/accounting/models/attachment_spec.rb +71 -71
  542. data/spec/accounting/models/attachments_spec.rb +41 -41
  543. data/spec/accounting/models/balances_spec.rb +47 -47
  544. data/spec/accounting/models/bank_transaction_spec.rb +175 -175
  545. data/spec/accounting/models/bank_transactions_spec.rb +41 -41
  546. data/spec/accounting/models/bank_transfer_spec.rb +101 -101
  547. data/spec/accounting/models/bank_transfers_spec.rb +41 -41
  548. data/spec/accounting/models/batch_payment_details_spec.rb +65 -65
  549. data/spec/accounting/models/batch_payment_spec.rb +139 -139
  550. data/spec/accounting/models/batch_payments_spec.rb +41 -41
  551. data/spec/accounting/models/bill_spec.rb +47 -47
  552. data/spec/accounting/models/branding_theme_spec.rb +75 -75
  553. data/spec/accounting/models/branding_themes_spec.rb +41 -41
  554. data/spec/accounting/models/cis_org_setting_spec.rb +53 -53
  555. data/spec/accounting/models/cis_setting_spec.rb +47 -47
  556. data/spec/accounting/models/cis_settings_spec.rb +41 -41
  557. data/spec/accounting/models/contact_group_spec.rb +63 -63
  558. data/spec/accounting/models/contact_groups_spec.rb +41 -41
  559. data/spec/accounting/models/contact_person_spec.rb +59 -59
  560. data/spec/accounting/models/contact_spec.rb +273 -273
  561. data/spec/accounting/models/contacts_spec.rb +41 -41
  562. data/spec/accounting/models/country_code_spec.rb +35 -35
  563. data/spec/accounting/models/credit_note_spec.rb +199 -199
  564. data/spec/accounting/models/credit_notes_spec.rb +41 -41
  565. data/spec/accounting/models/currencies_spec.rb +41 -41
  566. data/spec/accounting/models/currency_code_spec.rb +35 -35
  567. data/spec/accounting/models/currency_spec.rb +47 -47
  568. data/spec/accounting/models/element_spec.rb +83 -83
  569. data/spec/accounting/models/employee_spec.rb +87 -87
  570. data/spec/accounting/models/employees_spec.rb +41 -41
  571. data/spec/accounting/models/error_spec.rb +59 -59
  572. data/spec/accounting/models/expense_claim_spec.rb +111 -111
  573. data/spec/accounting/models/expense_claims_spec.rb +41 -41
  574. data/spec/accounting/models/external_link_spec.rb +57 -57
  575. data/spec/accounting/models/history_record_spec.rb +59 -59
  576. data/spec/accounting/models/history_records_spec.rb +41 -41
  577. data/spec/accounting/models/invoice_reminder_spec.rb +41 -41
  578. data/spec/accounting/models/invoice_reminders_spec.rb +41 -41
  579. data/spec/accounting/models/invoice_spec.rb +271 -271
  580. data/spec/accounting/models/invoices_spec.rb +41 -41
  581. data/spec/accounting/models/item_spec.rb +131 -131
  582. data/spec/accounting/models/items_spec.rb +41 -41
  583. data/spec/accounting/models/journal_line_spec.rb +107 -107
  584. data/spec/accounting/models/journal_spec.rb +87 -87
  585. data/spec/accounting/models/journals_spec.rb +41 -41
  586. data/spec/accounting/models/line_amount_types_spec.rb +35 -35
  587. data/spec/accounting/models/line_item_spec.rb +113 -113
  588. data/spec/accounting/models/line_item_tracking_spec.rb +59 -59
  589. data/spec/accounting/models/linked_transaction_spec.rb +113 -113
  590. data/spec/accounting/models/linked_transactions_spec.rb +41 -41
  591. data/spec/accounting/models/manual_journal_line_spec.rb +77 -77
  592. data/spec/accounting/models/manual_journal_spec.rb +123 -123
  593. data/spec/accounting/models/manual_journals_spec.rb +41 -41
  594. data/spec/accounting/models/online_invoice_spec.rb +41 -41
  595. data/spec/accounting/models/online_invoices_spec.rb +41 -41
  596. data/spec/accounting/models/organisation_spec.rb +255 -255
  597. data/spec/accounting/models/organisations_spec.rb +41 -41
  598. data/spec/accounting/models/overpayment_spec.rb +157 -157
  599. data/spec/accounting/models/overpayments_spec.rb +41 -41
  600. data/spec/accounting/models/payment_delete_spec.rb +41 -41
  601. data/spec/accounting/models/payment_service_spec.rb +71 -71
  602. data/spec/accounting/models/payment_services_spec.rb +41 -41
  603. data/spec/accounting/models/payment_spec.rb +187 -187
  604. data/spec/accounting/models/payment_term_spec.rb +47 -47
  605. data/spec/accounting/models/payment_term_type_spec.rb +35 -35
  606. data/spec/accounting/models/payments_spec.rb +41 -41
  607. data/spec/accounting/models/phone_spec.rb +63 -63
  608. data/spec/accounting/models/prepayment_spec.rb +157 -157
  609. data/spec/accounting/models/prepayments_spec.rb +41 -41
  610. data/spec/accounting/models/purchase_order_spec.rb +207 -207
  611. data/spec/accounting/models/purchase_orders_spec.rb +41 -41
  612. data/spec/accounting/models/purchase_spec.rb +59 -59
  613. data/spec/accounting/models/quote_line_amount_types_spec.rb +35 -35
  614. data/spec/accounting/models/quote_spec.rb +167 -167
  615. data/spec/accounting/models/quote_status_codes_spec.rb +35 -35
  616. data/spec/accounting/models/quotes_spec.rb +41 -41
  617. data/spec/accounting/models/receipt_spec.rb +147 -147
  618. data/spec/accounting/models/receipts_spec.rb +41 -41
  619. data/spec/accounting/models/repeating_invoice_spec.rb +139 -139
  620. data/spec/accounting/models/repeating_invoices_spec.rb +41 -41
  621. data/spec/accounting/models/report_attribute_spec.rb +47 -47
  622. data/spec/accounting/models/report_cell_spec.rb +47 -47
  623. data/spec/accounting/models/report_fields_spec.rb +53 -53
  624. data/spec/accounting/models/report_row_spec.rb +53 -53
  625. data/spec/accounting/models/report_rows_spec.rb +59 -59
  626. data/spec/accounting/models/report_spec.rb +81 -81
  627. data/spec/accounting/models/report_with_row_spec.rb +89 -89
  628. data/spec/accounting/models/report_with_rows_spec.rb +41 -41
  629. data/spec/accounting/models/reports_spec.rb +41 -41
  630. data/spec/accounting/models/request_empty_spec.rb +41 -41
  631. data/spec/accounting/models/row_type_spec.rb +35 -35
  632. data/spec/accounting/models/sales_tracking_category_spec.rb +47 -47
  633. data/spec/accounting/models/schedule_spec.rb +85 -85
  634. data/spec/accounting/models/tax_component_spec.rb +59 -59
  635. data/spec/accounting/models/tax_rate_spec.rb +115 -115
  636. data/spec/accounting/models/tax_rates_spec.rb +41 -41
  637. data/spec/accounting/models/tax_type_spec.rb +35 -35
  638. data/spec/accounting/models/ten_nintey_nine_contact_spec.rb +167 -167
  639. data/spec/accounting/models/time_zone_spec.rb +35 -35
  640. data/spec/accounting/models/tracking_categories_spec.rb +41 -41
  641. data/spec/accounting/models/tracking_category_spec.rb +75 -75
  642. data/spec/accounting/models/tracking_option_spec.rb +63 -63
  643. data/spec/accounting/models/tracking_options_spec.rb +41 -41
  644. data/spec/accounting/models/user_spec.rb +81 -81
  645. data/spec/accounting/models/users_spec.rb +41 -41
  646. data/spec/accounting/models/validation_error_spec.rb +41 -41
  647. data/spec/api_client_spec.rb +556 -556
  648. data/spec/api_error_spec.rb +45 -45
  649. data/spec/app_store/api/app_store_api_spec.rb +45 -45
  650. data/spec/app_store/models/plan_spec.rb +62 -62
  651. data/spec/app_store/models/price_spec.rb +52 -52
  652. data/spec/app_store/models/problem_details_spec.rb +70 -70
  653. data/spec/app_store/models/product_spec.rb +56 -56
  654. data/spec/app_store/models/subscription_item_spec.rb +70 -70
  655. data/spec/app_store/models/subscription_spec.rb +82 -82
  656. data/spec/assets/api/asset_api_spec.rb +116 -116
  657. data/spec/assets/models/asset_spec.rb +125 -125
  658. data/spec/assets/models/asset_status_query_param_spec.rb +35 -35
  659. data/spec/assets/models/asset_status_spec.rb +35 -35
  660. data/spec/assets/models/asset_type_spec.rb +77 -77
  661. data/spec/assets/models/assets_spec.rb +47 -47
  662. data/spec/assets/models/book_depreciation_detail_spec.rb +77 -77
  663. data/spec/assets/models/book_depreciation_setting_spec.rb +95 -95
  664. data/spec/assets/models/error_spec.rb +65 -65
  665. data/spec/assets/models/field_validation_errors_element_spec.rb +71 -71
  666. data/spec/assets/models/pagination_spec.rb +59 -59
  667. data/spec/assets/models/resource_validation_errors_element_spec.rb +65 -65
  668. data/spec/assets/models/setting_spec.rb +83 -83
  669. data/spec/configuration_spec.rb +37 -37
  670. data/spec/files/api/files_api_spec.rb +249 -249
  671. data/spec/files/models/association_spec.rb +59 -59
  672. data/spec/files/models/file_object_spec.rb +83 -83
  673. data/spec/files/models/files_spec.rb +59 -59
  674. data/spec/files/models/folder_spec.rb +65 -65
  675. data/spec/files/models/folders_spec.rb +41 -41
  676. data/spec/files/models/inline_object_spec.rb +59 -59
  677. data/spec/files/models/object_group_spec.rb +35 -35
  678. data/spec/files/models/object_type_spec.rb +35 -35
  679. data/spec/files/models/user_spec.rb +81 -81
  680. data/spec/finance/api/finance_api_spec.rb +156 -156
  681. data/spec/finance/models/account_usage_response_spec.rb +58 -58
  682. data/spec/finance/models/account_usage_spec.rb +112 -112
  683. data/spec/finance/models/balance_sheet_account_detail_spec.rb +64 -64
  684. data/spec/finance/models/balance_sheet_account_group_spec.rb +46 -46
  685. data/spec/finance/models/balance_sheet_account_type_spec.rb +52 -52
  686. data/spec/finance/models/balance_sheet_response_spec.rb +58 -58
  687. data/spec/finance/models/bank_statement_response_spec.rb +46 -46
  688. data/spec/finance/models/cash_account_response_spec.rb +64 -64
  689. data/spec/finance/models/cash_balance_spec.rb +52 -52
  690. data/spec/finance/models/cash_validation_response_spec.rb +64 -64
  691. data/spec/finance/models/cashflow_account_spec.rb +76 -76
  692. data/spec/finance/models/cashflow_activity_spec.rb +52 -52
  693. data/spec/finance/models/cashflow_response_spec.rb +58 -58
  694. data/spec/finance/models/cashflow_type_spec.rb +52 -52
  695. data/spec/finance/models/current_statement_response_spec.rb +70 -70
  696. data/spec/finance/models/data_source_response_spec.rb +124 -124
  697. data/spec/finance/models/history_record_response_spec.rb +64 -64
  698. data/spec/finance/models/lock_history_model_spec.rb +52 -52
  699. data/spec/finance/models/lock_history_response_spec.rb +52 -52
  700. data/spec/finance/models/pnl_account_class_spec.rb +46 -46
  701. data/spec/finance/models/pnl_account_spec.rb +70 -70
  702. data/spec/finance/models/pnl_account_type_spec.rb +52 -52
  703. data/spec/finance/models/practice_response_spec.rb +64 -64
  704. data/spec/finance/models/problem_spec.rb +58 -58
  705. data/spec/finance/models/problem_type_spec.rb +34 -34
  706. data/spec/finance/models/profit_and_loss_response_spec.rb +64 -64
  707. data/spec/finance/models/report_history_model_spec.rb +52 -52
  708. data/spec/finance/models/report_history_response_spec.rb +52 -52
  709. data/spec/finance/models/statement_balance_response_spec.rb +46 -46
  710. data/spec/finance/models/statement_lines_response_spec.rb +136 -136
  711. data/spec/finance/models/trial_balance_account_spec.rb +94 -94
  712. data/spec/finance/models/trial_balance_entry_spec.rb +46 -46
  713. data/spec/finance/models/trial_balance_movement_spec.rb +58 -58
  714. data/spec/finance/models/trial_balance_response_spec.rb +52 -52
  715. data/spec/finance/models/user_activities_response_spec.rb +52 -52
  716. data/spec/finance/models/user_response_spec.rb +106 -106
  717. data/spec/helper_methods_spec.rb +110 -110
  718. data/spec/payroll_au/api/payroll_au_api_spec.rb +415 -415
  719. data/spec/payroll_au/models/account_spec.rb +59 -59
  720. data/spec/payroll_au/models/account_type_spec.rb +35 -35
  721. data/spec/payroll_au/models/allowance_type_spec.rb +35 -35
  722. data/spec/payroll_au/models/api_exception_spec.rb +53 -53
  723. data/spec/payroll_au/models/bank_account_spec.rb +71 -71
  724. data/spec/payroll_au/models/calendar_type_spec.rb +35 -35
  725. data/spec/payroll_au/models/deduction_line_spec.rb +65 -65
  726. data/spec/payroll_au/models/deduction_type_calculation_type_spec.rb +35 -35
  727. data/spec/payroll_au/models/deduction_type_spec.rb +93 -93
  728. data/spec/payroll_au/models/earnings_line_spec.rb +89 -89
  729. data/spec/payroll_au/models/earnings_rate_calculation_type_spec.rb +35 -35
  730. data/spec/payroll_au/models/earnings_rate_spec.rb +137 -137
  731. data/spec/payroll_au/models/earnings_type_spec.rb +35 -35
  732. data/spec/payroll_au/models/employee_spec.rb +225 -225
  733. data/spec/payroll_au/models/employee_status_spec.rb +35 -35
  734. data/spec/payroll_au/models/employees_spec.rb +41 -41
  735. data/spec/payroll_au/models/employment_basis_spec.rb +35 -35
  736. data/spec/payroll_au/models/employment_termination_payment_type_spec.rb +35 -35
  737. data/spec/payroll_au/models/entitlement_final_pay_payout_type_spec.rb +35 -35
  738. data/spec/payroll_au/models/home_address_spec.rb +71 -71
  739. data/spec/payroll_au/models/leave_accrual_line_spec.rb +53 -53
  740. data/spec/payroll_au/models/leave_application_spec.rb +95 -95
  741. data/spec/payroll_au/models/leave_applications_spec.rb +41 -41
  742. data/spec/payroll_au/models/leave_balance_spec.rb +59 -59
  743. data/spec/payroll_au/models/leave_earnings_line_spec.rb +53 -53
  744. data/spec/payroll_au/models/leave_line_calculation_type_spec.rb +35 -35
  745. data/spec/payroll_au/models/leave_line_spec.rb +83 -83
  746. data/spec/payroll_au/models/leave_lines_spec.rb +41 -41
  747. data/spec/payroll_au/models/leave_period_spec.rb +59 -59
  748. data/spec/payroll_au/models/leave_period_status_spec.rb +35 -35
  749. data/spec/payroll_au/models/leave_type_contribution_type_spec.rb +35 -35
  750. data/spec/payroll_au/models/leave_type_spec.rb +89 -89
  751. data/spec/payroll_au/models/manual_tax_type_spec.rb +35 -35
  752. data/spec/payroll_au/models/opening_balances_spec.rb +77 -77
  753. data/spec/payroll_au/models/pay_item_spec.rb +59 -59
  754. data/spec/payroll_au/models/pay_items_spec.rb +41 -41
  755. data/spec/payroll_au/models/pay_run_spec.rb +131 -131
  756. data/spec/payroll_au/models/pay_run_status_spec.rb +35 -35
  757. data/spec/payroll_au/models/pay_runs_spec.rb +41 -41
  758. data/spec/payroll_au/models/pay_template_spec.rb +65 -65
  759. data/spec/payroll_au/models/payment_frequency_type_spec.rb +35 -35
  760. data/spec/payroll_au/models/payroll_calendar_spec.rb +77 -77
  761. data/spec/payroll_au/models/payroll_calendars_spec.rb +41 -41
  762. data/spec/payroll_au/models/payslip_lines_spec.rb +83 -83
  763. data/spec/payroll_au/models/payslip_object_spec.rb +41 -41
  764. data/spec/payroll_au/models/payslip_spec.rb +149 -149
  765. data/spec/payroll_au/models/payslip_summary_spec.rb +107 -107
  766. data/spec/payroll_au/models/payslips_spec.rb +41 -41
  767. data/spec/payroll_au/models/rate_type_spec.rb +35 -35
  768. data/spec/payroll_au/models/reimbursement_line_spec.rb +59 -59
  769. data/spec/payroll_au/models/reimbursement_lines_spec.rb +41 -41
  770. data/spec/payroll_au/models/reimbursement_type_spec.rb +65 -65
  771. data/spec/payroll_au/models/residency_status_spec.rb +35 -35
  772. data/spec/payroll_au/models/settings_object_spec.rb +41 -41
  773. data/spec/payroll_au/models/settings_spec.rb +53 -53
  774. data/spec/payroll_au/models/settings_tracking_categories_employee_groups_spec.rb +47 -47
  775. data/spec/payroll_au/models/settings_tracking_categories_spec.rb +47 -47
  776. data/spec/payroll_au/models/settings_tracking_categories_timesheet_categories_spec.rb +47 -47
  777. data/spec/payroll_au/models/state_spec.rb +35 -35
  778. data/spec/payroll_au/models/super_fund_product_spec.rb +59 -59
  779. data/spec/payroll_au/models/super_fund_products_spec.rb +41 -41
  780. data/spec/payroll_au/models/super_fund_spec.rb +113 -113
  781. data/spec/payroll_au/models/super_fund_type_spec.rb +35 -35
  782. data/spec/payroll_au/models/super_funds_spec.rb +41 -41
  783. data/spec/payroll_au/models/super_line_spec.rb +83 -83
  784. data/spec/payroll_au/models/super_membership_spec.rb +53 -53
  785. data/spec/payroll_au/models/superannuation_calculation_type_spec.rb +35 -35
  786. data/spec/payroll_au/models/superannuation_contribution_type_spec.rb +35 -35
  787. data/spec/payroll_au/models/superannuation_line_spec.rb +89 -89
  788. data/spec/payroll_au/models/tax_declaration_spec.rb +131 -131
  789. data/spec/payroll_au/models/tax_line_spec.rb +71 -71
  790. data/spec/payroll_au/models/tfn_exemption_type_spec.rb +35 -35
  791. data/spec/payroll_au/models/timesheet_line_spec.rb +59 -59
  792. data/spec/payroll_au/models/timesheet_object_spec.rb +41 -41
  793. data/spec/payroll_au/models/timesheet_spec.rb +89 -89
  794. data/spec/payroll_au/models/timesheet_status_spec.rb +35 -35
  795. data/spec/payroll_au/models/timesheets_spec.rb +41 -41
  796. data/spec/payroll_au/models/validation_error_spec.rb +41 -41
  797. data/spec/payroll_nz/api/payroll_nz_api_spec.rb +886 -886
  798. data/spec/payroll_nz/models/account_spec.rb +63 -63
  799. data/spec/payroll_nz/models/accounts_spec.rb +41 -41
  800. data/spec/payroll_nz/models/address_spec.rb +71 -71
  801. data/spec/payroll_nz/models/bank_account_spec.rb +87 -87
  802. data/spec/payroll_nz/models/benefit_spec.rb +103 -103
  803. data/spec/payroll_nz/models/deduction_line_spec.rb +65 -65
  804. data/spec/payroll_nz/models/deduction_object_spec.rb +53 -53
  805. data/spec/payroll_nz/models/deduction_spec.rb +75 -75
  806. data/spec/payroll_nz/models/deductions_spec.rb +53 -53
  807. data/spec/payroll_nz/models/earnings_line_spec.rb +95 -95
  808. data/spec/payroll_nz/models/earnings_order_object_spec.rb +53 -53
  809. data/spec/payroll_nz/models/earnings_order_spec.rb +65 -65
  810. data/spec/payroll_nz/models/earnings_orders_spec.rb +53 -53
  811. data/spec/payroll_nz/models/earnings_rate_object_spec.rb +53 -53
  812. data/spec/payroll_nz/models/earnings_rate_spec.rb +103 -103
  813. data/spec/payroll_nz/models/earnings_rates_spec.rb +53 -53
  814. data/spec/payroll_nz/models/earnings_template_object_spec.rb +53 -53
  815. data/spec/payroll_nz/models/earnings_template_spec.rb +71 -71
  816. data/spec/payroll_nz/models/employee_earnings_templates_spec.rb +53 -53
  817. data/spec/payroll_nz/models/employee_leave_balance_spec.rb +59 -59
  818. data/spec/payroll_nz/models/employee_leave_balances_spec.rb +53 -53
  819. data/spec/payroll_nz/models/employee_leave_object_spec.rb +53 -53
  820. data/spec/payroll_nz/models/employee_leave_setup_object_spec.rb +53 -53
  821. data/spec/payroll_nz/models/employee_leave_setup_spec.rb +77 -77
  822. data/spec/payroll_nz/models/employee_leave_spec.rb +77 -77
  823. data/spec/payroll_nz/models/employee_leave_type_object_spec.rb +53 -53
  824. data/spec/payroll_nz/models/employee_leave_type_spec.rb +99 -99
  825. data/spec/payroll_nz/models/employee_leave_types_spec.rb +53 -53
  826. data/spec/payroll_nz/models/employee_leaves_spec.rb +53 -53
  827. data/spec/payroll_nz/models/employee_object_spec.rb +53 -53
  828. data/spec/payroll_nz/models/employee_opening_balance_spec.rb +59 -59
  829. data/spec/payroll_nz/models/employee_opening_balances_object_spec.rb +53 -53
  830. data/spec/payroll_nz/models/employee_pay_template_object_spec.rb +53 -53
  831. data/spec/payroll_nz/models/employee_pay_template_spec.rb +47 -47
  832. data/spec/payroll_nz/models/employee_pay_templates_spec.rb +53 -53
  833. data/spec/payroll_nz/models/employee_spec.rb +123 -123
  834. data/spec/payroll_nz/models/employee_statutory_leave_balance_object_spec.rb +53 -53
  835. data/spec/payroll_nz/models/employee_statutory_leave_balance_spec.rb +61 -61
  836. data/spec/payroll_nz/models/employee_statutory_leave_summary_spec.rb +85 -85
  837. data/spec/payroll_nz/models/employee_statutory_leaves_summaries_spec.rb +53 -53
  838. data/spec/payroll_nz/models/employee_statutory_sick_leave_object_spec.rb +53 -53
  839. data/spec/payroll_nz/models/employee_statutory_sick_leave_spec.rb +135 -135
  840. data/spec/payroll_nz/models/employee_statutory_sick_leaves_spec.rb +53 -53
  841. data/spec/payroll_nz/models/employee_tax_object_spec.rb +53 -53
  842. data/spec/payroll_nz/models/employee_tax_spec.rb +135 -135
  843. data/spec/payroll_nz/models/employees_spec.rb +53 -53
  844. data/spec/payroll_nz/models/employment_object_spec.rb +53 -53
  845. data/spec/payroll_nz/models/employment_spec.rb +53 -53
  846. data/spec/payroll_nz/models/gross_earnings_history_spec.rb +47 -47
  847. data/spec/payroll_nz/models/invalid_field_spec.rb +47 -47
  848. data/spec/payroll_nz/models/leave_accrual_line_spec.rb +47 -47
  849. data/spec/payroll_nz/models/leave_earnings_line_spec.rb +95 -95
  850. data/spec/payroll_nz/models/leave_period_spec.rb +63 -63
  851. data/spec/payroll_nz/models/leave_periods_spec.rb +53 -53
  852. data/spec/payroll_nz/models/leave_type_object_spec.rb +53 -53
  853. data/spec/payroll_nz/models/leave_type_spec.rb +71 -71
  854. data/spec/payroll_nz/models/leave_types_spec.rb +53 -53
  855. data/spec/payroll_nz/models/pagination_spec.rb +59 -59
  856. data/spec/payroll_nz/models/pay_run_calendar_object_spec.rb +53 -53
  857. data/spec/payroll_nz/models/pay_run_calendar_spec.rb +81 -81
  858. data/spec/payroll_nz/models/pay_run_calendars_spec.rb +53 -53
  859. data/spec/payroll_nz/models/pay_run_object_spec.rb +53 -53
  860. data/spec/payroll_nz/models/pay_run_spec.rb +119 -119
  861. data/spec/payroll_nz/models/pay_runs_spec.rb +53 -53
  862. data/spec/payroll_nz/models/pay_slip_object_spec.rb +53 -53
  863. data/spec/payroll_nz/models/pay_slip_spec.rb +219 -219
  864. data/spec/payroll_nz/models/pay_slips_spec.rb +53 -53
  865. data/spec/payroll_nz/models/payment_line_spec.rb +65 -65
  866. data/spec/payroll_nz/models/payment_method_object_spec.rb +53 -53
  867. data/spec/payroll_nz/models/payment_method_spec.rb +51 -51
  868. data/spec/payroll_nz/models/problem_spec.rb +71 -71
  869. data/spec/payroll_nz/models/reimbursement_line_spec.rb +65 -65
  870. data/spec/payroll_nz/models/reimbursement_object_spec.rb +53 -53
  871. data/spec/payroll_nz/models/reimbursement_spec.rb +101 -101
  872. data/spec/payroll_nz/models/reimbursements_spec.rb +53 -53
  873. data/spec/payroll_nz/models/salary_and_wage_object_spec.rb +53 -53
  874. data/spec/payroll_nz/models/salary_and_wage_spec.rb +103 -103
  875. data/spec/payroll_nz/models/salary_and_wages_spec.rb +53 -53
  876. data/spec/payroll_nz/models/settings_spec.rb +53 -53
  877. data/spec/payroll_nz/models/statutory_deduction_category_spec.rb +35 -35
  878. data/spec/payroll_nz/models/statutory_deduction_line_spec.rb +59 -59
  879. data/spec/payroll_nz/models/statutory_deduction_object_spec.rb +53 -53
  880. data/spec/payroll_nz/models/statutory_deduction_spec.rb +65 -65
  881. data/spec/payroll_nz/models/statutory_deductions_spec.rb +53 -53
  882. data/spec/payroll_nz/models/superannuation_line_spec.rb +71 -71
  883. data/spec/payroll_nz/models/superannuation_object_spec.rb +53 -53
  884. data/spec/payroll_nz/models/superannuations_spec.rb +53 -53
  885. data/spec/payroll_nz/models/tax_code_spec.rb +35 -35
  886. data/spec/payroll_nz/models/tax_line_spec.rb +65 -65
  887. data/spec/payroll_nz/models/tax_settings_spec.rb +75 -75
  888. data/spec/payroll_nz/models/timesheet_earnings_line_spec.rb +95 -95
  889. data/spec/payroll_nz/models/timesheet_line_object_spec.rb +53 -53
  890. data/spec/payroll_nz/models/timesheet_line_spec.rb +65 -65
  891. data/spec/payroll_nz/models/timesheet_object_spec.rb +53 -53
  892. data/spec/payroll_nz/models/timesheet_spec.rb +93 -93
  893. data/spec/payroll_nz/models/timesheets_spec.rb +53 -53
  894. data/spec/payroll_nz/models/tracking_categories_spec.rb +53 -53
  895. data/spec/payroll_nz/models/tracking_category_spec.rb +47 -47
  896. data/spec/payroll_uk/api/payroll_uk_api_spec.rb +912 -912
  897. data/spec/payroll_uk/models/account_spec.rb +63 -63
  898. data/spec/payroll_uk/models/accounts_spec.rb +41 -41
  899. data/spec/payroll_uk/models/address_spec.rb +65 -65
  900. data/spec/payroll_uk/models/bank_account_spec.rb +53 -53
  901. data/spec/payroll_uk/models/benefit_line_spec.rb +65 -65
  902. data/spec/payroll_uk/models/benefit_object_spec.rb +53 -53
  903. data/spec/payroll_uk/models/benefit_spec.rb +127 -127
  904. data/spec/payroll_uk/models/benefits_spec.rb +53 -53
  905. data/spec/payroll_uk/models/court_order_line_spec.rb +47 -47
  906. data/spec/payroll_uk/models/deduction_line_spec.rb +59 -59
  907. data/spec/payroll_uk/models/deduction_object_spec.rb +53 -53
  908. data/spec/payroll_uk/models/deduction_spec.rb +139 -139
  909. data/spec/payroll_uk/models/deductions_spec.rb +53 -53
  910. data/spec/payroll_uk/models/earnings_line_spec.rb +89 -89
  911. data/spec/payroll_uk/models/earnings_order_object_spec.rb +53 -53
  912. data/spec/payroll_uk/models/earnings_order_spec.rb +65 -65
  913. data/spec/payroll_uk/models/earnings_orders_spec.rb +53 -53
  914. data/spec/payroll_uk/models/earnings_rate_object_spec.rb +53 -53
  915. data/spec/payroll_uk/models/earnings_rate_spec.rb +103 -103
  916. data/spec/payroll_uk/models/earnings_rates_spec.rb +53 -53
  917. data/spec/payroll_uk/models/earnings_template_object_spec.rb +53 -53
  918. data/spec/payroll_uk/models/earnings_template_spec.rb +71 -71
  919. data/spec/payroll_uk/models/employee_leave_balance_spec.rb +59 -59
  920. data/spec/payroll_uk/models/employee_leave_balances_spec.rb +53 -53
  921. data/spec/payroll_uk/models/employee_leave_object_spec.rb +53 -53
  922. data/spec/payroll_uk/models/employee_leave_spec.rb +77 -77
  923. data/spec/payroll_uk/models/employee_leave_type_object_spec.rb +53 -53
  924. data/spec/payroll_uk/models/employee_leave_type_spec.rb +75 -75
  925. data/spec/payroll_uk/models/employee_leave_types_spec.rb +53 -53
  926. data/spec/payroll_uk/models/employee_leaves_spec.rb +53 -53
  927. data/spec/payroll_uk/models/employee_object_spec.rb +53 -53
  928. data/spec/payroll_uk/models/employee_opening_balances_object_spec.rb +53 -53
  929. data/spec/payroll_uk/models/employee_opening_balances_spec.rb +71 -71
  930. data/spec/payroll_uk/models/employee_pay_template_object_spec.rb +53 -53
  931. data/spec/payroll_uk/models/employee_pay_template_spec.rb +47 -47
  932. data/spec/payroll_uk/models/employee_pay_templates_spec.rb +53 -53
  933. data/spec/payroll_uk/models/employee_spec.rb +129 -129
  934. data/spec/payroll_uk/models/employee_statutory_leave_balance_object_spec.rb +53 -53
  935. data/spec/payroll_uk/models/employee_statutory_leave_balance_spec.rb +61 -61
  936. data/spec/payroll_uk/models/employee_statutory_leave_summary_spec.rb +85 -85
  937. data/spec/payroll_uk/models/employee_statutory_leaves_summaries_spec.rb +53 -53
  938. data/spec/payroll_uk/models/employee_statutory_sick_leave_object_spec.rb +53 -53
  939. data/spec/payroll_uk/models/employee_statutory_sick_leave_spec.rb +135 -135
  940. data/spec/payroll_uk/models/employee_statutory_sick_leaves_spec.rb +53 -53
  941. data/spec/payroll_uk/models/employee_tax_object_spec.rb +53 -53
  942. data/spec/payroll_uk/models/employee_tax_spec.rb +101 -101
  943. data/spec/payroll_uk/models/employees_spec.rb +53 -53
  944. data/spec/payroll_uk/models/employment_object_spec.rb +53 -53
  945. data/spec/payroll_uk/models/employment_spec.rb +63 -63
  946. data/spec/payroll_uk/models/invalid_field_spec.rb +47 -47
  947. data/spec/payroll_uk/models/leave_accrual_line_spec.rb +47 -47
  948. data/spec/payroll_uk/models/leave_earnings_line_spec.rb +71 -71
  949. data/spec/payroll_uk/models/leave_period_spec.rb +63 -63
  950. data/spec/payroll_uk/models/leave_periods_spec.rb +53 -53
  951. data/spec/payroll_uk/models/leave_type_object_spec.rb +53 -53
  952. data/spec/payroll_uk/models/leave_type_spec.rb +83 -83
  953. data/spec/payroll_uk/models/leave_types_spec.rb +53 -53
  954. data/spec/payroll_uk/models/pagination_spec.rb +59 -59
  955. data/spec/payroll_uk/models/pay_run_calendar_object_spec.rb +53 -53
  956. data/spec/payroll_uk/models/pay_run_calendar_spec.rb +81 -81
  957. data/spec/payroll_uk/models/pay_run_calendars_spec.rb +53 -53
  958. data/spec/payroll_uk/models/pay_run_object_spec.rb +53 -53
  959. data/spec/payroll_uk/models/pay_run_spec.rb +119 -119
  960. data/spec/payroll_uk/models/pay_runs_spec.rb +53 -53
  961. data/spec/payroll_uk/models/payment_line_spec.rb +65 -65
  962. data/spec/payroll_uk/models/payment_method_object_spec.rb +53 -53
  963. data/spec/payroll_uk/models/payment_method_spec.rb +51 -51
  964. data/spec/payroll_uk/models/payslip_object_spec.rb +53 -53
  965. data/spec/payroll_uk/models/payslip_spec.rb +201 -201
  966. data/spec/payroll_uk/models/payslips_spec.rb +53 -53
  967. data/spec/payroll_uk/models/problem_spec.rb +71 -71
  968. data/spec/payroll_uk/models/reimbursement_line_spec.rb +53 -53
  969. data/spec/payroll_uk/models/reimbursement_object_spec.rb +53 -53
  970. data/spec/payroll_uk/models/reimbursement_spec.rb +59 -59
  971. data/spec/payroll_uk/models/reimbursements_spec.rb +53 -53
  972. data/spec/payroll_uk/models/salary_and_wage_object_spec.rb +53 -53
  973. data/spec/payroll_uk/models/salary_and_wage_spec.rb +97 -97
  974. data/spec/payroll_uk/models/salary_and_wages_spec.rb +53 -53
  975. data/spec/payroll_uk/models/settings_spec.rb +53 -53
  976. data/spec/payroll_uk/models/statutory_deduction_category_spec.rb +35 -35
  977. data/spec/payroll_uk/models/statutory_deduction_spec.rb +65 -65
  978. data/spec/payroll_uk/models/tax_line_spec.rb +71 -71
  979. data/spec/payroll_uk/models/timesheet_earnings_line_spec.rb +71 -71
  980. data/spec/payroll_uk/models/timesheet_line_object_spec.rb +53 -53
  981. data/spec/payroll_uk/models/timesheet_line_spec.rb +65 -65
  982. data/spec/payroll_uk/models/timesheet_object_spec.rb +53 -53
  983. data/spec/payroll_uk/models/timesheet_spec.rb +93 -93
  984. data/spec/payroll_uk/models/timesheets_spec.rb +53 -53
  985. data/spec/payroll_uk/models/tracking_categories_spec.rb +53 -53
  986. data/spec/payroll_uk/models/tracking_category_spec.rb +47 -47
  987. data/spec/projects/api/project_api_spec.rb +229 -229
  988. data/spec/projects/models/amount_spec.rb +47 -47
  989. data/spec/projects/models/charge_type_spec.rb +35 -35
  990. data/spec/projects/models/currency_code_spec.rb +35 -35
  991. data/spec/projects/models/error_spec.rb +47 -47
  992. data/spec/projects/models/pagination_spec.rb +59 -59
  993. data/spec/projects/models/project_create_or_update_spec.rb +59 -59
  994. data/spec/projects/models/project_patch_spec.rb +41 -41
  995. data/spec/projects/models/project_spec.rb +167 -167
  996. data/spec/projects/models/project_status_spec.rb +35 -35
  997. data/spec/projects/models/project_user_spec.rb +53 -53
  998. data/spec/projects/models/project_users_spec.rb +47 -47
  999. data/spec/projects/models/projects_spec.rb +47 -47
  1000. data/spec/projects/models/task_create_or_update_spec.rb +59 -59
  1001. data/spec/projects/models/task_spec.rb +129 -129
  1002. data/spec/projects/models/tasks_spec.rb +47 -47
  1003. data/spec/projects/models/time_entries_spec.rb +47 -47
  1004. data/spec/projects/models/time_entry_create_or_update_spec.rb +65 -65
  1005. data/spec/projects/models/time_entry_spec.rb +93 -93
  1006. data/spec/spec_helper.rb +111 -111
  1007. data/spec/where_spec.rb +82 -82
  1008. metadata +385 -383
@@ -1,961 +1,961 @@
1
- =begin
2
- #Xero Finance API
3
-
4
- #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.
5
-
6
- Contact: api@xero.com
7
- Generated by: https://openapi-generator.tech
8
- OpenAPI Generator version: 4.3.1
9
-
10
- =end
11
-
12
- module XeroRuby
13
- class FinanceApi
14
- attr_accessor :api_client
15
-
16
- def initialize(api_client = ApiClient.new)
17
- @api_client = api_client
18
- end
19
- # Get account usage
20
- # A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments.
21
- # @param xero_tenant_id [String] Xero identifier for Tenant
22
- # @param [Hash] opts the optional parameters
23
- # @option opts [String] :start_month 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.
24
- # @option opts [String] :end_month 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.
25
- # @return [AccountUsageResponse]
26
- def get_accounting_activity_account_usage(xero_tenant_id, opts = {})
27
- data, _status_code, _headers = get_accounting_activity_account_usage_with_http_info(xero_tenant_id, opts)
28
- data
29
- end
30
-
31
- # Get account usage
32
- # A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments.
33
- # @param xero_tenant_id [String] Xero identifier for Tenant
34
- # @param [Hash] opts the optional parameters
35
- # @option opts [String] :start_month 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.
36
- # @option opts [String] :end_month 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.
37
- # @return [Array<(AccountUsageResponse, Integer, Hash)>] AccountUsageResponse data, response status code and response headers
38
- def get_accounting_activity_account_usage_with_http_info(xero_tenant_id, options = {})
39
- opts = options.dup
40
- if @api_client.config.debugging
41
- @api_client.config.logger.debug 'Calling API: FinanceApi.get_accounting_activity_account_usage ...'
42
- end
43
- # verify the required parameter 'xero_tenant_id' is set
44
- if @api_client.config.client_side_validation && xero_tenant_id.nil?
45
- fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_accounting_activity_account_usage"
46
- end
47
- # resource path
48
- local_var_path = '/AccountingActivities/AccountUsage'
49
-
50
- # camelize keys of incoming `where` opts
51
- opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
52
-
53
- # query parameters
54
- query_params = opts[:query_params] || {}
55
- query_params[:'startMonth'] = opts[:'start_month'] if !opts[:'start_month'].nil?
56
- query_params[:'endMonth'] = opts[:'end_month'] if !opts[:'end_month'].nil?
57
-
58
- # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
59
- query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
60
- query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
61
-
62
- # header parameters
63
- header_params = opts[:header_params] || {}
64
- # HTTP header 'Accept' (if needed)
65
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
66
- header_params[:'xero-tenant-id'] = xero_tenant_id
67
-
68
- # form parameters
69
- form_params = opts[:form_params] || {}
70
-
71
- # http body (model)
72
- post_body = opts[:body]
73
-
74
- # return_type
75
- return_type = opts[:return_type] || 'AccountUsageResponse'
76
-
77
- # auth_names
78
- auth_names = opts[:auth_names] || ['OAuth2']
79
-
80
- new_options = opts.merge(
81
- :header_params => header_params,
82
- :query_params => query_params,
83
- :form_params => form_params,
84
- :body => post_body,
85
- :auth_names => auth_names,
86
- :return_type => return_type
87
- )
88
-
89
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
90
- if @api_client.config.debugging
91
- @api_client.config.logger.debug "API called: FinanceApi#get_accounting_activity_account_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
92
- end
93
- return data, status_code, headers
94
- end
95
-
96
- # Get lock history
97
- # 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.
98
- # @param xero_tenant_id [String] Xero identifier for Tenant
99
- # @param [Hash] opts the optional parameters
100
- # @option opts [String] :end_date 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.
101
- # @return [LockHistoryResponse]
102
- def get_accounting_activity_lock_history(xero_tenant_id, opts = {})
103
- data, _status_code, _headers = get_accounting_activity_lock_history_with_http_info(xero_tenant_id, opts)
104
- data
105
- end
106
-
107
- # Get lock history
108
- # 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.
109
- # @param xero_tenant_id [String] Xero identifier for Tenant
110
- # @param [Hash] opts the optional parameters
111
- # @option opts [String] :end_date 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.
112
- # @return [Array<(LockHistoryResponse, Integer, Hash)>] LockHistoryResponse data, response status code and response headers
113
- def get_accounting_activity_lock_history_with_http_info(xero_tenant_id, options = {})
114
- opts = options.dup
115
- if @api_client.config.debugging
116
- @api_client.config.logger.debug 'Calling API: FinanceApi.get_accounting_activity_lock_history ...'
117
- end
118
- # verify the required parameter 'xero_tenant_id' is set
119
- if @api_client.config.client_side_validation && xero_tenant_id.nil?
120
- fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_accounting_activity_lock_history"
121
- end
122
- # resource path
123
- local_var_path = '/AccountingActivities/LockHistory'
124
-
125
- # camelize keys of incoming `where` opts
126
- opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
127
-
128
- # query parameters
129
- query_params = opts[:query_params] || {}
130
- query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
131
-
132
- # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
133
- query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
134
- query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
135
-
136
- # header parameters
137
- header_params = opts[:header_params] || {}
138
- # HTTP header 'Accept' (if needed)
139
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
140
- header_params[:'xero-tenant-id'] = xero_tenant_id
141
-
142
- # form parameters
143
- form_params = opts[:form_params] || {}
144
-
145
- # http body (model)
146
- post_body = opts[:body]
147
-
148
- # return_type
149
- return_type = opts[:return_type] || 'LockHistoryResponse'
150
-
151
- # auth_names
152
- auth_names = opts[:auth_names] || ['OAuth2']
153
-
154
- new_options = opts.merge(
155
- :header_params => header_params,
156
- :query_params => query_params,
157
- :form_params => form_params,
158
- :body => post_body,
159
- :auth_names => auth_names,
160
- :return_type => return_type
161
- )
162
-
163
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
164
- if @api_client.config.debugging
165
- @api_client.config.logger.debug "API called: FinanceApi#get_accounting_activity_lock_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
166
- end
167
- return data, status_code, headers
168
- end
169
-
170
- # Get report history
171
- # 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.
172
- # @param xero_tenant_id [String] Xero identifier for Tenant
173
- # @param [Hash] opts the optional parameters
174
- # @option opts [String] :end_date 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.
175
- # @return [ReportHistoryResponse]
176
- def get_accounting_activity_report_history(xero_tenant_id, opts = {})
177
- data, _status_code, _headers = get_accounting_activity_report_history_with_http_info(xero_tenant_id, opts)
178
- data
179
- end
180
-
181
- # Get report history
182
- # 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.
183
- # @param xero_tenant_id [String] Xero identifier for Tenant
184
- # @param [Hash] opts the optional parameters
185
- # @option opts [String] :end_date 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.
186
- # @return [Array<(ReportHistoryResponse, Integer, Hash)>] ReportHistoryResponse data, response status code and response headers
187
- def get_accounting_activity_report_history_with_http_info(xero_tenant_id, options = {})
188
- opts = options.dup
189
- if @api_client.config.debugging
190
- @api_client.config.logger.debug 'Calling API: FinanceApi.get_accounting_activity_report_history ...'
191
- end
192
- # verify the required parameter 'xero_tenant_id' is set
193
- if @api_client.config.client_side_validation && xero_tenant_id.nil?
194
- fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_accounting_activity_report_history"
195
- end
196
- # resource path
197
- local_var_path = '/AccountingActivities/ReportHistory'
198
-
199
- # camelize keys of incoming `where` opts
200
- opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
201
-
202
- # query parameters
203
- query_params = opts[:query_params] || {}
204
- query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
205
-
206
- # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
207
- query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
208
- query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
209
-
210
- # header parameters
211
- header_params = opts[:header_params] || {}
212
- # HTTP header 'Accept' (if needed)
213
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
214
- header_params[:'xero-tenant-id'] = xero_tenant_id
215
-
216
- # form parameters
217
- form_params = opts[:form_params] || {}
218
-
219
- # http body (model)
220
- post_body = opts[:body]
221
-
222
- # return_type
223
- return_type = opts[:return_type] || 'ReportHistoryResponse'
224
-
225
- # auth_names
226
- auth_names = opts[:auth_names] || ['OAuth2']
227
-
228
- new_options = opts.merge(
229
- :header_params => header_params,
230
- :query_params => query_params,
231
- :form_params => form_params,
232
- :body => post_body,
233
- :auth_names => auth_names,
234
- :return_type => return_type
235
- )
236
-
237
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
238
- if @api_client.config.debugging
239
- @api_client.config.logger.debug "API called: FinanceApi#get_accounting_activity_report_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
240
- end
241
- return data, status_code, headers
242
- end
243
-
244
- # Get user activities
245
- # 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.
246
- # @param xero_tenant_id [String] Xero identifier for Tenant
247
- # @param [Hash] opts the optional parameters
248
- # @option opts [String] :data_month 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.
249
- # @return [UserActivitiesResponse]
250
- def get_accounting_activity_user_activities(xero_tenant_id, opts = {})
251
- data, _status_code, _headers = get_accounting_activity_user_activities_with_http_info(xero_tenant_id, opts)
252
- data
253
- end
254
-
255
- # Get user activities
256
- # 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.
257
- # @param xero_tenant_id [String] Xero identifier for Tenant
258
- # @param [Hash] opts the optional parameters
259
- # @option opts [String] :data_month 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.
260
- # @return [Array<(UserActivitiesResponse, Integer, Hash)>] UserActivitiesResponse data, response status code and response headers
261
- def get_accounting_activity_user_activities_with_http_info(xero_tenant_id, options = {})
262
- opts = options.dup
263
- if @api_client.config.debugging
264
- @api_client.config.logger.debug 'Calling API: FinanceApi.get_accounting_activity_user_activities ...'
265
- end
266
- # verify the required parameter 'xero_tenant_id' is set
267
- if @api_client.config.client_side_validation && xero_tenant_id.nil?
268
- fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_accounting_activity_user_activities"
269
- end
270
- # resource path
271
- local_var_path = '/AccountingActivities/UserActivities'
272
-
273
- # camelize keys of incoming `where` opts
274
- opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
275
-
276
- # query parameters
277
- query_params = opts[:query_params] || {}
278
- query_params[:'dataMonth'] = opts[:'data_month'] if !opts[:'data_month'].nil?
279
-
280
- # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
281
- query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
282
- query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
283
-
284
- # header parameters
285
- header_params = opts[:header_params] || {}
286
- # HTTP header 'Accept' (if needed)
287
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
288
- header_params[:'xero-tenant-id'] = xero_tenant_id
289
-
290
- # form parameters
291
- form_params = opts[:form_params] || {}
292
-
293
- # http body (model)
294
- post_body = opts[:body]
295
-
296
- # return_type
297
- return_type = opts[:return_type] || 'UserActivitiesResponse'
298
-
299
- # auth_names
300
- auth_names = opts[:auth_names] || ['OAuth2']
301
-
302
- new_options = opts.merge(
303
- :header_params => header_params,
304
- :query_params => query_params,
305
- :form_params => form_params,
306
- :body => post_body,
307
- :auth_names => auth_names,
308
- :return_type => return_type
309
- )
310
-
311
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
312
- if @api_client.config.debugging
313
- @api_client.config.logger.debug "API called: FinanceApi#get_accounting_activity_user_activities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
314
- end
315
- return data, status_code, headers
316
- end
317
-
318
- # Get Bank Statement Accounting
319
- # 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.
320
- # @param xero_tenant_id [String] Xero identifier for Tenant
321
- # @param bank_account_id [String] string, GUID Bank account Id
322
- # @param from_date [String] 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.
323
- # @param to_date [String] 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.
324
- # @param [Hash] opts the optional parameters
325
- # @option opts [Boolean] :summary_only 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.
326
- # @return [BankStatementAccountingResponse]
327
- def get_bank_statement_accounting(xero_tenant_id, bank_account_id, from_date, to_date, opts = {})
328
- data, _status_code, _headers = get_bank_statement_accounting_with_http_info(xero_tenant_id, bank_account_id, from_date, to_date, opts)
329
- data
330
- end
331
-
332
- # Get Bank Statement Accounting
333
- # 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&#39;s assessment measures.
334
- # @param xero_tenant_id [String] Xero identifier for Tenant
335
- # @param bank_account_id [String] string, GUID Bank account Id
336
- # @param from_date [String] 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.
337
- # @param to_date [String] 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.
338
- # @param [Hash] opts the optional parameters
339
- # @option opts [Boolean] :summary_only 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.
340
- # @return [Array<(BankStatementAccountingResponse, Integer, Hash)>] BankStatementAccountingResponse data, response status code and response headers
341
- def get_bank_statement_accounting_with_http_info(xero_tenant_id, bank_account_id, from_date, to_date, options = {})
342
- opts = options.dup
343
- if @api_client.config.debugging
344
- @api_client.config.logger.debug 'Calling API: FinanceApi.get_bank_statement_accounting ...'
345
- end
346
- # verify the required parameter 'xero_tenant_id' is set
347
- if @api_client.config.client_side_validation && xero_tenant_id.nil?
348
- fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_bank_statement_accounting"
349
- end
350
- # verify the required parameter 'bank_account_id' is set
351
- if @api_client.config.client_side_validation && bank_account_id.nil?
352
- fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling FinanceApi.get_bank_statement_accounting"
353
- end
354
- # verify the required parameter 'from_date' is set
355
- if @api_client.config.client_side_validation && from_date.nil?
356
- fail ArgumentError, "Missing the required parameter 'from_date' when calling FinanceApi.get_bank_statement_accounting"
357
- end
358
- # verify the required parameter 'to_date' is set
359
- if @api_client.config.client_side_validation && to_date.nil?
360
- fail ArgumentError, "Missing the required parameter 'to_date' when calling FinanceApi.get_bank_statement_accounting"
361
- end
362
- # resource path
363
- local_var_path = '/BankStatementsPlus/statements'
364
-
365
- # camelize keys of incoming `where` opts
366
- opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
367
-
368
- # query parameters
369
- query_params = opts[:query_params] || {}
370
- query_params[:'BankAccountID'] = bank_account_id
371
- query_params[:'FromDate'] = from_date
372
- query_params[:'ToDate'] = to_date
373
- query_params[:'SummaryOnly'] = opts[:'summary_only'] if !opts[:'summary_only'].nil?
374
-
375
- # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
376
- query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
377
- query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
378
-
379
- # header parameters
380
- header_params = opts[:header_params] || {}
381
- # HTTP header 'Accept' (if needed)
382
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
383
- header_params[:'xero-tenant-id'] = xero_tenant_id
384
-
385
- # form parameters
386
- form_params = opts[:form_params] || {}
387
-
388
- # http body (model)
389
- post_body = opts[:body]
390
-
391
- # return_type
392
- return_type = opts[:return_type] || 'BankStatementAccountingResponse'
393
-
394
- # auth_names
395
- auth_names = opts[:auth_names] || ['OAuth2']
396
-
397
- new_options = opts.merge(
398
- :header_params => header_params,
399
- :query_params => query_params,
400
- :form_params => form_params,
401
- :body => post_body,
402
- :auth_names => auth_names,
403
- :return_type => return_type
404
- )
405
-
406
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
407
- if @api_client.config.debugging
408
- @api_client.config.logger.debug "API called: FinanceApi#get_bank_statement_accounting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
409
- end
410
- return data, status_code, headers
411
- end
412
-
413
- # Get cash validation
414
- # Summarizes the total cash position for each account for an org
415
- # @param xero_tenant_id [String] Xero identifier for Tenant
416
- # @param [Hash] opts the optional parameters
417
- # @option opts [String] :balance_date 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)
418
- # @option opts [String] :as_at_system_date 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.
419
- # @option opts [String] :begin_date 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.
420
- # @return [Array<CashValidationResponse>]
421
- def get_cash_validation(xero_tenant_id, opts = {})
422
- data, _status_code, _headers = get_cash_validation_with_http_info(xero_tenant_id, opts)
423
- data
424
- end
425
-
426
- # Get cash validation
427
- # Summarizes the total cash position for each account for an org
428
- # @param xero_tenant_id [String] Xero identifier for Tenant
429
- # @param [Hash] opts the optional parameters
430
- # @option opts [String] :balance_date 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)
431
- # @option opts [String] :as_at_system_date 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.
432
- # @option opts [String] :begin_date 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.
433
- # @return [Array<(Array<CashValidationResponse>, Integer, Hash)>] Array<CashValidationResponse> data, response status code and response headers
434
- def get_cash_validation_with_http_info(xero_tenant_id, options = {})
435
- opts = options.dup
436
- if @api_client.config.debugging
437
- @api_client.config.logger.debug 'Calling API: FinanceApi.get_cash_validation ...'
438
- end
439
- # verify the required parameter 'xero_tenant_id' is set
440
- if @api_client.config.client_side_validation && xero_tenant_id.nil?
441
- fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_cash_validation"
442
- end
443
- # resource path
444
- local_var_path = '/CashValidation'
445
-
446
- # camelize keys of incoming `where` opts
447
- opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
448
-
449
- # query parameters
450
- query_params = opts[:query_params] || {}
451
- query_params[:'balanceDate'] = opts[:'balance_date'] if !opts[:'balance_date'].nil?
452
- query_params[:'asAtSystemDate'] = opts[:'as_at_system_date'] if !opts[:'as_at_system_date'].nil?
453
- query_params[:'beginDate'] = opts[:'begin_date'] if !opts[:'begin_date'].nil?
454
-
455
- # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
456
- query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
457
- query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
458
-
459
- # header parameters
460
- header_params = opts[:header_params] || {}
461
- # HTTP header 'Accept' (if needed)
462
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
463
- header_params[:'xero-tenant-id'] = xero_tenant_id
464
-
465
- # form parameters
466
- form_params = opts[:form_params] || {}
467
-
468
- # http body (model)
469
- post_body = opts[:body]
470
-
471
- # return_type
472
- return_type = opts[:return_type] || 'Array<CashValidationResponse>'
473
-
474
- # auth_names
475
- auth_names = opts[:auth_names] || ['OAuth2']
476
-
477
- new_options = opts.merge(
478
- :header_params => header_params,
479
- :query_params => query_params,
480
- :form_params => form_params,
481
- :body => post_body,
482
- :auth_names => auth_names,
483
- :return_type => return_type
484
- )
485
-
486
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
487
- if @api_client.config.debugging
488
- @api_client.config.logger.debug "API called: FinanceApi#get_cash_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
489
- end
490
- return data, status_code, headers
491
- end
492
-
493
- # Get Balance Sheet report
494
- # The balance sheet report is a standard financial report which describes the financial position of an organisation at a point in time.
495
- # @param xero_tenant_id [String] Xero identifier for Tenant
496
- # @param [Hash] opts the optional parameters
497
- # @option opts [String] :balance_date Specifies the date for balance sheet report. Format yyyy-MM-dd. If no parameter is provided, the current date will be used.
498
- # @return [BalanceSheetResponse]
499
- def get_financial_statement_balance_sheet(xero_tenant_id, opts = {})
500
- data, _status_code, _headers = get_financial_statement_balance_sheet_with_http_info(xero_tenant_id, opts)
501
- data
502
- end
503
-
504
- # Get Balance Sheet report
505
- # The balance sheet report is a standard financial report which describes the financial position of an organisation at a point in time.
506
- # @param xero_tenant_id [String] Xero identifier for Tenant
507
- # @param [Hash] opts the optional parameters
508
- # @option opts [String] :balance_date Specifies the date for balance sheet report. Format yyyy-MM-dd. If no parameter is provided, the current date will be used.
509
- # @return [Array<(BalanceSheetResponse, Integer, Hash)>] BalanceSheetResponse data, response status code and response headers
510
- def get_financial_statement_balance_sheet_with_http_info(xero_tenant_id, options = {})
511
- opts = options.dup
512
- if @api_client.config.debugging
513
- @api_client.config.logger.debug 'Calling API: FinanceApi.get_financial_statement_balance_sheet ...'
514
- end
515
- # verify the required parameter 'xero_tenant_id' is set
516
- if @api_client.config.client_side_validation && xero_tenant_id.nil?
517
- fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_financial_statement_balance_sheet"
518
- end
519
- # resource path
520
- local_var_path = '/FinancialStatements/BalanceSheet'
521
-
522
- # camelize keys of incoming `where` opts
523
- opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
524
-
525
- # query parameters
526
- query_params = opts[:query_params] || {}
527
- query_params[:'balanceDate'] = opts[:'balance_date'] if !opts[:'balance_date'].nil?
528
-
529
- # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
530
- query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
531
- query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
532
-
533
- # header parameters
534
- header_params = opts[:header_params] || {}
535
- # HTTP header 'Accept' (if needed)
536
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
537
- header_params[:'xero-tenant-id'] = xero_tenant_id
538
-
539
- # form parameters
540
- form_params = opts[:form_params] || {}
541
-
542
- # http body (model)
543
- post_body = opts[:body]
544
-
545
- # return_type
546
- return_type = opts[:return_type] || 'BalanceSheetResponse'
547
-
548
- # auth_names
549
- auth_names = opts[:auth_names] || ['OAuth2']
550
-
551
- new_options = opts.merge(
552
- :header_params => header_params,
553
- :query_params => query_params,
554
- :form_params => form_params,
555
- :body => post_body,
556
- :auth_names => auth_names,
557
- :return_type => return_type
558
- )
559
-
560
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
561
- if @api_client.config.debugging
562
- @api_client.config.logger.debug "API called: FinanceApi#get_financial_statement_balance_sheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
563
- end
564
- return data, status_code, headers
565
- end
566
-
567
- # Get Cash flow report
568
- # The statement of cash flows - direct method, provides the year to date changes in operating, financing and investing cash flow activities for an organisation. Cashflow statement is not available in US region at this stage.
569
- # @param xero_tenant_id [String] Xero identifier for Tenant
570
- # @param [Hash] opts the optional parameters
571
- # @option opts [String] :start_date Date e.g. yyyy-MM-dd Specifies the start date for cash flow report. If no parameter is provided, the date of 12 months before the end date will be used.
572
- # @option opts [String] :end_date Date e.g. yyyy-MM-dd Specifies the end date for cash flow report. If no parameter is provided, the current date will be used.
573
- # @return [CashflowResponse]
574
- def get_financial_statement_cashflow(xero_tenant_id, opts = {})
575
- data, _status_code, _headers = get_financial_statement_cashflow_with_http_info(xero_tenant_id, opts)
576
- data
577
- end
578
-
579
- # Get Cash flow report
580
- # The statement of cash flows - direct method, provides the year to date changes in operating, financing and investing cash flow activities for an organisation. Cashflow statement is not available in US region at this stage.
581
- # @param xero_tenant_id [String] Xero identifier for Tenant
582
- # @param [Hash] opts the optional parameters
583
- # @option opts [String] :start_date Date e.g. yyyy-MM-dd Specifies the start date for cash flow report. If no parameter is provided, the date of 12 months before the end date will be used.
584
- # @option opts [String] :end_date Date e.g. yyyy-MM-dd Specifies the end date for cash flow report. If no parameter is provided, the current date will be used.
585
- # @return [Array<(CashflowResponse, Integer, Hash)>] CashflowResponse data, response status code and response headers
586
- def get_financial_statement_cashflow_with_http_info(xero_tenant_id, options = {})
587
- opts = options.dup
588
- if @api_client.config.debugging
589
- @api_client.config.logger.debug 'Calling API: FinanceApi.get_financial_statement_cashflow ...'
590
- end
591
- # verify the required parameter 'xero_tenant_id' is set
592
- if @api_client.config.client_side_validation && xero_tenant_id.nil?
593
- fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_financial_statement_cashflow"
594
- end
595
- # resource path
596
- local_var_path = '/FinancialStatements/Cashflow'
597
-
598
- # camelize keys of incoming `where` opts
599
- opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
600
-
601
- # query parameters
602
- query_params = opts[:query_params] || {}
603
- query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
604
- query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
605
-
606
- # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
607
- query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
608
- query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
609
-
610
- # header parameters
611
- header_params = opts[:header_params] || {}
612
- # HTTP header 'Accept' (if needed)
613
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
614
- header_params[:'xero-tenant-id'] = xero_tenant_id
615
-
616
- # form parameters
617
- form_params = opts[:form_params] || {}
618
-
619
- # http body (model)
620
- post_body = opts[:body]
621
-
622
- # return_type
623
- return_type = opts[:return_type] || 'CashflowResponse'
624
-
625
- # auth_names
626
- auth_names = opts[:auth_names] || ['OAuth2']
627
-
628
- new_options = opts.merge(
629
- :header_params => header_params,
630
- :query_params => query_params,
631
- :form_params => form_params,
632
- :body => post_body,
633
- :auth_names => auth_names,
634
- :return_type => return_type
635
- )
636
-
637
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
638
- if @api_client.config.debugging
639
- @api_client.config.logger.debug "API called: FinanceApi#get_financial_statement_cashflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
640
- end
641
- return data, status_code, headers
642
- end
643
-
644
- # Get expense by contacts report
645
- # The expense by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.
646
- # @param xero_tenant_id [String] Xero identifier for Tenant
647
- # @param [Hash] opts the optional parameters
648
- # @option opts [Array<String>] :contact_ids Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included
649
- # @option opts [Boolean] :include_manual_journals Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included.
650
- # @option opts [String] :start_date Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
651
- # @option opts [String] :end_date Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
652
- # @return [IncomeByContactResponse]
653
- def get_financial_statement_contacts_expense(xero_tenant_id, opts = {})
654
- data, _status_code, _headers = get_financial_statement_contacts_expense_with_http_info(xero_tenant_id, opts)
655
- data
656
- end
657
-
658
- # Get expense by contacts report
659
- # The expense by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.
660
- # @param xero_tenant_id [String] Xero identifier for Tenant
661
- # @param [Hash] opts the optional parameters
662
- # @option opts [Array<String>] :contact_ids Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included
663
- # @option opts [Boolean] :include_manual_journals Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included.
664
- # @option opts [String] :start_date Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
665
- # @option opts [String] :end_date Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
666
- # @return [Array<(IncomeByContactResponse, Integer, Hash)>] IncomeByContactResponse data, response status code and response headers
667
- def get_financial_statement_contacts_expense_with_http_info(xero_tenant_id, options = {})
668
- opts = options.dup
669
- if @api_client.config.debugging
670
- @api_client.config.logger.debug 'Calling API: FinanceApi.get_financial_statement_contacts_expense ...'
671
- end
672
- # verify the required parameter 'xero_tenant_id' is set
673
- if @api_client.config.client_side_validation && xero_tenant_id.nil?
674
- fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_financial_statement_contacts_expense"
675
- end
676
- # resource path
677
- local_var_path = '/FinancialStatements/contacts/expense'
678
-
679
- # camelize keys of incoming `where` opts
680
- opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
681
-
682
- # query parameters
683
- query_params = opts[:query_params] || {}
684
- query_params[:'contactIds'] = @api_client.build_collection_param(opts[:'contact_ids'], :multi) if !opts[:'contact_ids'].nil?
685
- query_params[:'includeManualJournals'] = opts[:'include_manual_journals'] if !opts[:'include_manual_journals'].nil?
686
- query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
687
- query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
688
-
689
- # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
690
- query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
691
- query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
692
-
693
- # header parameters
694
- header_params = opts[:header_params] || {}
695
- # HTTP header 'Accept' (if needed)
696
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
697
- header_params[:'xero-tenant-id'] = xero_tenant_id
698
-
699
- # form parameters
700
- form_params = opts[:form_params] || {}
701
-
702
- # http body (model)
703
- post_body = opts[:body]
704
-
705
- # return_type
706
- return_type = opts[:return_type] || 'IncomeByContactResponse'
707
-
708
- # auth_names
709
- auth_names = opts[:auth_names] || ['OAuth2']
710
-
711
- new_options = opts.merge(
712
- :header_params => header_params,
713
- :query_params => query_params,
714
- :form_params => form_params,
715
- :body => post_body,
716
- :auth_names => auth_names,
717
- :return_type => return_type
718
- )
719
-
720
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
721
- if @api_client.config.debugging
722
- @api_client.config.logger.debug "API called: FinanceApi#get_financial_statement_contacts_expense\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
723
- end
724
- return data, status_code, headers
725
- end
726
-
727
- # Get revenue by contacts report
728
- # The revenue by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.
729
- # @param xero_tenant_id [String] Xero identifier for Tenant
730
- # @param [Hash] opts the optional parameters
731
- # @option opts [Array<String>] :contact_ids Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included
732
- # @option opts [Boolean] :include_manual_journals Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included.
733
- # @option opts [String] :start_date Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
734
- # @option opts [String] :end_date Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
735
- # @return [IncomeByContactResponse]
736
- def get_financial_statement_contacts_revenue(xero_tenant_id, opts = {})
737
- data, _status_code, _headers = get_financial_statement_contacts_revenue_with_http_info(xero_tenant_id, opts)
738
- data
739
- end
740
-
741
- # Get revenue by contacts report
742
- # The revenue by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.
743
- # @param xero_tenant_id [String] Xero identifier for Tenant
744
- # @param [Hash] opts the optional parameters
745
- # @option opts [Array<String>] :contact_ids Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included
746
- # @option opts [Boolean] :include_manual_journals Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included.
747
- # @option opts [String] :start_date Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
748
- # @option opts [String] :end_date Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
749
- # @return [Array<(IncomeByContactResponse, Integer, Hash)>] IncomeByContactResponse data, response status code and response headers
750
- def get_financial_statement_contacts_revenue_with_http_info(xero_tenant_id, options = {})
751
- opts = options.dup
752
- if @api_client.config.debugging
753
- @api_client.config.logger.debug 'Calling API: FinanceApi.get_financial_statement_contacts_revenue ...'
754
- end
755
- # verify the required parameter 'xero_tenant_id' is set
756
- if @api_client.config.client_side_validation && xero_tenant_id.nil?
757
- fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_financial_statement_contacts_revenue"
758
- end
759
- # resource path
760
- local_var_path = '/FinancialStatements/contacts/revenue'
761
-
762
- # camelize keys of incoming `where` opts
763
- opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
764
-
765
- # query parameters
766
- query_params = opts[:query_params] || {}
767
- query_params[:'contactIds'] = @api_client.build_collection_param(opts[:'contact_ids'], :multi) if !opts[:'contact_ids'].nil?
768
- query_params[:'includeManualJournals'] = opts[:'include_manual_journals'] if !opts[:'include_manual_journals'].nil?
769
- query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
770
- query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
771
-
772
- # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
773
- query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
774
- query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
775
-
776
- # header parameters
777
- header_params = opts[:header_params] || {}
778
- # HTTP header 'Accept' (if needed)
779
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
780
- header_params[:'xero-tenant-id'] = xero_tenant_id
781
-
782
- # form parameters
783
- form_params = opts[:form_params] || {}
784
-
785
- # http body (model)
786
- post_body = opts[:body]
787
-
788
- # return_type
789
- return_type = opts[:return_type] || 'IncomeByContactResponse'
790
-
791
- # auth_names
792
- auth_names = opts[:auth_names] || ['OAuth2']
793
-
794
- new_options = opts.merge(
795
- :header_params => header_params,
796
- :query_params => query_params,
797
- :form_params => form_params,
798
- :body => post_body,
799
- :auth_names => auth_names,
800
- :return_type => return_type
801
- )
802
-
803
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
804
- if @api_client.config.debugging
805
- @api_client.config.logger.debug "API called: FinanceApi#get_financial_statement_contacts_revenue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
806
- end
807
- return data, status_code, headers
808
- end
809
-
810
- # Get Profit & Loss report
811
- # The profit and loss statement is a standard financial report providing detailed year to date income and expense detail for an organisation.
812
- # @param xero_tenant_id [String] Xero identifier for Tenant
813
- # @param [Hash] opts the optional parameters
814
- # @option opts [String] :start_date Date e.g. yyyy-MM-dd Specifies the start date for profit and loss report If no parameter is provided, the date of 12 months before the end date will be used.
815
- # @option opts [String] :end_date Date e.g. yyyy-MM-dd Specifies the end date for profit and loss report If no parameter is provided, the current date will be used.
816
- # @return [ProfitAndLossResponse]
817
- def get_financial_statement_profit_and_loss(xero_tenant_id, opts = {})
818
- data, _status_code, _headers = get_financial_statement_profit_and_loss_with_http_info(xero_tenant_id, opts)
819
- data
820
- end
821
-
822
- # Get Profit &amp; Loss report
823
- # The profit and loss statement is a standard financial report providing detailed year to date income and expense detail for an organisation.
824
- # @param xero_tenant_id [String] Xero identifier for Tenant
825
- # @param [Hash] opts the optional parameters
826
- # @option opts [String] :start_date Date e.g. yyyy-MM-dd Specifies the start date for profit and loss report If no parameter is provided, the date of 12 months before the end date will be used.
827
- # @option opts [String] :end_date Date e.g. yyyy-MM-dd Specifies the end date for profit and loss report If no parameter is provided, the current date will be used.
828
- # @return [Array<(ProfitAndLossResponse, Integer, Hash)>] ProfitAndLossResponse data, response status code and response headers
829
- def get_financial_statement_profit_and_loss_with_http_info(xero_tenant_id, options = {})
830
- opts = options.dup
831
- if @api_client.config.debugging
832
- @api_client.config.logger.debug 'Calling API: FinanceApi.get_financial_statement_profit_and_loss ...'
833
- end
834
- # verify the required parameter 'xero_tenant_id' is set
835
- if @api_client.config.client_side_validation && xero_tenant_id.nil?
836
- fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_financial_statement_profit_and_loss"
837
- end
838
- # resource path
839
- local_var_path = '/FinancialStatements/ProfitAndLoss'
840
-
841
- # camelize keys of incoming `where` opts
842
- opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
843
-
844
- # query parameters
845
- query_params = opts[:query_params] || {}
846
- query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
847
- query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
848
-
849
- # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
850
- query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
851
- query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
852
-
853
- # header parameters
854
- header_params = opts[:header_params] || {}
855
- # HTTP header 'Accept' (if needed)
856
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
857
- header_params[:'xero-tenant-id'] = xero_tenant_id
858
-
859
- # form parameters
860
- form_params = opts[:form_params] || {}
861
-
862
- # http body (model)
863
- post_body = opts[:body]
864
-
865
- # return_type
866
- return_type = opts[:return_type] || 'ProfitAndLossResponse'
867
-
868
- # auth_names
869
- auth_names = opts[:auth_names] || ['OAuth2']
870
-
871
- new_options = opts.merge(
872
- :header_params => header_params,
873
- :query_params => query_params,
874
- :form_params => form_params,
875
- :body => post_body,
876
- :auth_names => auth_names,
877
- :return_type => return_type
878
- )
879
-
880
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
881
- if @api_client.config.debugging
882
- @api_client.config.logger.debug "API called: FinanceApi#get_financial_statement_profit_and_loss\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
883
- end
884
- return data, status_code, headers
885
- end
886
-
887
- # Get Trial Balance report
888
- # The trial balance provides a detailed list of all accounts of an organisation at a point in time, with revenue and expense items being year to date.
889
- # @param xero_tenant_id [String] Xero identifier for Tenant
890
- # @param [Hash] opts the optional parameters
891
- # @option opts [String] :end_date Date e.g. yyyy-MM-dd Specifies the end date for trial balance report If no parameter is provided, the current date will be used.
892
- # @return [TrialBalanceResponse]
893
- def get_financial_statement_trial_balance(xero_tenant_id, opts = {})
894
- data, _status_code, _headers = get_financial_statement_trial_balance_with_http_info(xero_tenant_id, opts)
895
- data
896
- end
897
-
898
- # Get Trial Balance report
899
- # The trial balance provides a detailed list of all accounts of an organisation at a point in time, with revenue and expense items being year to date.
900
- # @param xero_tenant_id [String] Xero identifier for Tenant
901
- # @param [Hash] opts the optional parameters
902
- # @option opts [String] :end_date Date e.g. yyyy-MM-dd Specifies the end date for trial balance report If no parameter is provided, the current date will be used.
903
- # @return [Array<(TrialBalanceResponse, Integer, Hash)>] TrialBalanceResponse data, response status code and response headers
904
- def get_financial_statement_trial_balance_with_http_info(xero_tenant_id, options = {})
905
- opts = options.dup
906
- if @api_client.config.debugging
907
- @api_client.config.logger.debug 'Calling API: FinanceApi.get_financial_statement_trial_balance ...'
908
- end
909
- # verify the required parameter 'xero_tenant_id' is set
910
- if @api_client.config.client_side_validation && xero_tenant_id.nil?
911
- fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_financial_statement_trial_balance"
912
- end
913
- # resource path
914
- local_var_path = '/FinancialStatements/TrialBalance'
915
-
916
- # camelize keys of incoming `where` opts
917
- opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
918
-
919
- # query parameters
920
- query_params = opts[:query_params] || {}
921
- query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
922
-
923
- # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
924
- query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
925
- query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
926
-
927
- # header parameters
928
- header_params = opts[:header_params] || {}
929
- # HTTP header 'Accept' (if needed)
930
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
931
- header_params[:'xero-tenant-id'] = xero_tenant_id
932
-
933
- # form parameters
934
- form_params = opts[:form_params] || {}
935
-
936
- # http body (model)
937
- post_body = opts[:body]
938
-
939
- # return_type
940
- return_type = opts[:return_type] || 'TrialBalanceResponse'
941
-
942
- # auth_names
943
- auth_names = opts[:auth_names] || ['OAuth2']
944
-
945
- new_options = opts.merge(
946
- :header_params => header_params,
947
- :query_params => query_params,
948
- :form_params => form_params,
949
- :body => post_body,
950
- :auth_names => auth_names,
951
- :return_type => return_type
952
- )
953
-
954
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
955
- if @api_client.config.debugging
956
- @api_client.config.logger.debug "API called: FinanceApi#get_financial_statement_trial_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
957
- end
958
- return data, status_code, headers
959
- end
960
- end
961
- end
1
+ =begin
2
+ #Xero Finance API
3
+
4
+ #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.
5
+
6
+ Contact: api@xero.com
7
+ Generated by: https://openapi-generator.tech
8
+ OpenAPI Generator version: 4.3.1
9
+
10
+ =end
11
+
12
+ module XeroRuby
13
+ class FinanceApi
14
+ attr_accessor :api_client
15
+
16
+ def initialize(api_client = ApiClient.new)
17
+ @api_client = api_client
18
+ end
19
+ # Get account usage
20
+ # A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments.
21
+ # @param xero_tenant_id [String] Xero identifier for Tenant
22
+ # @param [Hash] opts the optional parameters
23
+ # @option opts [String] :start_month 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.
24
+ # @option opts [String] :end_month 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.
25
+ # @return [AccountUsageResponse]
26
+ def get_accounting_activity_account_usage(xero_tenant_id, opts = {})
27
+ data, _status_code, _headers = get_accounting_activity_account_usage_with_http_info(xero_tenant_id, opts)
28
+ data
29
+ end
30
+
31
+ # Get account usage
32
+ # A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments.
33
+ # @param xero_tenant_id [String] Xero identifier for Tenant
34
+ # @param [Hash] opts the optional parameters
35
+ # @option opts [String] :start_month 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.
36
+ # @option opts [String] :end_month 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.
37
+ # @return [Array<(AccountUsageResponse, Integer, Hash)>] AccountUsageResponse data, response status code and response headers
38
+ def get_accounting_activity_account_usage_with_http_info(xero_tenant_id, options = {})
39
+ opts = options.dup
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: FinanceApi.get_accounting_activity_account_usage ...'
42
+ end
43
+ # verify the required parameter 'xero_tenant_id' is set
44
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
45
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_accounting_activity_account_usage"
46
+ end
47
+ # resource path
48
+ local_var_path = '/AccountingActivities/AccountUsage'
49
+
50
+ # camelize keys of incoming `where` opts
51
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
52
+
53
+ # query parameters
54
+ query_params = opts[:query_params] || {}
55
+ query_params[:'startMonth'] = opts[:'start_month'] if !opts[:'start_month'].nil?
56
+ query_params[:'endMonth'] = opts[:'end_month'] if !opts[:'end_month'].nil?
57
+
58
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
59
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
60
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
61
+
62
+ # header parameters
63
+ header_params = opts[:header_params] || {}
64
+ # HTTP header 'Accept' (if needed)
65
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
66
+ header_params[:'xero-tenant-id'] = xero_tenant_id
67
+
68
+ # form parameters
69
+ form_params = opts[:form_params] || {}
70
+
71
+ # http body (model)
72
+ post_body = opts[:body]
73
+
74
+ # return_type
75
+ return_type = opts[:return_type] || 'AccountUsageResponse'
76
+
77
+ # auth_names
78
+ auth_names = opts[:auth_names] || ['OAuth2']
79
+
80
+ new_options = opts.merge(
81
+ :header_params => header_params,
82
+ :query_params => query_params,
83
+ :form_params => form_params,
84
+ :body => post_body,
85
+ :auth_names => auth_names,
86
+ :return_type => return_type
87
+ )
88
+
89
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
90
+ if @api_client.config.debugging
91
+ @api_client.config.logger.debug "API called: FinanceApi#get_accounting_activity_account_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
92
+ end
93
+ return data, status_code, headers
94
+ end
95
+
96
+ # Get lock history
97
+ # 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.
98
+ # @param xero_tenant_id [String] Xero identifier for Tenant
99
+ # @param [Hash] opts the optional parameters
100
+ # @option opts [String] :end_date 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.
101
+ # @return [LockHistoryResponse]
102
+ def get_accounting_activity_lock_history(xero_tenant_id, opts = {})
103
+ data, _status_code, _headers = get_accounting_activity_lock_history_with_http_info(xero_tenant_id, opts)
104
+ data
105
+ end
106
+
107
+ # Get lock history
108
+ # 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.
109
+ # @param xero_tenant_id [String] Xero identifier for Tenant
110
+ # @param [Hash] opts the optional parameters
111
+ # @option opts [String] :end_date 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.
112
+ # @return [Array<(LockHistoryResponse, Integer, Hash)>] LockHistoryResponse data, response status code and response headers
113
+ def get_accounting_activity_lock_history_with_http_info(xero_tenant_id, options = {})
114
+ opts = options.dup
115
+ if @api_client.config.debugging
116
+ @api_client.config.logger.debug 'Calling API: FinanceApi.get_accounting_activity_lock_history ...'
117
+ end
118
+ # verify the required parameter 'xero_tenant_id' is set
119
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
120
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_accounting_activity_lock_history"
121
+ end
122
+ # resource path
123
+ local_var_path = '/AccountingActivities/LockHistory'
124
+
125
+ # camelize keys of incoming `where` opts
126
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
127
+
128
+ # query parameters
129
+ query_params = opts[:query_params] || {}
130
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
131
+
132
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
133
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
134
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
135
+
136
+ # header parameters
137
+ header_params = opts[:header_params] || {}
138
+ # HTTP header 'Accept' (if needed)
139
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
140
+ header_params[:'xero-tenant-id'] = xero_tenant_id
141
+
142
+ # form parameters
143
+ form_params = opts[:form_params] || {}
144
+
145
+ # http body (model)
146
+ post_body = opts[:body]
147
+
148
+ # return_type
149
+ return_type = opts[:return_type] || 'LockHistoryResponse'
150
+
151
+ # auth_names
152
+ auth_names = opts[:auth_names] || ['OAuth2']
153
+
154
+ new_options = opts.merge(
155
+ :header_params => header_params,
156
+ :query_params => query_params,
157
+ :form_params => form_params,
158
+ :body => post_body,
159
+ :auth_names => auth_names,
160
+ :return_type => return_type
161
+ )
162
+
163
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
164
+ if @api_client.config.debugging
165
+ @api_client.config.logger.debug "API called: FinanceApi#get_accounting_activity_lock_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
166
+ end
167
+ return data, status_code, headers
168
+ end
169
+
170
+ # Get report history
171
+ # 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.
172
+ # @param xero_tenant_id [String] Xero identifier for Tenant
173
+ # @param [Hash] opts the optional parameters
174
+ # @option opts [String] :end_date 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.
175
+ # @return [ReportHistoryResponse]
176
+ def get_accounting_activity_report_history(xero_tenant_id, opts = {})
177
+ data, _status_code, _headers = get_accounting_activity_report_history_with_http_info(xero_tenant_id, opts)
178
+ data
179
+ end
180
+
181
+ # Get report history
182
+ # 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.
183
+ # @param xero_tenant_id [String] Xero identifier for Tenant
184
+ # @param [Hash] opts the optional parameters
185
+ # @option opts [String] :end_date 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.
186
+ # @return [Array<(ReportHistoryResponse, Integer, Hash)>] ReportHistoryResponse data, response status code and response headers
187
+ def get_accounting_activity_report_history_with_http_info(xero_tenant_id, options = {})
188
+ opts = options.dup
189
+ if @api_client.config.debugging
190
+ @api_client.config.logger.debug 'Calling API: FinanceApi.get_accounting_activity_report_history ...'
191
+ end
192
+ # verify the required parameter 'xero_tenant_id' is set
193
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
194
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_accounting_activity_report_history"
195
+ end
196
+ # resource path
197
+ local_var_path = '/AccountingActivities/ReportHistory'
198
+
199
+ # camelize keys of incoming `where` opts
200
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
201
+
202
+ # query parameters
203
+ query_params = opts[:query_params] || {}
204
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
205
+
206
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
207
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
208
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
209
+
210
+ # header parameters
211
+ header_params = opts[:header_params] || {}
212
+ # HTTP header 'Accept' (if needed)
213
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
214
+ header_params[:'xero-tenant-id'] = xero_tenant_id
215
+
216
+ # form parameters
217
+ form_params = opts[:form_params] || {}
218
+
219
+ # http body (model)
220
+ post_body = opts[:body]
221
+
222
+ # return_type
223
+ return_type = opts[:return_type] || 'ReportHistoryResponse'
224
+
225
+ # auth_names
226
+ auth_names = opts[:auth_names] || ['OAuth2']
227
+
228
+ new_options = opts.merge(
229
+ :header_params => header_params,
230
+ :query_params => query_params,
231
+ :form_params => form_params,
232
+ :body => post_body,
233
+ :auth_names => auth_names,
234
+ :return_type => return_type
235
+ )
236
+
237
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
238
+ if @api_client.config.debugging
239
+ @api_client.config.logger.debug "API called: FinanceApi#get_accounting_activity_report_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
240
+ end
241
+ return data, status_code, headers
242
+ end
243
+
244
+ # Get user activities
245
+ # 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.
246
+ # @param xero_tenant_id [String] Xero identifier for Tenant
247
+ # @param [Hash] opts the optional parameters
248
+ # @option opts [String] :data_month 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.
249
+ # @return [UserActivitiesResponse]
250
+ def get_accounting_activity_user_activities(xero_tenant_id, opts = {})
251
+ data, _status_code, _headers = get_accounting_activity_user_activities_with_http_info(xero_tenant_id, opts)
252
+ data
253
+ end
254
+
255
+ # Get user activities
256
+ # 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.
257
+ # @param xero_tenant_id [String] Xero identifier for Tenant
258
+ # @param [Hash] opts the optional parameters
259
+ # @option opts [String] :data_month 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.
260
+ # @return [Array<(UserActivitiesResponse, Integer, Hash)>] UserActivitiesResponse data, response status code and response headers
261
+ def get_accounting_activity_user_activities_with_http_info(xero_tenant_id, options = {})
262
+ opts = options.dup
263
+ if @api_client.config.debugging
264
+ @api_client.config.logger.debug 'Calling API: FinanceApi.get_accounting_activity_user_activities ...'
265
+ end
266
+ # verify the required parameter 'xero_tenant_id' is set
267
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
268
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_accounting_activity_user_activities"
269
+ end
270
+ # resource path
271
+ local_var_path = '/AccountingActivities/UserActivities'
272
+
273
+ # camelize keys of incoming `where` opts
274
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
275
+
276
+ # query parameters
277
+ query_params = opts[:query_params] || {}
278
+ query_params[:'dataMonth'] = opts[:'data_month'] if !opts[:'data_month'].nil?
279
+
280
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
281
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
282
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
283
+
284
+ # header parameters
285
+ header_params = opts[:header_params] || {}
286
+ # HTTP header 'Accept' (if needed)
287
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
288
+ header_params[:'xero-tenant-id'] = xero_tenant_id
289
+
290
+ # form parameters
291
+ form_params = opts[:form_params] || {}
292
+
293
+ # http body (model)
294
+ post_body = opts[:body]
295
+
296
+ # return_type
297
+ return_type = opts[:return_type] || 'UserActivitiesResponse'
298
+
299
+ # auth_names
300
+ auth_names = opts[:auth_names] || ['OAuth2']
301
+
302
+ new_options = opts.merge(
303
+ :header_params => header_params,
304
+ :query_params => query_params,
305
+ :form_params => form_params,
306
+ :body => post_body,
307
+ :auth_names => auth_names,
308
+ :return_type => return_type
309
+ )
310
+
311
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
312
+ if @api_client.config.debugging
313
+ @api_client.config.logger.debug "API called: FinanceApi#get_accounting_activity_user_activities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
314
+ end
315
+ return data, status_code, headers
316
+ end
317
+
318
+ # Get Bank Statement Accounting
319
+ # 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.
320
+ # @param xero_tenant_id [String] Xero identifier for Tenant
321
+ # @param bank_account_id [String] string, GUID Bank account Id
322
+ # @param from_date [String] 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.
323
+ # @param to_date [String] 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.
324
+ # @param [Hash] opts the optional parameters
325
+ # @option opts [Boolean] :summary_only 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.
326
+ # @return [BankStatementAccountingResponse]
327
+ def get_bank_statement_accounting(xero_tenant_id, bank_account_id, from_date, to_date, opts = {})
328
+ data, _status_code, _headers = get_bank_statement_accounting_with_http_info(xero_tenant_id, bank_account_id, from_date, to_date, opts)
329
+ data
330
+ end
331
+
332
+ # Get Bank Statement Accounting
333
+ # 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&#39;s assessment measures.
334
+ # @param xero_tenant_id [String] Xero identifier for Tenant
335
+ # @param bank_account_id [String] string, GUID Bank account Id
336
+ # @param from_date [String] 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.
337
+ # @param to_date [String] 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.
338
+ # @param [Hash] opts the optional parameters
339
+ # @option opts [Boolean] :summary_only 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.
340
+ # @return [Array<(BankStatementAccountingResponse, Integer, Hash)>] BankStatementAccountingResponse data, response status code and response headers
341
+ def get_bank_statement_accounting_with_http_info(xero_tenant_id, bank_account_id, from_date, to_date, options = {})
342
+ opts = options.dup
343
+ if @api_client.config.debugging
344
+ @api_client.config.logger.debug 'Calling API: FinanceApi.get_bank_statement_accounting ...'
345
+ end
346
+ # verify the required parameter 'xero_tenant_id' is set
347
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
348
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_bank_statement_accounting"
349
+ end
350
+ # verify the required parameter 'bank_account_id' is set
351
+ if @api_client.config.client_side_validation && bank_account_id.nil?
352
+ fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling FinanceApi.get_bank_statement_accounting"
353
+ end
354
+ # verify the required parameter 'from_date' is set
355
+ if @api_client.config.client_side_validation && from_date.nil?
356
+ fail ArgumentError, "Missing the required parameter 'from_date' when calling FinanceApi.get_bank_statement_accounting"
357
+ end
358
+ # verify the required parameter 'to_date' is set
359
+ if @api_client.config.client_side_validation && to_date.nil?
360
+ fail ArgumentError, "Missing the required parameter 'to_date' when calling FinanceApi.get_bank_statement_accounting"
361
+ end
362
+ # resource path
363
+ local_var_path = '/BankStatementsPlus/statements'
364
+
365
+ # camelize keys of incoming `where` opts
366
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
367
+
368
+ # query parameters
369
+ query_params = opts[:query_params] || {}
370
+ query_params[:'BankAccountID'] = bank_account_id
371
+ query_params[:'FromDate'] = from_date
372
+ query_params[:'ToDate'] = to_date
373
+ query_params[:'SummaryOnly'] = opts[:'summary_only'] if !opts[:'summary_only'].nil?
374
+
375
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
376
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
377
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
378
+
379
+ # header parameters
380
+ header_params = opts[:header_params] || {}
381
+ # HTTP header 'Accept' (if needed)
382
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
383
+ header_params[:'xero-tenant-id'] = xero_tenant_id
384
+
385
+ # form parameters
386
+ form_params = opts[:form_params] || {}
387
+
388
+ # http body (model)
389
+ post_body = opts[:body]
390
+
391
+ # return_type
392
+ return_type = opts[:return_type] || 'BankStatementAccountingResponse'
393
+
394
+ # auth_names
395
+ auth_names = opts[:auth_names] || ['OAuth2']
396
+
397
+ new_options = opts.merge(
398
+ :header_params => header_params,
399
+ :query_params => query_params,
400
+ :form_params => form_params,
401
+ :body => post_body,
402
+ :auth_names => auth_names,
403
+ :return_type => return_type
404
+ )
405
+
406
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
407
+ if @api_client.config.debugging
408
+ @api_client.config.logger.debug "API called: FinanceApi#get_bank_statement_accounting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
409
+ end
410
+ return data, status_code, headers
411
+ end
412
+
413
+ # Get cash validation
414
+ # Summarizes the total cash position for each account for an org
415
+ # @param xero_tenant_id [String] Xero identifier for Tenant
416
+ # @param [Hash] opts the optional parameters
417
+ # @option opts [String] :balance_date 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)
418
+ # @option opts [String] :as_at_system_date 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.
419
+ # @option opts [String] :begin_date 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.
420
+ # @return [Array<CashValidationResponse>]
421
+ def get_cash_validation(xero_tenant_id, opts = {})
422
+ data, _status_code, _headers = get_cash_validation_with_http_info(xero_tenant_id, opts)
423
+ data
424
+ end
425
+
426
+ # Get cash validation
427
+ # Summarizes the total cash position for each account for an org
428
+ # @param xero_tenant_id [String] Xero identifier for Tenant
429
+ # @param [Hash] opts the optional parameters
430
+ # @option opts [String] :balance_date 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)
431
+ # @option opts [String] :as_at_system_date 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.
432
+ # @option opts [String] :begin_date 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.
433
+ # @return [Array<(Array<CashValidationResponse>, Integer, Hash)>] Array<CashValidationResponse> data, response status code and response headers
434
+ def get_cash_validation_with_http_info(xero_tenant_id, options = {})
435
+ opts = options.dup
436
+ if @api_client.config.debugging
437
+ @api_client.config.logger.debug 'Calling API: FinanceApi.get_cash_validation ...'
438
+ end
439
+ # verify the required parameter 'xero_tenant_id' is set
440
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
441
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_cash_validation"
442
+ end
443
+ # resource path
444
+ local_var_path = '/CashValidation'
445
+
446
+ # camelize keys of incoming `where` opts
447
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
448
+
449
+ # query parameters
450
+ query_params = opts[:query_params] || {}
451
+ query_params[:'balanceDate'] = opts[:'balance_date'] if !opts[:'balance_date'].nil?
452
+ query_params[:'asAtSystemDate'] = opts[:'as_at_system_date'] if !opts[:'as_at_system_date'].nil?
453
+ query_params[:'beginDate'] = opts[:'begin_date'] if !opts[:'begin_date'].nil?
454
+
455
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
456
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
457
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
458
+
459
+ # header parameters
460
+ header_params = opts[:header_params] || {}
461
+ # HTTP header 'Accept' (if needed)
462
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
463
+ header_params[:'xero-tenant-id'] = xero_tenant_id
464
+
465
+ # form parameters
466
+ form_params = opts[:form_params] || {}
467
+
468
+ # http body (model)
469
+ post_body = opts[:body]
470
+
471
+ # return_type
472
+ return_type = opts[:return_type] || 'Array<CashValidationResponse>'
473
+
474
+ # auth_names
475
+ auth_names = opts[:auth_names] || ['OAuth2']
476
+
477
+ new_options = opts.merge(
478
+ :header_params => header_params,
479
+ :query_params => query_params,
480
+ :form_params => form_params,
481
+ :body => post_body,
482
+ :auth_names => auth_names,
483
+ :return_type => return_type
484
+ )
485
+
486
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
487
+ if @api_client.config.debugging
488
+ @api_client.config.logger.debug "API called: FinanceApi#get_cash_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
489
+ end
490
+ return data, status_code, headers
491
+ end
492
+
493
+ # Get Balance Sheet report
494
+ # The balance sheet report is a standard financial report which describes the financial position of an organisation at a point in time.
495
+ # @param xero_tenant_id [String] Xero identifier for Tenant
496
+ # @param [Hash] opts the optional parameters
497
+ # @option opts [String] :balance_date Specifies the date for balance sheet report. Format yyyy-MM-dd. If no parameter is provided, the current date will be used.
498
+ # @return [BalanceSheetResponse]
499
+ def get_financial_statement_balance_sheet(xero_tenant_id, opts = {})
500
+ data, _status_code, _headers = get_financial_statement_balance_sheet_with_http_info(xero_tenant_id, opts)
501
+ data
502
+ end
503
+
504
+ # Get Balance Sheet report
505
+ # The balance sheet report is a standard financial report which describes the financial position of an organisation at a point in time.
506
+ # @param xero_tenant_id [String] Xero identifier for Tenant
507
+ # @param [Hash] opts the optional parameters
508
+ # @option opts [String] :balance_date Specifies the date for balance sheet report. Format yyyy-MM-dd. If no parameter is provided, the current date will be used.
509
+ # @return [Array<(BalanceSheetResponse, Integer, Hash)>] BalanceSheetResponse data, response status code and response headers
510
+ def get_financial_statement_balance_sheet_with_http_info(xero_tenant_id, options = {})
511
+ opts = options.dup
512
+ if @api_client.config.debugging
513
+ @api_client.config.logger.debug 'Calling API: FinanceApi.get_financial_statement_balance_sheet ...'
514
+ end
515
+ # verify the required parameter 'xero_tenant_id' is set
516
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
517
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_financial_statement_balance_sheet"
518
+ end
519
+ # resource path
520
+ local_var_path = '/FinancialStatements/BalanceSheet'
521
+
522
+ # camelize keys of incoming `where` opts
523
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
524
+
525
+ # query parameters
526
+ query_params = opts[:query_params] || {}
527
+ query_params[:'balanceDate'] = opts[:'balance_date'] if !opts[:'balance_date'].nil?
528
+
529
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
530
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
531
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
532
+
533
+ # header parameters
534
+ header_params = opts[:header_params] || {}
535
+ # HTTP header 'Accept' (if needed)
536
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
537
+ header_params[:'xero-tenant-id'] = xero_tenant_id
538
+
539
+ # form parameters
540
+ form_params = opts[:form_params] || {}
541
+
542
+ # http body (model)
543
+ post_body = opts[:body]
544
+
545
+ # return_type
546
+ return_type = opts[:return_type] || 'BalanceSheetResponse'
547
+
548
+ # auth_names
549
+ auth_names = opts[:auth_names] || ['OAuth2']
550
+
551
+ new_options = opts.merge(
552
+ :header_params => header_params,
553
+ :query_params => query_params,
554
+ :form_params => form_params,
555
+ :body => post_body,
556
+ :auth_names => auth_names,
557
+ :return_type => return_type
558
+ )
559
+
560
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
561
+ if @api_client.config.debugging
562
+ @api_client.config.logger.debug "API called: FinanceApi#get_financial_statement_balance_sheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
563
+ end
564
+ return data, status_code, headers
565
+ end
566
+
567
+ # Get Cash flow report
568
+ # The statement of cash flows - direct method, provides the year to date changes in operating, financing and investing cash flow activities for an organisation. Cashflow statement is not available in US region at this stage.
569
+ # @param xero_tenant_id [String] Xero identifier for Tenant
570
+ # @param [Hash] opts the optional parameters
571
+ # @option opts [String] :start_date Date e.g. yyyy-MM-dd Specifies the start date for cash flow report. If no parameter is provided, the date of 12 months before the end date will be used.
572
+ # @option opts [String] :end_date Date e.g. yyyy-MM-dd Specifies the end date for cash flow report. If no parameter is provided, the current date will be used.
573
+ # @return [CashflowResponse]
574
+ def get_financial_statement_cashflow(xero_tenant_id, opts = {})
575
+ data, _status_code, _headers = get_financial_statement_cashflow_with_http_info(xero_tenant_id, opts)
576
+ data
577
+ end
578
+
579
+ # Get Cash flow report
580
+ # The statement of cash flows - direct method, provides the year to date changes in operating, financing and investing cash flow activities for an organisation. Cashflow statement is not available in US region at this stage.
581
+ # @param xero_tenant_id [String] Xero identifier for Tenant
582
+ # @param [Hash] opts the optional parameters
583
+ # @option opts [String] :start_date Date e.g. yyyy-MM-dd Specifies the start date for cash flow report. If no parameter is provided, the date of 12 months before the end date will be used.
584
+ # @option opts [String] :end_date Date e.g. yyyy-MM-dd Specifies the end date for cash flow report. If no parameter is provided, the current date will be used.
585
+ # @return [Array<(CashflowResponse, Integer, Hash)>] CashflowResponse data, response status code and response headers
586
+ def get_financial_statement_cashflow_with_http_info(xero_tenant_id, options = {})
587
+ opts = options.dup
588
+ if @api_client.config.debugging
589
+ @api_client.config.logger.debug 'Calling API: FinanceApi.get_financial_statement_cashflow ...'
590
+ end
591
+ # verify the required parameter 'xero_tenant_id' is set
592
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
593
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_financial_statement_cashflow"
594
+ end
595
+ # resource path
596
+ local_var_path = '/FinancialStatements/Cashflow'
597
+
598
+ # camelize keys of incoming `where` opts
599
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
600
+
601
+ # query parameters
602
+ query_params = opts[:query_params] || {}
603
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
604
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
605
+
606
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
607
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
608
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
609
+
610
+ # header parameters
611
+ header_params = opts[:header_params] || {}
612
+ # HTTP header 'Accept' (if needed)
613
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
614
+ header_params[:'xero-tenant-id'] = xero_tenant_id
615
+
616
+ # form parameters
617
+ form_params = opts[:form_params] || {}
618
+
619
+ # http body (model)
620
+ post_body = opts[:body]
621
+
622
+ # return_type
623
+ return_type = opts[:return_type] || 'CashflowResponse'
624
+
625
+ # auth_names
626
+ auth_names = opts[:auth_names] || ['OAuth2']
627
+
628
+ new_options = opts.merge(
629
+ :header_params => header_params,
630
+ :query_params => query_params,
631
+ :form_params => form_params,
632
+ :body => post_body,
633
+ :auth_names => auth_names,
634
+ :return_type => return_type
635
+ )
636
+
637
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
638
+ if @api_client.config.debugging
639
+ @api_client.config.logger.debug "API called: FinanceApi#get_financial_statement_cashflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
640
+ end
641
+ return data, status_code, headers
642
+ end
643
+
644
+ # Get expense by contacts report
645
+ # The expense by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.
646
+ # @param xero_tenant_id [String] Xero identifier for Tenant
647
+ # @param [Hash] opts the optional parameters
648
+ # @option opts [Array<String>] :contact_ids Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included
649
+ # @option opts [Boolean] :include_manual_journals Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included.
650
+ # @option opts [String] :start_date Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
651
+ # @option opts [String] :end_date Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
652
+ # @return [IncomeByContactResponse]
653
+ def get_financial_statement_contacts_expense(xero_tenant_id, opts = {})
654
+ data, _status_code, _headers = get_financial_statement_contacts_expense_with_http_info(xero_tenant_id, opts)
655
+ data
656
+ end
657
+
658
+ # Get expense by contacts report
659
+ # The expense by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.
660
+ # @param xero_tenant_id [String] Xero identifier for Tenant
661
+ # @param [Hash] opts the optional parameters
662
+ # @option opts [Array<String>] :contact_ids Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included
663
+ # @option opts [Boolean] :include_manual_journals Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included.
664
+ # @option opts [String] :start_date Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
665
+ # @option opts [String] :end_date Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
666
+ # @return [Array<(IncomeByContactResponse, Integer, Hash)>] IncomeByContactResponse data, response status code and response headers
667
+ def get_financial_statement_contacts_expense_with_http_info(xero_tenant_id, options = {})
668
+ opts = options.dup
669
+ if @api_client.config.debugging
670
+ @api_client.config.logger.debug 'Calling API: FinanceApi.get_financial_statement_contacts_expense ...'
671
+ end
672
+ # verify the required parameter 'xero_tenant_id' is set
673
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
674
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_financial_statement_contacts_expense"
675
+ end
676
+ # resource path
677
+ local_var_path = '/FinancialStatements/contacts/expense'
678
+
679
+ # camelize keys of incoming `where` opts
680
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
681
+
682
+ # query parameters
683
+ query_params = opts[:query_params] || {}
684
+ query_params[:'contactIds'] = @api_client.build_collection_param(opts[:'contact_ids'], :multi) if !opts[:'contact_ids'].nil?
685
+ query_params[:'includeManualJournals'] = opts[:'include_manual_journals'] if !opts[:'include_manual_journals'].nil?
686
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
687
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
688
+
689
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
690
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
691
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
692
+
693
+ # header parameters
694
+ header_params = opts[:header_params] || {}
695
+ # HTTP header 'Accept' (if needed)
696
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
697
+ header_params[:'xero-tenant-id'] = xero_tenant_id
698
+
699
+ # form parameters
700
+ form_params = opts[:form_params] || {}
701
+
702
+ # http body (model)
703
+ post_body = opts[:body]
704
+
705
+ # return_type
706
+ return_type = opts[:return_type] || 'IncomeByContactResponse'
707
+
708
+ # auth_names
709
+ auth_names = opts[:auth_names] || ['OAuth2']
710
+
711
+ new_options = opts.merge(
712
+ :header_params => header_params,
713
+ :query_params => query_params,
714
+ :form_params => form_params,
715
+ :body => post_body,
716
+ :auth_names => auth_names,
717
+ :return_type => return_type
718
+ )
719
+
720
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
721
+ if @api_client.config.debugging
722
+ @api_client.config.logger.debug "API called: FinanceApi#get_financial_statement_contacts_expense\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
723
+ end
724
+ return data, status_code, headers
725
+ end
726
+
727
+ # Get revenue by contacts report
728
+ # The revenue by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.
729
+ # @param xero_tenant_id [String] Xero identifier for Tenant
730
+ # @param [Hash] opts the optional parameters
731
+ # @option opts [Array<String>] :contact_ids Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included
732
+ # @option opts [Boolean] :include_manual_journals Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included.
733
+ # @option opts [String] :start_date Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
734
+ # @option opts [String] :end_date Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
735
+ # @return [IncomeByContactResponse]
736
+ def get_financial_statement_contacts_revenue(xero_tenant_id, opts = {})
737
+ data, _status_code, _headers = get_financial_statement_contacts_revenue_with_http_info(xero_tenant_id, opts)
738
+ data
739
+ end
740
+
741
+ # Get revenue by contacts report
742
+ # The revenue by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.
743
+ # @param xero_tenant_id [String] Xero identifier for Tenant
744
+ # @param [Hash] opts the optional parameters
745
+ # @option opts [Array<String>] :contact_ids Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included
746
+ # @option opts [Boolean] :include_manual_journals Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included.
747
+ # @option opts [String] :start_date Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
748
+ # @option opts [String] :end_date Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.
749
+ # @return [Array<(IncomeByContactResponse, Integer, Hash)>] IncomeByContactResponse data, response status code and response headers
750
+ def get_financial_statement_contacts_revenue_with_http_info(xero_tenant_id, options = {})
751
+ opts = options.dup
752
+ if @api_client.config.debugging
753
+ @api_client.config.logger.debug 'Calling API: FinanceApi.get_financial_statement_contacts_revenue ...'
754
+ end
755
+ # verify the required parameter 'xero_tenant_id' is set
756
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
757
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_financial_statement_contacts_revenue"
758
+ end
759
+ # resource path
760
+ local_var_path = '/FinancialStatements/contacts/revenue'
761
+
762
+ # camelize keys of incoming `where` opts
763
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
764
+
765
+ # query parameters
766
+ query_params = opts[:query_params] || {}
767
+ query_params[:'contactIds'] = @api_client.build_collection_param(opts[:'contact_ids'], :multi) if !opts[:'contact_ids'].nil?
768
+ query_params[:'includeManualJournals'] = opts[:'include_manual_journals'] if !opts[:'include_manual_journals'].nil?
769
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
770
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
771
+
772
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
773
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
774
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
775
+
776
+ # header parameters
777
+ header_params = opts[:header_params] || {}
778
+ # HTTP header 'Accept' (if needed)
779
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
780
+ header_params[:'xero-tenant-id'] = xero_tenant_id
781
+
782
+ # form parameters
783
+ form_params = opts[:form_params] || {}
784
+
785
+ # http body (model)
786
+ post_body = opts[:body]
787
+
788
+ # return_type
789
+ return_type = opts[:return_type] || 'IncomeByContactResponse'
790
+
791
+ # auth_names
792
+ auth_names = opts[:auth_names] || ['OAuth2']
793
+
794
+ new_options = opts.merge(
795
+ :header_params => header_params,
796
+ :query_params => query_params,
797
+ :form_params => form_params,
798
+ :body => post_body,
799
+ :auth_names => auth_names,
800
+ :return_type => return_type
801
+ )
802
+
803
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
804
+ if @api_client.config.debugging
805
+ @api_client.config.logger.debug "API called: FinanceApi#get_financial_statement_contacts_revenue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
806
+ end
807
+ return data, status_code, headers
808
+ end
809
+
810
+ # Get Profit & Loss report
811
+ # The profit and loss statement is a standard financial report providing detailed year to date income and expense detail for an organisation.
812
+ # @param xero_tenant_id [String] Xero identifier for Tenant
813
+ # @param [Hash] opts the optional parameters
814
+ # @option opts [String] :start_date Date e.g. yyyy-MM-dd Specifies the start date for profit and loss report If no parameter is provided, the date of 12 months before the end date will be used.
815
+ # @option opts [String] :end_date Date e.g. yyyy-MM-dd Specifies the end date for profit and loss report If no parameter is provided, the current date will be used.
816
+ # @return [ProfitAndLossResponse]
817
+ def get_financial_statement_profit_and_loss(xero_tenant_id, opts = {})
818
+ data, _status_code, _headers = get_financial_statement_profit_and_loss_with_http_info(xero_tenant_id, opts)
819
+ data
820
+ end
821
+
822
+ # Get Profit &amp; Loss report
823
+ # The profit and loss statement is a standard financial report providing detailed year to date income and expense detail for an organisation.
824
+ # @param xero_tenant_id [String] Xero identifier for Tenant
825
+ # @param [Hash] opts the optional parameters
826
+ # @option opts [String] :start_date Date e.g. yyyy-MM-dd Specifies the start date for profit and loss report If no parameter is provided, the date of 12 months before the end date will be used.
827
+ # @option opts [String] :end_date Date e.g. yyyy-MM-dd Specifies the end date for profit and loss report If no parameter is provided, the current date will be used.
828
+ # @return [Array<(ProfitAndLossResponse, Integer, Hash)>] ProfitAndLossResponse data, response status code and response headers
829
+ def get_financial_statement_profit_and_loss_with_http_info(xero_tenant_id, options = {})
830
+ opts = options.dup
831
+ if @api_client.config.debugging
832
+ @api_client.config.logger.debug 'Calling API: FinanceApi.get_financial_statement_profit_and_loss ...'
833
+ end
834
+ # verify the required parameter 'xero_tenant_id' is set
835
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
836
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_financial_statement_profit_and_loss"
837
+ end
838
+ # resource path
839
+ local_var_path = '/FinancialStatements/ProfitAndLoss'
840
+
841
+ # camelize keys of incoming `where` opts
842
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
843
+
844
+ # query parameters
845
+ query_params = opts[:query_params] || {}
846
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
847
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
848
+
849
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
850
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
851
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
852
+
853
+ # header parameters
854
+ header_params = opts[:header_params] || {}
855
+ # HTTP header 'Accept' (if needed)
856
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
857
+ header_params[:'xero-tenant-id'] = xero_tenant_id
858
+
859
+ # form parameters
860
+ form_params = opts[:form_params] || {}
861
+
862
+ # http body (model)
863
+ post_body = opts[:body]
864
+
865
+ # return_type
866
+ return_type = opts[:return_type] || 'ProfitAndLossResponse'
867
+
868
+ # auth_names
869
+ auth_names = opts[:auth_names] || ['OAuth2']
870
+
871
+ new_options = opts.merge(
872
+ :header_params => header_params,
873
+ :query_params => query_params,
874
+ :form_params => form_params,
875
+ :body => post_body,
876
+ :auth_names => auth_names,
877
+ :return_type => return_type
878
+ )
879
+
880
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
881
+ if @api_client.config.debugging
882
+ @api_client.config.logger.debug "API called: FinanceApi#get_financial_statement_profit_and_loss\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
883
+ end
884
+ return data, status_code, headers
885
+ end
886
+
887
+ # Get Trial Balance report
888
+ # The trial balance provides a detailed list of all accounts of an organisation at a point in time, with revenue and expense items being year to date.
889
+ # @param xero_tenant_id [String] Xero identifier for Tenant
890
+ # @param [Hash] opts the optional parameters
891
+ # @option opts [String] :end_date Date e.g. yyyy-MM-dd Specifies the end date for trial balance report If no parameter is provided, the current date will be used.
892
+ # @return [TrialBalanceResponse]
893
+ def get_financial_statement_trial_balance(xero_tenant_id, opts = {})
894
+ data, _status_code, _headers = get_financial_statement_trial_balance_with_http_info(xero_tenant_id, opts)
895
+ data
896
+ end
897
+
898
+ # Get Trial Balance report
899
+ # The trial balance provides a detailed list of all accounts of an organisation at a point in time, with revenue and expense items being year to date.
900
+ # @param xero_tenant_id [String] Xero identifier for Tenant
901
+ # @param [Hash] opts the optional parameters
902
+ # @option opts [String] :end_date Date e.g. yyyy-MM-dd Specifies the end date for trial balance report If no parameter is provided, the current date will be used.
903
+ # @return [Array<(TrialBalanceResponse, Integer, Hash)>] TrialBalanceResponse data, response status code and response headers
904
+ def get_financial_statement_trial_balance_with_http_info(xero_tenant_id, options = {})
905
+ opts = options.dup
906
+ if @api_client.config.debugging
907
+ @api_client.config.logger.debug 'Calling API: FinanceApi.get_financial_statement_trial_balance ...'
908
+ end
909
+ # verify the required parameter 'xero_tenant_id' is set
910
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
911
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_financial_statement_trial_balance"
912
+ end
913
+ # resource path
914
+ local_var_path = '/FinancialStatements/TrialBalance'
915
+
916
+ # camelize keys of incoming `where` opts
917
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
918
+
919
+ # query parameters
920
+ query_params = opts[:query_params] || {}
921
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
922
+
923
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
924
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
925
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
926
+
927
+ # header parameters
928
+ header_params = opts[:header_params] || {}
929
+ # HTTP header 'Accept' (if needed)
930
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
931
+ header_params[:'xero-tenant-id'] = xero_tenant_id
932
+
933
+ # form parameters
934
+ form_params = opts[:form_params] || {}
935
+
936
+ # http body (model)
937
+ post_body = opts[:body]
938
+
939
+ # return_type
940
+ return_type = opts[:return_type] || 'TrialBalanceResponse'
941
+
942
+ # auth_names
943
+ auth_names = opts[:auth_names] || ['OAuth2']
944
+
945
+ new_options = opts.merge(
946
+ :header_params => header_params,
947
+ :query_params => query_params,
948
+ :form_params => form_params,
949
+ :body => post_body,
950
+ :auth_names => auth_names,
951
+ :return_type => return_type
952
+ )
953
+
954
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
955
+ if @api_client.config.debugging
956
+ @api_client.config.logger.debug "API called: FinanceApi#get_financial_statement_trial_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
957
+ end
958
+ return data, status_code, headers
959
+ end
960
+ end
961
+ end