xero-ruby 2.5.0 → 2.5.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (454) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -1
  3. data/lib/xero-ruby/api_client.rb +2 -1
  4. data/lib/xero-ruby/version.rb +1 -1
  5. data/spec/api_client_spec.rb +15 -1
  6. metadata +4 -452
  7. data/CODE_OF_CONDUCT.md +0 -76
  8. data/CONTRIBUTING.md +0 -82
  9. data/Gemfile +0 -9
  10. data/Gemfile.lock +0 -68
  11. data/LICENSE +0 -21
  12. data/Rakefile +0 -10
  13. data/build_notes.md +0 -52
  14. data/docs/accounting/Account.md +0 -55
  15. data/docs/accounting/AccountType.md +0 -16
  16. data/docs/accounting/AccountingApi.md +0 -15310
  17. data/docs/accounting/Accounts.md +0 -17
  18. data/docs/accounting/AccountsPayable.md +0 -19
  19. data/docs/accounting/AccountsReceivable.md +0 -19
  20. data/docs/accounting/Action.md +0 -19
  21. data/docs/accounting/Actions.md +0 -17
  22. data/docs/accounting/Address.md +0 -35
  23. data/docs/accounting/AddressForOrganisation.md +0 -35
  24. data/docs/accounting/Allocation.md +0 -31
  25. data/docs/accounting/Allocations.md +0 -17
  26. data/docs/accounting/Attachment.md +0 -27
  27. data/docs/accounting/Attachments.md +0 -17
  28. data/docs/accounting/BalanceDetails.md +0 -21
  29. data/docs/accounting/Balances.md +0 -19
  30. data/docs/accounting/BankTransaction.md +0 -59
  31. data/docs/accounting/BankTransactions.md +0 -17
  32. data/docs/accounting/BankTransfer.md +0 -37
  33. data/docs/accounting/BankTransfers.md +0 -17
  34. data/docs/accounting/BatchPayment.md +0 -47
  35. data/docs/accounting/BatchPaymentDetails.md +0 -25
  36. data/docs/accounting/BatchPayments.md +0 -17
  37. data/docs/accounting/Bill.md +0 -19
  38. data/docs/accounting/BrandingTheme.md +0 -27
  39. data/docs/accounting/BrandingThemes.md +0 -17
  40. data/docs/accounting/CISOrgSetting.md +0 -21
  41. data/docs/accounting/CISSetting.md +0 -19
  42. data/docs/accounting/CISSettings.md +0 -17
  43. data/docs/accounting/Contact.md +0 -93
  44. data/docs/accounting/ContactGroup.md +0 -23
  45. data/docs/accounting/ContactGroups.md +0 -17
  46. data/docs/accounting/ContactPerson.md +0 -23
  47. data/docs/accounting/Contacts.md +0 -17
  48. data/docs/accounting/ConversionBalances.md +0 -21
  49. data/docs/accounting/ConversionDate.md +0 -19
  50. data/docs/accounting/CountryCode.md +0 -16
  51. data/docs/accounting/CreditNote.md +0 -73
  52. data/docs/accounting/CreditNotes.md +0 -17
  53. data/docs/accounting/Currencies.md +0 -17
  54. data/docs/accounting/Currency.md +0 -19
  55. data/docs/accounting/CurrencyCode.md +0 -16
  56. data/docs/accounting/Element.md +0 -31
  57. data/docs/accounting/Employee.md +0 -31
  58. data/docs/accounting/Employees.md +0 -17
  59. data/docs/accounting/Error.md +0 -23
  60. data/docs/accounting/ExpenseClaim.md +0 -39
  61. data/docs/accounting/ExpenseClaims.md +0 -17
  62. data/docs/accounting/ExternalLink.md +0 -21
  63. data/docs/accounting/HistoryRecord.md +0 -23
  64. data/docs/accounting/HistoryRecords.md +0 -17
  65. data/docs/accounting/ImportSummary.md +0 -19
  66. data/docs/accounting/ImportSummaryAccounts.md +0 -33
  67. data/docs/accounting/ImportSummaryObject.md +0 -17
  68. data/docs/accounting/ImportSummaryOrganisation.md +0 -17
  69. data/docs/accounting/Invoice.md +0 -95
  70. data/docs/accounting/InvoiceReminder.md +0 -17
  71. data/docs/accounting/InvoiceReminders.md +0 -17
  72. data/docs/accounting/Invoices.md +0 -17
  73. data/docs/accounting/Item.md +0 -47
  74. data/docs/accounting/Items.md +0 -17
  75. data/docs/accounting/Journal.md +0 -31
  76. data/docs/accounting/JournalLine.md +0 -39
  77. data/docs/accounting/Journals.md +0 -17
  78. data/docs/accounting/LineAmountTypes.md +0 -16
  79. data/docs/accounting/LineItem.md +0 -41
  80. data/docs/accounting/LineItemTracking.md +0 -23
  81. data/docs/accounting/LinkedTransaction.md +0 -37
  82. data/docs/accounting/LinkedTransactions.md +0 -17
  83. data/docs/accounting/ManualJournal.md +0 -43
  84. data/docs/accounting/ManualJournalLine.md +0 -31
  85. data/docs/accounting/ManualJournals.md +0 -17
  86. data/docs/accounting/OnlineInvoice.md +0 -17
  87. data/docs/accounting/OnlineInvoices.md +0 -17
  88. data/docs/accounting/Organisation.md +0 -81
  89. data/docs/accounting/Organisations.md +0 -17
  90. data/docs/accounting/Overpayment.md +0 -53
  91. data/docs/accounting/Overpayments.md +0 -17
  92. data/docs/accounting/Payment.md +0 -63
  93. data/docs/accounting/PaymentDelete.md +0 -17
  94. data/docs/accounting/PaymentService.md +0 -27
  95. data/docs/accounting/PaymentServices.md +0 -17
  96. data/docs/accounting/PaymentTerm.md +0 -19
  97. data/docs/accounting/PaymentTermType.md +0 -16
  98. data/docs/accounting/Payments.md +0 -17
  99. data/docs/accounting/Phone.md +0 -23
  100. data/docs/accounting/Prepayment.md +0 -53
  101. data/docs/accounting/Prepayments.md +0 -17
  102. data/docs/accounting/Purchase.md +0 -23
  103. data/docs/accounting/PurchaseOrder.md +0 -71
  104. data/docs/accounting/PurchaseOrders.md +0 -17
  105. data/docs/accounting/Quote.md +0 -63
  106. data/docs/accounting/QuoteLineAmountTypes.md +0 -16
  107. data/docs/accounting/QuoteStatusCodes.md +0 -16
  108. data/docs/accounting/Quotes.md +0 -17
  109. data/docs/accounting/Receipt.md +0 -51
  110. data/docs/accounting/Receipts.md +0 -17
  111. data/docs/accounting/RepeatingInvoice.md +0 -47
  112. data/docs/accounting/RepeatingInvoices.md +0 -17
  113. data/docs/accounting/Report.md +0 -29
  114. data/docs/accounting/ReportAttribute.md +0 -19
  115. data/docs/accounting/ReportCell.md +0 -19
  116. data/docs/accounting/ReportFields.md +0 -21
  117. data/docs/accounting/ReportRow.md +0 -21
  118. data/docs/accounting/ReportRows.md +0 -23
  119. data/docs/accounting/ReportWithRow.md +0 -33
  120. data/docs/accounting/ReportWithRows.md +0 -17
  121. data/docs/accounting/Reports.md +0 -17
  122. data/docs/accounting/RequestEmpty.md +0 -17
  123. data/docs/accounting/RowType.md +0 -16
  124. data/docs/accounting/SalesTrackingCategory.md +0 -19
  125. data/docs/accounting/Schedule.md +0 -29
  126. data/docs/accounting/Setup.md +0 -21
  127. data/docs/accounting/TaxComponent.md +0 -23
  128. data/docs/accounting/TaxRate.md +0 -39
  129. data/docs/accounting/TaxRates.md +0 -17
  130. data/docs/accounting/TaxType.md +0 -16
  131. data/docs/accounting/TenNinetyNineContact.md +0 -59
  132. data/docs/accounting/TimeZone.md +0 -16
  133. data/docs/accounting/TrackingCategories.md +0 -17
  134. data/docs/accounting/TrackingCategory.md +0 -27
  135. data/docs/accounting/TrackingOption.md +0 -23
  136. data/docs/accounting/TrackingOptions.md +0 -17
  137. data/docs/accounting/User.md +0 -29
  138. data/docs/accounting/Users.md +0 -17
  139. data/docs/accounting/ValidationError.md +0 -17
  140. data/docs/assets/Asset.md +0 -47
  141. data/docs/assets/AssetApi.md +0 -426
  142. data/docs/assets/AssetStatus.md +0 -16
  143. data/docs/assets/AssetStatusQueryParam.md +0 -16
  144. data/docs/assets/AssetType.md +0 -29
  145. data/docs/assets/Assets.md +0 -19
  146. data/docs/assets/BookDepreciationDetail.md +0 -29
  147. data/docs/assets/BookDepreciationSetting.md +0 -31
  148. data/docs/assets/Error.md +0 -25
  149. data/docs/assets/FieldValidationErrorsElement.md +0 -27
  150. data/docs/assets/Pagination.md +0 -23
  151. data/docs/assets/ResourceValidationErrorsElement.md +0 -25
  152. data/docs/assets/Setting.md +0 -31
  153. data/docs/files/Association.md +0 -23
  154. data/docs/files/FileObject.md +0 -31
  155. data/docs/files/FileResponse204.md +0 -17
  156. data/docs/files/Files.md +0 -23
  157. data/docs/files/FilesApi.md +0 -1116
  158. data/docs/files/Folder.md +0 -25
  159. data/docs/files/Folders.md +0 -17
  160. data/docs/files/InlineObject.md +0 -23
  161. data/docs/files/ObjectGroup.md +0 -16
  162. data/docs/files/ObjectType.md +0 -16
  163. data/docs/files/User.md +0 -25
  164. data/docs/payroll_au/APIException.md +0 -21
  165. data/docs/payroll_au/Account.md +0 -23
  166. data/docs/payroll_au/AccountType.md +0 -16
  167. data/docs/payroll_au/AllowanceType.md +0 -16
  168. data/docs/payroll_au/BankAccount.md +0 -27
  169. data/docs/payroll_au/CalendarType.md +0 -16
  170. data/docs/payroll_au/DeductionLine.md +0 -25
  171. data/docs/payroll_au/DeductionType.md +0 -33
  172. data/docs/payroll_au/DeductionTypeCalculationType.md +0 -16
  173. data/docs/payroll_au/EarningsLine.md +0 -33
  174. data/docs/payroll_au/EarningsRate.md +0 -49
  175. data/docs/payroll_au/EarningsRateCalculationType.md +0 -16
  176. data/docs/payroll_au/EarningsType.md +0 -16
  177. data/docs/payroll_au/Employee.md +0 -77
  178. data/docs/payroll_au/EmployeeStatus.md +0 -16
  179. data/docs/payroll_au/Employees.md +0 -17
  180. data/docs/payroll_au/EmploymentBasis.md +0 -16
  181. data/docs/payroll_au/EmploymentTerminationPaymentType.md +0 -16
  182. data/docs/payroll_au/EntitlementFinalPayPayoutType.md +0 -16
  183. data/docs/payroll_au/HomeAddress.md +0 -27
  184. data/docs/payroll_au/LeaveAccrualLine.md +0 -21
  185. data/docs/payroll_au/LeaveApplication.md +0 -35
  186. data/docs/payroll_au/LeaveApplications.md +0 -17
  187. data/docs/payroll_au/LeaveBalance.md +0 -23
  188. data/docs/payroll_au/LeaveEarningsLine.md +0 -21
  189. data/docs/payroll_au/LeaveLine.md +0 -31
  190. data/docs/payroll_au/LeaveLineCalculationType.md +0 -16
  191. data/docs/payroll_au/LeaveLines.md +0 -17
  192. data/docs/payroll_au/LeavePeriod.md +0 -23
  193. data/docs/payroll_au/LeavePeriodStatus.md +0 -16
  194. data/docs/payroll_au/LeaveType.md +0 -33
  195. data/docs/payroll_au/LeaveTypeContributionType.md +0 -16
  196. data/docs/payroll_au/ManualTaxType.md +0 -16
  197. data/docs/payroll_au/OpeningBalances.md +0 -29
  198. data/docs/payroll_au/PayItem.md +0 -23
  199. data/docs/payroll_au/PayItems.md +0 -17
  200. data/docs/payroll_au/PayRun.md +0 -47
  201. data/docs/payroll_au/PayRunStatus.md +0 -16
  202. data/docs/payroll_au/PayRuns.md +0 -17
  203. data/docs/payroll_au/PayTemplate.md +0 -25
  204. data/docs/payroll_au/PaymentFrequencyType.md +0 -16
  205. data/docs/payroll_au/PayrollAuApi.md +0 -2018
  206. data/docs/payroll_au/PayrollCalendar.md +0 -29
  207. data/docs/payroll_au/PayrollCalendars.md +0 -17
  208. data/docs/payroll_au/Payslip.md +0 -53
  209. data/docs/payroll_au/PayslipLines.md +0 -31
  210. data/docs/payroll_au/PayslipObject.md +0 -17
  211. data/docs/payroll_au/PayslipSummary.md +0 -39
  212. data/docs/payroll_au/Payslips.md +0 -17
  213. data/docs/payroll_au/RateType.md +0 -16
  214. data/docs/payroll_au/ReimbursementLine.md +0 -23
  215. data/docs/payroll_au/ReimbursementLines.md +0 -17
  216. data/docs/payroll_au/ReimbursementType.md +0 -25
  217. data/docs/payroll_au/ResidencyStatus.md +0 -16
  218. data/docs/payroll_au/Settings.md +0 -21
  219. data/docs/payroll_au/SettingsObject.md +0 -17
  220. data/docs/payroll_au/SettingsTrackingCategories.md +0 -19
  221. data/docs/payroll_au/SettingsTrackingCategoriesEmployeeGroups.md +0 -19
  222. data/docs/payroll_au/SettingsTrackingCategoriesTimesheetCategories.md +0 -19
  223. data/docs/payroll_au/State.md +0 -16
  224. data/docs/payroll_au/SuperFund.md +0 -41
  225. data/docs/payroll_au/SuperFundProduct.md +0 -23
  226. data/docs/payroll_au/SuperFundProducts.md +0 -17
  227. data/docs/payroll_au/SuperFundType.md +0 -16
  228. data/docs/payroll_au/SuperFunds.md +0 -17
  229. data/docs/payroll_au/SuperLine.md +0 -31
  230. data/docs/payroll_au/SuperMembership.md +0 -21
  231. data/docs/payroll_au/SuperannuationCalculationType.md +0 -16
  232. data/docs/payroll_au/SuperannuationContributionType.md +0 -16
  233. data/docs/payroll_au/SuperannuationLine.md +0 -33
  234. data/docs/payroll_au/TFNExemptionType.md +0 -16
  235. data/docs/payroll_au/TaxDeclaration.md +0 -47
  236. data/docs/payroll_au/TaxLine.md +0 -27
  237. data/docs/payroll_au/Timesheet.md +0 -33
  238. data/docs/payroll_au/TimesheetLine.md +0 -23
  239. data/docs/payroll_au/TimesheetObject.md +0 -17
  240. data/docs/payroll_au/TimesheetStatus.md +0 -16
  241. data/docs/payroll_au/Timesheets.md +0 -17
  242. data/docs/payroll_au/ValidationError.md +0 -17
  243. data/docs/payroll_nz/Account.md +0 -23
  244. data/docs/payroll_nz/Accounts.md +0 -17
  245. data/docs/payroll_nz/Address.md +0 -27
  246. data/docs/payroll_nz/BankAccount.md +0 -31
  247. data/docs/payroll_nz/Benefit.md +0 -35
  248. data/docs/payroll_nz/CalendarType.md +0 -16
  249. data/docs/payroll_nz/Deduction.md +0 -27
  250. data/docs/payroll_nz/DeductionLine.md +0 -25
  251. data/docs/payroll_nz/DeductionObject.md +0 -21
  252. data/docs/payroll_nz/Deductions.md +0 -21
  253. data/docs/payroll_nz/EarningsLine.md +0 -35
  254. data/docs/payroll_nz/EarningsOrder.md +0 -25
  255. data/docs/payroll_nz/EarningsOrderObject.md +0 -21
  256. data/docs/payroll_nz/EarningsOrders.md +0 -21
  257. data/docs/payroll_nz/EarningsRate.md +0 -35
  258. data/docs/payroll_nz/EarningsRateObject.md +0 -21
  259. data/docs/payroll_nz/EarningsRates.md +0 -21
  260. data/docs/payroll_nz/EarningsTemplate.md +0 -27
  261. data/docs/payroll_nz/EarningsTemplateObject.md +0 -21
  262. data/docs/payroll_nz/Employee.md +0 -43
  263. data/docs/payroll_nz/EmployeeEarningsTemplates.md +0 -21
  264. data/docs/payroll_nz/EmployeeLeave.md +0 -29
  265. data/docs/payroll_nz/EmployeeLeaveBalance.md +0 -23
  266. data/docs/payroll_nz/EmployeeLeaveBalances.md +0 -21
  267. data/docs/payroll_nz/EmployeeLeaveObject.md +0 -21
  268. data/docs/payroll_nz/EmployeeLeaveSetup.md +0 -29
  269. data/docs/payroll_nz/EmployeeLeaveSetupObject.md +0 -21
  270. data/docs/payroll_nz/EmployeeLeaveType.md +0 -35
  271. data/docs/payroll_nz/EmployeeLeaveTypeObject.md +0 -21
  272. data/docs/payroll_nz/EmployeeLeaveTypes.md +0 -21
  273. data/docs/payroll_nz/EmployeeLeaves.md +0 -21
  274. data/docs/payroll_nz/EmployeeObject.md +0 -21
  275. data/docs/payroll_nz/EmployeeOpeningBalance.md +0 -23
  276. data/docs/payroll_nz/EmployeeOpeningBalancesObject.md +0 -21
  277. data/docs/payroll_nz/EmployeePayTemplate.md +0 -19
  278. data/docs/payroll_nz/EmployeePayTemplateObject.md +0 -21
  279. data/docs/payroll_nz/EmployeePayTemplates.md +0 -21
  280. data/docs/payroll_nz/EmployeeStatutoryLeaveBalance.md +0 -21
  281. data/docs/payroll_nz/EmployeeStatutoryLeaveBalanceObject.md +0 -21
  282. data/docs/payroll_nz/EmployeeStatutoryLeaveSummary.md +0 -29
  283. data/docs/payroll_nz/EmployeeStatutoryLeavesSummaries.md +0 -21
  284. data/docs/payroll_nz/EmployeeStatutorySickLeave.md +0 -47
  285. data/docs/payroll_nz/EmployeeStatutorySickLeaveObject.md +0 -21
  286. data/docs/payroll_nz/EmployeeStatutorySickLeaves.md +0 -21
  287. data/docs/payroll_nz/EmployeeTax.md +0 -47
  288. data/docs/payroll_nz/EmployeeTaxObject.md +0 -21
  289. data/docs/payroll_nz/Employees.md +0 -21
  290. data/docs/payroll_nz/Employment.md +0 -21
  291. data/docs/payroll_nz/EmploymentObject.md +0 -21
  292. data/docs/payroll_nz/GrossEarningsHistory.md +0 -19
  293. data/docs/payroll_nz/InvalidField.md +0 -19
  294. data/docs/payroll_nz/LeaveAccrualLine.md +0 -19
  295. data/docs/payroll_nz/LeaveEarningsLine.md +0 -35
  296. data/docs/payroll_nz/LeavePeriod.md +0 -23
  297. data/docs/payroll_nz/LeavePeriods.md +0 -21
  298. data/docs/payroll_nz/LeaveType.md +0 -27
  299. data/docs/payroll_nz/LeaveTypeObject.md +0 -21
  300. data/docs/payroll_nz/LeaveTypes.md +0 -21
  301. data/docs/payroll_nz/Pagination.md +0 -23
  302. data/docs/payroll_nz/PayRun.md +0 -39
  303. data/docs/payroll_nz/PayRunCalendar.md +0 -29
  304. data/docs/payroll_nz/PayRunCalendarObject.md +0 -21
  305. data/docs/payroll_nz/PayRunCalendars.md +0 -21
  306. data/docs/payroll_nz/PayRunObject.md +0 -21
  307. data/docs/payroll_nz/PayRuns.md +0 -21
  308. data/docs/payroll_nz/PaySlip.md +0 -75
  309. data/docs/payroll_nz/PaySlipObject.md +0 -21
  310. data/docs/payroll_nz/PaySlips.md +0 -21
  311. data/docs/payroll_nz/PaymentLine.md +0 -25
  312. data/docs/payroll_nz/PaymentMethod.md +0 -19
  313. data/docs/payroll_nz/PaymentMethodObject.md +0 -21
  314. data/docs/payroll_nz/PayrollNzApi.md +0 -4544
  315. data/docs/payroll_nz/Problem.md +0 -27
  316. data/docs/payroll_nz/Reimbursement.md +0 -33
  317. data/docs/payroll_nz/ReimbursementLine.md +0 -25
  318. data/docs/payroll_nz/ReimbursementObject.md +0 -21
  319. data/docs/payroll_nz/Reimbursements.md +0 -21
  320. data/docs/payroll_nz/SalaryAndWage.md +0 -35
  321. data/docs/payroll_nz/SalaryAndWageObject.md +0 -21
  322. data/docs/payroll_nz/SalaryAndWages.md +0 -21
  323. data/docs/payroll_nz/Settings.md +0 -21
  324. data/docs/payroll_nz/StatutoryDeduction.md +0 -25
  325. data/docs/payroll_nz/StatutoryDeductionCategory.md +0 -16
  326. data/docs/payroll_nz/StatutoryDeductionLine.md +0 -23
  327. data/docs/payroll_nz/StatutoryDeductionObject.md +0 -21
  328. data/docs/payroll_nz/StatutoryDeductions.md +0 -21
  329. data/docs/payroll_nz/SuperannuationLine.md +0 -27
  330. data/docs/payroll_nz/SuperannuationObject.md +0 -21
  331. data/docs/payroll_nz/Superannuations.md +0 -21
  332. data/docs/payroll_nz/TaxCode.md +0 -16
  333. data/docs/payroll_nz/TaxLine.md +0 -25
  334. data/docs/payroll_nz/TaxSettings.md +0 -27
  335. data/docs/payroll_nz/Timesheet.md +0 -33
  336. data/docs/payroll_nz/TimesheetEarningsLine.md +0 -35
  337. data/docs/payroll_nz/TimesheetLine.md +0 -25
  338. data/docs/payroll_nz/TimesheetLineObject.md +0 -21
  339. data/docs/payroll_nz/TimesheetObject.md +0 -21
  340. data/docs/payroll_nz/Timesheets.md +0 -21
  341. data/docs/payroll_nz/TrackingCategories.md +0 -21
  342. data/docs/payroll_nz/TrackingCategory.md +0 -19
  343. data/docs/payroll_uk/Account.md +0 -23
  344. data/docs/payroll_uk/Accounts.md +0 -17
  345. data/docs/payroll_uk/Address.md +0 -25
  346. data/docs/payroll_uk/BankAccount.md +0 -21
  347. data/docs/payroll_uk/Benefit.md +0 -43
  348. data/docs/payroll_uk/BenefitLine.md +0 -25
  349. data/docs/payroll_uk/BenefitObject.md +0 -21
  350. data/docs/payroll_uk/Benefits.md +0 -21
  351. data/docs/payroll_uk/CourtOrderLine.md +0 -19
  352. data/docs/payroll_uk/Deduction.md +0 -47
  353. data/docs/payroll_uk/DeductionLine.md +0 -23
  354. data/docs/payroll_uk/DeductionObject.md +0 -21
  355. data/docs/payroll_uk/Deductions.md +0 -21
  356. data/docs/payroll_uk/EarningsLine.md +0 -33
  357. data/docs/payroll_uk/EarningsOrder.md +0 -25
  358. data/docs/payroll_uk/EarningsOrderObject.md +0 -21
  359. data/docs/payroll_uk/EarningsOrders.md +0 -21
  360. data/docs/payroll_uk/EarningsRate.md +0 -35
  361. data/docs/payroll_uk/EarningsRateObject.md +0 -21
  362. data/docs/payroll_uk/EarningsRates.md +0 -21
  363. data/docs/payroll_uk/EarningsTemplate.md +0 -27
  364. data/docs/payroll_uk/EarningsTemplateObject.md +0 -21
  365. data/docs/payroll_uk/Employee.md +0 -45
  366. data/docs/payroll_uk/EmployeeLeave.md +0 -29
  367. data/docs/payroll_uk/EmployeeLeaveBalance.md +0 -23
  368. data/docs/payroll_uk/EmployeeLeaveBalances.md +0 -21
  369. data/docs/payroll_uk/EmployeeLeaveObject.md +0 -21
  370. data/docs/payroll_uk/EmployeeLeaveType.md +0 -27
  371. data/docs/payroll_uk/EmployeeLeaveTypeObject.md +0 -21
  372. data/docs/payroll_uk/EmployeeLeaveTypes.md +0 -21
  373. data/docs/payroll_uk/EmployeeLeaves.md +0 -21
  374. data/docs/payroll_uk/EmployeeObject.md +0 -21
  375. data/docs/payroll_uk/EmployeeOpeningBalances.md +0 -27
  376. data/docs/payroll_uk/EmployeeOpeningBalancesObject.md +0 -21
  377. data/docs/payroll_uk/EmployeePayTemplate.md +0 -19
  378. data/docs/payroll_uk/EmployeePayTemplateObject.md +0 -21
  379. data/docs/payroll_uk/EmployeePayTemplates.md +0 -21
  380. data/docs/payroll_uk/EmployeeStatutoryLeaveBalance.md +0 -21
  381. data/docs/payroll_uk/EmployeeStatutoryLeaveBalanceObject.md +0 -21
  382. data/docs/payroll_uk/EmployeeStatutoryLeaveSummary.md +0 -29
  383. data/docs/payroll_uk/EmployeeStatutoryLeavesSummaries.md +0 -21
  384. data/docs/payroll_uk/EmployeeStatutorySickLeave.md +0 -47
  385. data/docs/payroll_uk/EmployeeStatutorySickLeaveObject.md +0 -21
  386. data/docs/payroll_uk/EmployeeStatutorySickLeaves.md +0 -21
  387. data/docs/payroll_uk/EmployeeTax.md +0 -37
  388. data/docs/payroll_uk/EmployeeTaxObject.md +0 -21
  389. data/docs/payroll_uk/Employees.md +0 -21
  390. data/docs/payroll_uk/Employment.md +0 -23
  391. data/docs/payroll_uk/EmploymentObject.md +0 -21
  392. data/docs/payroll_uk/InvalidField.md +0 -19
  393. data/docs/payroll_uk/LeaveAccrualLine.md +0 -19
  394. data/docs/payroll_uk/LeaveEarningsLine.md +0 -27
  395. data/docs/payroll_uk/LeavePeriod.md +0 -23
  396. data/docs/payroll_uk/LeavePeriods.md +0 -21
  397. data/docs/payroll_uk/LeaveType.md +0 -31
  398. data/docs/payroll_uk/LeaveTypeObject.md +0 -21
  399. data/docs/payroll_uk/LeaveTypes.md +0 -21
  400. data/docs/payroll_uk/Pagination.md +0 -23
  401. data/docs/payroll_uk/PayRun.md +0 -39
  402. data/docs/payroll_uk/PayRunCalendar.md +0 -29
  403. data/docs/payroll_uk/PayRunCalendarObject.md +0 -21
  404. data/docs/payroll_uk/PayRunCalendars.md +0 -21
  405. data/docs/payroll_uk/PayRunObject.md +0 -21
  406. data/docs/payroll_uk/PayRuns.md +0 -21
  407. data/docs/payroll_uk/PaymentLine.md +0 -25
  408. data/docs/payroll_uk/PaymentMethod.md +0 -19
  409. data/docs/payroll_uk/PaymentMethodObject.md +0 -21
  410. data/docs/payroll_uk/PayrollUkApi.md +0 -4683
  411. data/docs/payroll_uk/Payslip.md +0 -71
  412. data/docs/payroll_uk/PayslipObject.md +0 -21
  413. data/docs/payroll_uk/Payslips.md +0 -21
  414. data/docs/payroll_uk/Problem.md +0 -27
  415. data/docs/payroll_uk/Reimbursement.md +0 -23
  416. data/docs/payroll_uk/ReimbursementLine.md +0 -21
  417. data/docs/payroll_uk/ReimbursementObject.md +0 -21
  418. data/docs/payroll_uk/Reimbursements.md +0 -21
  419. data/docs/payroll_uk/SalaryAndWage.md +0 -33
  420. data/docs/payroll_uk/SalaryAndWageObject.md +0 -21
  421. data/docs/payroll_uk/SalaryAndWages.md +0 -21
  422. data/docs/payroll_uk/Settings.md +0 -21
  423. data/docs/payroll_uk/StatutoryDeduction.md +0 -25
  424. data/docs/payroll_uk/StatutoryDeductionCategory.md +0 -16
  425. data/docs/payroll_uk/TaxLine.md +0 -27
  426. data/docs/payroll_uk/Timesheet.md +0 -33
  427. data/docs/payroll_uk/TimesheetEarningsLine.md +0 -27
  428. data/docs/payroll_uk/TimesheetLine.md +0 -25
  429. data/docs/payroll_uk/TimesheetLineObject.md +0 -21
  430. data/docs/payroll_uk/TimesheetObject.md +0 -21
  431. data/docs/payroll_uk/Timesheets.md +0 -21
  432. data/docs/payroll_uk/TrackingCategories.md +0 -21
  433. data/docs/payroll_uk/TrackingCategory.md +0 -19
  434. data/docs/projects/Amount.md +0 -19
  435. data/docs/projects/ChargeType.md +0 -16
  436. data/docs/projects/CurrencyCode.md +0 -16
  437. data/docs/projects/Error.md +0 -19
  438. data/docs/projects/Pagination.md +0 -23
  439. data/docs/projects/Project.md +0 -59
  440. data/docs/projects/ProjectApi.md +0 -956
  441. data/docs/projects/ProjectCreateOrUpdate.md +0 -23
  442. data/docs/projects/ProjectPatch.md +0 -17
  443. data/docs/projects/ProjectStatus.md +0 -16
  444. data/docs/projects/ProjectUser.md +0 -21
  445. data/docs/projects/ProjectUsers.md +0 -19
  446. data/docs/projects/Projects.md +0 -19
  447. data/docs/projects/Task.md +0 -45
  448. data/docs/projects/TaskCreateOrUpdate.md +0 -23
  449. data/docs/projects/Tasks.md +0 -19
  450. data/docs/projects/TimeEntries.md +0 -19
  451. data/docs/projects/TimeEntry.md +0 -33
  452. data/docs/projects/TimeEntryCreateOrUpdate.md +0 -25
  453. data/git_push.sh +0 -55
  454. data/xero-ruby.gemspec +0 -38
