RubyGems - xero-ruby - Versions diffs - 2.3.0 → 2.3.1 - Mend

xero-ruby 2.3.0 → 2.3.1

Files changed (442) hide show

checksums.yaml +4 -4
data/README.md +2 -0
data/lib/xero-ruby/version.rb +1 -1
metadata +2 -440
data/CODE_OF_CONDUCT.md +0 -76
data/CONTRIBUTING.md +0 -82
data/Gemfile +0 -9
data/LICENSE +0 -21
data/Rakefile +0 -10
data/build_notes.md +0 -52
data/docs/accounting/Account.md +0 -55
data/docs/accounting/AccountType.md +0 -16
data/docs/accounting/AccountingApi.md +0 -15245
data/docs/accounting/Accounts.md +0 -17
data/docs/accounting/AccountsPayable.md +0 -19
data/docs/accounting/AccountsReceivable.md +0 -19
data/docs/accounting/Action.md +0 -19
data/docs/accounting/Actions.md +0 -17
data/docs/accounting/Address.md +0 -35
data/docs/accounting/Allocation.md +0 -31
data/docs/accounting/Allocations.md +0 -17
data/docs/accounting/Attachment.md +0 -27
data/docs/accounting/Attachments.md +0 -17
data/docs/accounting/Balances.md +0 -19
data/docs/accounting/BankTransaction.md +0 -59
data/docs/accounting/BankTransactions.md +0 -17
data/docs/accounting/BankTransfer.md +0 -37
data/docs/accounting/BankTransfers.md +0 -17
data/docs/accounting/BatchPayment.md +0 -47
data/docs/accounting/BatchPaymentDetails.md +0 -25
data/docs/accounting/BatchPayments.md +0 -17
data/docs/accounting/Bill.md +0 -19
data/docs/accounting/BrandingTheme.md +0 -27
data/docs/accounting/BrandingThemes.md +0 -17
data/docs/accounting/CISOrgSetting.md +0 -21
data/docs/accounting/CISSetting.md +0 -19
data/docs/accounting/CISSettings.md +0 -17
data/docs/accounting/Contact.md +0 -93
data/docs/accounting/ContactGroup.md +0 -23
data/docs/accounting/ContactGroups.md +0 -17
data/docs/accounting/ContactPerson.md +0 -23
data/docs/accounting/Contacts.md +0 -17
data/docs/accounting/CountryCode.md +0 -16
data/docs/accounting/CreditNote.md +0 -67
data/docs/accounting/CreditNotes.md +0 -17
data/docs/accounting/Currencies.md +0 -17
data/docs/accounting/Currency.md +0 -19
data/docs/accounting/CurrencyCode.md +0 -16
data/docs/accounting/Element.md +0 -31
data/docs/accounting/Employee.md +0 -31
data/docs/accounting/Employees.md +0 -17
data/docs/accounting/Error.md +0 -23
data/docs/accounting/ExpenseClaim.md +0 -39
data/docs/accounting/ExpenseClaims.md +0 -17
data/docs/accounting/ExternalLink.md +0 -21
data/docs/accounting/HistoryRecord.md +0 -23
data/docs/accounting/HistoryRecords.md +0 -17
data/docs/accounting/Invoice.md +0 -93
data/docs/accounting/InvoiceReminder.md +0 -17
data/docs/accounting/InvoiceReminders.md +0 -17
data/docs/accounting/Invoices.md +0 -17
data/docs/accounting/Item.md +0 -47
data/docs/accounting/Items.md +0 -17
data/docs/accounting/Journal.md +0 -31
data/docs/accounting/JournalLine.md +0 -39
data/docs/accounting/Journals.md +0 -17
data/docs/accounting/LineAmountTypes.md +0 -16
data/docs/accounting/LineItem.md +0 -41
data/docs/accounting/LineItemTracking.md +0 -23
data/docs/accounting/LinkedTransaction.md +0 -37
data/docs/accounting/LinkedTransactions.md +0 -17
data/docs/accounting/ManualJournal.md +0 -43
data/docs/accounting/ManualJournalLine.md +0 -31
data/docs/accounting/ManualJournals.md +0 -17
data/docs/accounting/OnlineInvoice.md +0 -17
data/docs/accounting/OnlineInvoices.md +0 -17
data/docs/accounting/Organisation.md +0 -81
data/docs/accounting/Organisations.md +0 -17
data/docs/accounting/Overpayment.md +0 -53
data/docs/accounting/Overpayments.md +0 -17
data/docs/accounting/Payment.md +0 -63
data/docs/accounting/PaymentDelete.md +0 -17
data/docs/accounting/PaymentService.md +0 -27
data/docs/accounting/PaymentServices.md +0 -17
data/docs/accounting/PaymentTerm.md +0 -19
data/docs/accounting/PaymentTermType.md +0 -16
data/docs/accounting/Payments.md +0 -17
data/docs/accounting/Phone.md +0 -23
data/docs/accounting/Prepayment.md +0 -53
data/docs/accounting/Prepayments.md +0 -17
data/docs/accounting/Purchase.md +0 -23
data/docs/accounting/PurchaseOrder.md +0 -71
data/docs/accounting/PurchaseOrders.md +0 -17
data/docs/accounting/Quote.md +0 -63
data/docs/accounting/QuoteLineAmountTypes.md +0 -16
data/docs/accounting/QuoteStatusCodes.md +0 -16
data/docs/accounting/Quotes.md +0 -17
data/docs/accounting/Receipt.md +0 -51
data/docs/accounting/Receipts.md +0 -17
data/docs/accounting/RepeatingInvoice.md +0 -47
data/docs/accounting/RepeatingInvoices.md +0 -17
data/docs/accounting/Report.md +0 -29
data/docs/accounting/ReportAttribute.md +0 -19
data/docs/accounting/ReportCell.md +0 -19
data/docs/accounting/ReportFields.md +0 -21
data/docs/accounting/ReportRow.md +0 -21
data/docs/accounting/ReportRows.md +0 -23
data/docs/accounting/ReportWithRow.md +0 -33
data/docs/accounting/ReportWithRows.md +0 -17
data/docs/accounting/Reports.md +0 -17
data/docs/accounting/RequestEmpty.md +0 -17
data/docs/accounting/RowType.md +0 -16
data/docs/accounting/SalesTrackingCategory.md +0 -19
data/docs/accounting/Schedule.md +0 -29
data/docs/accounting/TaxComponent.md +0 -23
data/docs/accounting/TaxRate.md +0 -39
data/docs/accounting/TaxRates.md +0 -17
data/docs/accounting/TaxType.md +0 -16
data/docs/accounting/TenNinetyNineContact.md +0 -59
data/docs/accounting/TimeZone.md +0 -16
data/docs/accounting/TrackingCategories.md +0 -17
data/docs/accounting/TrackingCategory.md +0 -27
data/docs/accounting/TrackingOption.md +0 -23
data/docs/accounting/TrackingOptions.md +0 -17
data/docs/accounting/User.md +0 -29
data/docs/accounting/Users.md +0 -17
data/docs/accounting/ValidationError.md +0 -17
data/docs/assets/Asset.md +0 -45
data/docs/assets/AssetApi.md +0 -426
data/docs/assets/AssetStatus.md +0 -16
data/docs/assets/AssetStatusQueryParam.md +0 -16
data/docs/assets/AssetType.md +0 -29
data/docs/assets/Assets.md +0 -19
data/docs/assets/BookDepreciationDetail.md +0 -29
data/docs/assets/BookDepreciationSetting.md +0 -31
data/docs/assets/Error.md +0 -25
data/docs/assets/FieldValidationErrorsElement.md +0 -27
data/docs/assets/Pagination.md +0 -23
data/docs/assets/ResourceValidationErrorsElement.md +0 -25
data/docs/assets/Setting.md +0 -31
data/docs/files/Association.md +0 -23
data/docs/files/FileObject.md +0 -31
data/docs/files/FileResponse204.md +0 -17
data/docs/files/Files.md +0 -23
data/docs/files/FilesApi.md +0 -1116
data/docs/files/Folder.md +0 -25
data/docs/files/Folders.md +0 -17
data/docs/files/InlineObject.md +0 -23
data/docs/files/ObjectGroup.md +0 -16
data/docs/files/ObjectType.md +0 -16
data/docs/files/User.md +0 -29
data/docs/payroll_au/APIException.md +0 -21
data/docs/payroll_au/Account.md +0 -23
data/docs/payroll_au/AccountType.md +0 -16
data/docs/payroll_au/AllowanceType.md +0 -16
data/docs/payroll_au/BankAccount.md +0 -27
data/docs/payroll_au/CalendarType.md +0 -16
data/docs/payroll_au/DeductionLine.md +0 -25
data/docs/payroll_au/DeductionType.md +0 -33
data/docs/payroll_au/DeductionTypeCalculationType.md +0 -16
data/docs/payroll_au/EarningsLine.md +0 -33
data/docs/payroll_au/EarningsRate.md +0 -49
data/docs/payroll_au/EarningsRateCalculationType.md +0 -16
data/docs/payroll_au/EarningsType.md +0 -16
data/docs/payroll_au/Employee.md +0 -77
data/docs/payroll_au/EmployeeStatus.md +0 -16
data/docs/payroll_au/Employees.md +0 -17
data/docs/payroll_au/EmploymentBasis.md +0 -16
data/docs/payroll_au/EmploymentTerminationPaymentType.md +0 -16
data/docs/payroll_au/EntitlementFinalPayPayoutType.md +0 -16
data/docs/payroll_au/HomeAddress.md +0 -27
data/docs/payroll_au/LeaveAccrualLine.md +0 -21
data/docs/payroll_au/LeaveApplication.md +0 -35
data/docs/payroll_au/LeaveApplications.md +0 -17
data/docs/payroll_au/LeaveBalance.md +0 -23
data/docs/payroll_au/LeaveEarningsLine.md +0 -21
data/docs/payroll_au/LeaveLine.md +0 -31
data/docs/payroll_au/LeaveLineCalculationType.md +0 -16
data/docs/payroll_au/LeaveLines.md +0 -17
data/docs/payroll_au/LeavePeriod.md +0 -23
data/docs/payroll_au/LeavePeriodStatus.md +0 -16
data/docs/payroll_au/LeaveType.md +0 -33
data/docs/payroll_au/LeaveTypeContributionType.md +0 -16
data/docs/payroll_au/ManualTaxType.md +0 -16
data/docs/payroll_au/OpeningBalances.md +0 -29
data/docs/payroll_au/PayItem.md +0 -23
data/docs/payroll_au/PayItems.md +0 -17
data/docs/payroll_au/PayRun.md +0 -47
data/docs/payroll_au/PayRunStatus.md +0 -16
data/docs/payroll_au/PayRuns.md +0 -17
data/docs/payroll_au/PayTemplate.md +0 -25
data/docs/payroll_au/PaymentFrequencyType.md +0 -16
data/docs/payroll_au/PayrollAuApi.md +0 -2018
data/docs/payroll_au/PayrollCalendar.md +0 -29
data/docs/payroll_au/PayrollCalendars.md +0 -17
data/docs/payroll_au/Payslip.md +0 -53
data/docs/payroll_au/PayslipLines.md +0 -31
data/docs/payroll_au/PayslipObject.md +0 -17
data/docs/payroll_au/PayslipSummary.md +0 -39
data/docs/payroll_au/Payslips.md +0 -17
data/docs/payroll_au/RateType.md +0 -16
data/docs/payroll_au/ReimbursementLine.md +0 -23
data/docs/payroll_au/ReimbursementLines.md +0 -17
data/docs/payroll_au/ReimbursementType.md +0 -25
data/docs/payroll_au/ResidencyStatus.md +0 -16
data/docs/payroll_au/Settings.md +0 -21
data/docs/payroll_au/SettingsObject.md +0 -17
data/docs/payroll_au/SettingsTrackingCategories.md +0 -19
data/docs/payroll_au/SettingsTrackingCategoriesEmployeeGroups.md +0 -19
data/docs/payroll_au/SettingsTrackingCategoriesTimesheetCategories.md +0 -19
data/docs/payroll_au/State.md +0 -16
data/docs/payroll_au/SuperFund.md +0 -41
data/docs/payroll_au/SuperFundProduct.md +0 -23
data/docs/payroll_au/SuperFundProducts.md +0 -17
data/docs/payroll_au/SuperFundType.md +0 -16
data/docs/payroll_au/SuperFunds.md +0 -17
data/docs/payroll_au/SuperLine.md +0 -31
data/docs/payroll_au/SuperMembership.md +0 -21
data/docs/payroll_au/SuperannuationCalculationType.md +0 -16
data/docs/payroll_au/SuperannuationContributionType.md +0 -16
data/docs/payroll_au/SuperannuationLine.md +0 -33
data/docs/payroll_au/TFNExemptionType.md +0 -16
data/docs/payroll_au/TaxDeclaration.md +0 -47
data/docs/payroll_au/TaxLine.md +0 -27
data/docs/payroll_au/Timesheet.md +0 -33
data/docs/payroll_au/TimesheetLine.md +0 -23
data/docs/payroll_au/TimesheetObject.md +0 -17
data/docs/payroll_au/TimesheetStatus.md +0 -16
data/docs/payroll_au/Timesheets.md +0 -17
data/docs/payroll_au/ValidationError.md +0 -17
data/docs/payroll_nz/Account.md +0 -23
data/docs/payroll_nz/Accounts.md +0 -17
data/docs/payroll_nz/Address.md +0 -27
data/docs/payroll_nz/BankAccount.md +0 -31
data/docs/payroll_nz/Benefit.md +0 -35
data/docs/payroll_nz/Deduction.md +0 -27
data/docs/payroll_nz/DeductionLine.md +0 -25
data/docs/payroll_nz/DeductionObject.md +0 -21
data/docs/payroll_nz/Deductions.md +0 -21
data/docs/payroll_nz/EarningsLine.md +0 -35
data/docs/payroll_nz/EarningsOrder.md +0 -25
data/docs/payroll_nz/EarningsOrderObject.md +0 -21
data/docs/payroll_nz/EarningsOrders.md +0 -21
data/docs/payroll_nz/EarningsRate.md +0 -35
data/docs/payroll_nz/EarningsRateObject.md +0 -21
data/docs/payroll_nz/EarningsRates.md +0 -21
data/docs/payroll_nz/EarningsTemplate.md +0 -27
data/docs/payroll_nz/EarningsTemplateObject.md +0 -21
data/docs/payroll_nz/Employee.md +0 -43
data/docs/payroll_nz/EmployeeEarningsTemplates.md +0 -21
data/docs/payroll_nz/EmployeeLeave.md +0 -29
data/docs/payroll_nz/EmployeeLeaveBalance.md +0 -23
data/docs/payroll_nz/EmployeeLeaveBalances.md +0 -21
data/docs/payroll_nz/EmployeeLeaveObject.md +0 -21
data/docs/payroll_nz/EmployeeLeaveSetup.md +0 -29
data/docs/payroll_nz/EmployeeLeaveSetupObject.md +0 -21
data/docs/payroll_nz/EmployeeLeaveType.md +0 -35
data/docs/payroll_nz/EmployeeLeaveTypeObject.md +0 -21
data/docs/payroll_nz/EmployeeLeaveTypes.md +0 -21
data/docs/payroll_nz/EmployeeLeaves.md +0 -21
data/docs/payroll_nz/EmployeeObject.md +0 -21
data/docs/payroll_nz/EmployeeOpeningBalance.md +0 -23
data/docs/payroll_nz/EmployeeOpeningBalancesObject.md +0 -21
data/docs/payroll_nz/EmployeePayTemplate.md +0 -19
data/docs/payroll_nz/EmployeePayTemplateObject.md +0 -21
data/docs/payroll_nz/EmployeePayTemplates.md +0 -21
data/docs/payroll_nz/EmployeeStatutoryLeaveBalance.md +0 -21
data/docs/payroll_nz/EmployeeStatutoryLeaveBalanceObject.md +0 -21
data/docs/payroll_nz/EmployeeStatutoryLeaveSummary.md +0 -29
data/docs/payroll_nz/EmployeeStatutoryLeavesSummaries.md +0 -21
data/docs/payroll_nz/EmployeeStatutorySickLeave.md +0 -47
data/docs/payroll_nz/EmployeeStatutorySickLeaveObject.md +0 -21
data/docs/payroll_nz/EmployeeStatutorySickLeaves.md +0 -21
data/docs/payroll_nz/EmployeeTax.md +0 -47
data/docs/payroll_nz/EmployeeTaxObject.md +0 -21
data/docs/payroll_nz/Employees.md +0 -21
data/docs/payroll_nz/Employment.md +0 -21
data/docs/payroll_nz/EmploymentObject.md +0 -21
data/docs/payroll_nz/GrossEarningsHistory.md +0 -19
data/docs/payroll_nz/InvalidField.md +0 -19
data/docs/payroll_nz/LeaveAccrualLine.md +0 -19
data/docs/payroll_nz/LeaveEarningsLine.md +0 -35
data/docs/payroll_nz/LeavePeriod.md +0 -23
data/docs/payroll_nz/LeavePeriods.md +0 -21
data/docs/payroll_nz/LeaveType.md +0 -27
data/docs/payroll_nz/LeaveTypeObject.md +0 -21
data/docs/payroll_nz/LeaveTypes.md +0 -21
data/docs/payroll_nz/Pagination.md +0 -23
data/docs/payroll_nz/PayRun.md +0 -39
data/docs/payroll_nz/PayRunCalendar.md +0 -29
data/docs/payroll_nz/PayRunCalendarObject.md +0 -21
data/docs/payroll_nz/PayRunCalendars.md +0 -21
data/docs/payroll_nz/PayRunObject.md +0 -21
data/docs/payroll_nz/PayRuns.md +0 -21
data/docs/payroll_nz/PaySlip.md +0 -75
data/docs/payroll_nz/PaySlipObject.md +0 -21
data/docs/payroll_nz/PaySlips.md +0 -21
data/docs/payroll_nz/PaymentLine.md +0 -25
data/docs/payroll_nz/PaymentMethod.md +0 -19
data/docs/payroll_nz/PaymentMethodObject.md +0 -21
data/docs/payroll_nz/PayrollNzApi.md +0 -4544
data/docs/payroll_nz/Problem.md +0 -27
data/docs/payroll_nz/Reimbursement.md +0 -33
data/docs/payroll_nz/ReimbursementLine.md +0 -25
data/docs/payroll_nz/ReimbursementObject.md +0 -21
data/docs/payroll_nz/Reimbursements.md +0 -21
data/docs/payroll_nz/SalaryAndWage.md +0 -35
data/docs/payroll_nz/SalaryAndWageObject.md +0 -21
data/docs/payroll_nz/SalaryAndWages.md +0 -21
data/docs/payroll_nz/Settings.md +0 -21
data/docs/payroll_nz/StatutoryDeduction.md +0 -25
data/docs/payroll_nz/StatutoryDeductionCategory.md +0 -16
data/docs/payroll_nz/StatutoryDeductionLine.md +0 -23
data/docs/payroll_nz/StatutoryDeductionObject.md +0 -21
data/docs/payroll_nz/StatutoryDeductions.md +0 -21
data/docs/payroll_nz/SuperannuationLine.md +0 -27
data/docs/payroll_nz/SuperannuationObject.md +0 -21
data/docs/payroll_nz/Superannuations.md +0 -21
data/docs/payroll_nz/TaxCode.md +0 -16
data/docs/payroll_nz/TaxLine.md +0 -25
data/docs/payroll_nz/TaxSettings.md +0 -27
data/docs/payroll_nz/Timesheet.md +0 -33
data/docs/payroll_nz/TimesheetEarningsLine.md +0 -35
data/docs/payroll_nz/TimesheetLine.md +0 -25
data/docs/payroll_nz/TimesheetLineObject.md +0 -21
data/docs/payroll_nz/TimesheetObject.md +0 -21
data/docs/payroll_nz/Timesheets.md +0 -21
data/docs/payroll_nz/TrackingCategories.md +0 -21
data/docs/payroll_nz/TrackingCategory.md +0 -19
data/docs/payroll_uk/Account.md +0 -23
data/docs/payroll_uk/Accounts.md +0 -17
data/docs/payroll_uk/Address.md +0 -25
data/docs/payroll_uk/BankAccount.md +0 -21
data/docs/payroll_uk/Benefit.md +0 -43
data/docs/payroll_uk/BenefitLine.md +0 -25
data/docs/payroll_uk/BenefitObject.md +0 -21
data/docs/payroll_uk/Benefits.md +0 -21
data/docs/payroll_uk/CourtOrderLine.md +0 -19
data/docs/payroll_uk/Deduction.md +0 -47
data/docs/payroll_uk/DeductionLine.md +0 -23
data/docs/payroll_uk/DeductionObject.md +0 -21
data/docs/payroll_uk/Deductions.md +0 -21
data/docs/payroll_uk/EarningsLine.md +0 -33
data/docs/payroll_uk/EarningsOrder.md +0 -25
data/docs/payroll_uk/EarningsOrderObject.md +0 -21
data/docs/payroll_uk/EarningsOrders.md +0 -21
data/docs/payroll_uk/EarningsRate.md +0 -35
data/docs/payroll_uk/EarningsRateObject.md +0 -21
data/docs/payroll_uk/EarningsRates.md +0 -21
data/docs/payroll_uk/EarningsTemplate.md +0 -27
data/docs/payroll_uk/EarningsTemplateObject.md +0 -21
data/docs/payroll_uk/Employee.md +0 -45
data/docs/payroll_uk/EmployeeLeave.md +0 -29
data/docs/payroll_uk/EmployeeLeaveBalance.md +0 -23
data/docs/payroll_uk/EmployeeLeaveBalances.md +0 -21
data/docs/payroll_uk/EmployeeLeaveObject.md +0 -21
data/docs/payroll_uk/EmployeeLeaveType.md +0 -27
data/docs/payroll_uk/EmployeeLeaveTypeObject.md +0 -21
data/docs/payroll_uk/EmployeeLeaveTypes.md +0 -21
data/docs/payroll_uk/EmployeeLeaves.md +0 -21
data/docs/payroll_uk/EmployeeObject.md +0 -21
data/docs/payroll_uk/EmployeeOpeningBalances.md +0 -27
data/docs/payroll_uk/EmployeeOpeningBalancesObject.md +0 -21
data/docs/payroll_uk/EmployeePayTemplate.md +0 -19
data/docs/payroll_uk/EmployeePayTemplateObject.md +0 -21
data/docs/payroll_uk/EmployeePayTemplates.md +0 -21
data/docs/payroll_uk/EmployeeStatutoryLeaveBalance.md +0 -21
data/docs/payroll_uk/EmployeeStatutoryLeaveBalanceObject.md +0 -21
data/docs/payroll_uk/EmployeeStatutoryLeaveSummary.md +0 -29
data/docs/payroll_uk/EmployeeStatutoryLeavesSummaries.md +0 -21
data/docs/payroll_uk/EmployeeStatutorySickLeave.md +0 -47
data/docs/payroll_uk/EmployeeStatutorySickLeaveObject.md +0 -21
data/docs/payroll_uk/EmployeeStatutorySickLeaves.md +0 -21
data/docs/payroll_uk/EmployeeTax.md +0 -37
data/docs/payroll_uk/EmployeeTaxObject.md +0 -21
data/docs/payroll_uk/Employees.md +0 -21
data/docs/payroll_uk/Employment.md +0 -23
data/docs/payroll_uk/EmploymentObject.md +0 -21
data/docs/payroll_uk/InvalidField.md +0 -19
data/docs/payroll_uk/LeaveAccrualLine.md +0 -19
data/docs/payroll_uk/LeaveEarningsLine.md +0 -27
data/docs/payroll_uk/LeavePeriod.md +0 -23
data/docs/payroll_uk/LeavePeriods.md +0 -21
data/docs/payroll_uk/LeaveType.md +0 -31
data/docs/payroll_uk/LeaveTypeObject.md +0 -21
data/docs/payroll_uk/LeaveTypes.md +0 -21
data/docs/payroll_uk/Pagination.md +0 -23
data/docs/payroll_uk/PayRun.md +0 -39
data/docs/payroll_uk/PayRunCalendar.md +0 -29
data/docs/payroll_uk/PayRunCalendarObject.md +0 -21
data/docs/payroll_uk/PayRunCalendars.md +0 -21
data/docs/payroll_uk/PayRunObject.md +0 -21
data/docs/payroll_uk/PayRuns.md +0 -21
data/docs/payroll_uk/PaymentLine.md +0 -25
data/docs/payroll_uk/PaymentMethod.md +0 -19
data/docs/payroll_uk/PaymentMethodObject.md +0 -21
data/docs/payroll_uk/PayrollUkApi.md +0 -4683
data/docs/payroll_uk/Payslip.md +0 -69
data/docs/payroll_uk/PayslipObject.md +0 -21
data/docs/payroll_uk/Payslips.md +0 -21
data/docs/payroll_uk/Problem.md +0 -27
data/docs/payroll_uk/Reimbursement.md +0 -23
data/docs/payroll_uk/ReimbursementLine.md +0 -21
data/docs/payroll_uk/ReimbursementObject.md +0 -21
data/docs/payroll_uk/Reimbursements.md +0 -21
data/docs/payroll_uk/SalaryAndWage.md +0 -33
data/docs/payroll_uk/SalaryAndWageObject.md +0 -21
data/docs/payroll_uk/SalaryAndWages.md +0 -21
data/docs/payroll_uk/Settings.md +0 -21
data/docs/payroll_uk/StatutoryDeduction.md +0 -25
data/docs/payroll_uk/StatutoryDeductionCategory.md +0 -16
data/docs/payroll_uk/TaxLine.md +0 -27
data/docs/payroll_uk/Timesheet.md +0 -33
data/docs/payroll_uk/TimesheetEarningsLine.md +0 -27
data/docs/payroll_uk/TimesheetLine.md +0 -25
data/docs/payroll_uk/TimesheetLineObject.md +0 -21
data/docs/payroll_uk/TimesheetObject.md +0 -21
data/docs/payroll_uk/Timesheets.md +0 -21
data/docs/payroll_uk/TrackingCategories.md +0 -21
data/docs/payroll_uk/TrackingCategory.md +0 -19
data/docs/projects/Amount.md +0 -19
data/docs/projects/ChargeType.md +0 -16
data/docs/projects/CurrencyCode.md +0 -16
data/docs/projects/Error.md +0 -19
data/docs/projects/Pagination.md +0 -23
data/docs/projects/Project.md +0 -59
data/docs/projects/ProjectApi.md +0 -953
data/docs/projects/ProjectCreateOrUpdate.md +0 -23
data/docs/projects/ProjectPatch.md +0 -17
data/docs/projects/ProjectStatus.md +0 -16
data/docs/projects/ProjectUser.md +0 -21
data/docs/projects/ProjectUsers.md +0 -19
data/docs/projects/Projects.md +0 -19
data/docs/projects/Task.md +0 -45
data/docs/projects/TaskCreateOrUpdate.md +0 -23
data/docs/projects/Tasks.md +0 -19
data/docs/projects/TimeEntries.md +0 -19
data/docs/projects/TimeEntry.md +0 -33
data/docs/projects/TimeEntryCreateOrUpdate.md +0 -25
data/git_push.sh +0 -55
data/xero-ruby.gem +0 -0
data/xero-ruby.gemspec +0 -38

