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,16 +0,0 @@
1
- # XeroRuby::PayrollAu::LeaveTypeContributionType
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
-
8
- ## Code Sample
9
-
10
- ```ruby
11
- require 'XeroRuby::PayrollAu'
12
-
13
- instance = XeroRuby::PayrollAu::LeaveTypeContributionType.new()
14
- ```
15
-
16
-
@@ -1,16 +0,0 @@
1
- # XeroRuby::PayrollAu::ManualTaxType
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
-
8
- ## Code Sample
9
-
10
- ```ruby
11
- require 'XeroRuby::PayrollAu'
12
-
13
- instance = XeroRuby::PayrollAu::ManualTaxType.new()
14
- ```
15
-
16
-
@@ -1,29 +0,0 @@
1
- # XeroRuby::PayrollAu::OpeningBalances
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **opening_balance_date** | **Date** | Opening Balance Date. (YYYY-MM-DD) | [optional]
8
- **tax** | **String** | Opening Balance tax | [optional]
9
- **earnings_lines** | [**Array<EarningsLine>**](EarningsLine.md) | | [optional]
10
- **deduction_lines** | [**Array<DeductionLine>**](DeductionLine.md) | | [optional]
11
- **super_lines** | [**Array<SuperLine>**](SuperLine.md) | | [optional]
12
- **reimbursement_lines** | [**Array<ReimbursementLine>**](ReimbursementLine.md) | | [optional]
13
- **leave_lines** | [**Array<LeaveLine>**](LeaveLine.md) | | [optional]
14
-
15
- ## Code Sample
16
-
17
- ```ruby
18
- require 'XeroRuby::PayrollAu'
19
-
20
- instance = XeroRuby::PayrollAu::OpeningBalances.new(opening_balance_date: /Date(322560000000+0000)/,
21
- tax: 4333d5cd-53a5-4c31-98e5-a8b4e5676b0b,
22
- earnings_lines: null,
23
- deduction_lines: null,
24
- super_lines: null,
25
- reimbursement_lines: null,
26
- leave_lines: null)
27
- ```
28
-
29
-
@@ -1,23 +0,0 @@
1
- # XeroRuby::PayrollAu::PayItem
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **earnings_rates** | [**Array<EarningsRate>**](EarningsRate.md) | | [optional]
8
- **deduction_types** | [**Array<DeductionType>**](DeductionType.md) | | [optional]
9
- **leave_types** | [**Array<LeaveType>**](LeaveType.md) | | [optional]
10
- **reimbursement_types** | [**Array<ReimbursementType>**](ReimbursementType.md) | | [optional]
11
-
12
- ## Code Sample
13
-
14
- ```ruby
15
- require 'XeroRuby::PayrollAu'
16
-
17
- instance = XeroRuby::PayrollAu::PayItem.new(earnings_rates: null,
18
- deduction_types: null,
19
- leave_types: null,
20
- reimbursement_types: null)
21
- ```
22
-
23
-
@@ -1,17 +0,0 @@
1
- # XeroRuby::PayrollAu::PayItems
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **pay_items** | [**PayItem**](PayItem.md) | | [optional]
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'XeroRuby::PayrollAu'
13
-
14
- instance = XeroRuby::PayrollAu::PayItems.new(pay_items: null)
15
- ```
16
-
17
-
@@ -1,47 +0,0 @@
1
- # XeroRuby::PayrollAu::PayRun
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **payroll_calendar_id** | **String** | Xero identifier for pay run |
8
- **pay_run_id** | **String** | Xero identifier for pay run | [optional]
9
- **pay_run_period_start_date** | **Date** | Period Start Date for the PayRun (YYYY-MM-DD) | [optional]
10
- **pay_run_period_end_date** | **Date** | Period End Date for the PayRun (YYYY-MM-DD) | [optional]
11
- **pay_run_status** | [**PayRunStatus**](PayRunStatus.md) | | [optional]
12
- **payment_date** | **Date** | Payment Date for the PayRun (YYYY-MM-DD) | [optional]
13
- **payslip_message** | **String** | Payslip message for the PayRun | [optional]
14
- **updated_date_utc** | **DateTime** | Last modified timestamp | [optional]
15
- **payslips** | [**Array<PayslipSummary>**](PayslipSummary.md) | The payslips in the payrun | [optional]
16
- **wages** | **BigDecimal** | The total Wages for the Payrun | [optional]
17
- **deductions** | **BigDecimal** | The total Deductions for the Payrun | [optional]
18
- **tax** | **BigDecimal** | The total Tax for the Payrun | [optional]
19
- **_super** | **BigDecimal** | The total Super for the Payrun | [optional]
20
- **reimbursement** | **BigDecimal** | The total Reimbursements for the Payrun | [optional]
21
- **net_pay** | **BigDecimal** | The total NetPay for the Payrun | [optional]
22
- **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional]
23
-
24
- ## Code Sample
25
-
26
- ```ruby
27
- require 'XeroRuby::PayrollAu'
28
-
29
- instance = XeroRuby::PayrollAu::PayRun.new(payroll_calendar_id: bfac31bd-ea62-4fc8-a5e7-7965d9504b15,
30
- pay_run_id: bba1d10f-63b1-4692-b5c5-a99f869523a4,
31
- pay_run_period_start_date: /Date(322560000000+0000)/,
32
- pay_run_period_end_date: /Date(322560000000+0000)/,
33
- pay_run_status: null,
34
- payment_date: /Date(322560000000+0000)/,
35
- payslip_message: Thanks for being awesome,
36
- updated_date_utc: /Date(1583967733054+0000)/,
37
- payslips: null,
38
- wages: 1060.5,
39
- deductions: 0.0,
40
- tax: 198.0,
41
- _super: 75.6,
42
- reimbursement: 0.0,
43
- net_pay: 862.5,
44
- validation_errors: null)
45
- ```
46
-
47
-
@@ -1,16 +0,0 @@
1
- # XeroRuby::PayrollAu::PayRunStatus
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
-
8
- ## Code Sample
9
-
10
- ```ruby
11
- require 'XeroRuby::PayrollAu'
12
-
13
- instance = XeroRuby::PayrollAu::PayRunStatus.new()
14
- ```
15
-
16
-
@@ -1,17 +0,0 @@
1
- # XeroRuby::PayrollAu::PayRuns
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **pay_runs** | [**Array<PayRun>**](PayRun.md) | | [optional]
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'XeroRuby::PayrollAu'
13
-
14
- instance = XeroRuby::PayrollAu::PayRuns.new(pay_runs: null)
15
- ```
16
-
17
-
@@ -1,25 +0,0 @@
1
- # XeroRuby::PayrollAu::PayTemplate
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **earnings_lines** | [**Array<EarningsLine>**](EarningsLine.md) | | [optional]
8
- **deduction_lines** | [**Array<DeductionLine>**](DeductionLine.md) | | [optional]
9
- **super_lines** | [**Array<SuperLine>**](SuperLine.md) | | [optional]
10
- **reimbursement_lines** | [**Array<ReimbursementLine>**](ReimbursementLine.md) | | [optional]
11
- **leave_lines** | [**Array<LeaveLine>**](LeaveLine.md) | | [optional]
12
-
13
- ## Code Sample
14
-
15
- ```ruby
16
- require 'XeroRuby::PayrollAu'
17
-
18
- instance = XeroRuby::PayrollAu::PayTemplate.new(earnings_lines: null,
19
- deduction_lines: null,
20
- super_lines: null,
21
- reimbursement_lines: null,
22
- leave_lines: null)
23
- ```
24
-
25
-
@@ -1,16 +0,0 @@
1
- # XeroRuby::PayrollAu::PaymentFrequencyType
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
-
8
- ## Code Sample
9
-
10
- ```ruby
11
- require 'XeroRuby::PayrollAu'
12
-
13
- instance = XeroRuby::PayrollAu::PaymentFrequencyType.new()
14
- ```
15
-
16
-
@@ -1,2018 +0,0 @@
1
- # XeroRuby::PayrollAu::PayrollAuApi
2
-
3
- All URIs are relative to *https://api.xero.com/payroll.xro/1.0*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_employee**](PayrollAuApi.md#create_employee) | **POST** /Employees | Use this method to create a payroll employee
8
- [**create_leave_application**](PayrollAuApi.md#create_leave_application) | **POST** /LeaveApplications | Use this method to create a Leave Application
9
- [**create_pay_item**](PayrollAuApi.md#create_pay_item) | **POST** /PayItems | Use this method to create a Pay Item
10
- [**create_pay_run**](PayrollAuApi.md#create_pay_run) | **POST** /PayRuns | Use this method to create a PayRun
11
- [**create_payroll_calendar**](PayrollAuApi.md#create_payroll_calendar) | **POST** /PayrollCalendars | Use this method to create a Payroll Calendars
12
- [**create_superfund**](PayrollAuApi.md#create_superfund) | **POST** /Superfunds | Use this method to create a super fund
13
- [**create_timesheet**](PayrollAuApi.md#create_timesheet) | **POST** /Timesheets | Use this method to create a timesheet
14
- [**get_employee**](PayrollAuApi.md#get_employee) | **GET** /Employees/{EmployeeId} | searches for an employee by unique id
15
- [**get_employees**](PayrollAuApi.md#get_employees) | **GET** /Employees | searches employees
16
- [**get_leave_application**](PayrollAuApi.md#get_leave_application) | **GET** /LeaveApplications/{LeaveApplicationId} | searches for an Leave Application by unique id
17
- [**get_leave_applications**](PayrollAuApi.md#get_leave_applications) | **GET** /LeaveApplications | searches Leave Applications
18
- [**get_pay_items**](PayrollAuApi.md#get_pay_items) | **GET** /PayItems | searches Pay Items
19
- [**get_pay_run**](PayrollAuApi.md#get_pay_run) | **GET** /PayRuns/{PayRunID} | searches for an payrun by unique id
20
- [**get_pay_runs**](PayrollAuApi.md#get_pay_runs) | **GET** /PayRuns | searches PayRuns
21
- [**get_payroll_calendar**](PayrollAuApi.md#get_payroll_calendar) | **GET** /PayrollCalendars/{PayrollCalendarID} | searches Payroll Calendars
22
- [**get_payroll_calendars**](PayrollAuApi.md#get_payroll_calendars) | **GET** /PayrollCalendars | searches Payroll Calendars
23
- [**get_payslip**](PayrollAuApi.md#get_payslip) | **GET** /Payslip/{PayslipID} | searches for an payslip by unique id
24
- [**get_settings**](PayrollAuApi.md#get_settings) | **GET** /Settings | retrieve settings
25
- [**get_superfund**](PayrollAuApi.md#get_superfund) | **GET** /Superfunds/{SuperFundID} | searches for an Superfund by unique id
26
- [**get_superfund_products**](PayrollAuApi.md#get_superfund_products) | **GET** /SuperfundProducts | searches SuperfundProducts
27
- [**get_superfunds**](PayrollAuApi.md#get_superfunds) | **GET** /Superfunds | searches SuperFunds
28
- [**get_timesheet**](PayrollAuApi.md#get_timesheet) | **GET** /Timesheets/{TimesheetID} | searches for an timesheet by unique id
29
- [**get_timesheets**](PayrollAuApi.md#get_timesheets) | **GET** /Timesheets | searches timesheets
30
- [**update_employee**](PayrollAuApi.md#update_employee) | **POST** /Employees/{EmployeeId} | Update an Employee
31
- [**update_leave_application**](PayrollAuApi.md#update_leave_application) | **POST** /LeaveApplications/{LeaveApplicationId} | Use this method to update a Leave Application
32
- [**update_pay_run**](PayrollAuApi.md#update_pay_run) | **POST** /PayRuns/{PayRunID} | Update a PayRun
33
- [**update_payslip**](PayrollAuApi.md#update_payslip) | **POST** /Payslip/{PayslipID} | Update a Payslip
34
- [**update_superfund**](PayrollAuApi.md#update_superfund) | **POST** /Superfunds/{SuperFundID} | Update a Superfund
35
- [**update_timesheet**](PayrollAuApi.md#update_timesheet) | **POST** /Timesheets/{TimesheetID} | Update a Timesheet
36
-
37
-
38
-
39
- ## create_employee
40
-
41
- > Employees create_employee(xero_tenant_id, employee)
42
-
43
- Use this method to create a payroll employee
44
-
45
- ### Example
46
-
47
- ```ruby
48
- # load the gem
49
- require 'xero-ruby'
50
-
51
- creds = {
52
- client_id: ENV['CLIENT_ID'],
53
- client_secret: ENV['CLIENT_SECRET'],
54
- redirect_uri: ENV['REDIRECT_URI'],
55
- scopes: ENV['SCOPES']
56
- }
57
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
58
-
59
- token_set = fetch_valid_token_set(user) # example
60
-
61
- xero_client.refresh_token_set(token_set)
62
-
63
- # You need to namespace your api method call to one of the following api sets
64
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
65
-
66
- api_instance = xero_client.<api_set>
67
-
68
-
69
-
70
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
71
- employee = [ { "FirstName": "Albus", "LastName": "Dumbledore", "DateOfBirth": "/Date(321523200000+0000)/", "HomeAddress": { "AddressLine1": "101 Green St", "City": "Island Bay", "Region": "NSW", "PostalCode": "6023", "Country": "AUSTRALIA" }, "StartDate": "/Date(321523200000+0000)/", "MiddleNames": "Percival", "Email": "albus39608@hogwarts.edu", "Gender": "M", "Phone": "444-2323", "Mobile": "555-1212", "IsAuthorisedToApproveLeave": true, "IsAuthorisedToApproveTimesheets": true, "JobTitle": "Regional Manager", "Classification": "corporate", "OrdinaryEarningsRateID": "ab874dfb-ab09-4c91-954e-43acf6fc23b4", "Status": "ACTIVE" } ] # Array<Employee> |
72
- begin
73
- #Use this method to create a payroll employee
74
- result = api_instance.create_employee(xero_tenant_id, employee)
75
- p result
76
- rescue XeroRuby::PayrollAu::ApiError => e
77
- puts "Exception when calling PayrollAuApi->create_employee: #{e}"
78
- end
79
- ```
80
-
81
- ### Parameters
82
-
83
-
84
- Name | Type | Description | Notes
85
- ------------- | ------------- | ------------- | -------------
86
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
87
- **employee** | [**Array&lt;Employee&gt;**](Employee.md)| |
88
-
89
- ### Return type
90
-
91
- [**Employees**](Employees.md)
92
-
93
- ### Authorization
94
-
95
- [OAuth2](../README.md#OAuth2)
96
-
97
- ### HTTP request headers
98
-
99
- - **Content-Type**: application/json
100
- - **Accept**: application/json
101
-
102
-
103
- ## create_leave_application
104
-
105
- > LeaveApplications create_leave_application(xero_tenant_id, leave_application)
106
-
107
- Use this method to create a Leave Application
108
-
109
- ### Example
110
-
111
- ```ruby
112
- # load the gem
113
- require 'xero-ruby'
114
-
115
- creds = {
116
- client_id: ENV['CLIENT_ID'],
117
- client_secret: ENV['CLIENT_SECRET'],
118
- redirect_uri: ENV['REDIRECT_URI'],
119
- scopes: ENV['SCOPES']
120
- }
121
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
122
-
123
- token_set = fetch_valid_token_set(user) # example
124
-
125
- xero_client.refresh_token_set(token_set)
126
-
127
- # You need to namespace your api method call to one of the following api sets
128
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
129
-
130
- api_instance = xero_client.<api_set>
131
-
132
-
133
-
134
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
135
- leave_application = [ { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "LeaveTypeID": "184ea8f7-d143-46dd-bef3-0c60e1aa6fca", "Title": "Hello World", "StartDate": "/Date(1572559200000+0000)/", "EndDate": "/Date(1572645600000+0000)/" } ] # Array<LeaveApplication> |
136
- begin
137
- #Use this method to create a Leave Application
138
- result = api_instance.create_leave_application(xero_tenant_id, leave_application)
139
- p result
140
- rescue XeroRuby::PayrollAu::ApiError => e
141
- puts "Exception when calling PayrollAuApi->create_leave_application: #{e}"
142
- end
143
- ```
144
-
145
- ### Parameters
146
-
147
-
148
- Name | Type | Description | Notes
149
- ------------- | ------------- | ------------- | -------------
150
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
151
- **leave_application** | [**Array&lt;LeaveApplication&gt;**](LeaveApplication.md)| |
152
-
153
- ### Return type
154
-
155
- [**LeaveApplications**](LeaveApplications.md)
156
-
157
- ### Authorization
158
-
159
- [OAuth2](../README.md#OAuth2)
160
-
161
- ### HTTP request headers
162
-
163
- - **Content-Type**: application/json
164
- - **Accept**: application/json
165
-
166
-
167
- ## create_pay_item
168
-
169
- > PayItems create_pay_item(xero_tenant_id, pay_item)
170
-
171
- Use this method to create a Pay Item
172
-
173
- ### Example
174
-
175
- ```ruby
176
- # load the gem
177
- require 'xero-ruby'
178
-
179
- creds = {
180
- client_id: ENV['CLIENT_ID'],
181
- client_secret: ENV['CLIENT_SECRET'],
182
- redirect_uri: ENV['REDIRECT_URI'],
183
- scopes: ENV['SCOPES']
184
- }
185
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
186
-
187
- token_set = fetch_valid_token_set(user) # example
188
-
189
- xero_client.refresh_token_set(token_set)
190
-
191
- # You need to namespace your api method call to one of the following api sets
192
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
193
-
194
- api_instance = xero_client.<api_set>
195
-
196
-
197
-
198
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
199
- pay_item = { "EarningsRates": [ { "Name": "MyRate", "AccountCode": "400", "TypeOfUnits": "4.00", "IsExemptFromTax": true, "IsExemptFromSuper": true, "IsReportableAsW1": false, "EarningsType": "ORDINARYTIMEEARNINGS", "EarningsRateID": "1fa4e226-b711-46ba-a8a7-4344c9c5fb87", "RateType": "MULTIPLE", "RatePerUnit": "10.0", "Multiplier": 1.5, "Amount": 5, "EmploymentTerminationPaymentType": "O" } ] } # PayItem |
200
- begin
201
- #Use this method to create a Pay Item
202
- result = api_instance.create_pay_item(xero_tenant_id, pay_item)
203
- p result
204
- rescue XeroRuby::PayrollAu::ApiError => e
205
- puts "Exception when calling PayrollAuApi->create_pay_item: #{e}"
206
- end
207
- ```
208
-
209
- ### Parameters
210
-
211
-
212
- Name | Type | Description | Notes
213
- ------------- | ------------- | ------------- | -------------
214
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
215
- **pay_item** | [**PayItem**](PayItem.md)| |
216
-
217
- ### Return type
218
-
219
- [**PayItems**](PayItems.md)
220
-
221
- ### Authorization
222
-
223
- [OAuth2](../README.md#OAuth2)
224
-
225
- ### HTTP request headers
226
-
227
- - **Content-Type**: application/json
228
- - **Accept**: application/json
229
-
230
-
231
- ## create_pay_run
232
-
233
- > PayRuns create_pay_run(xero_tenant_id, pay_run)
234
-
235
- Use this method to create a PayRun
236
-
237
- ### Example
238
-
239
- ```ruby
240
- # load the gem
241
- require 'xero-ruby'
242
-
243
- creds = {
244
- client_id: ENV['CLIENT_ID'],
245
- client_secret: ENV['CLIENT_SECRET'],
246
- redirect_uri: ENV['REDIRECT_URI'],
247
- scopes: ENV['SCOPES']
248
- }
249
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
250
-
251
- token_set = fetch_valid_token_set(user) # example
252
-
253
- xero_client.refresh_token_set(token_set)
254
-
255
- # You need to namespace your api method call to one of the following api sets
256
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
257
-
258
- api_instance = xero_client.<api_set>
259
-
260
-
261
-
262
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
263
- pay_run = [ { "PayrollCalendarID": "78bb86b9-e1ea-47ac-b75d-f087a81931de", "PayRunPeriodStartDate": "/Date(1572566400000+0000)/", "PayRunPeriodEndDate": "/Date(1573084800000+0000)/", "PayRunStatus": "DRAFT", "PaymentDate": "/Date(1573171200000+0000)/" } ] # Array<PayRun> |
264
- begin
265
- #Use this method to create a PayRun
266
- result = api_instance.create_pay_run(xero_tenant_id, pay_run)
267
- p result
268
- rescue XeroRuby::PayrollAu::ApiError => e
269
- puts "Exception when calling PayrollAuApi->create_pay_run: #{e}"
270
- end
271
- ```
272
-
273
- ### Parameters
274
-
275
-
276
- Name | Type | Description | Notes
277
- ------------- | ------------- | ------------- | -------------
278
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
279
- **pay_run** | [**Array&lt;PayRun&gt;**](PayRun.md)| |
280
-
281
- ### Return type
282
-
283
- [**PayRuns**](PayRuns.md)
284
-
285
- ### Authorization
286
-
287
- [OAuth2](../README.md#OAuth2)
288
-
289
- ### HTTP request headers
290
-
291
- - **Content-Type**: application/json
292
- - **Accept**: application/json
293
-
294
-
295
- ## create_payroll_calendar
296
-
297
- > PayrollCalendars create_payroll_calendar(xero_tenant_id, payroll_calendar)
298
-
299
- Use this method to create a Payroll Calendars
300
-
301
- ### Example
302
-
303
- ```ruby
304
- # load the gem
305
- require 'xero-ruby'
306
-
307
- creds = {
308
- client_id: ENV['CLIENT_ID'],
309
- client_secret: ENV['CLIENT_SECRET'],
310
- redirect_uri: ENV['REDIRECT_URI'],
311
- scopes: ENV['SCOPES']
312
- }
313
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
314
-
315
- token_set = fetch_valid_token_set(user) # example
316
-
317
- xero_client.refresh_token_set(token_set)
318
-
319
- # You need to namespace your api method call to one of the following api sets
320
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
321
-
322
- api_instance = xero_client.<api_set>
323
-
324
-
325
-
326
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
327
- payroll_calendar = [ { "PayrollCalendarID":"78bb86b9-e1ea-47ac-b75d-f087a81931de", "PayRunPeriodStartDate":"/Date(1572566400000+0000)/", "PayRunPeriodEndDate":"/Date(1573084800000+0000)/", "PayRunStatus":"DRAFT", "PaymentDate":"/Date(1573171200000+0000)/" } ] # Array<PayrollCalendar> |
328
- begin
329
- #Use this method to create a Payroll Calendars
330
- result = api_instance.create_payroll_calendar(xero_tenant_id, payroll_calendar)
331
- p result
332
- rescue XeroRuby::PayrollAu::ApiError => e
333
- puts "Exception when calling PayrollAuApi->create_payroll_calendar: #{e}"
334
- end
335
- ```
336
-
337
- ### Parameters
338
-
339
-
340
- Name | Type | Description | Notes
341
- ------------- | ------------- | ------------- | -------------
342
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
343
- **payroll_calendar** | [**Array&lt;PayrollCalendar&gt;**](PayrollCalendar.md)| |
344
-
345
- ### Return type
346
-
347
- [**PayrollCalendars**](PayrollCalendars.md)
348
-
349
- ### Authorization
350
-
351
- [OAuth2](../README.md#OAuth2)
352
-
353
- ### HTTP request headers
354
-
355
- - **Content-Type**: application/json
356
- - **Accept**: application/json
357
-
358
-
359
- ## create_superfund
360
-
361
- > SuperFunds create_superfund(xero_tenant_id, super_fund)
362
-
363
- Use this method to create a super fund
364
-
365
- ### Example
366
-
367
- ```ruby
368
- # load the gem
369
- require 'xero-ruby'
370
-
371
- creds = {
372
- client_id: ENV['CLIENT_ID'],
373
- client_secret: ENV['CLIENT_SECRET'],
374
- redirect_uri: ENV['REDIRECT_URI'],
375
- scopes: ENV['SCOPES']
376
- }
377
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
378
-
379
- token_set = fetch_valid_token_set(user) # example
380
-
381
- xero_client.refresh_token_set(token_set)
382
-
383
- # You need to namespace your api method call to one of the following api sets
384
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
385
-
386
- api_instance = xero_client.<api_set>
387
-
388
-
389
-
390
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
391
- super_fund = [ { "usi":"PTC0133AU", "Type":"REGULATED", "Name":"Bar99359", "AccountNumber":"FB36350", "AccountName":"Foo38428", "USI":"PTC0133AU" } ] # Array<SuperFund> |
392
- begin
393
- #Use this method to create a super fund
394
- result = api_instance.create_superfund(xero_tenant_id, super_fund)
395
- p result
396
- rescue XeroRuby::PayrollAu::ApiError => e
397
- puts "Exception when calling PayrollAuApi->create_superfund: #{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
- **super_fund** | [**Array&lt;SuperFund&gt;**](SuperFund.md)| |
408
-
409
- ### Return type
410
-
411
- [**SuperFunds**](SuperFunds.md)
412
-
413
- ### Authorization
414
-
415
- [OAuth2](../README.md#OAuth2)
416
-
417
- ### HTTP request headers
418
-
419
- - **Content-Type**: application/json
420
- - **Accept**: application/json
421
-
422
-
423
- ## create_timesheet
424
-
425
- > Timesheets create_timesheet(xero_tenant_id, timesheet)
426
-
427
- Use this method to create a timesheet
428
-
429
- ### Example
430
-
431
- ```ruby
432
- # load the gem
433
- require 'xero-ruby'
434
-
435
- creds = {
436
- client_id: ENV['CLIENT_ID'],
437
- client_secret: ENV['CLIENT_SECRET'],
438
- redirect_uri: ENV['REDIRECT_URI'],
439
- scopes: ENV['SCOPES']
440
- }
441
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
442
-
443
- token_set = fetch_valid_token_set(user) # example
444
-
445
- xero_client.refresh_token_set(token_set)
446
-
447
- # You need to namespace your api method call to one of the following api sets
448
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
449
-
450
- api_instance = xero_client.<api_set>
451
-
452
-
453
-
454
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
455
- timesheet = [ { "EmployeeID":"b34e89ff-770d-4099-b7e5-f968767118bc", "StartDate":"/Date(1573171200000+0000)/", "EndDate":"/Date(1573689600000+0000)/", "Status":"DRAFT", "TimesheetLines":[ { "EarningsRateID":"ab874dfb-ab09-4c91-954e-43acf6fc23b4", "TrackingItemID":"af5e9ce2-2349-4136-be99-3561b189f473", "NumberOfUnits":[ 2.0, 10.0, 0.0, 0.0, 5.0, 0.0, 5.0 ] } ] } ] # Array<Timesheet> |
456
- begin
457
- #Use this method to create a timesheet
458
- result = api_instance.create_timesheet(xero_tenant_id, timesheet)
459
- p result
460
- rescue XeroRuby::PayrollAu::ApiError => e
461
- puts "Exception when calling PayrollAuApi->create_timesheet: #{e}"
462
- end
463
- ```
464
-
465
- ### Parameters
466
-
467
-
468
- Name | Type | Description | Notes
469
- ------------- | ------------- | ------------- | -------------
470
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
471
- **timesheet** | [**Array&lt;Timesheet&gt;**](Timesheet.md)| |
472
-
473
- ### Return type
474
-
475
- [**Timesheets**](Timesheets.md)
476
-
477
- ### Authorization
478
-
479
- [OAuth2](../README.md#OAuth2)
480
-
481
- ### HTTP request headers
482
-
483
- - **Content-Type**: application/json
484
- - **Accept**: application/json
485
-
486
-
487
- ## get_employee
488
-
489
- > Employees get_employee(xero_tenant_id, employee_id)
490
-
491
- searches for an employee by unique id
492
-
493
- ### Example
494
-
495
- ```ruby
496
- # load the gem
497
- require 'xero-ruby'
498
-
499
- creds = {
500
- client_id: ENV['CLIENT_ID'],
501
- client_secret: ENV['CLIENT_SECRET'],
502
- redirect_uri: ENV['REDIRECT_URI'],
503
- scopes: ENV['SCOPES']
504
- }
505
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
506
-
507
- token_set = fetch_valid_token_set(user) # example
508
-
509
- xero_client.refresh_token_set(token_set)
510
-
511
- # You need to namespace your api method call to one of the following api sets
512
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
513
-
514
- api_instance = xero_client.<api_set>
515
-
516
-
517
-
518
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
519
- employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
520
- begin
521
- #searches for an employee by unique id
522
- result = api_instance.get_employee(xero_tenant_id, employee_id)
523
- p result
524
- rescue XeroRuby::PayrollAu::ApiError => e
525
- puts "Exception when calling PayrollAuApi->get_employee: #{e}"
526
- end
527
- ```
528
-
529
- ### Parameters
530
-
531
-
532
- Name | Type | Description | Notes
533
- ------------- | ------------- | ------------- | -------------
534
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
535
- **employee_id** | [**String**](.md)| Employee id for single object |
536
-
537
- ### Return type
538
-
539
- [**Employees**](Employees.md)
540
-
541
- ### Authorization
542
-
543
- [OAuth2](../README.md#OAuth2)
544
-
545
- ### HTTP request headers
546
-
547
- - **Content-Type**: Not defined
548
- - **Accept**: application/json
549
-
550
-
551
- ## get_employees
552
-
553
- > Employees get_employees(xero_tenant_id, opts)
554
-
555
- searches employees
556
-
557
- ### Example
558
-
559
- ```ruby
560
- # load the gem
561
- require 'xero-ruby'
562
-
563
- creds = {
564
- client_id: ENV['CLIENT_ID'],
565
- client_secret: ENV['CLIENT_SECRET'],
566
- redirect_uri: ENV['REDIRECT_URI'],
567
- scopes: ENV['SCOPES']
568
- }
569
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
570
-
571
- token_set = fetch_valid_token_set(user) # example
572
-
573
- xero_client.refresh_token_set(token_set)
574
-
575
- # You need to namespace your api method call to one of the following api sets
576
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
577
-
578
- api_instance = xero_client.<api_set>
579
-
580
-
581
-
582
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
583
- opts = {
584
- if_modified_since: 'if_modified_since_example', # String | Only records created or modified since this timestamp will be returned
585
-
586
- where: 'Status==\"ACTIVE\"', # String | Filter by an any element
587
-
588
- order: 'EmailAddress%20DESC', # String | Order by an any element
589
-
590
- page: 56 # Integer | e.g. page=1 – Up to 100 employees will be returned in a single API call
591
- }
592
-
593
- begin
594
- #searches employees
595
- result = api_instance.get_employees(xero_tenant_id, opts)
596
- p result
597
- rescue XeroRuby::PayrollAu::ApiError => e
598
- puts "Exception when calling PayrollAuApi->get_employees: #{e}"
599
- end
600
- ```
601
-
602
- ### Parameters
603
-
604
-
605
- Name | Type | Description | Notes
606
- ------------- | ------------- | ------------- | -------------
607
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
608
- **if_modified_since** | **String**| Only records created or modified since this timestamp will be returned | [optional]
609
- **where** | **String**| Filter by an any element | [optional]
610
- **order** | **String**| Order by an any element | [optional]
611
- **page** | **Integer**| e.g. page&#x3D;1 – Up to 100 employees will be returned in a single API call | [optional]
612
-
613
- ### Return type
614
-
615
- [**Employees**](Employees.md)
616
-
617
- ### Authorization
618
-
619
- [OAuth2](../README.md#OAuth2)
620
-
621
- ### HTTP request headers
622
-
623
- - **Content-Type**: Not defined
624
- - **Accept**: application/json
625
-
626
-
627
- ## get_leave_application
628
-
629
- > LeaveApplications get_leave_application(xero_tenant_id, leave_application_id)
630
-
631
- searches for an Leave Application by unique id
632
-
633
- ### Example
634
-
635
- ```ruby
636
- # load the gem
637
- require 'xero-ruby'
638
-
639
- creds = {
640
- client_id: ENV['CLIENT_ID'],
641
- client_secret: ENV['CLIENT_SECRET'],
642
- redirect_uri: ENV['REDIRECT_URI'],
643
- scopes: ENV['SCOPES']
644
- }
645
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
646
-
647
- token_set = fetch_valid_token_set(user) # example
648
-
649
- xero_client.refresh_token_set(token_set)
650
-
651
- # You need to namespace your api method call to one of the following api sets
652
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
653
-
654
- api_instance = xero_client.<api_set>
655
-
656
-
657
-
658
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
659
- leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Leave Application id for single object
660
- begin
661
- #searches for an Leave Application by unique id
662
- result = api_instance.get_leave_application(xero_tenant_id, leave_application_id)
663
- p result
664
- rescue XeroRuby::PayrollAu::ApiError => e
665
- puts "Exception when calling PayrollAuApi->get_leave_application: #{e}"
666
- end
667
- ```
668
-
669
- ### Parameters
670
-
671
-
672
- Name | Type | Description | Notes
673
- ------------- | ------------- | ------------- | -------------
674
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
675
- **leave_application_id** | [**String**](.md)| Leave Application id for single object |
676
-
677
- ### Return type
678
-
679
- [**LeaveApplications**](LeaveApplications.md)
680
-
681
- ### Authorization
682
-
683
- [OAuth2](../README.md#OAuth2)
684
-
685
- ### HTTP request headers
686
-
687
- - **Content-Type**: Not defined
688
- - **Accept**: application/json
689
-
690
-
691
- ## get_leave_applications
692
-
693
- > LeaveApplications get_leave_applications(xero_tenant_id, opts)
694
-
695
- searches Leave Applications
696
-
697
- ### Example
698
-
699
- ```ruby
700
- # load the gem
701
- require 'xero-ruby'
702
-
703
- creds = {
704
- client_id: ENV['CLIENT_ID'],
705
- client_secret: ENV['CLIENT_SECRET'],
706
- redirect_uri: ENV['REDIRECT_URI'],
707
- scopes: ENV['SCOPES']
708
- }
709
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
710
-
711
- token_set = fetch_valid_token_set(user) # example
712
-
713
- xero_client.refresh_token_set(token_set)
714
-
715
- # You need to namespace your api method call to one of the following api sets
716
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
717
-
718
- api_instance = xero_client.<api_set>
719
-
720
-
721
-
722
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
723
- opts = {
724
- if_modified_since: 'if_modified_since_example', # String | Only records created or modified since this timestamp will be returned
725
-
726
- where: 'Status==\"ACTIVE\"', # String | Filter by an any element
727
-
728
- order: 'EmailAddress%20DESC', # String | Order by an any element
729
-
730
- page: 56 # Integer | e.g. page=1 – Up to 100 objects will be returned in a single API call
731
- }
732
-
733
- begin
734
- #searches Leave Applications
735
- result = api_instance.get_leave_applications(xero_tenant_id, opts)
736
- p result
737
- rescue XeroRuby::PayrollAu::ApiError => e
738
- puts "Exception when calling PayrollAuApi->get_leave_applications: #{e}"
739
- end
740
- ```
741
-
742
- ### Parameters
743
-
744
-
745
- Name | Type | Description | Notes
746
- ------------- | ------------- | ------------- | -------------
747
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
748
- **if_modified_since** | **String**| Only records created or modified since this timestamp will be returned | [optional]
749
- **where** | **String**| Filter by an any element | [optional]
750
- **order** | **String**| Order by an any element | [optional]
751
- **page** | **Integer**| e.g. page&#x3D;1 – Up to 100 objects will be returned in a single API call | [optional]
752
-
753
- ### Return type
754
-
755
- [**LeaveApplications**](LeaveApplications.md)
756
-
757
- ### Authorization
758
-
759
- [OAuth2](../README.md#OAuth2)
760
-
761
- ### HTTP request headers
762
-
763
- - **Content-Type**: Not defined
764
- - **Accept**: application/json
765
-
766
-
767
- ## get_pay_items
768
-
769
- > PayItems get_pay_items(xero_tenant_id, opts)
770
-
771
- searches Pay Items
772
-
773
- ### Example
774
-
775
- ```ruby
776
- # load the gem
777
- require 'xero-ruby'
778
-
779
- creds = {
780
- client_id: ENV['CLIENT_ID'],
781
- client_secret: ENV['CLIENT_SECRET'],
782
- redirect_uri: ENV['REDIRECT_URI'],
783
- scopes: ENV['SCOPES']
784
- }
785
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
786
-
787
- token_set = fetch_valid_token_set(user) # example
788
-
789
- xero_client.refresh_token_set(token_set)
790
-
791
- # You need to namespace your api method call to one of the following api sets
792
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
793
-
794
- api_instance = xero_client.<api_set>
795
-
796
-
797
-
798
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
799
- opts = {
800
- if_modified_since: 'if_modified_since_example', # String | Only records created or modified since this timestamp will be returned
801
-
802
- where: 'Status==\"ACTIVE\"', # String | Filter by an any element
803
-
804
- order: 'EmailAddress%20DESC', # String | Order by an any element
805
-
806
- page: 56 # Integer | e.g. page=1 – Up to 100 objects will be returned in a single API call
807
- }
808
-
809
- begin
810
- #searches Pay Items
811
- result = api_instance.get_pay_items(xero_tenant_id, opts)
812
- p result
813
- rescue XeroRuby::PayrollAu::ApiError => e
814
- puts "Exception when calling PayrollAuApi->get_pay_items: #{e}"
815
- end
816
- ```
817
-
818
- ### Parameters
819
-
820
-
821
- Name | Type | Description | Notes
822
- ------------- | ------------- | ------------- | -------------
823
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
824
- **if_modified_since** | **String**| Only records created or modified since this timestamp will be returned | [optional]
825
- **where** | **String**| Filter by an any element | [optional]
826
- **order** | **String**| Order by an any element | [optional]
827
- **page** | **Integer**| e.g. page&#x3D;1 – Up to 100 objects will be returned in a single API call | [optional]
828
-
829
- ### Return type
830
-
831
- [**PayItems**](PayItems.md)
832
-
833
- ### Authorization
834
-
835
- [OAuth2](../README.md#OAuth2)
836
-
837
- ### HTTP request headers
838
-
839
- - **Content-Type**: Not defined
840
- - **Accept**: application/json
841
-
842
-
843
- ## get_pay_run
844
-
845
- > PayRuns get_pay_run(xero_tenant_id, pay_run_id)
846
-
847
- searches for an payrun by unique id
848
-
849
- ### Example
850
-
851
- ```ruby
852
- # load the gem
853
- require 'xero-ruby'
854
-
855
- creds = {
856
- client_id: ENV['CLIENT_ID'],
857
- client_secret: ENV['CLIENT_SECRET'],
858
- redirect_uri: ENV['REDIRECT_URI'],
859
- scopes: ENV['SCOPES']
860
- }
861
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
862
-
863
- token_set = fetch_valid_token_set(user) # example
864
-
865
- xero_client.refresh_token_set(token_set)
866
-
867
- # You need to namespace your api method call to one of the following api sets
868
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
869
-
870
- api_instance = xero_client.<api_set>
871
-
872
-
873
-
874
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
875
- pay_run_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | PayRun id for single object
876
- begin
877
- #searches for an payrun by unique id
878
- result = api_instance.get_pay_run(xero_tenant_id, pay_run_id)
879
- p result
880
- rescue XeroRuby::PayrollAu::ApiError => e
881
- puts "Exception when calling PayrollAuApi->get_pay_run: #{e}"
882
- end
883
- ```
884
-
885
- ### Parameters
886
-
887
-
888
- Name | Type | Description | Notes
889
- ------------- | ------------- | ------------- | -------------
890
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
891
- **pay_run_id** | [**String**](.md)| PayRun id for single object |
892
-
893
- ### Return type
894
-
895
- [**PayRuns**](PayRuns.md)
896
-
897
- ### Authorization
898
-
899
- [OAuth2](../README.md#OAuth2)
900
-
901
- ### HTTP request headers
902
-
903
- - **Content-Type**: Not defined
904
- - **Accept**: application/json
905
-
906
-
907
- ## get_pay_runs
908
-
909
- > PayRuns get_pay_runs(xero_tenant_id, opts)
910
-
911
- searches PayRuns
912
-
913
- ### Example
914
-
915
- ```ruby
916
- # load the gem
917
- require 'xero-ruby'
918
-
919
- creds = {
920
- client_id: ENV['CLIENT_ID'],
921
- client_secret: ENV['CLIENT_SECRET'],
922
- redirect_uri: ENV['REDIRECT_URI'],
923
- scopes: ENV['SCOPES']
924
- }
925
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
926
-
927
- token_set = fetch_valid_token_set(user) # example
928
-
929
- xero_client.refresh_token_set(token_set)
930
-
931
- # You need to namespace your api method call to one of the following api sets
932
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
933
-
934
- api_instance = xero_client.<api_set>
935
-
936
-
937
-
938
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
939
- opts = {
940
- if_modified_since: 'if_modified_since_example', # String | Only records created or modified since this timestamp will be returned
941
-
942
- where: 'Status==\"ACTIVE\"', # String | Filter by an any element
943
-
944
- order: 'EmailAddress%20DESC', # String | Order by an any element
945
-
946
- page: 56 # Integer | e.g. page=1 – Up to 100 PayRuns will be returned in a single API call
947
- }
948
-
949
- begin
950
- #searches PayRuns
951
- result = api_instance.get_pay_runs(xero_tenant_id, opts)
952
- p result
953
- rescue XeroRuby::PayrollAu::ApiError => e
954
- puts "Exception when calling PayrollAuApi->get_pay_runs: #{e}"
955
- end
956
- ```
957
-
958
- ### Parameters
959
-
960
-
961
- Name | Type | Description | Notes
962
- ------------- | ------------- | ------------- | -------------
963
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
964
- **if_modified_since** | **String**| Only records created or modified since this timestamp will be returned | [optional]
965
- **where** | **String**| Filter by an any element | [optional]
966
- **order** | **String**| Order by an any element | [optional]
967
- **page** | **Integer**| e.g. page&#x3D;1 – Up to 100 PayRuns will be returned in a single API call | [optional]
968
-
969
- ### Return type
970
-
971
- [**PayRuns**](PayRuns.md)
972
-
973
- ### Authorization
974
-
975
- [OAuth2](../README.md#OAuth2)
976
-
977
- ### HTTP request headers
978
-
979
- - **Content-Type**: Not defined
980
- - **Accept**: application/json
981
-
982
-
983
- ## get_payroll_calendar
984
-
985
- > PayrollCalendars get_payroll_calendar(xero_tenant_id, payroll_calendar_id)
986
-
987
- searches Payroll Calendars
988
-
989
- ### Example
990
-
991
- ```ruby
992
- # load the gem
993
- require 'xero-ruby'
994
-
995
- creds = {
996
- client_id: ENV['CLIENT_ID'],
997
- client_secret: ENV['CLIENT_SECRET'],
998
- redirect_uri: ENV['REDIRECT_URI'],
999
- scopes: ENV['SCOPES']
1000
- }
1001
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1002
-
1003
- token_set = fetch_valid_token_set(user) # example
1004
-
1005
- xero_client.refresh_token_set(token_set)
1006
-
1007
- # You need to namespace your api method call to one of the following api sets
1008
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1009
-
1010
- api_instance = xero_client.<api_set>
1011
-
1012
-
1013
-
1014
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1015
- payroll_calendar_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Payroll Calendar id for single object
1016
- begin
1017
- #searches Payroll Calendars
1018
- result = api_instance.get_payroll_calendar(xero_tenant_id, payroll_calendar_id)
1019
- p result
1020
- rescue XeroRuby::PayrollAu::ApiError => e
1021
- puts "Exception when calling PayrollAuApi->get_payroll_calendar: #{e}"
1022
- end
1023
- ```
1024
-
1025
- ### Parameters
1026
-
1027
-
1028
- Name | Type | Description | Notes
1029
- ------------- | ------------- | ------------- | -------------
1030
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1031
- **payroll_calendar_id** | [**String**](.md)| Payroll Calendar id for single object |
1032
-
1033
- ### Return type
1034
-
1035
- [**PayrollCalendars**](PayrollCalendars.md)
1036
-
1037
- ### Authorization
1038
-
1039
- [OAuth2](../README.md#OAuth2)
1040
-
1041
- ### HTTP request headers
1042
-
1043
- - **Content-Type**: Not defined
1044
- - **Accept**: application/json
1045
-
1046
-
1047
- ## get_payroll_calendars
1048
-
1049
- > PayrollCalendars get_payroll_calendars(xero_tenant_id, opts)
1050
-
1051
- searches Payroll Calendars
1052
-
1053
- ### Example
1054
-
1055
- ```ruby
1056
- # load the gem
1057
- require 'xero-ruby'
1058
-
1059
- creds = {
1060
- client_id: ENV['CLIENT_ID'],
1061
- client_secret: ENV['CLIENT_SECRET'],
1062
- redirect_uri: ENV['REDIRECT_URI'],
1063
- scopes: ENV['SCOPES']
1064
- }
1065
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1066
-
1067
- token_set = fetch_valid_token_set(user) # example
1068
-
1069
- xero_client.refresh_token_set(token_set)
1070
-
1071
- # You need to namespace your api method call to one of the following api sets
1072
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1073
-
1074
- api_instance = xero_client.<api_set>
1075
-
1076
-
1077
-
1078
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1079
- opts = {
1080
- if_modified_since: 'if_modified_since_example', # String | Only records created or modified since this timestamp will be returned
1081
-
1082
- where: 'Status==\"ACTIVE\"', # String | Filter by an any element
1083
-
1084
- order: 'EmailAddress%20DESC', # String | Order by an any element
1085
-
1086
- page: 56 # Integer | e.g. page=1 – Up to 100 objects will be returned in a single API call
1087
- }
1088
-
1089
- begin
1090
- #searches Payroll Calendars
1091
- result = api_instance.get_payroll_calendars(xero_tenant_id, opts)
1092
- p result
1093
- rescue XeroRuby::PayrollAu::ApiError => e
1094
- puts "Exception when calling PayrollAuApi->get_payroll_calendars: #{e}"
1095
- end
1096
- ```
1097
-
1098
- ### Parameters
1099
-
1100
-
1101
- Name | Type | Description | Notes
1102
- ------------- | ------------- | ------------- | -------------
1103
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1104
- **if_modified_since** | **String**| Only records created or modified since this timestamp will be returned | [optional]
1105
- **where** | **String**| Filter by an any element | [optional]
1106
- **order** | **String**| Order by an any element | [optional]
1107
- **page** | **Integer**| e.g. page&#x3D;1 – Up to 100 objects will be returned in a single API call | [optional]
1108
-
1109
- ### Return type
1110
-
1111
- [**PayrollCalendars**](PayrollCalendars.md)
1112
-
1113
- ### Authorization
1114
-
1115
- [OAuth2](../README.md#OAuth2)
1116
-
1117
- ### HTTP request headers
1118
-
1119
- - **Content-Type**: Not defined
1120
- - **Accept**: application/json
1121
-
1122
-
1123
- ## get_payslip
1124
-
1125
- > PayslipObject get_payslip(xero_tenant_id, payslip_id)
1126
-
1127
- searches for an payslip by unique id
1128
-
1129
- ### Example
1130
-
1131
- ```ruby
1132
- # load the gem
1133
- require 'xero-ruby'
1134
-
1135
- creds = {
1136
- client_id: ENV['CLIENT_ID'],
1137
- client_secret: ENV['CLIENT_SECRET'],
1138
- redirect_uri: ENV['REDIRECT_URI'],
1139
- scopes: ENV['SCOPES']
1140
- }
1141
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1142
-
1143
- token_set = fetch_valid_token_set(user) # example
1144
-
1145
- xero_client.refresh_token_set(token_set)
1146
-
1147
- # You need to namespace your api method call to one of the following api sets
1148
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1149
-
1150
- api_instance = xero_client.<api_set>
1151
-
1152
-
1153
-
1154
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1155
- payslip_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Payslip id for single object
1156
- begin
1157
- #searches for an payslip by unique id
1158
- result = api_instance.get_payslip(xero_tenant_id, payslip_id)
1159
- p result
1160
- rescue XeroRuby::PayrollAu::ApiError => e
1161
- puts "Exception when calling PayrollAuApi->get_payslip: #{e}"
1162
- end
1163
- ```
1164
-
1165
- ### Parameters
1166
-
1167
-
1168
- Name | Type | Description | Notes
1169
- ------------- | ------------- | ------------- | -------------
1170
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1171
- **payslip_id** | [**String**](.md)| Payslip id for single object |
1172
-
1173
- ### Return type
1174
-
1175
- [**PayslipObject**](PayslipObject.md)
1176
-
1177
- ### Authorization
1178
-
1179
- [OAuth2](../README.md#OAuth2)
1180
-
1181
- ### HTTP request headers
1182
-
1183
- - **Content-Type**: Not defined
1184
- - **Accept**: application/json
1185
-
1186
-
1187
- ## get_settings
1188
-
1189
- > SettingsObject get_settings(xero_tenant_id)
1190
-
1191
- retrieve settings
1192
-
1193
- ### Example
1194
-
1195
- ```ruby
1196
- # load the gem
1197
- require 'xero-ruby'
1198
-
1199
- creds = {
1200
- client_id: ENV['CLIENT_ID'],
1201
- client_secret: ENV['CLIENT_SECRET'],
1202
- redirect_uri: ENV['REDIRECT_URI'],
1203
- scopes: ENV['SCOPES']
1204
- }
1205
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1206
-
1207
- token_set = fetch_valid_token_set(user) # example
1208
-
1209
- xero_client.refresh_token_set(token_set)
1210
-
1211
- # You need to namespace your api method call to one of the following api sets
1212
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1213
-
1214
- api_instance = xero_client.<api_set>
1215
-
1216
-
1217
-
1218
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1219
- begin
1220
- #retrieve settings
1221
- result = api_instance.get_settings(xero_tenant_id)
1222
- p result
1223
- rescue XeroRuby::PayrollAu::ApiError => e
1224
- puts "Exception when calling PayrollAuApi->get_settings: #{e}"
1225
- end
1226
- ```
1227
-
1228
- ### Parameters
1229
-
1230
-
1231
- Name | Type | Description | Notes
1232
- ------------- | ------------- | ------------- | -------------
1233
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1234
-
1235
- ### Return type
1236
-
1237
- [**SettingsObject**](SettingsObject.md)
1238
-
1239
- ### Authorization
1240
-
1241
- [OAuth2](../README.md#OAuth2)
1242
-
1243
- ### HTTP request headers
1244
-
1245
- - **Content-Type**: Not defined
1246
- - **Accept**: application/json
1247
-
1248
-
1249
- ## get_superfund
1250
-
1251
- > SuperFunds get_superfund(xero_tenant_id, super_fund_id)
1252
-
1253
- searches for an Superfund by unique id
1254
-
1255
- ### Example
1256
-
1257
- ```ruby
1258
- # load the gem
1259
- require 'xero-ruby'
1260
-
1261
- creds = {
1262
- client_id: ENV['CLIENT_ID'],
1263
- client_secret: ENV['CLIENT_SECRET'],
1264
- redirect_uri: ENV['REDIRECT_URI'],
1265
- scopes: ENV['SCOPES']
1266
- }
1267
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1268
-
1269
- token_set = fetch_valid_token_set(user) # example
1270
-
1271
- xero_client.refresh_token_set(token_set)
1272
-
1273
- # You need to namespace your api method call to one of the following api sets
1274
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1275
-
1276
- api_instance = xero_client.<api_set>
1277
-
1278
-
1279
-
1280
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1281
- super_fund_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Superfund id for single object
1282
- begin
1283
- #searches for an Superfund by unique id
1284
- result = api_instance.get_superfund(xero_tenant_id, super_fund_id)
1285
- p result
1286
- rescue XeroRuby::PayrollAu::ApiError => e
1287
- puts "Exception when calling PayrollAuApi->get_superfund: #{e}"
1288
- end
1289
- ```
1290
-
1291
- ### Parameters
1292
-
1293
-
1294
- Name | Type | Description | Notes
1295
- ------------- | ------------- | ------------- | -------------
1296
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1297
- **super_fund_id** | [**String**](.md)| Superfund id for single object |
1298
-
1299
- ### Return type
1300
-
1301
- [**SuperFunds**](SuperFunds.md)
1302
-
1303
- ### Authorization
1304
-
1305
- [OAuth2](../README.md#OAuth2)
1306
-
1307
- ### HTTP request headers
1308
-
1309
- - **Content-Type**: Not defined
1310
- - **Accept**: application/json
1311
-
1312
-
1313
- ## get_superfund_products
1314
-
1315
- > SuperFundProducts get_superfund_products(xero_tenant_id, opts)
1316
-
1317
- searches SuperfundProducts
1318
-
1319
- ### Example
1320
-
1321
- ```ruby
1322
- # load the gem
1323
- require 'xero-ruby'
1324
-
1325
- creds = {
1326
- client_id: ENV['CLIENT_ID'],
1327
- client_secret: ENV['CLIENT_SECRET'],
1328
- redirect_uri: ENV['REDIRECT_URI'],
1329
- scopes: ENV['SCOPES']
1330
- }
1331
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1332
-
1333
- token_set = fetch_valid_token_set(user) # example
1334
-
1335
- xero_client.refresh_token_set(token_set)
1336
-
1337
- # You need to namespace your api method call to one of the following api sets
1338
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1339
-
1340
- api_instance = xero_client.<api_set>
1341
-
1342
-
1343
-
1344
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1345
- opts = {
1346
- abn: '40022701955', # String | The ABN of the Regulated SuperFund
1347
-
1348
- usi: 'OSF0001AU' # String | The USI of the Regulated SuperFund
1349
- }
1350
-
1351
- begin
1352
- #searches SuperfundProducts
1353
- result = api_instance.get_superfund_products(xero_tenant_id, opts)
1354
- p result
1355
- rescue XeroRuby::PayrollAu::ApiError => e
1356
- puts "Exception when calling PayrollAuApi->get_superfund_products: #{e}"
1357
- end
1358
- ```
1359
-
1360
- ### Parameters
1361
-
1362
-
1363
- Name | Type | Description | Notes
1364
- ------------- | ------------- | ------------- | -------------
1365
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1366
- **abn** | **String**| The ABN of the Regulated SuperFund | [optional]
1367
- **usi** | **String**| The USI of the Regulated SuperFund | [optional]
1368
-
1369
- ### Return type
1370
-
1371
- [**SuperFundProducts**](SuperFundProducts.md)
1372
-
1373
- ### Authorization
1374
-
1375
- [OAuth2](../README.md#OAuth2)
1376
-
1377
- ### HTTP request headers
1378
-
1379
- - **Content-Type**: Not defined
1380
- - **Accept**: application/json
1381
-
1382
-
1383
- ## get_superfunds
1384
-
1385
- > SuperFunds get_superfunds(xero_tenant_id, opts)
1386
-
1387
- searches SuperFunds
1388
-
1389
- ### Example
1390
-
1391
- ```ruby
1392
- # load the gem
1393
- require 'xero-ruby'
1394
-
1395
- creds = {
1396
- client_id: ENV['CLIENT_ID'],
1397
- client_secret: ENV['CLIENT_SECRET'],
1398
- redirect_uri: ENV['REDIRECT_URI'],
1399
- scopes: ENV['SCOPES']
1400
- }
1401
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1402
-
1403
- token_set = fetch_valid_token_set(user) # example
1404
-
1405
- xero_client.refresh_token_set(token_set)
1406
-
1407
- # You need to namespace your api method call to one of the following api sets
1408
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1409
-
1410
- api_instance = xero_client.<api_set>
1411
-
1412
-
1413
-
1414
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1415
- opts = {
1416
- if_modified_since: 'if_modified_since_example', # String | Only records created or modified since this timestamp will be returned
1417
-
1418
- where: 'Status==\"ACTIVE\"', # String | Filter by an any element
1419
-
1420
- order: 'EmailAddress%20DESC', # String | Order by an any element
1421
-
1422
- page: 56 # Integer | e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call
1423
- }
1424
-
1425
- begin
1426
- #searches SuperFunds
1427
- result = api_instance.get_superfunds(xero_tenant_id, opts)
1428
- p result
1429
- rescue XeroRuby::PayrollAu::ApiError => e
1430
- puts "Exception when calling PayrollAuApi->get_superfunds: #{e}"
1431
- end
1432
- ```
1433
-
1434
- ### Parameters
1435
-
1436
-
1437
- Name | Type | Description | Notes
1438
- ------------- | ------------- | ------------- | -------------
1439
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1440
- **if_modified_since** | **String**| Only records created or modified since this timestamp will be returned | [optional]
1441
- **where** | **String**| Filter by an any element | [optional]
1442
- **order** | **String**| Order by an any element | [optional]
1443
- **page** | **Integer**| e.g. page&#x3D;1 – Up to 100 SuperFunds will be returned in a single API call | [optional]
1444
-
1445
- ### Return type
1446
-
1447
- [**SuperFunds**](SuperFunds.md)
1448
-
1449
- ### Authorization
1450
-
1451
- [OAuth2](../README.md#OAuth2)
1452
-
1453
- ### HTTP request headers
1454
-
1455
- - **Content-Type**: Not defined
1456
- - **Accept**: application/json
1457
-
1458
-
1459
- ## get_timesheet
1460
-
1461
- > TimesheetObject get_timesheet(xero_tenant_id, timesheet_id)
1462
-
1463
- searches for an timesheet by unique id
1464
-
1465
- ### Example
1466
-
1467
- ```ruby
1468
- # load the gem
1469
- require 'xero-ruby'
1470
-
1471
- creds = {
1472
- client_id: ENV['CLIENT_ID'],
1473
- client_secret: ENV['CLIENT_SECRET'],
1474
- redirect_uri: ENV['REDIRECT_URI'],
1475
- scopes: ENV['SCOPES']
1476
- }
1477
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1478
-
1479
- token_set = fetch_valid_token_set(user) # example
1480
-
1481
- xero_client.refresh_token_set(token_set)
1482
-
1483
- # You need to namespace your api method call to one of the following api sets
1484
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1485
-
1486
- api_instance = xero_client.<api_set>
1487
-
1488
-
1489
-
1490
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1491
- timesheet_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Timesheet id for single object
1492
- begin
1493
- #searches for an timesheet by unique id
1494
- result = api_instance.get_timesheet(xero_tenant_id, timesheet_id)
1495
- p result
1496
- rescue XeroRuby::PayrollAu::ApiError => e
1497
- puts "Exception when calling PayrollAuApi->get_timesheet: #{e}"
1498
- end
1499
- ```
1500
-
1501
- ### Parameters
1502
-
1503
-
1504
- Name | Type | Description | Notes
1505
- ------------- | ------------- | ------------- | -------------
1506
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1507
- **timesheet_id** | [**String**](.md)| Timesheet id for single object |
1508
-
1509
- ### Return type
1510
-
1511
- [**TimesheetObject**](TimesheetObject.md)
1512
-
1513
- ### Authorization
1514
-
1515
- [OAuth2](../README.md#OAuth2)
1516
-
1517
- ### HTTP request headers
1518
-
1519
- - **Content-Type**: Not defined
1520
- - **Accept**: application/json
1521
-
1522
-
1523
- ## get_timesheets
1524
-
1525
- > Timesheets get_timesheets(xero_tenant_id, opts)
1526
-
1527
- searches timesheets
1528
-
1529
- ### Example
1530
-
1531
- ```ruby
1532
- # load the gem
1533
- require 'xero-ruby'
1534
-
1535
- creds = {
1536
- client_id: ENV['CLIENT_ID'],
1537
- client_secret: ENV['CLIENT_SECRET'],
1538
- redirect_uri: ENV['REDIRECT_URI'],
1539
- scopes: ENV['SCOPES']
1540
- }
1541
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1542
-
1543
- token_set = fetch_valid_token_set(user) # example
1544
-
1545
- xero_client.refresh_token_set(token_set)
1546
-
1547
- # You need to namespace your api method call to one of the following api sets
1548
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1549
-
1550
- api_instance = xero_client.<api_set>
1551
-
1552
-
1553
-
1554
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1555
- opts = {
1556
- if_modified_since: 'if_modified_since_example', # String | Only records created or modified since this timestamp will be returned
1557
-
1558
- where: 'Status==\"ACTIVE\"', # String | Filter by an any element
1559
-
1560
- order: 'EmailAddress%20DESC', # String | Order by an any element
1561
-
1562
- page: 56 # Integer | e.g. page=1 – Up to 100 timesheets will be returned in a single API call
1563
- }
1564
-
1565
- begin
1566
- #searches timesheets
1567
- result = api_instance.get_timesheets(xero_tenant_id, opts)
1568
- p result
1569
- rescue XeroRuby::PayrollAu::ApiError => e
1570
- puts "Exception when calling PayrollAuApi->get_timesheets: #{e}"
1571
- end
1572
- ```
1573
-
1574
- ### Parameters
1575
-
1576
-
1577
- Name | Type | Description | Notes
1578
- ------------- | ------------- | ------------- | -------------
1579
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1580
- **if_modified_since** | **String**| Only records created or modified since this timestamp will be returned | [optional]
1581
- **where** | **String**| Filter by an any element | [optional]
1582
- **order** | **String**| Order by an any element | [optional]
1583
- **page** | **Integer**| e.g. page&#x3D;1 – Up to 100 timesheets will be returned in a single API call | [optional]
1584
-
1585
- ### Return type
1586
-
1587
- [**Timesheets**](Timesheets.md)
1588
-
1589
- ### Authorization
1590
-
1591
- [OAuth2](../README.md#OAuth2)
1592
-
1593
- ### HTTP request headers
1594
-
1595
- - **Content-Type**: Not defined
1596
- - **Accept**: application/json
1597
-
1598
-
1599
- ## update_employee
1600
-
1601
- > Employees update_employee(xero_tenant_id, employee_id, opts)
1602
-
1603
- Update an Employee
1604
-
1605
- Update properties on a single employee
1606
-
1607
- ### Example
1608
-
1609
- ```ruby
1610
- # load the gem
1611
- require 'xero-ruby'
1612
-
1613
- creds = {
1614
- client_id: ENV['CLIENT_ID'],
1615
- client_secret: ENV['CLIENT_SECRET'],
1616
- redirect_uri: ENV['REDIRECT_URI'],
1617
- scopes: ENV['SCOPES']
1618
- }
1619
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1620
-
1621
- token_set = fetch_valid_token_set(user) # example
1622
-
1623
- xero_client.refresh_token_set(token_set)
1624
-
1625
- # You need to namespace your api method call to one of the following api sets
1626
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1627
-
1628
- api_instance = xero_client.<api_set>
1629
-
1630
-
1631
-
1632
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1633
- employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
1634
- opts = {
1635
- employee: [ { "MiddleNames": "Frank" } ] # Array<Employee> |
1636
- }
1637
-
1638
- begin
1639
- #Update an Employee
1640
- result = api_instance.update_employee(xero_tenant_id, employee_id, opts)
1641
- p result
1642
- rescue XeroRuby::PayrollAu::ApiError => e
1643
- puts "Exception when calling PayrollAuApi->update_employee: #{e}"
1644
- end
1645
- ```
1646
-
1647
- ### Parameters
1648
-
1649
-
1650
- Name | Type | Description | Notes
1651
- ------------- | ------------- | ------------- | -------------
1652
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1653
- **employee_id** | [**String**](.md)| Employee id for single object |
1654
- **employee** | [**Array&lt;Employee&gt;**](Employee.md)| | [optional]
1655
-
1656
- ### Return type
1657
-
1658
- [**Employees**](Employees.md)
1659
-
1660
- ### Authorization
1661
-
1662
- [OAuth2](../README.md#OAuth2)
1663
-
1664
- ### HTTP request headers
1665
-
1666
- - **Content-Type**: application/json
1667
- - **Accept**: application/json
1668
-
1669
-
1670
- ## update_leave_application
1671
-
1672
- > LeaveApplications update_leave_application(xero_tenant_id, leave_application_id, leave_application)
1673
-
1674
- Use this method to update a Leave Application
1675
-
1676
- ### Example
1677
-
1678
- ```ruby
1679
- # load the gem
1680
- require 'xero-ruby'
1681
-
1682
- creds = {
1683
- client_id: ENV['CLIENT_ID'],
1684
- client_secret: ENV['CLIENT_SECRET'],
1685
- redirect_uri: ENV['REDIRECT_URI'],
1686
- scopes: ENV['SCOPES']
1687
- }
1688
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1689
-
1690
- token_set = fetch_valid_token_set(user) # example
1691
-
1692
- xero_client.refresh_token_set(token_set)
1693
-
1694
- # You need to namespace your api method call to one of the following api sets
1695
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1696
-
1697
- api_instance = xero_client.<api_set>
1698
-
1699
-
1700
-
1701
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1702
- leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Leave Application id for single object
1703
- leave_application = [ { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "LeaveTypeID": "184ea8f7-d143-46dd-bef3-0c60e1aa6fca", "StartDate": "/Date(1572559200000+0000)/", "EndDate": "/Date(1572645600000+0000)/", "Description": "My updated Description" } ] # Array<LeaveApplication> |
1704
- begin
1705
- #Use this method to update a Leave Application
1706
- result = api_instance.update_leave_application(xero_tenant_id, leave_application_id, leave_application)
1707
- p result
1708
- rescue XeroRuby::PayrollAu::ApiError => e
1709
- puts "Exception when calling PayrollAuApi->update_leave_application: #{e}"
1710
- end
1711
- ```
1712
-
1713
- ### Parameters
1714
-
1715
-
1716
- Name | Type | Description | Notes
1717
- ------------- | ------------- | ------------- | -------------
1718
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1719
- **leave_application_id** | [**String**](.md)| Leave Application id for single object |
1720
- **leave_application** | [**Array&lt;LeaveApplication&gt;**](LeaveApplication.md)| |
1721
-
1722
- ### Return type
1723
-
1724
- [**LeaveApplications**](LeaveApplications.md)
1725
-
1726
- ### Authorization
1727
-
1728
- [OAuth2](../README.md#OAuth2)
1729
-
1730
- ### HTTP request headers
1731
-
1732
- - **Content-Type**: application/json
1733
- - **Accept**: application/json
1734
-
1735
-
1736
- ## update_pay_run
1737
-
1738
- > PayRuns update_pay_run(xero_tenant_id, pay_run_id, opts)
1739
-
1740
- Update a PayRun
1741
-
1742
- Update properties on a single PayRun
1743
-
1744
- ### Example
1745
-
1746
- ```ruby
1747
- # load the gem
1748
- require 'xero-ruby'
1749
-
1750
- creds = {
1751
- client_id: ENV['CLIENT_ID'],
1752
- client_secret: ENV['CLIENT_SECRET'],
1753
- redirect_uri: ENV['REDIRECT_URI'],
1754
- scopes: ENV['SCOPES']
1755
- }
1756
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1757
-
1758
- token_set = fetch_valid_token_set(user) # example
1759
-
1760
- xero_client.refresh_token_set(token_set)
1761
-
1762
- # You need to namespace your api method call to one of the following api sets
1763
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1764
-
1765
- api_instance = xero_client.<api_set>
1766
-
1767
-
1768
-
1769
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1770
- pay_run_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | PayRun id for single object
1771
- opts = {
1772
- pay_run: [XeroRuby::PayrollAu::PayRun.new] # Array<PayRun> |
1773
- }
1774
-
1775
- begin
1776
- #Update a PayRun
1777
- result = api_instance.update_pay_run(xero_tenant_id, pay_run_id, opts)
1778
- p result
1779
- rescue XeroRuby::PayrollAu::ApiError => e
1780
- puts "Exception when calling PayrollAuApi->update_pay_run: #{e}"
1781
- end
1782
- ```
1783
-
1784
- ### Parameters
1785
-
1786
-
1787
- Name | Type | Description | Notes
1788
- ------------- | ------------- | ------------- | -------------
1789
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1790
- **pay_run_id** | [**String**](.md)| PayRun id for single object |
1791
- **pay_run** | [**Array&lt;PayRun&gt;**](PayRun.md)| | [optional]
1792
-
1793
- ### Return type
1794
-
1795
- [**PayRuns**](PayRuns.md)
1796
-
1797
- ### Authorization
1798
-
1799
- [OAuth2](../README.md#OAuth2)
1800
-
1801
- ### HTTP request headers
1802
-
1803
- - **Content-Type**: application/json
1804
- - **Accept**: application/json
1805
-
1806
-
1807
- ## update_payslip
1808
-
1809
- > Payslips update_payslip(xero_tenant_id, payslip_id, opts)
1810
-
1811
- Update a Payslip
1812
-
1813
- Update lines on a single payslips
1814
-
1815
- ### Example
1816
-
1817
- ```ruby
1818
- # load the gem
1819
- require 'xero-ruby'
1820
-
1821
- creds = {
1822
- client_id: ENV['CLIENT_ID'],
1823
- client_secret: ENV['CLIENT_SECRET'],
1824
- redirect_uri: ENV['REDIRECT_URI'],
1825
- scopes: ENV['SCOPES']
1826
- }
1827
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1828
-
1829
- token_set = fetch_valid_token_set(user) # example
1830
-
1831
- xero_client.refresh_token_set(token_set)
1832
-
1833
- # You need to namespace your api method call to one of the following api sets
1834
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1835
-
1836
- api_instance = xero_client.<api_set>
1837
-
1838
-
1839
-
1840
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1841
- payslip_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Payslip id for single object
1842
- opts = {
1843
- payslip_lines: { "Payslip": { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "DeductionLines": [ { "DeductionTypeID": "727af5e8-b347-4ae7-85fc-9b82266d0aec", "CalculationType": "FIXEDAMOUNT", "NumberOfUnits": 10 } ] } } # Array<PayslipLines> |
1844
- }
1845
-
1846
- begin
1847
- #Update a Payslip
1848
- result = api_instance.update_payslip(xero_tenant_id, payslip_id, opts)
1849
- p result
1850
- rescue XeroRuby::PayrollAu::ApiError => e
1851
- puts "Exception when calling PayrollAuApi->update_payslip: #{e}"
1852
- end
1853
- ```
1854
-
1855
- ### Parameters
1856
-
1857
-
1858
- Name | Type | Description | Notes
1859
- ------------- | ------------- | ------------- | -------------
1860
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1861
- **payslip_id** | [**String**](.md)| Payslip id for single object |
1862
- **payslip_lines** | [**Array&lt;PayslipLines&gt;**](PayslipLines.md)| | [optional]
1863
-
1864
- ### Return type
1865
-
1866
- [**Payslips**](Payslips.md)
1867
-
1868
- ### Authorization
1869
-
1870
- [OAuth2](../README.md#OAuth2)
1871
-
1872
- ### HTTP request headers
1873
-
1874
- - **Content-Type**: application/json
1875
- - **Accept**: application/json
1876
-
1877
-
1878
- ## update_superfund
1879
-
1880
- > SuperFunds update_superfund(xero_tenant_id, super_fund_id, opts)
1881
-
1882
- Update a Superfund
1883
-
1884
- Update properties on a single Superfund
1885
-
1886
- ### Example
1887
-
1888
- ```ruby
1889
- # load the gem
1890
- require 'xero-ruby'
1891
-
1892
- creds = {
1893
- client_id: ENV['CLIENT_ID'],
1894
- client_secret: ENV['CLIENT_SECRET'],
1895
- redirect_uri: ENV['REDIRECT_URI'],
1896
- scopes: ENV['SCOPES']
1897
- }
1898
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1899
-
1900
- token_set = fetch_valid_token_set(user) # example
1901
-
1902
- xero_client.refresh_token_set(token_set)
1903
-
1904
- # You need to namespace your api method call to one of the following api sets
1905
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1906
-
1907
- api_instance = xero_client.<api_set>
1908
-
1909
-
1910
-
1911
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1912
- super_fund_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Superfund id for single object
1913
- opts = {
1914
- super_fund: [ { "Type":"REGULATED", "Name":"Nice23534" } ] # Array<SuperFund> |
1915
- }
1916
-
1917
- begin
1918
- #Update a Superfund
1919
- result = api_instance.update_superfund(xero_tenant_id, super_fund_id, opts)
1920
- p result
1921
- rescue XeroRuby::PayrollAu::ApiError => e
1922
- puts "Exception when calling PayrollAuApi->update_superfund: #{e}"
1923
- end
1924
- ```
1925
-
1926
- ### Parameters
1927
-
1928
-
1929
- Name | Type | Description | Notes
1930
- ------------- | ------------- | ------------- | -------------
1931
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1932
- **super_fund_id** | [**String**](.md)| Superfund id for single object |
1933
- **super_fund** | [**Array&lt;SuperFund&gt;**](SuperFund.md)| | [optional]
1934
-
1935
- ### Return type
1936
-
1937
- [**SuperFunds**](SuperFunds.md)
1938
-
1939
- ### Authorization
1940
-
1941
- [OAuth2](../README.md#OAuth2)
1942
-
1943
- ### HTTP request headers
1944
-
1945
- - **Content-Type**: application/json
1946
- - **Accept**: application/json
1947
-
1948
-
1949
- ## update_timesheet
1950
-
1951
- > Timesheets update_timesheet(xero_tenant_id, timesheet_id, opts)
1952
-
1953
- Update a Timesheet
1954
-
1955
- Update properties on a single timesheet
1956
-
1957
- ### Example
1958
-
1959
- ```ruby
1960
- # load the gem
1961
- require 'xero-ruby'
1962
-
1963
- creds = {
1964
- client_id: ENV['CLIENT_ID'],
1965
- client_secret: ENV['CLIENT_SECRET'],
1966
- redirect_uri: ENV['REDIRECT_URI'],
1967
- scopes: ENV['SCOPES']
1968
- }
1969
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1970
-
1971
- token_set = fetch_valid_token_set(user) # example
1972
-
1973
- xero_client.refresh_token_set(token_set)
1974
-
1975
- # You need to namespace your api method call to one of the following api sets
1976
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1977
-
1978
- api_instance = xero_client.<api_set>
1979
-
1980
-
1981
-
1982
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
1983
- timesheet_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Timesheet id for single object
1984
- opts = {
1985
- timesheet: [ { "EmployeeID":"b34e89ff-770d-4099-b7e5-f968767118bc", "StartDate":"/Date(1573171200000+0000)/", "EndDate":"/Date(1573689600000+0000)/", "Status":"APPROVED", "Hours":22.0, "TimesheetID":"a7eb0a79-8511-4ee7-b473-3a25f28abcb9", "TimesheetLines":[ { "EarningsRateID":"ab874dfb-ab09-4c91-954e-43acf6fc23b4", "TrackingItemID":"af5e9ce2-2349-4136-be99-3561b189f473", "NumberOfUnits":[ 2.0, 10.0, 0.0, 0.0, 5.0, 0.0, 5.0 ], "UpdatedDateUTC":"/Date(1573516185127+0000)/" } ] } ] # Array<Timesheet> |
1986
- }
1987
-
1988
- begin
1989
- #Update a Timesheet
1990
- result = api_instance.update_timesheet(xero_tenant_id, timesheet_id, opts)
1991
- p result
1992
- rescue XeroRuby::PayrollAu::ApiError => e
1993
- puts "Exception when calling PayrollAuApi->update_timesheet: #{e}"
1994
- end
1995
- ```
1996
-
1997
- ### Parameters
1998
-
1999
-
2000
- Name | Type | Description | Notes
2001
- ------------- | ------------- | ------------- | -------------
2002
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
2003
- **timesheet_id** | [**String**](.md)| Timesheet id for single object |
2004
- **timesheet** | [**Array&lt;Timesheet&gt;**](Timesheet.md)| | [optional]
2005
-
2006
- ### Return type
2007
-
2008
- [**Timesheets**](Timesheets.md)
2009
-
2010
- ### Authorization
2011
-
2012
- [OAuth2](../README.md#OAuth2)
2013
-
2014
- ### HTTP request headers
2015
-
2016
- - **Content-Type**: application/json
2017
- - **Accept**: application/json
2018
-