@@ -1,17 +0,0 @@
1
- # XeroRuby::Accounting::TaxRates
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **tax_rates** | [**Array<TaxRate>**](TaxRate.md) | | [optional]
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'XeroRuby::Accounting'
13
-
14
- instance = XeroRuby::Accounting::TaxRates.new(tax_rates: null)
15
- ```
16
-
17
-
@@ -1,16 +0,0 @@
1
- # XeroRuby::Accounting::TaxType
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
-
8
- ## Code Sample
9
-
10
- ```ruby
11
- require 'XeroRuby::Accounting'
12
-
13
- instance = XeroRuby::Accounting::TaxType.new()
14
- ```
15
-
16
-
@@ -1,59 +0,0 @@
1
- # XeroRuby::Accounting::TenNinetyNineContact
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **box1** | **BigDecimal** | Box 1 on 1099 Form | [optional]
8
- **box2** | **BigDecimal** | Box 2 on 1099 Form | [optional]
9
- **box3** | **BigDecimal** | Box 3 on 1099 Form | [optional]
10
- **box4** | **BigDecimal** | Box 4 on 1099 Form | [optional]
11
- **box5** | **BigDecimal** | Box 5 on 1099 Form | [optional]
12
- **box6** | **BigDecimal** | Box 6 on 1099 Form | [optional]
13
- **box7** | **BigDecimal** | Box 7 on 1099 Form | [optional]
14
- **box8** | **BigDecimal** | Box 8 on 1099 Form | [optional]
15
- **box9** | **BigDecimal** | Box 9 on 1099 Form | [optional]
16
- **box10** | **BigDecimal** | Box 10 on 1099 Form | [optional]
17
- **box11** | **BigDecimal** | Box 11 on 1099 Form | [optional]
18
- **box13** | **BigDecimal** | Box 13 on 1099 Form | [optional]
19
- **box14** | **BigDecimal** | Box 14 on 1099 Form | [optional]
20
- **name** | **String** | Contact name on 1099 Form | [optional]
21
- **federal_tax_id_type** | **String** | Contact Fed Tax ID type | [optional]
22
- **city** | **String** | Contact city on 1099 Form | [optional]
23
- **zip** | **String** | Contact zip on 1099 Form | [optional]
24
- **state** | **String** | Contact State on 1099 Form | [optional]
25
- **email** | **String** | Contact email on 1099 Form | [optional]
26
- **street_address** | **String** | Contact address on 1099 Form | [optional]
27
- **tax_id** | **String** | Contact tax id on 1099 Form | [optional]
28
- **contact_id** | **String** | Contact contact id | [optional]
29
-
30
- ## Code Sample
31
-
32
- ```ruby
33
- require 'XeroRuby::Accounting'
34
-
35
- instance = XeroRuby::Accounting::TenNinetyNineContact.new(box1: null,
36
- box2: null,
37
- box3: null,
38
- box4: null,
39
- box5: null,
40
- box6: null,
41
- box7: null,
42
- box8: null,
43
- box9: null,
44
- box10: null,
45
- box11: null,
46
- box13: null,
47
- box14: null,
48
- name: null,
49
- federal_tax_id_type: null,
50
- city: null,
51
- zip: null,
52
- state: null,
53
- email: null,
54
- street_address: null,
55
- tax_id: null,
56
- contact_id: null)
57
- ```
58
-
59
-
@@ -1,16 +0,0 @@
1
- # XeroRuby::Accounting::TimeZone
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
-
8
- ## Code Sample
9
-
10
- ```ruby
11
- require 'XeroRuby::Accounting'
12
-
13
- instance = XeroRuby::Accounting::TimeZone.new()
14
- ```
15
-
16
-
@@ -1,17 +0,0 @@
1
- # XeroRuby::Accounting::TrackingCategories
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **tracking_categories** | [**Array<TrackingCategory>**](TrackingCategory.md) | | [optional]
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'XeroRuby::Accounting'
13
-
14
- instance = XeroRuby::Accounting::TrackingCategories.new(tracking_categories: null)
15
- ```
16
-
17
-
@@ -1,27 +0,0 @@
1
- # XeroRuby::Accounting::TrackingCategory
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **tracking_category_id** | **String** | The Xero identifier for a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional]
8
- **tracking_option_id** | **String** | The Xero identifier for a tracking option e.g. dc54c220-0140-495a-b925-3246adc0075f | [optional]
9
- **name** | **String** | The name of the tracking category e.g. Department, Region (max length = 100) | [optional]
10
- **option** | **String** | The option name of the tracking option e.g. East, West (max length = 100) | [optional]
11
- **status** | **String** | The status of a tracking category | [optional]
12
- **options** | [**Array<TrackingOption>**](TrackingOption.md) | See Tracking Options | [optional]
13
-
14
- ## Code Sample
15
-
16
- ```ruby
17
- require 'XeroRuby::Accounting'
18
-
19
- instance = XeroRuby::Accounting::TrackingCategory.new(tracking_category_id: null,
20
- tracking_option_id: null,
21
- name: null,
22
- option: null,
23
- status: null,
24
- options: null)
25
- ```
26
-
27
-
@@ -1,23 +0,0 @@
1
- # XeroRuby::Accounting::TrackingOption
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **tracking_option_id** | **String** | The Xero identifier for a tracking option e.g. ae777a87-5ef3-4fa0-a4f0-d10e1f13073a | [optional]
8
- **name** | **String** | The name of the tracking option e.g. Marketing, East (max length = 100) | [optional]
9
- **status** | **String** | The status of a tracking option | [optional]
10
- **tracking_category_id** | **String** | Filter by a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional]
11
-
12
- ## Code Sample
13
-
14
- ```ruby
15
- require 'XeroRuby::Accounting'
16
-
17
- instance = XeroRuby::Accounting::TrackingOption.new(tracking_option_id: null,
18
- name: null,
19
- status: null,
20
- tracking_category_id: null)
21
- ```
22
-
23
-
@@ -1,17 +0,0 @@
1
- # XeroRuby::Accounting::TrackingOptions
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **options** | [**Array<TrackingOption>**](TrackingOption.md) | | [optional]
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'XeroRuby::Accounting'
13
-
14
- instance = XeroRuby::Accounting::TrackingOptions.new(options: null)
15
- ```
16
-
17
-
@@ -1,29 +0,0 @@
1
- # XeroRuby::Accounting::User
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **user_id** | **String** | Xero identifier | [optional]
8
- **email_address** | **String** | Email address of user | [optional]
9
- **first_name** | **String** | First name of user | [optional]
10
- **last_name** | **String** | Last name of user | [optional]
11
- **updated_date_utc** | **DateTime** | Timestamp of last change to user | [optional]
12
- **is_subscriber** | **Boolean** | Boolean to indicate if user is the subscriber | [optional]
13
- **organisation_role** | **String** | User role that defines permissions in Xero and via API (READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, etc) | [optional]
14
-
15
- ## Code Sample
16
-
17
- ```ruby
18
- require 'XeroRuby::Accounting'
19
-
20
- instance = XeroRuby::Accounting::User.new(user_id: null,
21
- email_address: null,
22
- first_name: null,
23
- last_name: null,
24
- updated_date_utc: /Date(1573755038314)/,
25
- is_subscriber: null,
26
- organisation_role: null)
27
- ```
28
-
29
-
@@ -1,17 +0,0 @@
1
- # XeroRuby::Accounting::Users
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **users** | [**Array<User>**](User.md) | | [optional]
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'XeroRuby::Accounting'
13
-
14
- instance = XeroRuby::Accounting::Users.new(users: null)
15
- ```
16
-
17
-
@@ -1,17 +0,0 @@
1
- # XeroRuby::Accounting::ValidationError
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **message** | **String** | Validation error message | [optional]
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'XeroRuby::Accounting'
13
-
14
- instance = XeroRuby::Accounting::ValidationError.new(message: null)
15
- ```
16
-
17
-
@@ -1,47 +0,0 @@
1
- # XeroRuby::Assets::Asset
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **asset_id** | **String** | The Xero-generated Id for the asset | [optional]
8
- **asset_name** | **String** | The name of the asset |
9
- **asset_type_id** | **String** | The Xero-generated Id for the asset type | [optional]
10
- **asset_number** | **String** | Must be unique. | [optional]
11
- **purchase_date** | **Date** | The date the asset was purchased YYYY-MM-DD | [optional]
12
- **purchase_price** | **BigDecimal** | The purchase price of the asset | [optional]
13
- **disposal_date** | **Date** | The date the asset was disposed | [optional]
14
- **disposal_price** | **BigDecimal** | The price the asset was disposed at | [optional]
15
- **asset_status** | [**AssetStatus**](AssetStatus.md) | | [optional]
16
- **warranty_expiry_date** | **String** | The date the asset’s warranty expires (if needed) YYYY-MM-DD | [optional]
17
- **serial_number** | **String** | The asset's serial number | [optional]
18
- **book_depreciation_setting** | [**BookDepreciationSetting**](BookDepreciationSetting.md) | | [optional]
19
- **book_depreciation_detail** | [**BookDepreciationDetail**](BookDepreciationDetail.md) | | [optional]
20
- **can_rollback** | **Boolean** | Boolean to indicate whether depreciation can be rolled back for this asset individually. This is true if it doesn't have 'legacy' journal entries and if there is no lock period that would prevent this asset from rolling back. | [optional]
21
- **accounting_book_value** | **BigDecimal** | The accounting value of the asset | [optional]
22
- **is_delete_enabled_for_date** | **Boolean** | Boolean to indicate whether delete is enabled | [optional]
23
-
24
- ## Code Sample
25
-
26
- ```ruby
27
- require 'XeroRuby::Assets'
28
-
29
- instance = XeroRuby::Assets::Asset.new(asset_id: 3b5b3a38-5649-495f-87a1-14a4e5918634,
30
- asset_name: Awesome Truck 3,
31
- asset_type_id: 3b5b3a38-5649-495f-87a1-14a4e5918634,
32
- asset_number: FA-0013,
33
- purchase_date: null,
34
- purchase_price: 1000.0000,
35
- disposal_date: null,
36
- disposal_price: 1.0000,
37
- asset_status: null,
38
- warranty_expiry_date: ca4c6b39-4f4f-43e8-98da-5e1f350a6694,
39
- serial_number: ca4c6b39-4f4f-43e8-98da-5e1f350a6694,
40
- book_depreciation_setting: null,
41
- book_depreciation_detail: null,
42
- can_rollback: true,
43
- accounting_book_value: 0,
44
- is_delete_enabled_for_date: true)
45
- ```
46
-
47
-
@@ -1,426 +0,0 @@
1
- # XeroRuby::Assets::AssetApi
2
-
3
- All URIs are relative to *https://api.xero.com/assets.xro/1.0*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_asset**](AssetApi.md#create_asset) | **POST** /Assets | adds a fixed asset
8
- [**create_asset_type**](AssetApi.md#create_asset_type) | **POST** /AssetTypes | adds a fixed asset type
9
- [**get_asset_by_id**](AssetApi.md#get_asset_by_id) | **GET** /Assets/{id} | retrieves fixed asset by id
10
- [**get_asset_settings**](AssetApi.md#get_asset_settings) | **GET** /Settings | searches fixed asset settings
11
- [**get_asset_types**](AssetApi.md#get_asset_types) | **GET** /AssetTypes | searches fixed asset types
12
- [**get_assets**](AssetApi.md#get_assets) | **GET** /Assets | searches fixed asset
13
-
14
-
15
-
16
- ## create_asset
17
-
18
- > Asset create_asset(xero_tenant_id, asset)
19
-
20
- adds a fixed asset
21
-
22
- Adds an asset to the system
23
-
24
- ### Example
25
-
26
- ```ruby
27
- # load the gem
28
- require 'xero-ruby'
29
-
30
- creds = {
31
- client_id: ENV['CLIENT_ID'],
32
- client_secret: ENV['CLIENT_SECRET'],
33
- redirect_uri: ENV['REDIRECT_URI'],
34
- scopes: ENV['SCOPES']
35
- }
36
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
37
-
38
- token_set = fetch_valid_token_set(user) # example
39
-
40
- xero_client.refresh_token_set(token_set)
41
-
42
- # You need to namespace your api method call to one of the following api sets
43
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
44
-
45
- api_instance = xero_client.<api_set>
46
-
47
-
48
-
49
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
50
- asset = { "assetName":"Computer74863", "assetNumber":"123477544", "purchaseDate":"2020-01-01", "purchasePrice":100.0, "disposalPrice":23.23, "assetStatus":"Draft", "bookDepreciationSetting":{ "depreciationMethod":"StraightLine", "averagingMethod":"ActualDays", "depreciationRate":0.5, "depreciationCalculationMethod":"None" }, "bookDepreciationDetail":{ "currentCapitalGain":5.32, "currentGainLoss":3.88, "depreciationStartDate":"2020-01-02", "costLimit":100.0, "currentAccumDepreciationAmount":2.25 }, "AccountingBookValue":99.5 } # Asset | Fixed asset you are creating
51
- begin
52
- #adds a fixed asset
53
- result = api_instance.create_asset(xero_tenant_id, asset)
54
- p result
55
- rescue XeroRuby::Assets::ApiError => e
56
- puts "Exception when calling AssetApi->create_asset: #{e}"
57
- end
58
- ```
59
-
60
- ### Parameters
61
-
62
-
63
- Name | Type | Description | Notes
64
- ------------- | ------------- | ------------- | -------------
65
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
66
- **asset** | [**Asset**](Asset.md)| Fixed asset you are creating |
67
-
68
- ### Return type
69
-
70
- [**Asset**](Asset.md)
71
-
72
- ### Authorization
73
-
74
- [OAuth2](../README.md#OAuth2)
75
-
76
- ### HTTP request headers
77
-
78
- - **Content-Type**: application/json
79
- - **Accept**: application/json
80
-
81
-
82
- ## create_asset_type
83
-
84
- > AssetType create_asset_type(xero_tenant_id, opts)
85
-
86
- adds a fixed asset type
87
-
88
- Adds an fixed asset type to the system
89
-
90
- ### Example
91
-
92
- ```ruby
93
- # load the gem
94
- require 'xero-ruby'
95
-
96
- creds = {
97
- client_id: ENV['CLIENT_ID'],
98
- client_secret: ENV['CLIENT_SECRET'],
99
- redirect_uri: ENV['REDIRECT_URI'],
100
- scopes: ENV['SCOPES']
101
- }
102
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
103
-
104
- token_set = fetch_valid_token_set(user) # example
105
-
106
- xero_client.refresh_token_set(token_set)
107
-
108
- # You need to namespace your api method call to one of the following api sets
109
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
110
-
111
- api_instance = xero_client.<api_set>
112
-
113
-
114
-
115
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
116
- opts = {
117
- asset_type: { "assetTypeName":"Machinery11004", "fixedAssetAccountId":"3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82", "depreciationExpenseAccountId":"d1602f69-f900-4616-8d34-90af393fa368", "accumulatedDepreciationAccountId":"9195cadd-8645-41e6-9f67-7bcd421defe8", "bookDepreciationSetting":{ "depreciationMethod":"DiminishingValue100", "averagingMethod":"ActualDays", "depreciationRate":0.05, "depreciationCalculationMethod":"None" } } # AssetType | Asset type to add
118
- }
119
-
120
- begin
121
- #adds a fixed asset type
122
- result = api_instance.create_asset_type(xero_tenant_id, opts)
123
- p result
124
- rescue XeroRuby::Assets::ApiError => e
125
- puts "Exception when calling AssetApi->create_asset_type: #{e}"
126
- end
127
- ```
128
-
129
- ### Parameters
130
-
131
-
132
- Name | Type | Description | Notes
133
- ------------- | ------------- | ------------- | -------------
134
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
135
- **asset_type** | [**AssetType**](AssetType.md)| Asset type to add | [optional]
136
-
137
- ### Return type
138
-
139
- [**AssetType**](AssetType.md)
140
-
141
- ### Authorization
142
-
143
- [OAuth2](../README.md#OAuth2)
144
-
145
- ### HTTP request headers
146
-
147
- - **Content-Type**: application/json
148
- - **Accept**: application/json
149
-
150
-
151
- ## get_asset_by_id
152
-
153
- > Asset get_asset_by_id(xero_tenant_id, id)
154
-
155
- retrieves fixed asset by id
156
-
157
- By passing in the appropriate asset id, you can search for a specific fixed asset in the system
158
-
159
- ### Example
160
-
161
- ```ruby
162
- # load the gem
163
- require 'xero-ruby'
164
-
165
- creds = {
166
- client_id: ENV['CLIENT_ID'],
167
- client_secret: ENV['CLIENT_SECRET'],
168
- redirect_uri: ENV['REDIRECT_URI'],
169
- scopes: ENV['SCOPES']
170
- }
171
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
172
-
173
- token_set = fetch_valid_token_set(user) # example
174
-
175
- xero_client.refresh_token_set(token_set)
176
-
177
- # You need to namespace your api method call to one of the following api sets
178
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
179
-
180
- api_instance = xero_client.<api_set>
181
-
182
-
183
-
184
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
185
- id = '4f7bcdcb-5ec1-4258-9558-19f662fccdfe' # String | fixed asset id for single object
186
- begin
187
- #retrieves fixed asset by id
188
- result = api_instance.get_asset_by_id(xero_tenant_id, id)
189
- p result
190
- rescue XeroRuby::Assets::ApiError => e
191
- puts "Exception when calling AssetApi->get_asset_by_id: #{e}"
192
- end
193
- ```
194
-
195
- ### Parameters
196
-
197
-
198
- Name | Type | Description | Notes
199
- ------------- | ------------- | ------------- | -------------
200
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
201
- **id** | [**String**](.md)| fixed asset id for single object |
202
-
203
- ### Return type
204
-
205
- [**Asset**](Asset.md)
206
-
207
- ### Authorization
208
-
209
- [OAuth2](../README.md#OAuth2)
210
-
211
- ### HTTP request headers
212
-
213
- - **Content-Type**: Not defined
214
- - **Accept**: application/json
215
-
216
-
217
- ## get_asset_settings
218
-
219
- > Setting get_asset_settings(xero_tenant_id)
220
-
221
- searches fixed asset settings
222
-
223
- By passing in the appropriate options, you can search for available fixed asset types in the system
224
-
225
- ### Example
226
-
227
- ```ruby
228
- # load the gem
229
- require 'xero-ruby'
230
-
231
- creds = {
232
- client_id: ENV['CLIENT_ID'],
233
- client_secret: ENV['CLIENT_SECRET'],
234
- redirect_uri: ENV['REDIRECT_URI'],
235
- scopes: ENV['SCOPES']
236
- }
237
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
238
-
239
- token_set = fetch_valid_token_set(user) # example
240
-
241
- xero_client.refresh_token_set(token_set)
242
-
243
- # You need to namespace your api method call to one of the following api sets
244
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
245
-
246
- api_instance = xero_client.<api_set>
247
-
248
-
249
-
250
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
251
- begin
252
- #searches fixed asset settings
253
- result = api_instance.get_asset_settings(xero_tenant_id)
254
- p result
255
- rescue XeroRuby::Assets::ApiError => e
256
- puts "Exception when calling AssetApi->get_asset_settings: #{e}"
257
- end
258
- ```
259
-
260
- ### Parameters
261
-
262
-
263
- Name | Type | Description | Notes
264
- ------------- | ------------- | ------------- | -------------
265
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
266
-
267
- ### Return type
268
-
269
- [**Setting**](Setting.md)
270
-
271
- ### Authorization
272
-
273
- [OAuth2](../README.md#OAuth2)
274
-
275
- ### HTTP request headers
276
-
277
- - **Content-Type**: Not defined
278
- - **Accept**: application/json
279
-
280
-
281
- ## get_asset_types
282
-
283
- > Array&lt;AssetType&gt; get_asset_types(xero_tenant_id)
284
-
285
- searches fixed asset types
286
-
287
- By passing in the appropriate options, you can search for available fixed asset types in the system
288
-
289
- ### Example
290
-
291
- ```ruby
292
- # load the gem
293
- require 'xero-ruby'
294
-
295
- creds = {
296
- client_id: ENV['CLIENT_ID'],
297
- client_secret: ENV['CLIENT_SECRET'],
298
- redirect_uri: ENV['REDIRECT_URI'],
299
- scopes: ENV['SCOPES']
300
- }
301
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
302
-
303
- token_set = fetch_valid_token_set(user) # example
304
-
305
- xero_client.refresh_token_set(token_set)
306
-
307
- # You need to namespace your api method call to one of the following api sets
308
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
309
-
310
- api_instance = xero_client.<api_set>
311
-
312
-
313
-
314
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
315
- begin
316
- #searches fixed asset types
317
- result = api_instance.get_asset_types(xero_tenant_id)
318
- p result
319
- rescue XeroRuby::Assets::ApiError => e
320
- puts "Exception when calling AssetApi->get_asset_types: #{e}"
321
- end
322
- ```
323
-
324
- ### Parameters
325
-
326
-
327
- Name | Type | Description | Notes
328
- ------------- | ------------- | ------------- | -------------
329
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
330
-
331
- ### Return type
332
-
333
- [**Array&lt;AssetType&gt;**](AssetType.md)
334
-
335
- ### Authorization
336
-
337
- [OAuth2](../README.md#OAuth2)
338
-
339
- ### HTTP request headers
340
-
341
- - **Content-Type**: Not defined
342
- - **Accept**: application/json
343
-
344
-
345
- ## get_assets
346
-
347
- > Assets get_assets(xero_tenant_id, status, opts)
348
-
349
- searches fixed asset
350
-
351
- By passing in the appropriate options, you can search for available fixed asset in the system
352
-
353
- ### Example
354
-
355
- ```ruby
356
- # load the gem
357
- require 'xero-ruby'
358
-
359
- creds = {
360
- client_id: ENV['CLIENT_ID'],
361
- client_secret: ENV['CLIENT_SECRET'],
362
- redirect_uri: ENV['REDIRECT_URI'],
363
- scopes: ENV['SCOPES']
364
- }
365
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
366
-
367
- token_set = fetch_valid_token_set(user) # example
368
-
369
- xero_client.refresh_token_set(token_set)
370
-
371
- # You need to namespace your api method call to one of the following api sets
372
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
373
-
374
- api_instance = xero_client.<api_set>
375
-
376
-
377
-
378
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
379
- status = XeroRuby::Assets::AssetStatusQueryParam.new # AssetStatusQueryParam | Required when retrieving a collection of assets. See Asset Status Codes
380
- opts = {
381
- page: 1, # Integer | Results are paged. This specifies which page of the results to return. The default page is 1.
382
-
383
- page_size: 5, # Integer | The number of records returned per page. By default the number of records returned is 10.
384
-
385
- order_by: 'AssetName', # String | Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice.
386
-
387
- sort_direction: 'ASC', # String | ASC or DESC
388
-
389
- filter_by: 'Draft' # String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields.
390
- }
391
-
392
- begin
393
- #searches fixed asset
394
- result = api_instance.get_assets(xero_tenant_id, status, opts)
395
- p result
396
- rescue XeroRuby::Assets::ApiError => e
397
- puts "Exception when calling AssetApi->get_assets: #{e}"
398
- end
399
- ```
400
-
401
- ### Parameters
402
-
403
-
404
- Name | Type | Description | Notes
405
- ------------- | ------------- | ------------- | -------------
406
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
407
- **status** | [**AssetStatusQueryParam**](.md)| Required when retrieving a collection of assets. See Asset Status Codes |
408
- **page** | **Integer**| Results are paged. This specifies which page of the results to return. The default page is 1. | [optional]
409
- **page_size** | **Integer**| The number of records returned per page. By default the number of records returned is 10. | [optional]
410
- **order_by** | **String**| Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice. | [optional]
411
- **sort_direction** | **String**| ASC or DESC | [optional]
412
- **filter_by** | **String**| A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields. | [optional]
413
-
414
- ### Return type
415
-
416
- [**Assets**](Assets.md)
417
-
418
- ### Authorization
419
-
420
- [OAuth2](../README.md#OAuth2)
421
-
422
- ### HTTP request headers
423
-
424
- - **Content-Type**: Not defined
425
- - **Accept**: application/json
426
-