data/docs/payroll_nz/PaymentMethodObject.md DELETED

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollNz::PaymentMethodObject
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pagination** | [**Pagination**](Pagination.md) |  | [optional]
-**problem** | [**Problem**](Problem.md) |  | [optional]
-**payment_method** | [**PaymentMethod**](PaymentMethod.md) |  | [optional]
-## Code Sample
-```ruby
-require 'XeroRuby::PayrollNz'
-instance = XeroRuby::PayrollNz::PaymentMethodObject.new(pagination: null,
-                                 problem: null,
-                                 payment_method: null)
-```

data/docs/payroll_nz/PayrollNzApi.md DELETED

@@ -1,4544 +0,0 @@
-# XeroRuby::PayrollNz::PayrollNzApi
-All URIs are relative to *https://api.xero.com/payroll.xro/2.0*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**approve_timesheet**](PayrollNzApi.md#approve_timesheet) | **POST** /Timesheets/{TimesheetID}/Approve | approve a timesheet
-[**create_deduction**](PayrollNzApi.md#create_deduction) | **POST** /Deductions | create a new deduction
-[**create_earnings_rate**](PayrollNzApi.md#create_earnings_rate) | **POST** /EarningsRates | create a new earnings rate
-[**create_employee**](PayrollNzApi.md#create_employee) | **POST** /Employees | creates employees
-[**create_employee_earnings_template**](PayrollNzApi.md#create_employee_earnings_template) | **POST** /Employees/{EmployeeId}/PayTemplates/earnings | creates employee earnings template records
-[**create_employee_leave**](PayrollNzApi.md#create_employee_leave) | **POST** /Employees/{EmployeeId}/Leave | creates employee leave records
-[**create_employee_leave_setup**](PayrollNzApi.md#create_employee_leave_setup) | **POST** /Employees/{EmployeeId}/leaveSetup | Allows you to set-up leave for a specific employee. This is required before viewing, configuring and requesting leave for an employee
-[**create_employee_leave_type**](PayrollNzApi.md#create_employee_leave_type) | **POST** /Employees/{EmployeeId}/LeaveTypes | creates employee leave type records
-[**create_employee_opening_balances**](PayrollNzApi.md#create_employee_opening_balances) | **POST** /Employees/{EmployeeId}/openingBalances | creates employee opening balances
-[**create_employee_payment_method**](PayrollNzApi.md#create_employee_payment_method) | **POST** /Employees/{EmployeeId}/PaymentMethods | creates employee payment method
-[**create_employee_salary_and_wage**](PayrollNzApi.md#create_employee_salary_and_wage) | **POST** /Employees/{EmployeeId}/SalaryAndWages | creates employee salary and wage record
-[**create_employment**](PayrollNzApi.md#create_employment) | **POST** /Employees/{EmployeeId}/Employment | creates employment
-[**create_leave_type**](PayrollNzApi.md#create_leave_type) | **POST** /LeaveTypes | create a new leave type
-[**create_multiple_employee_earnings_template**](PayrollNzApi.md#create_multiple_employee_earnings_template) | **POST** /Employees/{EmployeeId}/paytemplateearnings | creates multiple employee earnings template records
-[**create_pay_run**](PayrollNzApi.md#create_pay_run) | **POST** /PayRuns | create a pay run
-[**create_pay_run_calendar**](PayrollNzApi.md#create_pay_run_calendar) | **POST** /PayRunCalendars | create a new payrun calendar
-[**create_reimbursement**](PayrollNzApi.md#create_reimbursement) | **POST** /Reimbursements | create a new reimbursement
-[**create_superannuation**](PayrollNzApi.md#create_superannuation) | **POST** /superannuations | create a new superannuation
-[**create_timesheet**](PayrollNzApi.md#create_timesheet) | **POST** /Timesheets | create a new timesheet
-[**create_timesheet_line**](PayrollNzApi.md#create_timesheet_line) | **POST** /Timesheets/{TimesheetID}/Lines | create a new timesheet line
-[**delete_employee_earnings_template**](PayrollNzApi.md#delete_employee_earnings_template) | **DELETE** /Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID} | deletes an employee earnings template record
-[**delete_employee_leave**](PayrollNzApi.md#delete_employee_leave) | **DELETE** /Employees/{EmployeeId}/Leave/{LeaveID} | deletes an employee leave record
-[**delete_employee_salary_and_wage**](PayrollNzApi.md#delete_employee_salary_and_wage) | **DELETE** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | deletes an employee salary and wages record
-[**delete_timesheet**](PayrollNzApi.md#delete_timesheet) | **DELETE** /Timesheets/{TimesheetID} | delete a timesheet
-[**delete_timesheet_line**](PayrollNzApi.md#delete_timesheet_line) | **DELETE** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | delete a timesheet line
-[**get_deduction**](PayrollNzApi.md#get_deduction) | **GET** /Deductions/{deductionId} | retrieve a single deduction by id
-[**get_deductions**](PayrollNzApi.md#get_deductions) | **GET** /Deductions | searches deductions
-[**get_earnings_rate**](PayrollNzApi.md#get_earnings_rate) | **GET** /EarningsRates/{EarningsRateID} | retrieve a single earnings rates by id
-[**get_earnings_rates**](PayrollNzApi.md#get_earnings_rates) | **GET** /EarningsRates | searches earnings rates
-[**get_employee**](PayrollNzApi.md#get_employee) | **GET** /Employees/{EmployeeId} | searches employees
-[**get_employee_leave_balances**](PayrollNzApi.md#get_employee_leave_balances) | **GET** /Employees/{EmployeeId}/LeaveBalances | search employee leave balances
-[**get_employee_leave_periods**](PayrollNzApi.md#get_employee_leave_periods) | **GET** /Employees/{EmployeeId}/LeavePeriods | searches employee leave periods
-[**get_employee_leave_types**](PayrollNzApi.md#get_employee_leave_types) | **GET** /Employees/{EmployeeId}/LeaveTypes | searches employee leave types
-[**get_employee_leaves**](PayrollNzApi.md#get_employee_leaves) | **GET** /Employees/{EmployeeId}/Leave | search employee leave records
-[**get_employee_opening_balances**](PayrollNzApi.md#get_employee_opening_balances) | **GET** /Employees/{EmployeeId}/openingBalances | retrieve employee openingbalances
-[**get_employee_pay_templates**](PayrollNzApi.md#get_employee_pay_templates) | **GET** /Employees/{EmployeeId}/PayTemplates | searches employee pay templates
-[**get_employee_payment_method**](PayrollNzApi.md#get_employee_payment_method) | **GET** /Employees/{EmployeeId}/PaymentMethods | retrieves an employee&#39;s payment method
-[**get_employee_salary_and_wage**](PayrollNzApi.md#get_employee_salary_and_wage) | **GET** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | get employee salary and wages record by id
-[**get_employee_salary_and_wages**](PayrollNzApi.md#get_employee_salary_and_wages) | **GET** /Employees/{EmployeeId}/SalaryAndWages | retrieves an employee&#39;s salary and wages
-[**get_employee_tax**](PayrollNzApi.md#get_employee_tax) | **GET** /Employees/{EmployeeId}/Tax | searches tax records for an employee
-[**get_employees**](PayrollNzApi.md#get_employees) | **GET** /Employees | searches employees
-[**get_leave_type**](PayrollNzApi.md#get_leave_type) | **GET** /LeaveTypes/{LeaveTypeID} | retrieve a single leave type by id
-[**get_leave_types**](PayrollNzApi.md#get_leave_types) | **GET** /LeaveTypes | searches leave types
-[**get_pay_run**](PayrollNzApi.md#get_pay_run) | **GET** /PayRuns/{PayRunID} | retrieve a single pay run by id
-[**get_pay_run_calendar**](PayrollNzApi.md#get_pay_run_calendar) | **GET** /PayRunCalendars/{PayrollCalendarID} | retrieve a single payrun calendar by id
-[**get_pay_run_calendars**](PayrollNzApi.md#get_pay_run_calendars) | **GET** /PayRunCalendars | searches payrun calendars
-[**get_pay_runs**](PayrollNzApi.md#get_pay_runs) | **GET** /PayRuns | searches pay runs
-[**get_pay_slip**](PayrollNzApi.md#get_pay_slip) | **GET** /PaySlips/{PaySlipID} | retrieve a single payslip by id
-[**get_pay_slips**](PayrollNzApi.md#get_pay_slips) | **GET** /PaySlips | searches payslips
-[**get_reimbursement**](PayrollNzApi.md#get_reimbursement) | **GET** /Reimbursements/{ReimbursementID} | retrieve a single reimbursement by id
-[**get_reimbursements**](PayrollNzApi.md#get_reimbursements) | **GET** /Reimbursements | searches reimbursements
-[**get_settings**](PayrollNzApi.md#get_settings) | **GET** /Settings | searches settings
-[**get_statutory_deduction**](PayrollNzApi.md#get_statutory_deduction) | **GET** /StatutoryDeductions/{Id} | retrieve a single statutory deduction by id
-[**get_statutory_deductions**](PayrollNzApi.md#get_statutory_deductions) | **GET** /StatutoryDeductions | searches statutory deductions
-[**get_superannuation**](PayrollNzApi.md#get_superannuation) | **GET** /superannuations/{SuperannuationID} | searches for a unique superannuation
-[**get_superannuations**](PayrollNzApi.md#get_superannuations) | **GET** /superannuations | searches statutory deductions
-[**get_timesheet**](PayrollNzApi.md#get_timesheet) | **GET** /Timesheets/{TimesheetID} | retrieve a single timesheet by id
-[**get_timesheets**](PayrollNzApi.md#get_timesheets) | **GET** /Timesheets | searches timesheets
-[**get_tracking_categories**](PayrollNzApi.md#get_tracking_categories) | **GET** /settings/trackingCategories | searches tracking categories
-[**revert_timesheet**](PayrollNzApi.md#revert_timesheet) | **POST** /Timesheets/{TimesheetID}/RevertToDraft | revert a timesheet to draft
-[**update_employee**](PayrollNzApi.md#update_employee) | **PUT** /Employees/{EmployeeId} | updates employee
-[**update_employee_earnings_template**](PayrollNzApi.md#update_employee_earnings_template) | **PUT** /Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID} | updates employee earnings template records
-[**update_employee_leave**](PayrollNzApi.md#update_employee_leave) | **PUT** /Employees/{EmployeeId}/Leave/{LeaveID} | updates employee leave records
-[**update_employee_salary_and_wage**](PayrollNzApi.md#update_employee_salary_and_wage) | **PUT** /Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID} | updates employee salary and wages record
-[**update_employee_tax**](PayrollNzApi.md#update_employee_tax) | **POST** /Employees/{EmployeeId}/Tax | updates the tax records for an employee
-[**update_pay_run**](PayrollNzApi.md#update_pay_run) | **PUT** /PayRuns/{PayRunID} | update a pay run
-[**update_pay_slip_line_items**](PayrollNzApi.md#update_pay_slip_line_items) | **PUT** /PaySlips/{PaySlipID} | creates employee pay slip
-[**update_timesheet_line**](PayrollNzApi.md#update_timesheet_line) | **PUT** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | update a timesheet line
-## approve_timesheet
-> TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id)
-approve a timesheet
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet
-begin
-  #approve a timesheet
-  result = api_instance.approve_timesheet(xero_tenant_id, timesheet_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->approve_timesheet: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **timesheet_id** | [**String**](.md)| Identifier for the timesheet |
-### Return type
-[**TimesheetObject**](TimesheetObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## create_deduction
-> DeductionObject create_deduction(xero_tenant_id, deduction)
-create a new deduction
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-deduction = { "deductionName": "My new deducation", "deductionCategory": "NzOther", "liabilityAccountId": "568f2e9a-0870-46cc-8678-f83f132ed4e3" } # Deduction |
-begin
-  #create a new deduction
-  result = api_instance.create_deduction(xero_tenant_id, deduction)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_deduction: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **deduction** | [**Deduction**](Deduction.md)|  |
-### Return type
-[**DeductionObject**](DeductionObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_earnings_rate
-> EarningsRateObject create_earnings_rate(xero_tenant_id, earnings_rate)
-create a new earnings rate
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-earnings_rate = { "name": "My Earnings Rate", "earningsType": "RegularEarnings", "rateType": "RatePerUnit", "typeOfUnits": "hours", "expenseAccountID": "e4eb36f6-97e3-4427-a394-dd4e1b355c2e" } # EarningsRate |
-begin
-  #create a new earnings rate
-  result = api_instance.create_earnings_rate(xero_tenant_id, earnings_rate)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_earnings_rate: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **earnings_rate** | [**EarningsRate**](EarningsRate.md)|  |
-### Return type
-[**EarningsRateObject**](EarningsRateObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_employee
-> EmployeeObject create_employee(xero_tenant_id, employee)
-creates employees
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee = { "title": "Mr", "firstName": "Mike", "lastName": "Johntzxzpxhmkgson", "dateOfBirth": "2000-01-01", "address": { "addressLine1": "101 Green St", "city": "San Francisco", "postCode": "4351", "countryName": "United Kingdom" }, "email": "83139@starkindustries.com", "gender": "M" } # Employee |
-begin
-  #creates employees
-  result = api_instance.create_employee(xero_tenant_id, employee)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_employee: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee** | [**Employee**](Employee.md)|  |
-### Return type
-[**EmployeeObject**](EmployeeObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_employee_earnings_template
-> EarningsTemplateObject create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template)
-creates employee earnings template records
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-earnings_template = { "ratePerUnit": 20, "numberOfUnits": 8, "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "name": "My New One" } # EarningsTemplate |
-begin
-  #creates employee earnings template records
-  result = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_employee_earnings_template: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **earnings_template** | [**EarningsTemplate**](EarningsTemplate.md)|  |
-### Return type
-[**EarningsTemplateObject**](EarningsTemplateObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_employee_leave
-> EmployeeLeaveObject create_employee_leave(xero_tenant_id, employee_id, employee_leave)
-creates employee leave records
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-employee_leave = { "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4", "description": "Creating a Desription", "startDate": "2020-04-24", "endDate": "2020-04-26" } # EmployeeLeave |
-begin
-  #creates employee leave records
-  result = api_instance.create_employee_leave(xero_tenant_id, employee_id, employee_leave)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_employee_leave: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **employee_leave** | [**EmployeeLeave**](EmployeeLeave.md)|  |
-### Return type
-[**EmployeeLeaveObject**](EmployeeLeaveObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_employee_leave_setup
-> EmployeeLeaveSetupObject create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setup)
-Allows you to set-up leave for a specific employee. This is required before viewing, configuring and requesting leave for an employee
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-employee_leave_setup = { "holidayPayOpeningBalance": 10, "annualLeaveOpeningBalance": 100, "sickLeaveHoursToAccrueAnnually": 20, "sickLeaveOpeningBalance": 10 } # EmployeeLeaveSetup |
-begin
-  #Allows you to set-up leave for a specific employee. This is required before viewing, configuring and requesting leave for an employee
-  result = api_instance.create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setup)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_employee_leave_setup: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **employee_leave_setup** | [**EmployeeLeaveSetup**](EmployeeLeaveSetup.md)|  |
-### Return type
-[**EmployeeLeaveSetupObject**](EmployeeLeaveSetupObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_employee_leave_type
-> EmployeeLeaveTypeObject create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type)
-creates employee leave type records
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-employee_leave_type = { "leaveTypeID": "35da97ae-05b9-427f-9a98-69157ba42cec", "scheduleOfAccrual": "AnnuallyAfter6Months", "hoursAccruedAnnually": 10, "maximumToAccrue": 80, "openingBalance": 100, "rateAccruedHourly": 3.5 } # EmployeeLeaveType |
-begin
-  #creates employee leave type records
-  result = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_employee_leave_type: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **employee_leave_type** | [**EmployeeLeaveType**](EmployeeLeaveType.md)|  |
-### Return type
-[**EmployeeLeaveTypeObject**](EmployeeLeaveTypeObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_employee_opening_balances
-> EmployeeOpeningBalancesObject create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance)
-creates employee opening balances
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-employee_opening_balance = [{"periodEndDate":"2020-10-01","daysPaid":3,"unpaidWeeks":2,"grossEarnings":40.0}] # Array<EmployeeOpeningBalance> |
-begin
-  #creates employee opening balances
-  result = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_employee_opening_balances: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **employee_opening_balance** | [**Array&lt;EmployeeOpeningBalance&gt;**](EmployeeOpeningBalance.md)|  |
-### Return type
-[**EmployeeOpeningBalancesObject**](EmployeeOpeningBalancesObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_employee_payment_method
-> PaymentMethodObject create_employee_payment_method(xero_tenant_id, employee_id, payment_method)
-creates employee payment method
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-payment_method = XeroRuby::PayrollNz::PaymentMethod.new # PaymentMethod |
-begin
-  #creates employee payment method
-  result = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, payment_method)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_employee_payment_method: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **payment_method** | [**PaymentMethod**](PaymentMethod.md)|  |
-### Return type
-[**PaymentMethodObject**](PaymentMethodObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_employee_salary_and_wage
-> SalaryAndWageObject create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage)
-creates employee salary and wage record
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-salary_and_wage = { "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnitsPerWeek": 2, "ratePerUnit": 10, "numberOfUnitsPerDay": 2, "daysPerWeek": 1, "effectiveFrom": "2020-05-01", "annualSalary": 100, "status": "Active", "paymentType": "Salary" } # SalaryAndWage |
-begin
-  #creates employee salary and wage record
-  result = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_employee_salary_and_wage: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **salary_and_wage** | [**SalaryAndWage**](SalaryAndWage.md)|  |
-### Return type
-[**SalaryAndWageObject**](SalaryAndWageObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_employment
-> EmploymentObject create_employment(xero_tenant_id, employee_id, employment)
-creates employment
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-employment = { "payrollCalendarID": "9aa56064-990f-4ad3-a189-d966d8f6a030", "startDate": "2020-09-02" } # Employment |
-begin
-  #creates employment
-  result = api_instance.create_employment(xero_tenant_id, employee_id, employment)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_employment: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **employment** | [**Employment**](Employment.md)|  |
-### Return type
-[**EmploymentObject**](EmploymentObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_leave_type
-> LeaveTypeObject create_leave_type(xero_tenant_id, leave_type)
-create a new leave type
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-leave_type = { "name": "My wqwhhiktun Leave", "isPaidLeave": false, "showOnPayslip": true } # LeaveType |
-begin
-  #create a new leave type
-  result = api_instance.create_leave_type(xero_tenant_id, leave_type)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_leave_type: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **leave_type** | [**LeaveType**](LeaveType.md)|  |
-### Return type
-[**LeaveTypeObject**](LeaveTypeObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_multiple_employee_earnings_template
-> EmployeeEarningsTemplates create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template)
-creates multiple employee earnings template records
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-earnings_template = [{"ratePerUnit":20.0,"numberOfUnits":8.0,"earningsRateID":"f9d8f5b5-9049-47f4-8541-35e200f750a5"},{"ratePerUnit":0.0,"numberOfUnits":8.0,"earningsRateID":"65b83d94-f20f-45e1-85ae-387fcf460c26"}] # Array<EarningsTemplate> |
-begin
-  #creates multiple employee earnings template records
-  result = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_multiple_employee_earnings_template: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **earnings_template** | [**Array&lt;EarningsTemplate&gt;**](EarningsTemplate.md)|  |
-### Return type
-[**EmployeeEarningsTemplates**](EmployeeEarningsTemplates.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_pay_run
-> PayRunObject create_pay_run(xero_tenant_id, pay_run)
-create a pay run
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-pay_run = { "payrollCalendarID": "9aa56064-990f-4ad3-a189-d966d8f6a030", "periodStartDate": "2020-09-08", "periodEndDate": "2020-09-15", "paymentDate": "2020-09-20", "payRunStatus": "Draft", "payRunType": "Scheduled", "calendarType": "Weekly" } # PayRun |
-begin
-  #create a pay run
-  result = api_instance.create_pay_run(xero_tenant_id, pay_run)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_pay_run: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **pay_run** | [**PayRun**](PayRun.md)|  |
-### Return type
-[**PayRunObject**](PayRunObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_pay_run_calendar
-> PayRunCalendarObject create_pay_run_calendar(xero_tenant_id, pay_run_calendar)
-create a new payrun calendar
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-pay_run_calendar = { "name": "My Weekly Cal", "calendarType": "Weekly", "periodStartDate": "2020-05-01", "paymentDate": "2020-05-15" } # PayRunCalendar |
-begin
-  #create a new payrun calendar
-  result = api_instance.create_pay_run_calendar(xero_tenant_id, pay_run_calendar)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_pay_run_calendar: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **pay_run_calendar** | [**PayRunCalendar**](PayRunCalendar.md)|  |
-### Return type
-[**PayRunCalendarObject**](PayRunCalendarObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_reimbursement
-> ReimbursementObject create_reimbursement(xero_tenant_id, reimbursement)
-create a new reimbursement
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-reimbursement = { "name": "My new Reimburse", "accountID": "fa5cdc43-643b-4ad8-b4ac-3ffe0d0f4488", "reimbursementCategory": "GSTInclusive", "calculationType": "FixedAmount" } # Reimbursement |
-begin
-  #create a new reimbursement
-  result = api_instance.create_reimbursement(xero_tenant_id, reimbursement)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_reimbursement: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **reimbursement** | [**Reimbursement**](Reimbursement.md)|  |
-### Return type
-[**ReimbursementObject**](ReimbursementObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_superannuation
-> SuperannuationObject create_superannuation(xero_tenant_id, benefit)
-create a new superannuation
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-benefit = { "name": "SidSaver", "category": "Other", "liabilityAccountId": "568f2e9a-0870-46cc-8678-f83f132ed4e3", "expenseAccountId": "e4eb36f6-97e3-4427-a394-dd4e1b355c2e", "CalculationTypeNZ": "FixedAmount", "standardAmount": 10 } # Benefit |
-begin
-  #create a new superannuation
-  result = api_instance.create_superannuation(xero_tenant_id, benefit)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_superannuation: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **benefit** | [**Benefit**](Benefit.md)|  |
-### Return type
-[**SuperannuationObject**](SuperannuationObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_timesheet
-> TimesheetObject create_timesheet(xero_tenant_id, timesheet)
-create a new timesheet
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet = { "payrollCalendarID": "9aa56064-990f-4ad3-a189-d966d8f6a030", "employeeID": "68342973-c405-4b86-b5d3-d7b877c27995", "startDate": "2020-04-13", "endDate": "2020-04-19", "timesheetLines": [ { "date": "2020-04-13", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 8 }, { "date": "2020-04-15", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 6 } ] } # Timesheet |
-begin
-  #create a new timesheet
-  result = api_instance.create_timesheet(xero_tenant_id, timesheet)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_timesheet: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **timesheet** | [**Timesheet**](Timesheet.md)|  |
-### Return type
-[**TimesheetObject**](TimesheetObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## create_timesheet_line
-> TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line)
-create a new timesheet line
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet
-timesheet_line = { "date": "2020-08-03", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 1 } # TimesheetLine |
-begin
-  #create a new timesheet line
-  result = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->create_timesheet_line: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **timesheet_id** | [**String**](.md)| Identifier for the timesheet |
- **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)|  |
-### Return type
-[**TimesheetLineObject**](TimesheetLineObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## delete_employee_earnings_template
-> EarningsTemplateObject delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id)
-deletes an employee earnings template record
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # String | Id for single pay template earnings object
-begin
-  #deletes an employee earnings template record
-  result = api_instance.delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->delete_employee_earnings_template: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **pay_template_earning_id** | [**String**](.md)| Id for single pay template earnings object |
-### Return type
-[**EarningsTemplateObject**](EarningsTemplateObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## delete_employee_leave
-> EmployeeLeaveObject delete_employee_leave(xero_tenant_id, employee_id, leave_id)
-deletes an employee leave record
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314' # String | Leave id for single object
-begin
-  #deletes an employee leave record
-  result = api_instance.delete_employee_leave(xero_tenant_id, employee_id, leave_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->delete_employee_leave: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **leave_id** | [**String**](.md)| Leave id for single object |
-### Return type
-[**EmployeeLeaveObject**](EmployeeLeaveObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## delete_employee_salary_and_wage
-> SalaryAndWageObject delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
-deletes an employee salary and wages record
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # String | Id for single salary and wages object
-begin
-  #deletes an employee salary and wages record
-  result = api_instance.delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->delete_employee_salary_and_wage: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **salary_and_wages_id** | [**String**](.md)| Id for single salary and wages object |
-### Return type
-[**SalaryAndWageObject**](SalaryAndWageObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## delete_timesheet
-> TimesheetLine delete_timesheet(xero_tenant_id, timesheet_id)
-delete a timesheet
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet
-begin
-  #delete a timesheet
-  result = api_instance.delete_timesheet(xero_tenant_id, timesheet_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->delete_timesheet: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **timesheet_id** | [**String**](.md)| Identifier for the timesheet |
-### Return type
-[**TimesheetLine**](TimesheetLine.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## delete_timesheet_line
-> TimesheetLine delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id)
-delete a timesheet line
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet
-timesheet_line_id = 'timesheet_line_id_example' # String | Identifier for the timesheet line
-begin
-  #delete a timesheet line
-  result = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->delete_timesheet_line: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **timesheet_id** | [**String**](.md)| Identifier for the timesheet |
- **timesheet_line_id** | [**String**](.md)| Identifier for the timesheet line |
-### Return type
-[**TimesheetLine**](TimesheetLine.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_deduction
-> DeductionObject get_deduction(xero_tenant_id, deduction_id)
-retrieve a single deduction by id
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-deduction_id = 'deduction_id_example' # String | Identifier for the deduction
-begin
-  #retrieve a single deduction by id
-  result = api_instance.get_deduction(xero_tenant_id, deduction_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_deduction: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **deduction_id** | [**String**](.md)| Identifier for the deduction |
-### Return type
-[**DeductionObject**](DeductionObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_deductions
-> Deductions get_deductions(xero_tenant_id, opts)
-searches deductions
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-begin
-  #searches deductions
-  result = api_instance.get_deductions(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_deductions: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional]
-### Return type
-[**Deductions**](Deductions.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_earnings_rate
-> EarningsRateObject get_earnings_rate(xero_tenant_id, earnings_rate_id)
-retrieve a single earnings rates by id
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-earnings_rate_id = 'earnings_rate_id_example' # String | Identifier for the earnings rate
-begin
-  #retrieve a single earnings rates by id
-  result = api_instance.get_earnings_rate(xero_tenant_id, earnings_rate_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_earnings_rate: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **earnings_rate_id** | [**String**](.md)| Identifier for the earnings rate |
-### Return type
-[**EarningsRateObject**](EarningsRateObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_earnings_rates
-> EarningsRates get_earnings_rates(xero_tenant_id, opts)
-searches earnings rates
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-begin
-  #searches earnings rates
-  result = api_instance.get_earnings_rates(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_earnings_rates: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional]
-### Return type
-[**EarningsRates**](EarningsRates.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_employee
-> EmployeeObject get_employee(xero_tenant_id, employee_id)
-searches employees
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #searches employees
-  result = api_instance.get_employee(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_employee: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
-### Return type
-[**EmployeeObject**](EmployeeObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_employee_leave_balances
-> EmployeeLeaveBalances get_employee_leave_balances(xero_tenant_id, employee_id)
-search employee leave balances
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #search employee leave balances
-  result = api_instance.get_employee_leave_balances(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_employee_leave_balances: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
-### Return type
-[**EmployeeLeaveBalances**](EmployeeLeaveBalances.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_employee_leave_periods
-> LeavePeriods get_employee_leave_periods(xero_tenant_id, employee_id, opts)
-searches employee leave periods
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-opts = {
-  start_date: Date.parse('2013-10-20'), # Date | Filter by start date
-  end_date: Date.parse('Johnson') # Date | Filter by end date
-}
-begin
-  #searches employee leave periods
-  result = api_instance.get_employee_leave_periods(xero_tenant_id, employee_id, opts)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_employee_leave_periods: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **start_date** | **Date**| Filter by start date | [optional]
- **end_date** | **Date**| Filter by end date | [optional]
-### Return type
-[**LeavePeriods**](LeavePeriods.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_employee_leave_types
-> EmployeeLeaveTypes get_employee_leave_types(xero_tenant_id, employee_id)
-searches employee leave types
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #searches employee leave types
-  result = api_instance.get_employee_leave_types(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_employee_leave_types: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
-### Return type
-[**EmployeeLeaveTypes**](EmployeeLeaveTypes.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_employee_leaves
-> EmployeeLeaves get_employee_leaves(xero_tenant_id, employee_id)
-search employee leave records
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #search employee leave records
-  result = api_instance.get_employee_leaves(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_employee_leaves: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
-### Return type
-[**EmployeeLeaves**](EmployeeLeaves.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_employee_opening_balances
-> EmployeeOpeningBalancesObject get_employee_opening_balances(xero_tenant_id, employee_id)
-retrieve employee openingbalances
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #retrieve employee openingbalances
-  result = api_instance.get_employee_opening_balances(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_employee_opening_balances: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
-### Return type
-[**EmployeeOpeningBalancesObject**](EmployeeOpeningBalancesObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_employee_pay_templates
-> EmployeePayTemplates get_employee_pay_templates(xero_tenant_id, employee_id)
-searches employee pay templates
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #searches employee pay templates
-  result = api_instance.get_employee_pay_templates(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_employee_pay_templates: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
-### Return type
-[**EmployeePayTemplates**](EmployeePayTemplates.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_employee_payment_method
-> PaymentMethodObject get_employee_payment_method(xero_tenant_id, employee_id)
-retrieves an employee's payment method
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #retrieves an employee's payment method
-  result = api_instance.get_employee_payment_method(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_employee_payment_method: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
-### Return type
-[**PaymentMethodObject**](PaymentMethodObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_employee_salary_and_wage
-> SalaryAndWages get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
-get employee salary and wages record by id
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # String | Id for single pay template earnings object
-begin
-  #get employee salary and wages record by id
-  result = api_instance.get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_employee_salary_and_wage: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **salary_and_wages_id** | [**String**](.md)| Id for single pay template earnings object |
-### Return type
-[**SalaryAndWages**](SalaryAndWages.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_employee_salary_and_wages
-> SalaryAndWages get_employee_salary_and_wages(xero_tenant_id, employee_id, opts)
-retrieves an employee's salary and wages
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-begin
-  #retrieves an employee's salary and wages
-  result = api_instance.get_employee_salary_and_wages(xero_tenant_id, employee_id, opts)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_employee_salary_and_wages: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional]
-### Return type
-[**SalaryAndWages**](SalaryAndWages.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_employee_tax
-> EmployeeTaxObject get_employee_tax(xero_tenant_id, employee_id)
-searches tax records for an employee
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-begin
-  #searches tax records for an employee
-  result = api_instance.get_employee_tax(xero_tenant_id, employee_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_employee_tax: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
-### Return type
-[**EmployeeTaxObject**](EmployeeTaxObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_employees
-> Employees get_employees(xero_tenant_id, opts)
-searches employees
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  first_name: 'John', # String | Filter by first name
-  last_name: 'Johnson', # String | Filter by last name
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-begin
-  #searches employees
-  result = api_instance.get_employees(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_employees: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **first_name** | **String**| Filter by first name | [optional]
- **last_name** | **String**| Filter by last name | [optional]
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional]
-### Return type
-[**Employees**](Employees.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_leave_type
-> LeaveTypeObject get_leave_type(xero_tenant_id, leave_type_id)
-retrieve a single leave type by id
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-leave_type_id = 'leave_type_id_example' # String | Identifier for the leave type
-begin
-  #retrieve a single leave type by id
-  result = api_instance.get_leave_type(xero_tenant_id, leave_type_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_leave_type: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **leave_type_id** | [**String**](.md)| Identifier for the leave type |
-### Return type
-[**LeaveTypeObject**](LeaveTypeObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_leave_types
-> LeaveTypes get_leave_types(xero_tenant_id, opts)
-searches leave types
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56, # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-  active_only: true # Boolean | Filters leave types by active status. By default the API returns all leave types.
-}
-begin
-  #searches leave types
-  result = api_instance.get_leave_types(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_leave_types: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional]
- **active_only** | **Boolean**| Filters leave types by active status. By default the API returns all leave types. | [optional]
-### Return type
-[**LeaveTypes**](LeaveTypes.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_pay_run
-> PayRunObject get_pay_run(xero_tenant_id, pay_run_id)
-retrieve a single pay run by id
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-pay_run_id = 'pay_run_id_example' # String | Identifier for the pay run
-begin
-  #retrieve a single pay run by id
-  result = api_instance.get_pay_run(xero_tenant_id, pay_run_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_pay_run: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **pay_run_id** | [**String**](.md)| Identifier for the pay run |
-### Return type
-[**PayRunObject**](PayRunObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_pay_run_calendar
-> PayRunCalendarObject get_pay_run_calendar(xero_tenant_id, payroll_calendar_id)
-retrieve a single payrun calendar by id
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-payroll_calendar_id = 'payroll_calendar_id_example' # String | Identifier for the payrun calendars
-begin
-  #retrieve a single payrun calendar by id
-  result = api_instance.get_pay_run_calendar(xero_tenant_id, payroll_calendar_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_pay_run_calendar: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **payroll_calendar_id** | [**String**](.md)| Identifier for the payrun calendars |
-### Return type
-[**PayRunCalendarObject**](PayRunCalendarObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_pay_run_calendars
-> PayRunCalendars get_pay_run_calendars(xero_tenant_id, opts)
-searches payrun calendars
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-begin
-  #searches payrun calendars
-  result = api_instance.get_pay_run_calendars(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_pay_run_calendars: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional]
-### Return type
-[**PayRunCalendars**](PayRunCalendars.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_pay_runs
-> PayRuns get_pay_runs(xero_tenant_id, opts)
-searches pay runs
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56, # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-  status: 'status_example' # String | By default get payruns will return all the payruns for an organization. You can add GET https://api.xero.com/payroll.xro/2.0/payRuns?statu={PayRunStatus} to filter the payruns by status.
-}
-begin
-  #searches pay runs
-  result = api_instance.get_pay_runs(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_pay_runs: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional]
- **status** | **String**| By default get payruns will return all the payruns for an organization. You can add GET https://api.xero.com/payroll.xro/2.0/payRuns?statu&#x3D;{PayRunStatus} to filter the payruns by status. | [optional]
-### Return type
-[**PayRuns**](PayRuns.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_pay_slip
-> PaySlipObject get_pay_slip(xero_tenant_id, pay_slip_id)
-retrieve a single payslip by id
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-pay_slip_id = 'pay_slip_id_example' # String | Identifier for the payslip
-begin
-  #retrieve a single payslip by id
-  result = api_instance.get_pay_slip(xero_tenant_id, pay_slip_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_pay_slip: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **pay_slip_id** | [**String**](.md)| Identifier for the payslip |
-### Return type
-[**PaySlipObject**](PaySlipObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_pay_slips
-> PaySlips get_pay_slips(xero_tenant_id, pay_run_id, opts)
-searches payslips
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-pay_run_id = 'pay_run_id_example' # String | PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun.
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-begin
-  #searches payslips
-  result = api_instance.get_pay_slips(xero_tenant_id, pay_run_id, opts)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_pay_slips: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **pay_run_id** | [**String**](.md)| PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun. |
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional]
-### Return type
-[**PaySlips**](PaySlips.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_reimbursement
-> ReimbursementObject get_reimbursement(xero_tenant_id, reimbursement_id)
-retrieve a single reimbursement by id
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-reimbursement_id = 'reimbursement_id_example' # String | Identifier for the reimbursement
-begin
-  #retrieve a single reimbursement by id
-  result = api_instance.get_reimbursement(xero_tenant_id, reimbursement_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_reimbursement: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **reimbursement_id** | [**String**](.md)| Identifier for the reimbursement |
-### Return type
-[**ReimbursementObject**](ReimbursementObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_reimbursements
-> Reimbursements get_reimbursements(xero_tenant_id, opts)
-searches reimbursements
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-begin
-  #searches reimbursements
-  result = api_instance.get_reimbursements(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_reimbursements: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional]
-### Return type
-[**Reimbursements**](Reimbursements.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_settings
-> Settings get_settings(xero_tenant_id)
-searches settings
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-begin
-  #searches settings
-  result = api_instance.get_settings(xero_tenant_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_settings: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
-### Return type
-[**Settings**](Settings.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_statutory_deduction
-> StatutoryDeductionObject get_statutory_deduction(xero_tenant_id, id)
-retrieve a single statutory deduction by id
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-id = 'id_example' # String | Identifier for the statutory deduction
-begin
-  #retrieve a single statutory deduction by id
-  result = api_instance.get_statutory_deduction(xero_tenant_id, id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_statutory_deduction: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **id** | [**String**](.md)| Identifier for the statutory deduction |
-### Return type
-[**StatutoryDeductionObject**](StatutoryDeductionObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_statutory_deductions
-> StatutoryDeductions get_statutory_deductions(xero_tenant_id, opts)
-searches statutory deductions
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-begin
-  #searches statutory deductions
-  result = api_instance.get_statutory_deductions(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_statutory_deductions: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional]
-### Return type
-[**StatutoryDeductions**](StatutoryDeductions.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_superannuation
-> SuperannuationObject get_superannuation(xero_tenant_id, superannuation_id)
-searches for a unique superannuation
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-superannuation_id = 'superannuation_id_example' # String | Identifier for the superannuation
-begin
-  #searches for a unique superannuation
-  result = api_instance.get_superannuation(xero_tenant_id, superannuation_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_superannuation: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **superannuation_id** | [**String**](.md)| Identifier for the superannuation |
-### Return type
-[**SuperannuationObject**](SuperannuationObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_superannuations
-> Superannuations get_superannuations(xero_tenant_id, opts)
-searches statutory deductions
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-}
-begin
-  #searches statutory deductions
-  result = api_instance.get_superannuations(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_superannuations: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional]
-### Return type
-[**Superannuations**](Superannuations.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_timesheet
-> TimesheetObject get_timesheet(xero_tenant_id, timesheet_id)
-retrieve a single timesheet by id
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet
-begin
-  #retrieve a single timesheet by id
-  result = api_instance.get_timesheet(xero_tenant_id, timesheet_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_timesheet: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **timesheet_id** | [**String**](.md)| Identifier for the timesheet |
-### Return type
-[**TimesheetObject**](TimesheetObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_timesheets
-> Timesheets get_timesheets(xero_tenant_id, opts)
-searches timesheets
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 56, # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
-  employee_id: 'employee_id_example', # String | By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter=employeeId=={EmployeeId} to get only the timesheets of a particular employee.
-  payroll_calendar_id: 'payroll_calendar_id_example' # String | By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter=payrollCalendarId=={PayrollCalendarID} to filter the timesheets by payroll calendar id
-}
-begin
-  #searches timesheets
-  result = api_instance.get_timesheets(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_timesheets: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **page** | **Integer**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional]
- **employee_id** | [**String**](.md)| By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter&#x3D;employeeId&#x3D;&#x3D;{EmployeeId} to get only the timesheets of a particular employee. | [optional]
- **payroll_calendar_id** | [**String**](.md)| By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter&#x3D;payrollCalendarId&#x3D;&#x3D;{PayrollCalendarID} to filter the timesheets by payroll calendar id | [optional]
-### Return type
-[**Timesheets**](Timesheets.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_tracking_categories
-> TrackingCategories get_tracking_categories(xero_tenant_id)
-searches tracking categories
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-begin
-  #searches tracking categories
-  result = api_instance.get_tracking_categories(xero_tenant_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->get_tracking_categories: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
-### Return type
-[**TrackingCategories**](TrackingCategories.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## revert_timesheet
-> TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id)
-revert a timesheet to draft
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet
-begin
-  #revert a timesheet to draft
-  result = api_instance.revert_timesheet(xero_tenant_id, timesheet_id)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->revert_timesheet: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **timesheet_id** | [**String**](.md)| Identifier for the timesheet |
-### Return type
-[**TimesheetObject**](TimesheetObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## update_employee
-> EmployeeObject update_employee(xero_tenant_id, employee_id, employee)
-updates employee
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-employee = { "title": "Mr", "firstName": "Tony", "lastName": "Starkgtrzgquusrson", "dateOfBirth": "1999-01-01", "address": { "addressLine1": "101 Green St", "city": "San Francisco", "postCode": "4432", "countryName": "United Kingdom" }, "email": "58315@starkindustries.com", "gender": "M" } # Employee |
-begin
-  #updates employee
-  result = api_instance.update_employee(xero_tenant_id, employee_id, employee)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->update_employee: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **employee** | [**Employee**](Employee.md)|  |
-### Return type
-[**EmployeeObject**](EmployeeObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## update_employee_earnings_template
-> EarningsTemplateObject update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template)
-updates employee earnings template records
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # String | Id for single pay template earnings object
-earnings_template = { "ratePerUnit": 25, "numberOfUnits": 4, "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5" } # EarningsTemplate |
-begin
-  #updates employee earnings template records
-  result = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->update_employee_earnings_template: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **pay_template_earning_id** | [**String**](.md)| Id for single pay template earnings object |
- **earnings_template** | [**EarningsTemplate**](EarningsTemplate.md)|  |
-### Return type
-[**EarningsTemplateObject**](EarningsTemplateObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## update_employee_leave
-> EmployeeLeaveObject update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave)
-updates employee leave records
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314' # String | Leave id for single object
-employee_leave = { "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4", "description": "Creating a Desription", "startDate": "2020-04-24", "endDate": "2020-04-26", "periods": [ { "periodStartDate": "2020-04-20", "periodEndDate": "2020-04-26", "numberOfUnits": 1, "periodStatus": "Approved" } ] } # EmployeeLeave |
-begin
-  #updates employee leave records
-  result = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->update_employee_leave: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **leave_id** | [**String**](.md)| Leave id for single object |
- **employee_leave** | [**EmployeeLeave**](EmployeeLeave.md)|  |
-### Return type
-[**EmployeeLeaveObject**](EmployeeLeaveObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## update_employee_salary_and_wage
-> SalaryAndWageObject update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage)
-updates employee salary and wages record
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # String | Id for single pay template earnings object
-salary_and_wage = { "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnitsPerWeek": 3, "ratePerUnit": 11, "numberOfUnitsPerDay": 3, "daysPerWeek": 1, "effectiveFrom": "2020-05-15", "annualSalary": 101, "status": "Active", "paymentType": "Salary" } # SalaryAndWage |
-begin
-  #updates employee salary and wages record
-  result = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->update_employee_salary_and_wage: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **salary_and_wages_id** | [**String**](.md)| Id for single pay template earnings object |
- **salary_and_wage** | [**SalaryAndWage**](SalaryAndWage.md)|  |
-### Return type
-[**SalaryAndWageObject**](SalaryAndWageObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## update_employee_tax
-> EmployeeTaxObject update_employee_tax(xero_tenant_id, employee_id, employee_tax)
-updates the tax records for an employee
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
-employee_tax = XeroRuby::PayrollNz::EmployeeTax.new # EmployeeTax |
-begin
-  #updates the tax records for an employee
-  result = api_instance.update_employee_tax(xero_tenant_id, employee_id, employee_tax)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->update_employee_tax: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **employee_id** | [**String**](.md)| Employee id for single object |
- **employee_tax** | [**EmployeeTax**](EmployeeTax.md)|  |
-### Return type
-[**EmployeeTaxObject**](EmployeeTaxObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## update_pay_run
-> PayRunObject update_pay_run(xero_tenant_id, pay_run_id, pay_run)
-update a pay run
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-pay_run_id = 'pay_run_id_example' # String | Identifier for the pay run
-pay_run = { "paymentDate": "2019-07-01" } # PayRun |
-begin
-  #update a pay run
-  result = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->update_pay_run: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **pay_run_id** | [**String**](.md)| Identifier for the pay run |
- **pay_run** | [**PayRun**](PayRun.md)|  |
-### Return type
-[**PayRunObject**](PayRunObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## update_pay_slip_line_items
-> PaySlipObject update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip)
-creates employee pay slip
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-pay_slip_id = 'pay_slip_id_example' # String | Identifier for the payslip
-pay_slip = { "earningsLines": [ { "earningsLineID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "displayName": "Ordinary Time", "ratePerUnit": 25, "numberOfUnits": 0, "amount": 0, "isLinkedToTimesheet": false, "isSystemGenerated": true }, { "earningsLineID": "65b83d94-f20f-45e1-85ae-387fcf460c26", "earningsRateID": "65b83d94-f20f-45e1-85ae-387fcf460c26", "displayName": "Salary", "ratePerUnit": 0, "numberOfUnits": 8, "amount": 0, "isLinkedToTimesheet": false, "isSystemGenerated": false } ], "leaveEarningsLines": [ { "earningsLineID": "0441497f-5dc7-4cd3-a90d-f2e07e21b2a6", "earningsRateID": "39b3560a-5d2f-4538-924a-4349dc86396e", "displayName": "Holiday Pay", "fixedAmount": 268.8, "amount": 268.8, "isLinkedToTimesheet": false, "isSystemGenerated": true } ], "deductionLines": [ { "deductionTypeID": "a3760fe4-68a4-4e38-8326-fe616af7dc74", "amount": 100 } ], "leaveAccrualLines": [ { "leaveTypeID": "0441497f-5dc7-4cd3-a90d-f2e07e21b2a6", "numberOfUnits": 268.8 }, { "leaveTypeID": "b0b1b79e-2a25-46c2-ad08-ca25ef48d7e4", "numberOfUnits": 0 }, { "leaveTypeID": "f2f994cf-1899-46f3-ad4f-5d92d78c3719", "numberOfUnits": 0 }, { "leaveTypeID": "34129765-11cb-4d8c-b568-84a2219beda3", "numberOfUnits": 0 } ], "superannuationLines": [ { "superannuationTypeID": "563273ea-0dae-4f82-86a4-e0db77c008ea", "displayName": "KiwiSaver", "amount": 108.86, "fixedAmount": 3, "percentage": 3, "manualAdjustment": false } ], "employeeTaxLines": [ { "taxLineID": "1084146b-e890-489c-aed3-06de80f63d84", "amount": 1057.22, "globalTaxTypeID": "11", "manualAdjustment": false } ], "employerTaxLines": [ { "taxLineID": "6f9eb8cd-0f4a-440b-939c-bdb0f6ad694c", "amount": 18.9, "globalTaxTypeID": "10", "manualAdjustment": false } ], "statutoryDeductionLines": [ { "statutoryDeductionTypeID": "b5efd8d1-0c93-4a14-a314-b5cba4a4e6b3", "amount": 108.86 } ], "grossEarningsHistory": { "daysPaid": 3, "unpaidWeeks": 0 } } # PaySlip |
-begin
-  #creates employee pay slip
-  result = api_instance.update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->update_pay_slip_line_items: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **pay_slip_id** | [**String**](.md)| Identifier for the payslip |
- **pay_slip** | [**PaySlip**](PaySlip.md)|  |
-### Return type
-[**PaySlipObject**](PaySlipObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## update_timesheet_line
-> TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line)
-update a timesheet line
-### Example
-```ruby
-# load the gem
-require 'xero-ruby'
-creds = {
-  client_id: ENV['CLIENT_ID'],
-  client_secret: ENV['CLIENT_SECRET'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
-}
-xero_client = XeroRuby::ApiClient.new(credentials: creds)
-token_set = fetch_valid_token_set(user) # example
-xero_client.refresh_token_set(token_set)
-# You need to namespace your api method call to one of the following api sets
-# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
-api_instance = xero_client.<api_set>
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet
-timesheet_line_id = 'timesheet_line_id_example' # String | Identifier for the timesheet line
-timesheet_line = { "date": "2020-08-04", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 2 } # TimesheetLine |
-begin
-  #update a timesheet line
-  result = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line)
-  p result
-rescue XeroRuby::PayrollNz::ApiError => e
-  puts "Exception when calling PayrollNzApi->update_timesheet_line: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
- **timesheet_id** | [**String**](.md)| Identifier for the timesheet |
- **timesheet_line_id** | [**String**](.md)| Identifier for the timesheet line |
- **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)|  |
-### Return type
-[**TimesheetLineObject**](TimesheetLineObject.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json