From 9489b66f9479c402252190885f66061e6e087e40 Mon Sep 17 00:00:00 2001 From: pumpkinball <91833653+pumpkinball@users.noreply.github.com> Date: Fri, 1 Dec 2023 15:41:37 +0000 Subject: [PATCH] Update xero-ruby-4.3.2 built against new OAS for openapi-generator 5.4.0 --- docs/accounting/AccountingApi.md | 2532 +- docs/accounting/Allocation.md | 6 +- docs/accounting/Contact.md | 2 - docs/accounting/TenNinetyNineContact.md | 8 +- docs/accounting/index.html | 43976 ---------------- docs/app_store/AppStoreApi.md | 46 +- docs/app_store/CreateUsageRecord.md | 2 +- docs/app_store/ProblemDetails.md | 2 +- docs/app_store/Subscription.md | 6 +- docs/app_store/SubscriptionItem.md | 4 +- docs/app_store/UsageRecord.md | 2 +- docs/app_store/index.html | 3514 -- docs/assets/AssetApi.md | 36 +- docs/assets/index.html | 3944 -- docs/files/FilesApi.md | 152 +- docs/files/UploadObject.md | 23 - docs/files/index.html | 5359 -- docs/finance/AccountUsage.md | 2 +- docs/finance/CurrentStatementResponse.md | 2 +- docs/finance/FinanceApi.md | 72 +- docs/finance/HistoryRecordResponse.md | 2 +- docs/finance/LockHistoryModel.md | 2 +- docs/finance/ReportHistoryModel.md | 2 +- docs/finance/StatementResponse.md | 2 +- docs/finance/UserResponse.md | 4 +- docs/finance/index.html | 6230 --- docs/payroll_au/PayrollAuApi.md | 299 +- docs/payroll_au/index.html | 9847 ---- docs/payroll_nz/Employee.md | 10 +- docs/payroll_nz/EmployeeLeave.md | 2 +- docs/payroll_nz/LeaveType.md | 2 +- docs/payroll_nz/PayRunCalendar.md | 2 +- docs/payroll_nz/PayrollNzApi.md | 643 +- docs/payroll_nz/Timesheet.md | 2 +- docs/payroll_nz/index.html | 14975 ------ docs/payroll_uk/Employee.md | 10 +- docs/payroll_uk/EmployeeLeave.md | 2 +- docs/payroll_uk/LeaveType.md | 2 +- docs/payroll_uk/PayRunCalendar.md | 2 +- docs/payroll_uk/PayrollUkApi.md | 643 +- docs/payroll_uk/Timesheet.md | 2 +- docs/payroll_uk/index.html | 14904 ------ docs/projects/Error.md | 2 +- docs/projects/Project.md | 2 +- docs/projects/ProjectApi.md | 215 +- docs/projects/ProjectCreateOrUpdate.md | 2 +- docs/projects/TimeEntry.md | 4 +- docs/projects/TimeEntryCreateOrUpdate.md | 2 +- docs/projects/index.html | 5942 --- lib/xero-ruby.rb | 3 +- lib/xero-ruby/api/accounting_api.rb | 642 +- lib/xero-ruby/api/app_store_api.rb | 8 +- lib/xero-ruby/api/asset_api.rb | 8 +- lib/xero-ruby/api/files_api.rb | 48 +- lib/xero-ruby/api/finance_api.rb | 2 +- lib/xero-ruby/api/payroll_au_api.rb | 79 +- lib/xero-ruby/api/payroll_nz_api.rb | 89 +- lib/xero-ruby/api/payroll_uk_api.rb | 83 +- lib/xero-ruby/api/project_api.rb | 31 +- lib/xero-ruby/api_client.rb | 2 +- lib/xero-ruby/api_error.rb | 2 +- lib/xero-ruby/configuration.rb | 2 +- lib/xero-ruby/models/accounting/account.rb | 2 +- .../models/accounting/account_type.rb | 6 +- lib/xero-ruby/models/accounting/accounts.rb | 2 +- .../models/accounting/accounts_payable.rb | 2 +- .../models/accounting/accounts_receivable.rb | 2 +- lib/xero-ruby/models/accounting/action.rb | 2 +- lib/xero-ruby/models/accounting/actions.rb | 2 +- lib/xero-ruby/models/accounting/address.rb | 2 +- .../accounting/address_for_organisation.rb | 2 +- lib/xero-ruby/models/accounting/allocation.rb | 24 +- .../models/accounting/allocations.rb | 2 +- lib/xero-ruby/models/accounting/attachment.rb | 2 +- .../models/accounting/attachments.rb | 2 +- .../models/accounting/balance_details.rb | 2 +- lib/xero-ruby/models/accounting/balances.rb | 2 +- .../models/accounting/bank_transaction.rb | 2 +- .../models/accounting/bank_transactions.rb | 2 +- .../models/accounting/bank_transfer.rb | 2 +- .../models/accounting/bank_transfers.rb | 2 +- .../models/accounting/batch_payment.rb | 2 +- .../models/accounting/batch_payment_delete.rb | 2 +- .../batch_payment_delete_by_url_param.rb | 2 +- .../accounting/batch_payment_details.rb | 2 +- .../models/accounting/batch_payments.rb | 2 +- lib/xero-ruby/models/accounting/bill.rb | 2 +- .../models/accounting/branding_theme.rb | 2 +- .../models/accounting/branding_themes.rb | 2 +- lib/xero-ruby/models/accounting/budget.rb | 2 +- .../models/accounting/budget_balance.rb | 2 +- .../models/accounting/budget_line.rb | 2 +- lib/xero-ruby/models/accounting/budgets.rb | 2 +- .../models/accounting/cis_org_setting.rb | 2 +- .../models/accounting/cis_org_settings.rb | 2 +- .../models/accounting/cis_setting.rb | 2 +- .../models/accounting/cis_settings.rb | 2 +- lib/xero-ruby/models/accounting/contact.rb | 14 +- .../models/accounting/contact_group.rb | 2 +- .../models/accounting/contact_groups.rb | 2 +- .../models/accounting/contact_person.rb | 2 +- lib/xero-ruby/models/accounting/contacts.rb | 2 +- .../models/accounting/conversion_balances.rb | 2 +- .../models/accounting/conversion_date.rb | 2 +- .../models/accounting/country_code.rb | 2 +- .../models/accounting/credit_note.rb | 2 +- .../models/accounting/credit_notes.rb | 2 +- lib/xero-ruby/models/accounting/currencies.rb | 2 +- lib/xero-ruby/models/accounting/currency.rb | 2 +- .../models/accounting/currency_code.rb | 2 +- lib/xero-ruby/models/accounting/element.rb | 2 +- lib/xero-ruby/models/accounting/employee.rb | 2 +- lib/xero-ruby/models/accounting/employees.rb | 2 +- lib/xero-ruby/models/accounting/error.rb | 2 +- .../models/accounting/expense_claim.rb | 2 +- .../models/accounting/expense_claims.rb | 2 +- .../models/accounting/external_link.rb | 2 +- .../models/accounting/history_record.rb | 2 +- .../models/accounting/history_records.rb | 2 +- .../models/accounting/import_summary.rb | 2 +- .../accounting/import_summary_accounts.rb | 2 +- .../accounting/import_summary_object.rb | 2 +- .../accounting/import_summary_organisation.rb | 2 +- lib/xero-ruby/models/accounting/invoice.rb | 2 +- .../models/accounting/invoice_reminder.rb | 2 +- .../models/accounting/invoice_reminders.rb | 2 +- lib/xero-ruby/models/accounting/invoices.rb | 2 +- lib/xero-ruby/models/accounting/item.rb | 2 +- lib/xero-ruby/models/accounting/items.rb | 2 +- lib/xero-ruby/models/accounting/journal.rb | 2 +- .../models/accounting/journal_line.rb | 2 +- lib/xero-ruby/models/accounting/journals.rb | 2 +- .../models/accounting/line_amount_types.rb | 2 +- lib/xero-ruby/models/accounting/line_item.rb | 2 +- .../models/accounting/line_item_item.rb | 2 +- .../models/accounting/line_item_tracking.rb | 2 +- .../models/accounting/linked_transaction.rb | 2 +- .../models/accounting/linked_transactions.rb | 2 +- .../models/accounting/manual_journal.rb | 2 +- .../models/accounting/manual_journal_line.rb | 2 +- .../models/accounting/manual_journals.rb | 2 +- .../models/accounting/online_invoice.rb | 2 +- .../models/accounting/online_invoices.rb | 2 +- .../models/accounting/organisation.rb | 2 +- .../models/accounting/organisations.rb | 2 +- .../models/accounting/overpayment.rb | 2 +- .../models/accounting/overpayments.rb | 2 +- lib/xero-ruby/models/accounting/payment.rb | 2 +- .../models/accounting/payment_delete.rb | 2 +- .../models/accounting/payment_service.rb | 2 +- .../models/accounting/payment_services.rb | 2 +- .../models/accounting/payment_term.rb | 2 +- .../models/accounting/payment_term_type.rb | 2 +- lib/xero-ruby/models/accounting/payments.rb | 2 +- lib/xero-ruby/models/accounting/phone.rb | 2 +- lib/xero-ruby/models/accounting/prepayment.rb | 2 +- .../models/accounting/prepayments.rb | 2 +- lib/xero-ruby/models/accounting/purchase.rb | 2 +- .../models/accounting/purchase_order.rb | 2 +- .../models/accounting/purchase_orders.rb | 2 +- lib/xero-ruby/models/accounting/quote.rb | 2 +- .../accounting/quote_line_amount_types.rb | 2 +- .../models/accounting/quote_status_codes.rb | 2 +- lib/xero-ruby/models/accounting/quotes.rb | 2 +- lib/xero-ruby/models/accounting/receipt.rb | 2 +- lib/xero-ruby/models/accounting/receipts.rb | 2 +- .../models/accounting/repeating_invoice.rb | 2 +- .../models/accounting/repeating_invoices.rb | 2 +- lib/xero-ruby/models/accounting/report.rb | 2 +- .../models/accounting/report_attribute.rb | 2 +- .../models/accounting/report_cell.rb | 2 +- .../models/accounting/report_fields.rb | 2 +- lib/xero-ruby/models/accounting/report_row.rb | 2 +- .../models/accounting/report_rows.rb | 2 +- .../models/accounting/report_with_row.rb | 2 +- .../models/accounting/report_with_rows.rb | 2 +- lib/xero-ruby/models/accounting/reports.rb | 2 +- .../models/accounting/request_empty.rb | 2 +- lib/xero-ruby/models/accounting/row_type.rb | 2 +- .../accounting/sales_tracking_category.rb | 2 +- lib/xero-ruby/models/accounting/schedule.rb | 2 +- lib/xero-ruby/models/accounting/setup.rb | 2 +- .../models/accounting/tax_component.rb | 2 +- lib/xero-ruby/models/accounting/tax_rate.rb | 2 +- lib/xero-ruby/models/accounting/tax_rates.rb | 2 +- lib/xero-ruby/models/accounting/tax_type.rb | 26 +- .../accounting/ten_ninety_nine_contact.rb | 81 +- lib/xero-ruby/models/accounting/time_zone.rb | 2 +- .../models/accounting/tracking_categories.rb | 2 +- .../models/accounting/tracking_category.rb | 2 +- .../models/accounting/tracking_option.rb | 2 +- .../models/accounting/tracking_options.rb | 2 +- lib/xero-ruby/models/accounting/user.rb | 2 +- lib/xero-ruby/models/accounting/users.rb | 2 +- .../models/accounting/validation_error.rb | 2 +- .../models/app_store/create_usage_record.rb | 4 +- lib/xero-ruby/models/app_store/plan.rb | 2 +- lib/xero-ruby/models/app_store/price.rb | 2 +- .../models/app_store/problem_details.rb | 2 +- lib/xero-ruby/models/app_store/product.rb | 2 +- .../models/app_store/subscription.rb | 8 +- .../models/app_store/subscription_item.rb | 6 +- .../models/app_store/update_usage_record.rb | 2 +- .../models/app_store/usage_record.rb | 4 +- .../models/app_store/usage_records_list.rb | 2 +- lib/xero-ruby/models/assets/asset.rb | 2 +- lib/xero-ruby/models/assets/asset_status.rb | 2 +- .../models/assets/asset_status_query_param.rb | 2 +- lib/xero-ruby/models/assets/asset_type.rb | 2 +- lib/xero-ruby/models/assets/assets.rb | 2 +- .../models/assets/book_depreciation_detail.rb | 2 +- .../assets/book_depreciation_setting.rb | 2 +- lib/xero-ruby/models/assets/error.rb | 2 +- .../assets/field_validation_errors_element.rb | 2 +- lib/xero-ruby/models/assets/pagination.rb | 2 +- .../resource_validation_errors_element.rb | 2 +- lib/xero-ruby/models/assets/setting.rb | 2 +- lib/xero-ruby/models/files/association.rb | 2 +- lib/xero-ruby/models/files/file_object.rb | 2 +- lib/xero-ruby/models/files/files.rb | 2 +- lib/xero-ruby/models/files/folder.rb | 2 +- lib/xero-ruby/models/files/folders.rb | 2 +- lib/xero-ruby/models/files/object_group.rb | 2 +- lib/xero-ruby/models/files/object_type.rb | 2 +- lib/xero-ruby/models/files/upload_object.rb | 267 - lib/xero-ruby/models/files/user.rb | 2 +- lib/xero-ruby/models/finance/account_usage.rb | 4 +- .../models/finance/account_usage_response.rb | 2 +- .../finance/balance_sheet_account_detail.rb | 2 +- .../finance/balance_sheet_account_group.rb | 2 +- .../finance/balance_sheet_account_type.rb | 2 +- .../models/finance/balance_sheet_response.rb | 2 +- .../bank_statement_accounting_response.rb | 2 +- .../models/finance/bank_statement_response.rb | 2 +- .../finance/bank_transaction_response.rb | 2 +- .../models/finance/cash_account_response.rb | 2 +- lib/xero-ruby/models/finance/cash_balance.rb | 2 +- .../finance/cash_validation_response.rb | 2 +- .../models/finance/cashflow_account.rb | 2 +- .../models/finance/cashflow_activity.rb | 2 +- .../models/finance/cashflow_response.rb | 2 +- lib/xero-ruby/models/finance/cashflow_type.rb | 2 +- .../models/finance/contact_detail.rb | 2 +- .../models/finance/contact_response.rb | 2 +- .../models/finance/contact_total_detail.rb | 2 +- .../models/finance/contact_total_other.rb | 2 +- .../models/finance/credit_note_response.rb | 2 +- .../finance/current_statement_response.rb | 4 +- .../models/finance/data_source_response.rb | 2 +- .../models/finance/history_record_response.rb | 4 +- .../finance/income_by_contact_response.rb | 2 +- .../models/finance/invoice_response.rb | 2 +- .../models/finance/line_item_response.rb | 2 +- .../models/finance/lock_history_model.rb | 4 +- .../models/finance/lock_history_response.rb | 2 +- .../models/finance/manual_journal_total.rb | 2 +- .../models/finance/overpayment_response.rb | 2 +- .../models/finance/payment_response.rb | 2 +- lib/xero-ruby/models/finance/pnl_account.rb | 2 +- .../models/finance/pnl_account_class.rb | 2 +- .../models/finance/pnl_account_type.rb | 2 +- .../models/finance/practice_response.rb | 2 +- .../models/finance/prepayment_response.rb | 2 +- lib/xero-ruby/models/finance/problem.rb | 2 +- lib/xero-ruby/models/finance/problem_type.rb | 3 +- .../finance/profit_and_loss_response.rb | 2 +- .../models/finance/report_history_model.rb | 4 +- .../models/finance/report_history_response.rb | 2 +- .../finance/statement_balance_response.rb | 2 +- .../models/finance/statement_line_response.rb | 2 +- .../finance/statement_lines_response.rb | 2 +- .../models/finance/statement_response.rb | 4 +- lib/xero-ruby/models/finance/total_detail.rb | 2 +- lib/xero-ruby/models/finance/total_other.rb | 2 +- .../models/finance/trial_balance_account.rb | 2 +- .../models/finance/trial_balance_entry.rb | 2 +- .../models/finance/trial_balance_movement.rb | 2 +- .../models/finance/trial_balance_response.rb | 2 +- .../finance/user_activities_response.rb | 2 +- lib/xero-ruby/models/finance/user_response.rb | 6 +- lib/xero-ruby/models/payroll_au/account.rb | 2 +- .../models/payroll_au/account_type.rb | 2 +- .../models/payroll_au/allowance_category.rb | 2 +- .../models/payroll_au/allowance_type.rb | 2 +- .../models/payroll_au/api_exception.rb | 2 +- .../models/payroll_au/bank_account.rb | 2 +- .../models/payroll_au/calendar_type.rb | 2 +- .../models/payroll_au/country_of_residence.rb | 2 +- .../models/payroll_au/deduction_line.rb | 2 +- .../models/payroll_au/deduction_type.rb | 2 +- .../deduction_type_calculation_type.rb | 2 +- .../models/payroll_au/earnings_line.rb | 2 +- .../models/payroll_au/earnings_rate.rb | 2 +- .../earnings_rate_calculation_type.rb | 2 +- .../models/payroll_au/earnings_type.rb | 2 +- lib/xero-ruby/models/payroll_au/employee.rb | 2 +- .../models/payroll_au/employee_status.rb | 2 +- lib/xero-ruby/models/payroll_au/employees.rb | 2 +- .../models/payroll_au/employment_basis.rb | 2 +- .../employment_termination_payment_type.rb | 2 +- .../models/payroll_au/employment_type.rb | 2 +- .../entitlement_final_pay_payout_type.rb | 2 +- .../models/payroll_au/home_address.rb | 2 +- .../models/payroll_au/income_type.rb | 2 +- .../models/payroll_au/leave_accrual_line.rb | 2 +- .../models/payroll_au/leave_application.rb | 2 +- .../models/payroll_au/leave_applications.rb | 2 +- .../models/payroll_au/leave_balance.rb | 2 +- .../models/payroll_au/leave_category_code.rb | 2 +- .../models/payroll_au/leave_earnings_line.rb | 2 +- lib/xero-ruby/models/payroll_au/leave_line.rb | 2 +- .../payroll_au/leave_line_calculation_type.rb | 2 +- .../models/payroll_au/leave_lines.rb | 2 +- .../models/payroll_au/leave_period.rb | 2 +- .../models/payroll_au/leave_period_status.rb | 4 +- lib/xero-ruby/models/payroll_au/leave_type.rb | 2 +- .../leave_type_contribution_type.rb | 2 +- .../models/payroll_au/manual_tax_type.rb | 2 +- .../models/payroll_au/opening_balances.rb | 2 +- .../payroll_au/paid_leave_earnings_line.rb | 2 +- lib/xero-ruby/models/payroll_au/pay_item.rb | 2 +- lib/xero-ruby/models/payroll_au/pay_items.rb | 2 +- .../models/payroll_au/pay_out_type.rb | 2 +- lib/xero-ruby/models/payroll_au/pay_run.rb | 2 +- .../models/payroll_au/pay_run_status.rb | 2 +- lib/xero-ruby/models/payroll_au/pay_runs.rb | 2 +- .../models/payroll_au/pay_template.rb | 2 +- .../payroll_au/payment_frequency_type.rb | 2 +- .../models/payroll_au/payroll_calendar.rb | 2 +- .../models/payroll_au/payroll_calendars.rb | 2 +- lib/xero-ruby/models/payroll_au/payslip.rb | 2 +- .../models/payroll_au/payslip_lines.rb | 2 +- .../models/payroll_au/payslip_object.rb | 2 +- .../models/payroll_au/payslip_summary.rb | 2 +- lib/xero-ruby/models/payroll_au/payslips.rb | 2 +- lib/xero-ruby/models/payroll_au/rate_type.rb | 2 +- .../models/payroll_au/reimbursement_line.rb | 2 +- .../models/payroll_au/reimbursement_lines.rb | 2 +- .../models/payroll_au/reimbursement_type.rb | 2 +- .../models/payroll_au/residency_status.rb | 2 +- .../payroll_au/senior_marital_status.rb | 2 +- lib/xero-ruby/models/payroll_au/settings.rb | 2 +- .../models/payroll_au/settings_object.rb | 2 +- .../settings_tracking_categories.rb | 2 +- ...ngs_tracking_categories_employee_groups.rb | 2 +- ...racking_categories_timesheet_categories.rb | 2 +- lib/xero-ruby/models/payroll_au/state.rb | 2 +- lib/xero-ruby/models/payroll_au/super_fund.rb | 2 +- .../models/payroll_au/super_fund_product.rb | 2 +- .../models/payroll_au/super_fund_products.rb | 2 +- .../models/payroll_au/super_fund_type.rb | 2 +- .../models/payroll_au/super_funds.rb | 2 +- lib/xero-ruby/models/payroll_au/super_line.rb | 2 +- .../models/payroll_au/super_membership.rb | 2 +- .../superannuation_calculation_type.rb | 2 +- .../superannuation_contribution_type.rb | 2 +- .../models/payroll_au/superannuation_line.rb | 2 +- .../models/payroll_au/tax_declaration.rb | 2 +- lib/xero-ruby/models/payroll_au/tax_line.rb | 2 +- .../models/payroll_au/tax_scale_type.rb | 2 +- .../models/payroll_au/tfn_exemption_type.rb | 2 +- lib/xero-ruby/models/payroll_au/timesheet.rb | 2 +- .../models/payroll_au/timesheet_line.rb | 2 +- .../models/payroll_au/timesheet_object.rb | 2 +- .../models/payroll_au/timesheet_status.rb | 2 +- lib/xero-ruby/models/payroll_au/timesheets.rb | 2 +- .../models/payroll_au/validation_error.rb | 2 +- .../models/payroll_au/work_condition.rb | 2 +- lib/xero-ruby/models/payroll_nz/account.rb | 2 +- lib/xero-ruby/models/payroll_nz/accounts.rb | 2 +- lib/xero-ruby/models/payroll_nz/address.rb | 2 +- .../models/payroll_nz/bank_account.rb | 2 +- lib/xero-ruby/models/payroll_nz/benefit.rb | 2 +- .../models/payroll_nz/calendar_type.rb | 2 +- lib/xero-ruby/models/payroll_nz/deduction.rb | 2 +- .../models/payroll_nz/deduction_line.rb | 2 +- .../models/payroll_nz/deduction_object.rb | 2 +- lib/xero-ruby/models/payroll_nz/deductions.rb | 2 +- .../models/payroll_nz/earnings_line.rb | 2 +- .../models/payroll_nz/earnings_order.rb | 2 +- .../payroll_nz/earnings_order_object.rb | 2 +- .../models/payroll_nz/earnings_orders.rb | 2 +- .../models/payroll_nz/earnings_rate.rb | 2 +- .../models/payroll_nz/earnings_rate_object.rb | 2 +- .../models/payroll_nz/earnings_rates.rb | 2 +- .../models/payroll_nz/earnings_template.rb | 2 +- .../payroll_nz/earnings_template_object.rb | 2 +- lib/xero-ruby/models/payroll_nz/employee.rb | 6 +- .../payroll_nz/employee_earnings_templates.rb | 2 +- .../models/payroll_nz/employee_leave.rb | 4 +- .../payroll_nz/employee_leave_balance.rb | 2 +- .../payroll_nz/employee_leave_balances.rb | 2 +- .../payroll_nz/employee_leave_object.rb | 2 +- .../models/payroll_nz/employee_leave_setup.rb | 2 +- .../payroll_nz/employee_leave_setup_object.rb | 2 +- .../models/payroll_nz/employee_leave_type.rb | 2 +- .../payroll_nz/employee_leave_type_object.rb | 2 +- .../models/payroll_nz/employee_leave_types.rb | 2 +- .../models/payroll_nz/employee_leaves.rb | 2 +- .../models/payroll_nz/employee_object.rb | 2 +- .../payroll_nz/employee_opening_balance.rb | 2 +- .../employee_opening_balances_object.rb | 2 +- .../payroll_nz/employee_pay_template.rb | 2 +- .../employee_pay_template_object.rb | 2 +- .../payroll_nz/employee_pay_templates.rb | 2 +- .../employee_statutory_leave_balance.rb | 2 +- ...employee_statutory_leave_balance_object.rb | 2 +- .../employee_statutory_leave_summary.rb | 2 +- .../employee_statutory_leaves_summaries.rb | 2 +- .../employee_statutory_sick_leave.rb | 2 +- .../employee_statutory_sick_leave_object.rb | 2 +- .../employee_statutory_sick_leaves.rb | 2 +- .../models/payroll_nz/employee_tax.rb | 2 +- .../models/payroll_nz/employee_tax_object.rb | 2 +- lib/xero-ruby/models/payroll_nz/employees.rb | 2 +- lib/xero-ruby/models/payroll_nz/employment.rb | 2 +- .../models/payroll_nz/employment_object.rb | 2 +- .../payroll_nz/gross_earnings_history.rb | 2 +- .../models/payroll_nz/invalid_field.rb | 2 +- .../models/payroll_nz/leave_accrual_line.rb | 2 +- .../models/payroll_nz/leave_earnings_line.rb | 2 +- .../models/payroll_nz/leave_period.rb | 2 +- .../models/payroll_nz/leave_periods.rb | 2 +- lib/xero-ruby/models/payroll_nz/leave_type.rb | 4 +- .../models/payroll_nz/leave_type_object.rb | 2 +- .../models/payroll_nz/leave_types.rb | 2 +- lib/xero-ruby/models/payroll_nz/pagination.rb | 2 +- lib/xero-ruby/models/payroll_nz/pay_run.rb | 2 +- .../models/payroll_nz/pay_run_calendar.rb | 4 +- .../payroll_nz/pay_run_calendar_object.rb | 2 +- .../models/payroll_nz/pay_run_calendars.rb | 2 +- .../models/payroll_nz/pay_run_object.rb | 2 +- lib/xero-ruby/models/payroll_nz/pay_runs.rb | 2 +- lib/xero-ruby/models/payroll_nz/pay_slip.rb | 2 +- .../models/payroll_nz/pay_slip_object.rb | 2 +- lib/xero-ruby/models/payroll_nz/pay_slips.rb | 2 +- .../models/payroll_nz/payment_line.rb | 2 +- .../models/payroll_nz/payment_method.rb | 2 +- .../payroll_nz/payment_method_object.rb | 2 +- lib/xero-ruby/models/payroll_nz/problem.rb | 2 +- .../models/payroll_nz/reimbursement.rb | 2 +- .../models/payroll_nz/reimbursement_line.rb | 2 +- .../models/payroll_nz/reimbursement_object.rb | 2 +- .../models/payroll_nz/reimbursements.rb | 2 +- .../models/payroll_nz/salary_and_wage.rb | 2 +- .../payroll_nz/salary_and_wage_object.rb | 2 +- .../models/payroll_nz/salary_and_wages.rb | 2 +- lib/xero-ruby/models/payroll_nz/settings.rb | 2 +- .../models/payroll_nz/statutory_deduction.rb | 2 +- .../statutory_deduction_category.rb | 2 +- .../payroll_nz/statutory_deduction_line.rb | 2 +- .../payroll_nz/statutory_deduction_object.rb | 2 +- .../models/payroll_nz/statutory_deductions.rb | 2 +- .../models/payroll_nz/superannuation_line.rb | 2 +- .../payroll_nz/superannuation_object.rb | 2 +- .../models/payroll_nz/superannuations.rb | 2 +- lib/xero-ruby/models/payroll_nz/tax_code.rb | 2 +- lib/xero-ruby/models/payroll_nz/tax_line.rb | 2 +- .../models/payroll_nz/tax_settings.rb | 2 +- lib/xero-ruby/models/payroll_nz/timesheet.rb | 4 +- .../payroll_nz/timesheet_earnings_line.rb | 2 +- .../models/payroll_nz/timesheet_line.rb | 2 +- .../payroll_nz/timesheet_line_object.rb | 2 +- .../models/payroll_nz/timesheet_object.rb | 2 +- lib/xero-ruby/models/payroll_nz/timesheets.rb | 2 +- .../models/payroll_nz/tracking_categories.rb | 2 +- .../models/payroll_nz/tracking_category.rb | 2 +- lib/xero-ruby/models/payroll_uk/account.rb | 2 +- lib/xero-ruby/models/payroll_uk/accounts.rb | 2 +- lib/xero-ruby/models/payroll_uk/address.rb | 2 +- .../models/payroll_uk/bank_account.rb | 2 +- lib/xero-ruby/models/payroll_uk/benefit.rb | 2 +- .../models/payroll_uk/benefit_line.rb | 2 +- .../models/payroll_uk/benefit_object.rb | 2 +- lib/xero-ruby/models/payroll_uk/benefits.rb | 2 +- .../models/payroll_uk/court_order_line.rb | 2 +- lib/xero-ruby/models/payroll_uk/deduction.rb | 2 +- .../models/payroll_uk/deduction_line.rb | 2 +- .../models/payroll_uk/deduction_object.rb | 2 +- lib/xero-ruby/models/payroll_uk/deductions.rb | 2 +- .../models/payroll_uk/earnings_line.rb | 2 +- .../models/payroll_uk/earnings_order.rb | 2 +- .../payroll_uk/earnings_order_object.rb | 2 +- .../models/payroll_uk/earnings_orders.rb | 2 +- .../models/payroll_uk/earnings_rate.rb | 2 +- .../models/payroll_uk/earnings_rate_object.rb | 2 +- .../models/payroll_uk/earnings_rates.rb | 2 +- .../models/payroll_uk/earnings_template.rb | 2 +- .../payroll_uk/earnings_template_object.rb | 2 +- lib/xero-ruby/models/payroll_uk/employee.rb | 6 +- .../models/payroll_uk/employee_leave.rb | 4 +- .../payroll_uk/employee_leave_balance.rb | 2 +- .../payroll_uk/employee_leave_balances.rb | 2 +- .../payroll_uk/employee_leave_object.rb | 2 +- .../models/payroll_uk/employee_leave_type.rb | 2 +- .../payroll_uk/employee_leave_type_object.rb | 2 +- .../models/payroll_uk/employee_leave_types.rb | 2 +- .../models/payroll_uk/employee_leaves.rb | 2 +- .../models/payroll_uk/employee_object.rb | 2 +- .../payroll_uk/employee_opening_balances.rb | 2 +- .../employee_opening_balances_object.rb | 2 +- .../payroll_uk/employee_pay_template.rb | 2 +- .../employee_pay_template_object.rb | 2 +- .../payroll_uk/employee_pay_templates.rb | 2 +- .../employee_statutory_leave_balance.rb | 2 +- ...employee_statutory_leave_balance_object.rb | 2 +- .../employee_statutory_leave_summary.rb | 2 +- .../employee_statutory_leaves_summaries.rb | 2 +- .../employee_statutory_sick_leave.rb | 2 +- .../employee_statutory_sick_leave_object.rb | 2 +- .../employee_statutory_sick_leaves.rb | 2 +- .../models/payroll_uk/employee_tax.rb | 2 +- .../models/payroll_uk/employee_tax_object.rb | 2 +- lib/xero-ruby/models/payroll_uk/employees.rb | 2 +- lib/xero-ruby/models/payroll_uk/employment.rb | 2 +- .../models/payroll_uk/employment_object.rb | 2 +- .../models/payroll_uk/invalid_field.rb | 2 +- .../models/payroll_uk/leave_accrual_line.rb | 2 +- .../models/payroll_uk/leave_earnings_line.rb | 2 +- .../models/payroll_uk/leave_period.rb | 2 +- .../models/payroll_uk/leave_periods.rb | 2 +- lib/xero-ruby/models/payroll_uk/leave_type.rb | 4 +- .../models/payroll_uk/leave_type_object.rb | 2 +- .../models/payroll_uk/leave_types.rb | 2 +- lib/xero-ruby/models/payroll_uk/pagination.rb | 2 +- lib/xero-ruby/models/payroll_uk/pay_run.rb | 2 +- .../models/payroll_uk/pay_run_calendar.rb | 4 +- .../payroll_uk/pay_run_calendar_object.rb | 2 +- .../models/payroll_uk/pay_run_calendars.rb | 2 +- .../models/payroll_uk/pay_run_object.rb | 2 +- lib/xero-ruby/models/payroll_uk/pay_runs.rb | 2 +- .../models/payroll_uk/payment_line.rb | 2 +- .../models/payroll_uk/payment_method.rb | 2 +- .../payroll_uk/payment_method_object.rb | 2 +- lib/xero-ruby/models/payroll_uk/payslip.rb | 2 +- .../models/payroll_uk/payslip_object.rb | 2 +- lib/xero-ruby/models/payroll_uk/payslips.rb | 2 +- lib/xero-ruby/models/payroll_uk/problem.rb | 2 +- .../models/payroll_uk/reimbursement.rb | 2 +- .../models/payroll_uk/reimbursement_line.rb | 2 +- .../models/payroll_uk/reimbursement_object.rb | 2 +- .../models/payroll_uk/reimbursements.rb | 2 +- .../models/payroll_uk/salary_and_wage.rb | 2 +- .../payroll_uk/salary_and_wage_object.rb | 2 +- .../models/payroll_uk/salary_and_wages.rb | 2 +- lib/xero-ruby/models/payroll_uk/settings.rb | 2 +- .../models/payroll_uk/statutory_deduction.rb | 2 +- .../statutory_deduction_category.rb | 2 +- lib/xero-ruby/models/payroll_uk/tax_line.rb | 2 +- lib/xero-ruby/models/payroll_uk/timesheet.rb | 4 +- .../payroll_uk/timesheet_earnings_line.rb | 2 +- .../models/payroll_uk/timesheet_line.rb | 2 +- .../payroll_uk/timesheet_line_object.rb | 2 +- .../models/payroll_uk/timesheet_object.rb | 2 +- lib/xero-ruby/models/payroll_uk/timesheets.rb | 2 +- .../models/payroll_uk/tracking_categories.rb | 2 +- .../models/payroll_uk/tracking_category.rb | 2 +- lib/xero-ruby/models/projects/amount.rb | 2 +- lib/xero-ruby/models/projects/charge_type.rb | 2 +- .../models/projects/currency_code.rb | 2 +- lib/xero-ruby/models/projects/error.rb | 2 +- lib/xero-ruby/models/projects/pagination.rb | 2 +- lib/xero-ruby/models/projects/project.rb | 4 +- .../projects/project_create_or_update.rb | 4 +- .../models/projects/project_patch.rb | 2 +- .../models/projects/project_status.rb | 2 +- lib/xero-ruby/models/projects/project_user.rb | 2 +- .../models/projects/project_users.rb | 2 +- lib/xero-ruby/models/projects/projects.rb | 2 +- lib/xero-ruby/models/projects/task.rb | 2 +- .../models/projects/task_create_or_update.rb | 12 +- lib/xero-ruby/models/projects/tasks.rb | 2 +- lib/xero-ruby/models/projects/time_entries.rb | 2 +- lib/xero-ruby/models/projects/time_entry.rb | 6 +- .../projects/time_entry_create_or_update.rb | 4 +- lib/xero-ruby/version.rb | 6 +- xero-ruby.gemspec | 4 +- 577 files changed, 4500 insertions(+), 111466 deletions(-) delete mode 100644 docs/accounting/index.html delete mode 100644 docs/app_store/index.html delete mode 100644 docs/assets/index.html delete mode 100644 docs/files/UploadObject.md delete mode 100644 docs/files/index.html delete mode 100644 docs/finance/index.html delete mode 100644 docs/payroll_au/index.html delete mode 100644 docs/payroll_nz/index.html delete mode 100644 docs/payroll_uk/index.html delete mode 100644 docs/projects/index.html delete mode 100644 lib/xero-ruby/models/files/upload_object.rb diff --git a/docs/accounting/AccountingApi.md b/docs/accounting/AccountingApi.md index 54cdfdd1..d87da847 100644 --- a/docs/accounting/AccountingApi.md +++ b/docs/accounting/AccountingApi.md @@ -65,9 +65,12 @@ Method | HTTP request | Description [**delete_batch_payment_by_url_param**](AccountingApi.md#delete_batch_payment_by_url_param) | **POST** /BatchPayments/{BatchPaymentID} | Updates a specific batch payment for invoices and credit notes [**delete_contact_group_contact**](AccountingApi.md#delete_contact_group_contact) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts/{ContactID} | Deletes a specific contact from a contact group using a unique contact Id [**delete_contact_group_contacts**](AccountingApi.md#delete_contact_group_contacts) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts | Deletes all contacts from a specific contact group +[**delete_credit_note_allocations**](AccountingApi.md#delete_credit_note_allocations) | **DELETE** /CreditNotes/{CreditNoteID}/Allocations/{AllocationID} | Deletes an Allocation from a Credit Note [**delete_item**](AccountingApi.md#delete_item) | **DELETE** /Items/{ItemID} | Deletes a specific item [**delete_linked_transaction**](AccountingApi.md#delete_linked_transaction) | **DELETE** /LinkedTransactions/{LinkedTransactionID} | Deletes a specific linked transactions (billable expenses) +[**delete_overpayment_allocations**](AccountingApi.md#delete_overpayment_allocations) | **DELETE** /Overpayments/{OverpaymentID}/Allocations/{AllocationID} | Deletes an Allocation from an overpayment [**delete_payment**](AccountingApi.md#delete_payment) | **POST** /Payments/{PaymentID} | Updates a specific payment for invoices and credit notes +[**delete_prepayment_allocations**](AccountingApi.md#delete_prepayment_allocations) | **DELETE** /Prepayments/{PrepaymentID}/Allocations/{AllocationID} | Deletes an Allocation from a Prepayment [**delete_tracking_category**](AccountingApi.md#delete_tracking_category) | **DELETE** /TrackingCategories/{TrackingCategoryID} | Deletes a specific tracking category [**delete_tracking_options**](AccountingApi.md#delete_tracking_options) | **DELETE** /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID} | Deletes a specific option for a specific tracking category [**email_invoice**](AccountingApi.md#email_invoice) | **POST** /Invoices/{InvoiceID}/Email | Sends a copy of a specific invoice to related contact via email @@ -242,7 +245,7 @@ Method | HTTP request | Description ## create_account -> Accounts create_account(xero_tenant_id, account) +> Accounts create_account(xero_tenant_id, account, opts) Creates a new chart of accounts @@ -271,11 +274,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant account = { "Code":"123456", "Name":"Foobar", "Type":"EXPENSE", "Description":"Hello World" } # Account | Account object in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new chart of accounts - result = api_instance.create_account(xero_tenant_id, account) + result = api_instance.create_account(xero_tenant_id, account, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_account: #{e}" @@ -289,6 +296,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **account** | [**Account**](Account.md)| Account object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -306,7 +314,7 @@ Name | Type | Description | Notes ## create_account_attachment_by_file_name -> Attachments create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) +> Attachments create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, opts) Creates an attachment on a specific account @@ -335,13 +343,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -account_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Account object -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +account_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Account object +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an attachment on a specific account - result = api_instance.create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) + result = api_instance.create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_account_attachment_by_file_name: #{e}" @@ -354,9 +366,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **account_id** | [**String**](.md)| Unique identifier for Account object | + **account_id** | **String**| Unique identifier for Account object | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -374,7 +387,7 @@ Name | Type | Description | Notes ## create_bank_transaction_attachment_by_file_name -> Attachments create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) +> Attachments create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, opts) Creates an attachment for a specific bank transaction by filename @@ -403,13 +416,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transaction -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transaction_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transaction +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an attachment for a specific bank transaction by filename - result = api_instance.create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) + result = api_instance.create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_bank_transaction_attachment_by_file_name: #{e}" @@ -422,9 +439,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transaction_id** | [**String**](.md)| Xero generated unique identifier for a bank transaction | + **bank_transaction_id** | **String**| Xero generated unique identifier for a bank transaction | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -442,7 +460,7 @@ Name | Type | Description | Notes ## create_bank_transaction_history_record -> HistoryRecords create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records) +> HistoryRecords create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records, opts) Creates a history record for a specific bank transactions @@ -471,12 +489,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transaction +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transaction_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transaction history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific bank transactions - result = api_instance.create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records) + result = api_instance.create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_bank_transaction_history_record: #{e}" @@ -489,8 +511,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transaction_id** | [**String**](.md)| Xero generated unique identifier for a bank transaction | + **bank_transaction_id** | **String**| Xero generated unique identifier for a bank transaction | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -537,10 +560,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant bank_transactions = { bankTransactions: [{ type: BankTransaction.TypeEnum.SPEND, contact: { contactID: "00000000-0000-0000-0000-000000000000" }, lineItems: [{ description: "Foobar", quantity: 1.0, unitAmount: 20.0, accountCode: "000" } ], bankAccount: { code: "000" }}]} # BankTransactions | BankTransactions with an array of BankTransaction objects in body of request opts = { - summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -561,6 +586,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **bank_transactions** | [**BankTransactions**](BankTransactions.md)| BankTransactions with an array of BankTransaction objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -580,7 +606,7 @@ Name | Type | Description | Notes ## create_bank_transfer -> BankTransfers create_bank_transfer(xero_tenant_id, bank_transfers) +> BankTransfers create_bank_transfer(xero_tenant_id, bank_transfers, opts) Creates a bank transfer @@ -609,11 +635,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant bank_transfers = { "BankTransfers": [ { "FromBankAccount": { "Code": "090", "Name": "My Savings", "AccountID": "00000000-0000-0000-0000-000000000000", "Type": "BANK", "BankAccountNumber": "123455", "Status": "ACTIVE", "BankAccountType": "BANK", "CurrencyCode": "USD", "TaxType": "NONE", "EnablePaymentsToAccount": false, "ShowInExpenseClaims": false, "Class": "ASSET", "ReportingCode": "ASS", "ReportingCodeName": "Assets", "HasAttachments": false, "UpdatedDateUTC": "2016-10-17T13:45:33.993-07:00" }, "ToBankAccount": { "Code": "088", "Name": "Business Wells Fargo", "AccountID": "00000000-0000-0000-0000-000000000000", "Type": "BANK", "BankAccountNumber": "123455", "Status": "ACTIVE", "BankAccountType": "BANK", "CurrencyCode": "USD", "TaxType": "NONE", "EnablePaymentsToAccount": false, "ShowInExpenseClaims": false, "Class": "ASSET", "ReportingCode": "ASS", "ReportingCodeName": "Assets", "HasAttachments": false, "UpdatedDateUTC": "2016-06-03T08:31:14.517-07:00" }, "Amount": "50.00", "FromIsReconciled": true, "ToIsReconciled": true, "Reference": "Sub 098801" } ] } # BankTransfers | BankTransfers with array of BankTransfer objects in request body +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a bank transfer - result = api_instance.create_bank_transfer(xero_tenant_id, bank_transfers) + result = api_instance.create_bank_transfer(xero_tenant_id, bank_transfers, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_bank_transfer: #{e}" @@ -627,6 +657,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **bank_transfers** | [**BankTransfers**](BankTransfers.md)| BankTransfers with array of BankTransfer objects in request body | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -644,7 +675,7 @@ Name | Type | Description | Notes ## create_bank_transfer_attachment_by_file_name -> Attachments create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) +> Attachments create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, opts) @@ -673,12 +704,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transfer -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transfer_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transfer +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin - result = api_instance.create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) + result = api_instance.create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_bank_transfer_attachment_by_file_name: #{e}" @@ -691,9 +726,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transfer_id** | [**String**](.md)| Xero generated unique identifier for a bank transfer | + **bank_transfer_id** | **String**| Xero generated unique identifier for a bank transfer | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -711,7 +747,7 @@ Name | Type | Description | Notes ## create_bank_transfer_history_record -> HistoryRecords create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records) +> HistoryRecords create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records, opts) Creates a history record for a specific bank transfer @@ -740,12 +776,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transfer +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transfer_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transfer history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific bank transfer - result = api_instance.create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records) + result = api_instance.create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_bank_transfer_history_record: #{e}" @@ -758,8 +798,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transfer_id** | [**String**](.md)| Xero generated unique identifier for a bank transfer | + **bank_transfer_id** | **String**| Xero generated unique identifier for a bank transfer | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -806,10 +847,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant batch_payments = { "BatchPayments": [ { "Account": { "AccountID": "00000000-0000-0000-0000-000000000000" }, "Reference": "ref", "Date": "2018-08-01", "Payments": [ { "Account": { "Code": "001" }, "Date": "2019-12-31", "Amount": 500, "Invoice": { "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" } } ] } ] } # BatchPayments | BatchPayments with an array of Payments in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: true, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -829,6 +872,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **batch_payments** | [**BatchPayments**](BatchPayments.md)| BatchPayments with an array of Payments in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -846,7 +890,7 @@ Name | Type | Description | Notes ## create_batch_payment_history_record -> HistoryRecords create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records) +> HistoryRecords create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records, opts) Creates a history record for a specific batch payment @@ -875,12 +919,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -batch_payment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for BatchPayment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +batch_payment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for BatchPayment history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific batch payment - result = api_instance.create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records) + result = api_instance.create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_batch_payment_history_record: #{e}" @@ -893,8 +941,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **batch_payment_id** | [**String**](.md)| Unique identifier for BatchPayment | + **batch_payment_id** | **String**| Unique identifier for BatchPayment | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -912,7 +961,7 @@ Name | Type | Description | Notes ## create_branding_theme_payment_services -> PaymentServices create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_services) +> PaymentServices create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_services, opts) Creates a new custom payment service for a specific branding theme @@ -941,12 +990,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -branding_theme_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Branding Theme +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +branding_theme_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Branding Theme payment_services = { "PaymentServices": [ { "PaymentServiceID": "54b3b4f6-0443-4fba-bcd1-61ec0c35ca55", "PaymentServiceName": "PayUpNow", "PaymentServiceUrl": "https://www.payupnow.com/", "PaymentServiceType": "Custom", "PayNowText": "Time To Pay" } ] } # PaymentServices | PaymentServices array with PaymentService object in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new custom payment service for a specific branding theme - result = api_instance.create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_services) + result = api_instance.create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_services, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_branding_theme_payment_services: #{e}" @@ -959,8 +1012,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **branding_theme_id** | [**String**](.md)| Unique identifier for a Branding Theme | + **branding_theme_id** | **String**| Unique identifier for a Branding Theme | **payment_services** | [**PaymentServices**](PaymentServices.md)| PaymentServices array with PaymentService object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -978,7 +1032,7 @@ Name | Type | Description | Notes ## create_contact_attachment_by_file_name -> Attachments create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) +> Attachments create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, opts) @@ -1007,12 +1061,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin - result = api_instance.create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) + result = api_instance.create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_contact_attachment_by_file_name: #{e}" @@ -1025,9 +1083,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_id** | [**String**](.md)| Unique identifier for a Contact | + **contact_id** | **String**| Unique identifier for a Contact | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1045,7 +1104,7 @@ Name | Type | Description | Notes ## create_contact_group -> ContactGroups create_contact_group(xero_tenant_id, contact_groups) +> ContactGroups create_contact_group(xero_tenant_id, contact_groups, opts) Creates a contact group @@ -1074,11 +1133,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant contact_groups = { "ContactGroups": [{ "Name": "VIPs" }]} # ContactGroups | ContactGroups with an array of names in request body +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a contact group - result = api_instance.create_contact_group(xero_tenant_id, contact_groups) + result = api_instance.create_contact_group(xero_tenant_id, contact_groups, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_contact_group: #{e}" @@ -1092,6 +1155,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **contact_groups** | [**ContactGroups**](ContactGroups.md)| ContactGroups with an array of names in request body | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1109,7 +1173,7 @@ Name | Type | Description | Notes ## create_contact_group_contacts -> Contacts create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts) +> Contacts create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts, opts) Creates contacts to a specific contact group @@ -1138,12 +1202,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_group_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact Group +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_group_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact Group contacts = { "Contacts": [ { "ContactID": "a3675fc4-f8dd-4f03-ba5b-f1870566bcd7" }, { "ContactID": "4e1753b9-018a-4775-b6aa-1bc7871cfee3" } ] } # Contacts | Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates contacts to a specific contact group - result = api_instance.create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts) + result = api_instance.create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_contact_group_contacts: #{e}" @@ -1156,8 +1224,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_group_id** | [**String**](.md)| Unique identifier for a Contact Group | + **contact_group_id** | **String**| Unique identifier for a Contact Group | **contacts** | [**Contacts**](Contacts.md)| Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1175,7 +1244,7 @@ Name | Type | Description | Notes ## create_contact_history -> HistoryRecords create_contact_history(xero_tenant_id, contact_id, history_records) +> HistoryRecords create_contact_history(xero_tenant_id, contact_id, history_records, opts) Creates a new history record for a specific contact @@ -1204,12 +1273,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new history record for a specific contact - result = api_instance.create_contact_history(xero_tenant_id, contact_id, history_records) + result = api_instance.create_contact_history(xero_tenant_id, contact_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_contact_history: #{e}" @@ -1222,8 +1295,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_id** | [**String**](.md)| Unique identifier for a Contact | + **contact_id** | **String**| Unique identifier for a Contact | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1270,10 +1344,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant contacts = { "Contacts": [ { "ContactID": "3ff6d40c-af9a-40a3-89ce-3c1556a25591", "ContactStatus": "ACTIVE", "Name": "Foo9987", "EmailAddress": "sid32476@blah.com", "BankAccountDetails": "", "Addresses": [ { "AddressType": "STREET", "City": "", "Region": "", "PostalCode": "", "Country": "" }, { "AddressType": "POBOX", "City": "", "Region": "", "PostalCode": "", "Country": "" } ], "Phones": [ { "PhoneType": "DEFAULT", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "DDI", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "FAX", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "MOBILE", "PhoneNumber": "555-1212", "PhoneAreaCode": "415", "PhoneCountryCode": "" } ], "UpdatedDateUTC": "/Date(1551399321043+0000)/", "ContactGroups": [], "IsSupplier": false, "IsCustomer": false, "SalesTrackingCategories": [], "PurchasesTrackingCategories": [], "PaymentTerms": { "Bills": { "Day": 15, "Type": "OFCURRENTMONTH" }, "Sales": { "Day": 10, "Type": "DAYSAFTERBILLMONTH" } }, "ContactPersons": [] } ] } # Contacts | Contacts with an array of Contact objects to create in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -1292,6 +1368,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **contacts** | [**Contacts**](Contacts.md)| Contacts with an array of Contact objects to create in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -1339,11 +1416,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +credit_note_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Credit Note allocations = { "Allocations": [ { "Invoice": { "LineItems": [], "InvoiceID": "c45720a1-ade3-4a38-a064-d15489be6841" }, "Amount": 1, "Date": "2019-03-05" } ] } # Allocations | Allocations with array of Allocation object in body of request. opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -1361,8 +1440,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | + **credit_note_id** | **String**| Unique identifier for a Credit Note | **allocations** | [**Allocations**](Allocations.md)| Allocations with array of Allocation object in body of request. | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -1410,12 +1490,14 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +credit_note_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Credit Note +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request opts = { - include_online: false # Boolean | Allows an attachment to be seen by the end customer within their online invoice + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + include_online: true # Boolean | Allows an attachment to be seen by the end customer within their online invoice } begin @@ -1433,9 +1515,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | + **credit_note_id** | **String**| Unique identifier for a Credit Note | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **include_online** | **Boolean**| Allows an attachment to be seen by the end customer within their online invoice | [optional] [default to false] ### Return type @@ -1454,7 +1537,7 @@ Name | Type | Description | Notes ## create_credit_note_history -> HistoryRecords create_credit_note_history(xero_tenant_id, credit_note_id, history_records) +> HistoryRecords create_credit_note_history(xero_tenant_id, credit_note_id, history_records, opts) Retrieves history records of a specific credit note @@ -1483,12 +1566,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +credit_note_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Credit Note history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Retrieves history records of a specific credit note - result = api_instance.create_credit_note_history(xero_tenant_id, credit_note_id, history_records) + result = api_instance.create_credit_note_history(xero_tenant_id, credit_note_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_credit_note_history: #{e}" @@ -1501,8 +1588,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | + **credit_note_id** | **String**| Unique identifier for a Credit Note | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1549,10 +1637,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant credit_notes = { "CreditNotes":[ { "Type":"ACCPAYCREDIT", "Contact":{ "ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8" }, "Date":"2019-01-05", "LineItems":[ { "Description":"Foobar", "Quantity":2.0, "UnitAmount":20.0, "AccountCode":"400" } ] } ] } # CreditNotes | Credit Notes with array of CreditNote object in body of request opts = { - summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -1573,6 +1663,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **credit_notes** | [**CreditNotes**](CreditNotes.md)| Credit Notes with array of CreditNote object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -1592,7 +1683,7 @@ Name | Type | Description | Notes ## create_currency -> Currencies create_currency(xero_tenant_id, currency) +> Currencies create_currency(xero_tenant_id, currency, opts) Create a new currency for a Xero organisation @@ -1621,11 +1712,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant currency = { "Code": "USD", "Description": "United States Dollar" } # Currency | Currency object in the body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Create a new currency for a Xero organisation - result = api_instance.create_currency(xero_tenant_id, currency) + result = api_instance.create_currency(xero_tenant_id, currency, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_currency: #{e}" @@ -1639,6 +1734,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **currency** | [**Currency**](Currency.md)| Currency object in the body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1685,10 +1781,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant employees = { "Employees": [ { "FirstName": "Nick", "LastName": "Fury", "ExternalLink": { "Url": "http://twitter.com/#!/search/Nick+Fury" } } ] } # Employees | Employees with array of Employee object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -1707,6 +1805,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **employees** | [**Employees**](Employees.md)| Employees with array of Employee object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -1725,7 +1824,7 @@ Name | Type | Description | Notes ## create_expense_claim_history -> HistoryRecords create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records) +> HistoryRecords create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records, opts) Creates a history record for a specific expense claim @@ -1754,12 +1853,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -expense_claim_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ExpenseClaim +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +expense_claim_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a ExpenseClaim history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific expense claim - result = api_instance.create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records) + result = api_instance.create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_expense_claim_history: #{e}" @@ -1772,8 +1875,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **expense_claim_id** | [**String**](.md)| Unique identifier for a ExpenseClaim | + **expense_claim_id** | **String**| Unique identifier for a ExpenseClaim | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1791,7 +1895,7 @@ Name | Type | Description | Notes ## create_expense_claims -> ExpenseClaims create_expense_claims(xero_tenant_id, expense_claims) +> ExpenseClaims create_expense_claims(xero_tenant_id, expense_claims, opts) Creates expense claims @@ -1820,11 +1924,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant expense_claims = { "ExpenseClaims": [ { "Status": "SUBMITTED", "User": { "UserID": "d1164823-0ac1-41ad-987b-b4e30fe0b273" }, "Receipts": [ { "Lineitems": [], "ReceiptID": "dc1c7f6d-0a4c-402f-acac-551d62ce5816" } ] } ] } # ExpenseClaims | ExpenseClaims with array of ExpenseClaim object in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates expense claims - result = api_instance.create_expense_claims(xero_tenant_id, expense_claims) + result = api_instance.create_expense_claims(xero_tenant_id, expense_claims, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_expense_claims: #{e}" @@ -1838,6 +1946,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **expense_claims** | [**ExpenseClaims**](ExpenseClaims.md)| ExpenseClaims with array of ExpenseClaim object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1884,12 +1993,14 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Invoice +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request opts = { - include_online: false # Boolean | Allows an attachment to be seen by the end customer within their online invoice + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + include_online: true # Boolean | Allows an attachment to be seen by the end customer within their online invoice } begin @@ -1907,9 +2018,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | + **invoice_id** | **String**| Unique identifier for an Invoice | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **include_online** | **Boolean**| Allows an attachment to be seen by the end customer within their online invoice | [optional] [default to false] ### Return type @@ -1928,7 +2040,7 @@ Name | Type | Description | Notes ## create_invoice_history -> HistoryRecords create_invoice_history(xero_tenant_id, invoice_id, history_records) +> HistoryRecords create_invoice_history(xero_tenant_id, invoice_id, history_records, opts) Creates a history record for a specific invoice @@ -1957,12 +2069,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Invoice history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific invoice - result = api_instance.create_invoice_history(xero_tenant_id, invoice_id, history_records) + result = api_instance.create_invoice_history(xero_tenant_id, invoice_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_invoice_history: #{e}" @@ -1975,8 +2091,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | + **invoice_id** | **String**| Unique identifier for an Invoice | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2023,10 +2140,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant invoices = { "Invoices": [ { "Type": "ACCREC", "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8" }, "LineItems": [ { "Description": "Acme Tires", "Quantity": 2, "UnitAmount": 20, "AccountCode": "200", "TaxType": "NONE", "LineAmount": 40 } ], "Date": "2019-03-11", "DueDate": "2018-12-10", "Reference": "Website Design", "Status": "AUTHORISED" } ] } # Invoices | Invoices with an array of invoice objects in body of request opts = { - summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -2047,6 +2166,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **invoices** | [**Invoices**](Invoices.md)| Invoices with an array of invoice objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -2066,7 +2186,7 @@ Name | Type | Description | Notes ## create_item_history -> HistoryRecords create_item_history(xero_tenant_id, item_id, history_records) +> HistoryRecords create_item_history(xero_tenant_id, item_id, history_records, opts) Creates a history record for a specific item @@ -2095,12 +2215,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -item_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Item +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +item_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Item history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific item - result = api_instance.create_item_history(xero_tenant_id, item_id, history_records) + result = api_instance.create_item_history(xero_tenant_id, item_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_item_history: #{e}" @@ -2113,8 +2237,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **item_id** | [**String**](.md)| Unique identifier for an Item | + **item_id** | **String**| Unique identifier for an Item | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2161,10 +2286,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant items = { "Items": [ { "Code": "code123", "Name": "Item Name XYZ", "Description": "Foobar", "InventoryAssetAccountCode": "140", "PurchaseDetails": { "COGSAccountCode": "500" } } ] } # Items | Items with an array of Item objects in body of request opts = { - summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -2185,6 +2312,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **items** | [**Items**](Items.md)| Items with an array of Item objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -2204,7 +2332,7 @@ Name | Type | Description | Notes ## create_linked_transaction -> LinkedTransactions create_linked_transaction(xero_tenant_id, linked_transaction) +> LinkedTransactions create_linked_transaction(xero_tenant_id, linked_transaction, opts) Creates linked transactions (billable expenses) @@ -2233,11 +2361,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant linked_transaction = { "LinkedTransactions": [ { "SourceTransactionID": "a848644a-f20f-4630-98c3-386bd7505631", "SourceLineItemID": "b0df260d-3cc8-4ced-9bd6-41924f624ed3" } ] } # LinkedTransaction | LinkedTransaction object in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates linked transactions (billable expenses) - result = api_instance.create_linked_transaction(xero_tenant_id, linked_transaction) + result = api_instance.create_linked_transaction(xero_tenant_id, linked_transaction, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_linked_transaction: #{e}" @@ -2251,6 +2383,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **linked_transaction** | [**LinkedTransaction**](LinkedTransaction.md)| LinkedTransaction object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2268,7 +2401,7 @@ Name | Type | Description | Notes ## create_manual_journal_attachment_by_file_name -> Attachments create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) +> Attachments create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, opts) Creates a specific attachment for a specific manual journal by file name @@ -2297,13 +2430,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ManualJournal -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +manual_journal_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a ManualJournal +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a specific attachment for a specific manual journal by file name - result = api_instance.create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) + result = api_instance.create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_manual_journal_attachment_by_file_name: #{e}" @@ -2316,9 +2453,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **manual_journal_id** | [**String**](.md)| Unique identifier for a ManualJournal | + **manual_journal_id** | **String**| Unique identifier for a ManualJournal | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2336,7 +2474,7 @@ Name | Type | Description | Notes ## create_manual_journal_history_record -> HistoryRecords create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records) +> HistoryRecords create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records, opts) Creates a history record for a specific manual journal @@ -2365,12 +2503,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ManualJournal +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +manual_journal_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a ManualJournal history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific manual journal - result = api_instance.create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records) + result = api_instance.create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_manual_journal_history_record: #{e}" @@ -2383,8 +2525,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **manual_journal_id** | [**String**](.md)| Unique identifier for a ManualJournal | + **manual_journal_id** | **String**| Unique identifier for a ManualJournal | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2431,10 +2574,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant manual_journals = { "ManualJournals": [ { "Narration": "Journal Desc", "JournalLines": [ { "LineAmount": 100, "AccountCode": "400", "Description": "Money Movement" }, { "LineAmount": -100, "AccountCode": "400", "Description": "Prepayment of things", "Tracking": [ { "Name": "North", "Option": "Region" } ] } ], "Date": "2019-03-14" } ] } # ManualJournals | ManualJournals array with ManualJournal object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -2453,6 +2598,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **manual_journals** | [**ManualJournals**](ManualJournals.md)| ManualJournals array with ManualJournal object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -2500,11 +2646,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -overpayment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Overpayment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +overpayment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Overpayment allocations = { "Allocations": [ { "Invoice": { "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }, "Amount": 10.00, "Date": "2019-03-12" } ] } # Allocations | Allocations array with Allocation object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -2522,8 +2670,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **overpayment_id** | [**String**](.md)| Unique identifier for a Overpayment | + **overpayment_id** | **String**| Unique identifier for a Overpayment | **allocations** | [**Allocations**](Allocations.md)| Allocations array with Allocation object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -2542,7 +2691,7 @@ Name | Type | Description | Notes ## create_overpayment_history -> HistoryRecords create_overpayment_history(xero_tenant_id, overpayment_id, history_records) +> HistoryRecords create_overpayment_history(xero_tenant_id, overpayment_id, history_records, opts) Creates a history record for a specific overpayment @@ -2571,12 +2720,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -overpayment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Overpayment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +overpayment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Overpayment history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific overpayment - result = api_instance.create_overpayment_history(xero_tenant_id, overpayment_id, history_records) + result = api_instance.create_overpayment_history(xero_tenant_id, overpayment_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_overpayment_history: #{e}" @@ -2589,8 +2742,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **overpayment_id** | [**String**](.md)| Unique identifier for a Overpayment | + **overpayment_id** | **String**| Unique identifier for a Overpayment | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2608,7 +2762,7 @@ Name | Type | Description | Notes ## create_payment -> Payments create_payment(xero_tenant_id, payment) +> Payments create_payment(xero_tenant_id, payment, opts) Creates a single payment for invoice or credit notes @@ -2637,11 +2791,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant payment = { "Payments": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-0000-000000000000" }, "Account": { "Code": "970" }, "Date": "2019-03-12", "Amount": 1 } ] } # Payment | Request body with a single Payment object +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a single payment for invoice or credit notes - result = api_instance.create_payment(xero_tenant_id, payment) + result = api_instance.create_payment(xero_tenant_id, payment, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_payment: #{e}" @@ -2655,6 +2813,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **payment** | [**Payment**](Payment.md)| Request body with a single Payment object | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2672,7 +2831,7 @@ Name | Type | Description | Notes ## create_payment_history -> HistoryRecords create_payment_history(xero_tenant_id, payment_id, history_records) +> HistoryRecords create_payment_history(xero_tenant_id, payment_id, history_records, opts) Creates a history record for a specific payment @@ -2701,12 +2860,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -payment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Payment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +payment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Payment history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific payment - result = api_instance.create_payment_history(xero_tenant_id, payment_id, history_records) + result = api_instance.create_payment_history(xero_tenant_id, payment_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_payment_history: #{e}" @@ -2719,8 +2882,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **payment_id** | [**String**](.md)| Unique identifier for a Payment | + **payment_id** | **String**| Unique identifier for a Payment | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2738,7 +2902,7 @@ Name | Type | Description | Notes ## create_payment_service -> PaymentServices create_payment_service(xero_tenant_id, payment_services) +> PaymentServices create_payment_service(xero_tenant_id, payment_services, opts) Creates a payment service @@ -2767,11 +2931,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant payment_services = { "PaymentServices": [ { "PaymentServiceName": "PayUpNow", "PaymentServiceUrl": "https://www.payupnow.com/", "PayNowText": "Time To Pay" } ] } # PaymentServices | PaymentServices array with PaymentService object in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a payment service - result = api_instance.create_payment_service(xero_tenant_id, payment_services) + result = api_instance.create_payment_service(xero_tenant_id, payment_services, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_payment_service: #{e}" @@ -2785,6 +2953,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **payment_services** | [**PaymentServices**](PaymentServices.md)| PaymentServices array with PaymentService object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2831,10 +3000,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant payments = { "Payments": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-0000-000000000000" }, "Account": { "Code": "970" }, "Date": "2019-03-12", "Amount": 1 } ] } # Payments | Payments array with Payment object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -2853,6 +3024,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **payments** | [**Payments**](Payments.md)| Payments array with Payment object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -2900,11 +3072,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -prepayment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a PrePayment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +prepayment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a PrePayment allocations = { "Allocations": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-0000-000000000000" }, "Amount": 1, "Date": "2019-01-10" } ] } # Allocations | Allocations with an array of Allocation object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -2922,8 +3096,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **prepayment_id** | [**String**](.md)| Unique identifier for a PrePayment | + **prepayment_id** | **String**| Unique identifier for a PrePayment | **allocations** | [**Allocations**](Allocations.md)| Allocations with an array of Allocation object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -2942,7 +3117,7 @@ Name | Type | Description | Notes ## create_prepayment_history -> HistoryRecords create_prepayment_history(xero_tenant_id, prepayment_id, history_records) +> HistoryRecords create_prepayment_history(xero_tenant_id, prepayment_id, history_records, opts) Creates a history record for a specific prepayment @@ -2971,12 +3146,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -prepayment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a PrePayment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +prepayment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a PrePayment history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific prepayment - result = api_instance.create_prepayment_history(xero_tenant_id, prepayment_id, history_records) + result = api_instance.create_prepayment_history(xero_tenant_id, prepayment_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_prepayment_history: #{e}" @@ -2989,8 +3168,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **prepayment_id** | [**String**](.md)| Unique identifier for a PrePayment | + **prepayment_id** | **String**| Unique identifier for a PrePayment | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3008,7 +3188,7 @@ Name | Type | Description | Notes ## create_purchase_order_attachment_by_file_name -> Attachments create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) +> Attachments create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, opts) Creates attachment for a specific purchase order @@ -3037,13 +3217,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Purchase Order -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +purchase_order_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Purchase Order +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates attachment for a specific purchase order - result = api_instance.create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) + result = api_instance.create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_purchase_order_attachment_by_file_name: #{e}" @@ -3056,9 +3240,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **purchase_order_id** | [**String**](.md)| Unique identifier for an Purchase Order | + **purchase_order_id** | **String**| Unique identifier for an Purchase Order | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3076,7 +3261,7 @@ Name | Type | Description | Notes ## create_purchase_order_history -> HistoryRecords create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records) +> HistoryRecords create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records, opts) Creates a history record for a specific purchase orders @@ -3105,12 +3290,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Purchase Order +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +purchase_order_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Purchase Order history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific purchase orders - result = api_instance.create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records) + result = api_instance.create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_purchase_order_history: #{e}" @@ -3123,8 +3312,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **purchase_order_id** | [**String**](.md)| Unique identifier for an Purchase Order | + **purchase_order_id** | **String**| Unique identifier for an Purchase Order | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3171,10 +3361,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant purchase_orders = { "PurchaseOrders": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "710" } ], "Date": "2019-03-13" } ] } # PurchaseOrders | PurchaseOrders with an array of PurchaseOrder object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -3193,6 +3385,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **purchase_orders** | [**PurchaseOrders**](PurchaseOrders.md)| PurchaseOrders with an array of PurchaseOrder object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -3211,7 +3404,7 @@ Name | Type | Description | Notes ## create_quote_attachment_by_file_name -> Attachments create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) +> Attachments create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, opts) Creates attachment for a specific quote @@ -3240,13 +3433,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -quote_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Quote -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +quote_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Quote +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates attachment for a specific quote - result = api_instance.create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) + result = api_instance.create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_quote_attachment_by_file_name: #{e}" @@ -3259,9 +3456,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **quote_id** | [**String**](.md)| Unique identifier for an Quote | + **quote_id** | **String**| Unique identifier for an Quote | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3279,7 +3477,7 @@ Name | Type | Description | Notes ## create_quote_history -> HistoryRecords create_quote_history(xero_tenant_id, quote_id, history_records) +> HistoryRecords create_quote_history(xero_tenant_id, quote_id, history_records, opts) Creates a history record for a specific quote @@ -3308,12 +3506,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -quote_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Quote +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +quote_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Quote history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific quote - result = api_instance.create_quote_history(xero_tenant_id, quote_id, history_records) + result = api_instance.create_quote_history(xero_tenant_id, quote_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_quote_history: #{e}" @@ -3326,8 +3528,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **quote_id** | [**String**](.md)| Unique identifier for an Quote | + **quote_id** | **String**| Unique identifier for an Quote | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3374,10 +3577,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant quotes = { "Quotes": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "12775" } ], "Date": "2020-02-01" } ] } # Quotes | Quotes with an array of Quote object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -3396,6 +3601,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **quotes** | [**Quotes**](Quotes.md)| Quotes with an array of Quote object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -3443,9 +3649,11 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant receipts = { "Receipts": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "Lineitems": [ { "Description": "Foobar", "Quantity": 2, "UnitAmount": 20, "AccountCode": "400", "TaxType": "NONE", "LineAmount": 40 } ], "User": { "UserID": "00000000-0000-0000-0000-000000000000" }, "LineAmountTypes": "NoTax", "Status": "DRAFT" } ] } # Receipts | Receipts with an array of Receipt object in body of request opts = { + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -3465,6 +3673,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **receipts** | [**Receipts**](Receipts.md)| Receipts with an array of Receipt object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] ### Return type @@ -3483,7 +3692,7 @@ Name | Type | Description | Notes ## create_receipt_attachment_by_file_name -> Attachments create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) +> Attachments create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, opts) Creates an attachment on a specific expense claim receipts by file name @@ -3512,13 +3721,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Receipt -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +receipt_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Receipt +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an attachment on a specific expense claim receipts by file name - result = api_instance.create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) + result = api_instance.create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_receipt_attachment_by_file_name: #{e}" @@ -3531,9 +3744,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **receipt_id** | [**String**](.md)| Unique identifier for a Receipt | + **receipt_id** | **String**| Unique identifier for a Receipt | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3551,7 +3765,7 @@ Name | Type | Description | Notes ## create_receipt_history -> HistoryRecords create_receipt_history(xero_tenant_id, receipt_id, history_records) +> HistoryRecords create_receipt_history(xero_tenant_id, receipt_id, history_records, opts) Creates a history record for a specific receipt @@ -3580,12 +3794,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Receipt +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +receipt_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Receipt history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific receipt - result = api_instance.create_receipt_history(xero_tenant_id, receipt_id, history_records) + result = api_instance.create_receipt_history(xero_tenant_id, receipt_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_receipt_history: #{e}" @@ -3598,8 +3816,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **receipt_id** | [**String**](.md)| Unique identifier for a Receipt | + **receipt_id** | **String**| Unique identifier for a Receipt | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3617,7 +3836,7 @@ Name | Type | Description | Notes ## create_repeating_invoice_attachment_by_file_name -> Attachments create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) +> Attachments create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, opts) Creates an attachment from a specific repeating invoices by file name @@ -3646,13 +3865,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Repeating Invoice -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +repeating_invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Repeating Invoice +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an attachment from a specific repeating invoices by file name - result = api_instance.create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) + result = api_instance.create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_repeating_invoice_attachment_by_file_name: #{e}" @@ -3665,9 +3888,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **repeating_invoice_id** | [**String**](.md)| Unique identifier for a Repeating Invoice | + **repeating_invoice_id** | **String**| Unique identifier for a Repeating Invoice | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3685,7 +3909,7 @@ Name | Type | Description | Notes ## create_repeating_invoice_history -> HistoryRecords create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records) +> HistoryRecords create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records, opts) Creates a history record for a specific repeating invoice @@ -3714,12 +3938,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Repeating Invoice +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +repeating_invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Repeating Invoice history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific repeating invoice - result = api_instance.create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records) + result = api_instance.create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_repeating_invoice_history: #{e}" @@ -3732,8 +3960,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **repeating_invoice_id** | [**String**](.md)| Unique identifier for a Repeating Invoice | + **repeating_invoice_id** | **String**| Unique identifier for a Repeating Invoice | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3780,10 +4009,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant repeating_invoices = { "RepeatingInvoices": [ { "Schedule": { "Period": 1, "Unit": "MONTHLY", "DueDate": 10, "DueDateType": "OFFOLLOWINGMONTH", "StartDate": "\/Date(1555286400000+0000)\/" }, "Type": "ACCREC", "Reference": "[Week]", "ApprovedForSending": false, "SendCopy": false, "MarkAsSent": false, "IncludePDF": false, "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8", "Name": "Liam Gallagher" }, "Status": "AUTHORISED", "LineAmountTypes": "Exclusive", "LineItems": [ { "Description": "Guitars Fender Strat", "UnitAmount": 5000.00, "TaxType": "OUTPUT2", "TaxAmount": 750.00, "LineAmount": 5000.00, "AccountCode": "200", "Tracking": [], "Quantity": 1.0000, "LineItemID": "13a8353c-d2af-4d5b-920c-438449f08900", "DiscountEnteredAsPercent": true } ], "CurrencyCode": "NZD" } ] } # RepeatingInvoices | RepeatingInvoices with an array of repeating invoice objects in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -3802,6 +4033,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **repeating_invoices** | [**RepeatingInvoices**](RepeatingInvoices.md)| RepeatingInvoices with an array of repeating invoice objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -3820,7 +4052,7 @@ Name | Type | Description | Notes ## create_tax_rates -> TaxRates create_tax_rates(xero_tenant_id, tax_rates) +> TaxRates create_tax_rates(xero_tenant_id, tax_rates, opts) Creates one or more tax rates @@ -3849,11 +4081,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant tax_rates = { "TaxRates": [ { "Name": "CA State Tax", "TaxComponents": [ { "Name": "State Tax", "Rate": 2.25 } ] } ] } # TaxRates | TaxRates array with TaxRate object in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates one or more tax rates - result = api_instance.create_tax_rates(xero_tenant_id, tax_rates) + result = api_instance.create_tax_rates(xero_tenant_id, tax_rates, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_tax_rates: #{e}" @@ -3867,6 +4103,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **tax_rates** | [**TaxRates**](TaxRates.md)| TaxRates array with TaxRate object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3884,7 +4121,7 @@ Name | Type | Description | Notes ## create_tracking_category -> TrackingCategories create_tracking_category(xero_tenant_id, tracking_category) +> TrackingCategories create_tracking_category(xero_tenant_id, tracking_category, opts) Create tracking categories @@ -3913,11 +4150,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant tracking_category = { name: "FooBar" } # TrackingCategory | TrackingCategory object in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Create tracking categories - result = api_instance.create_tracking_category(xero_tenant_id, tracking_category) + result = api_instance.create_tracking_category(xero_tenant_id, tracking_category, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_tracking_category: #{e}" @@ -3931,6 +4172,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **tracking_category** | [**TrackingCategory**](TrackingCategory.md)| TrackingCategory object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3948,7 +4190,7 @@ Name | Type | Description | Notes ## create_tracking_options -> TrackingOptions create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option) +> TrackingOptions create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option, opts) Creates options for a specific tracking category @@ -3977,12 +4219,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -tracking_category_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a TrackingCategory +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +tracking_category_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a TrackingCategory tracking_option = { name: " Bar" } # TrackingOption | TrackingOption object in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates options for a specific tracking category - result = api_instance.create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option) + result = api_instance.create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_tracking_options: #{e}" @@ -3995,8 +4241,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **tracking_category_id** | [**String**](.md)| Unique identifier for a TrackingCategory | + **tracking_category_id** | **String**| Unique identifier for a TrackingCategory | **tracking_option** | [**TrackingOption**](TrackingOption.md)| TrackingOption object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4043,8 +4290,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -account_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Account object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +account_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Account object begin #Deletes a chart of accounts result = api_instance.delete_account(xero_tenant_id, account_id) @@ -4060,7 +4307,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **account_id** | [**String**](.md)| Unique identifier for Account object | + **account_id** | **String**| Unique identifier for Account object | ### Return type @@ -4078,7 +4325,7 @@ Name | Type | Description | Notes ## delete_batch_payment -> BatchPayments delete_batch_payment(xero_tenant_id, batch_payment_delete) +> BatchPayments delete_batch_payment(xero_tenant_id, batch_payment_delete, opts) Updates a specific batch payment for invoices and credit notes @@ -4107,11 +4354,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant batch_payment_delete = { "BatchPaymentID": "9bf296e9-0748-4d29-a3dc-24dde1098030", "Status":"DELETED" } # BatchPaymentDelete | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific batch payment for invoices and credit notes - result = api_instance.delete_batch_payment(xero_tenant_id, batch_payment_delete) + result = api_instance.delete_batch_payment(xero_tenant_id, batch_payment_delete, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->delete_batch_payment: #{e}" @@ -4125,6 +4376,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **batch_payment_delete** | [**BatchPaymentDelete**](BatchPaymentDelete.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4142,7 +4394,7 @@ Name | Type | Description | Notes ## delete_batch_payment_by_url_param -> BatchPayments delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param) +> BatchPayments delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param, opts) Updates a specific batch payment for invoices and credit notes @@ -4171,12 +4423,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -batch_payment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for BatchPayment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +batch_payment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for BatchPayment batch_payment_delete_by_url_param = { "Status":"DELETED" } # BatchPaymentDeleteByUrlParam | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific batch payment for invoices and credit notes - result = api_instance.delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param) + result = api_instance.delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->delete_batch_payment_by_url_param: #{e}" @@ -4189,8 +4445,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **batch_payment_id** | [**String**](.md)| Unique identifier for BatchPayment | + **batch_payment_id** | **String**| Unique identifier for BatchPayment | **batch_payment_delete_by_url_param** | [**BatchPaymentDeleteByUrlParam**](BatchPaymentDeleteByUrlParam.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4237,9 +4494,9 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_group_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact Group -contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_group_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact Group +contact_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact begin #Deletes a specific contact from a contact group using a unique contact Id api_instance.delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id) @@ -4254,8 +4511,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_group_id** | [**String**](.md)| Unique identifier for a Contact Group | - **contact_id** | [**String**](.md)| Unique identifier for a Contact | + **contact_group_id** | **String**| Unique identifier for a Contact Group | + **contact_id** | **String**| Unique identifier for a Contact | ### Return type @@ -4302,8 +4559,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_group_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact Group +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_group_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact Group begin #Deletes all contacts from a specific contact group api_instance.delete_contact_group_contacts(xero_tenant_id, contact_group_id) @@ -4318,7 +4575,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_group_id** | [**String**](.md)| Unique identifier for a Contact Group | + **contact_group_id** | **String**| Unique identifier for a Contact Group | ### Return type @@ -4334,6 +4591,72 @@ nil (empty response body) - **Accept**: Not defined +## delete_credit_note_allocations + +> Allocation delete_credit_note_allocations(xero_tenant_id, credit_note_id, allocation_id) + +Deletes an Allocation from a Credit Note + +### 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, :app_store_api] + +api_instance = xero_client. + + + +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +credit_note_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Credit Note +allocation_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Allocation object +begin + #Deletes an Allocation from a Credit Note + result = api_instance.delete_credit_note_allocations(xero_tenant_id, credit_note_id, allocation_id) + p result +rescue XeroRuby::Accounting::ApiError => e + puts "Exception when calling AccountingApi->delete_credit_note_allocations: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **String**| Xero identifier for Tenant | + **credit_note_id** | **String**| Unique identifier for a Credit Note | + **allocation_id** | **String**| Unique identifier for Allocation object | + +### Return type + +[**Allocation**](Allocation.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + ## delete_item > delete_item(xero_tenant_id, item_id) @@ -4365,8 +4688,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -item_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Item +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +item_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Item begin #Deletes a specific item api_instance.delete_item(xero_tenant_id, item_id) @@ -4381,7 +4704,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **item_id** | [**String**](.md)| Unique identifier for an Item | + **item_id** | **String**| Unique identifier for an Item | ### Return type @@ -4428,8 +4751,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -linked_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a LinkedTransaction +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +linked_transaction_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a LinkedTransaction begin #Deletes a specific linked transactions (billable expenses) api_instance.delete_linked_transaction(xero_tenant_id, linked_transaction_id) @@ -4444,7 +4767,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **linked_transaction_id** | [**String**](.md)| Unique identifier for a LinkedTransaction | + **linked_transaction_id** | **String**| Unique identifier for a LinkedTransaction | ### Return type @@ -4460,9 +4783,75 @@ nil (empty response body) - **Accept**: application/json +## delete_overpayment_allocations + +> Allocation delete_overpayment_allocations(xero_tenant_id, overpayment_id, allocation_id) + +Deletes an Allocation from an overpayment + +### 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, :app_store_api] + +api_instance = xero_client. + + + +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +overpayment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Overpayment +allocation_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Allocation object +begin + #Deletes an Allocation from an overpayment + result = api_instance.delete_overpayment_allocations(xero_tenant_id, overpayment_id, allocation_id) + p result +rescue XeroRuby::Accounting::ApiError => e + puts "Exception when calling AccountingApi->delete_overpayment_allocations: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **String**| Xero identifier for Tenant | + **overpayment_id** | **String**| Unique identifier for a Overpayment | + **allocation_id** | **String**| Unique identifier for Allocation object | + +### Return type + +[**Allocation**](Allocation.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + ## delete_payment -> Payments delete_payment(xero_tenant_id, payment_id, payment_delete) +> Payments delete_payment(xero_tenant_id, payment_id, payment_delete, opts) Updates a specific payment for invoices and credit notes @@ -4491,12 +4880,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -payment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Payment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +payment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Payment payment_delete = { "Payments":[ { "Status":"DELETED" } ] } # PaymentDelete | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific payment for invoices and credit notes - result = api_instance.delete_payment(xero_tenant_id, payment_id, payment_delete) + result = api_instance.delete_payment(xero_tenant_id, payment_id, payment_delete, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->delete_payment: #{e}" @@ -4509,8 +4902,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **payment_id** | [**String**](.md)| Unique identifier for a Payment | + **payment_id** | **String**| Unique identifier for a Payment | **payment_delete** | [**PaymentDelete**](PaymentDelete.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4526,6 +4920,72 @@ Name | Type | Description | Notes - **Accept**: application/json +## delete_prepayment_allocations + +> Allocation delete_prepayment_allocations(xero_tenant_id, prepayment_id, allocation_id) + +Deletes an Allocation from a Prepayment + +### 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, :app_store_api] + +api_instance = xero_client. + + + +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +prepayment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a PrePayment +allocation_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Allocation object +begin + #Deletes an Allocation from a Prepayment + result = api_instance.delete_prepayment_allocations(xero_tenant_id, prepayment_id, allocation_id) + p result +rescue XeroRuby::Accounting::ApiError => e + puts "Exception when calling AccountingApi->delete_prepayment_allocations: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **String**| Xero identifier for Tenant | + **prepayment_id** | **String**| Unique identifier for a PrePayment | + **allocation_id** | **String**| Unique identifier for Allocation object | + +### Return type + +[**Allocation**](Allocation.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + ## delete_tracking_category > TrackingCategories delete_tracking_category(xero_tenant_id, tracking_category_id) @@ -4557,8 +5017,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -tracking_category_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a TrackingCategory +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +tracking_category_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a TrackingCategory begin #Deletes a specific tracking category result = api_instance.delete_tracking_category(xero_tenant_id, tracking_category_id) @@ -4574,7 +5034,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **tracking_category_id** | [**String**](.md)| Unique identifier for a TrackingCategory | + **tracking_category_id** | **String**| Unique identifier for a TrackingCategory | ### Return type @@ -4621,9 +5081,9 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -tracking_category_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a TrackingCategory -tracking_option_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Tracking Option +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +tracking_category_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a TrackingCategory +tracking_option_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Tracking Option begin #Deletes a specific option for a specific tracking category result = api_instance.delete_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id) @@ -4639,8 +5099,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **tracking_category_id** | [**String**](.md)| Unique identifier for a TrackingCategory | - **tracking_option_id** | [**String**](.md)| Unique identifier for a Tracking Option | + **tracking_category_id** | **String**| Unique identifier for a TrackingCategory | + **tracking_option_id** | **String**| Unique identifier for a Tracking Option | ### Return type @@ -4658,7 +5118,7 @@ Name | Type | Description | Notes ## email_invoice -> email_invoice(xero_tenant_id, invoice_id, request_empty) +> email_invoice(xero_tenant_id, invoice_id, request_empty, opts) Sends a copy of a specific invoice to related contact via email @@ -4687,12 +5147,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Invoice request_empty = {} # RequestEmpty | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Sends a copy of a specific invoice to related contact via email - api_instance.email_invoice(xero_tenant_id, invoice_id, request_empty) + api_instance.email_invoice(xero_tenant_id, invoice_id, request_empty, opts) rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->email_invoice: #{e}" end @@ -4704,8 +5168,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | + **invoice_id** | **String**| Unique identifier for an Invoice | **request_empty** | [**RequestEmpty**](RequestEmpty.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4752,8 +5217,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -account_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Account object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +account_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Account object begin #Retrieves a single chart of accounts by using a unique account Id result = api_instance.get_account(xero_tenant_id, account_id) @@ -4769,7 +5234,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **account_id** | [**String**](.md)| Unique identifier for Account object | + **account_id** | **String**| Unique identifier for Account object | ### Return type @@ -4816,10 +5281,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -account_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Account object -file_name = 'xero-dev.jpg' # String | Name of the attachment -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +account_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Account object +file_name = xero-dev.jpg # String | Name of the attachment +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves an attachment for a specific account by filename result = api_instance.get_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, content_type) @@ -4835,7 +5300,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **account_id** | [**String**](.md)| Unique identifier for Account object | + **account_id** | **String**| Unique identifier for Account object | **file_name** | **String**| Name of the attachment | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | @@ -4884,10 +5349,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -account_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Account object -attachment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Attachment object -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +account_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Account object +attachment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Attachment object +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment from a specific account using a unique attachment Id result = api_instance.get_account_attachment_by_id(xero_tenant_id, account_id, attachment_id, content_type) @@ -4903,8 +5368,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **account_id** | [**String**](.md)| Unique identifier for Account object | - **attachment_id** | [**String**](.md)| Unique identifier for Attachment object | + **account_id** | **String**| Unique identifier for Account object | + **attachment_id** | **String**| Unique identifier for Attachment object | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | ### Return type @@ -4952,8 +5417,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -account_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Account object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +account_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Account object begin #Retrieves attachments for a specific accounts by using a unique account Id result = api_instance.get_account_attachments(xero_tenant_id, account_id) @@ -4969,7 +5434,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **account_id** | [**String**](.md)| Unique identifier for Account object | + **account_id** | **String**| Unique identifier for Account object | ### Return type @@ -5016,13 +5481,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status=="ACTIVE" AND Type=="BANK"', # String | Filter by an any element + where: Status=="ACTIVE" AND Type=="BANK", # String | Filter by an any element - order: 'Name ASC' # String | Order by an any element + order: Name ASC # String | Order by an any element } begin @@ -5040,7 +5505,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] @@ -5089,8 +5554,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transaction +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transaction_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transaction opts = { unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -5110,7 +5575,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transaction_id** | [**String**](.md)| Xero generated unique identifier for a bank transaction | + **bank_transaction_id** | **String**| Xero generated unique identifier for a bank transaction | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] ### Return type @@ -5158,10 +5623,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transaction -file_name = 'xero-dev.jpg' # String | Name of the attachment -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transaction_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transaction +file_name = xero-dev.jpg # String | Name of the attachment +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment from a specific bank transaction by filename result = api_instance.get_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, content_type) @@ -5177,7 +5642,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transaction_id** | [**String**](.md)| Xero generated unique identifier for a bank transaction | + **bank_transaction_id** | **String**| Xero generated unique identifier for a bank transaction | **file_name** | **String**| Name of the attachment | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | @@ -5226,10 +5691,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transaction -attachment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Attachment object -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transaction_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transaction +attachment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Attachment object +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves specific attachments from a specific BankTransaction using a unique attachment Id result = api_instance.get_bank_transaction_attachment_by_id(xero_tenant_id, bank_transaction_id, attachment_id, content_type) @@ -5245,8 +5710,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transaction_id** | [**String**](.md)| Xero generated unique identifier for a bank transaction | - **attachment_id** | [**String**](.md)| Unique identifier for Attachment object | + **bank_transaction_id** | **String**| Xero generated unique identifier for a bank transaction | + **attachment_id** | **String**| Unique identifier for Attachment object | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | ### Return type @@ -5294,8 +5759,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transaction +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transaction_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transaction begin #Retrieves any attachments from a specific bank transactions result = api_instance.get_bank_transaction_attachments(xero_tenant_id, bank_transaction_id) @@ -5311,7 +5776,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transaction_id** | [**String**](.md)| Xero generated unique identifier for a bank transaction | + **bank_transaction_id** | **String**| Xero generated unique identifier for a bank transaction | ### Return type @@ -5358,13 +5823,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"AUTHORISED\"', # String | Filter by an any element + where: Status=="AUTHORISED", # String | Filter by an any element - order: 'Type ASC', # String | Order by an any element + order: Type ASC, # String | Order by an any element page: 1, # Integer | Up to 100 bank transactions will be returned in a single API call with line items details @@ -5386,7 +5851,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| Up to 100 bank transactions will be returned in a single API call with line items details | [optional] @@ -5437,8 +5902,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transaction +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transaction_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transaction begin #Retrieves history from a specific bank transaction using a unique bank transaction Id result = api_instance.get_bank_transactions_history(xero_tenant_id, bank_transaction_id) @@ -5454,7 +5919,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transaction_id** | [**String**](.md)| Xero generated unique identifier for a bank transaction | + **bank_transaction_id** | **String**| Xero generated unique identifier for a bank transaction | ### Return type @@ -5501,8 +5966,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transfer +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transfer_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transfer begin #Retrieves specific bank transfers by using a unique bank transfer Id result = api_instance.get_bank_transfer(xero_tenant_id, bank_transfer_id) @@ -5518,7 +5983,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transfer_id** | [**String**](.md)| Xero generated unique identifier for a bank transfer | + **bank_transfer_id** | **String**| Xero generated unique identifier for a bank transfer | ### Return type @@ -5565,10 +6030,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transfer -file_name = 'xero-dev.jpg' # String | Name of the attachment -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transfer_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transfer +file_name = xero-dev.jpg # String | Name of the attachment +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment on a specific bank transfer by file name result = api_instance.get_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, content_type) @@ -5584,7 +6049,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transfer_id** | [**String**](.md)| Xero generated unique identifier for a bank transfer | + **bank_transfer_id** | **String**| Xero generated unique identifier for a bank transfer | **file_name** | **String**| Name of the attachment | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | @@ -5633,10 +6098,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transfer -attachment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Attachment object -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transfer_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transfer +attachment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Attachment object +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment from a specific bank transfer using a unique attachment ID result = api_instance.get_bank_transfer_attachment_by_id(xero_tenant_id, bank_transfer_id, attachment_id, content_type) @@ -5652,8 +6117,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transfer_id** | [**String**](.md)| Xero generated unique identifier for a bank transfer | - **attachment_id** | [**String**](.md)| Unique identifier for Attachment object | + **bank_transfer_id** | **String**| Xero generated unique identifier for a bank transfer | + **attachment_id** | **String**| Unique identifier for Attachment object | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | ### Return type @@ -5701,8 +6166,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transfer +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transfer_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transfer begin #Retrieves attachments from a specific bank transfer result = api_instance.get_bank_transfer_attachments(xero_tenant_id, bank_transfer_id) @@ -5718,7 +6183,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transfer_id** | [**String**](.md)| Xero generated unique identifier for a bank transfer | + **bank_transfer_id** | **String**| Xero generated unique identifier for a bank transfer | ### Return type @@ -5765,8 +6230,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transfer +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transfer_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transfer begin #Retrieves history from a specific bank transfer using a unique bank transfer Id result = api_instance.get_bank_transfer_history(xero_tenant_id, bank_transfer_id) @@ -5782,7 +6247,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transfer_id** | [**String**](.md)| Xero generated unique identifier for a bank transfer | + **bank_transfer_id** | **String**| Xero generated unique identifier for a bank transfer | ### Return type @@ -5829,13 +6294,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'HasAttachments==true', # String | Filter by an any element + where: HasAttachments==true, # String | Filter by an any element - order: 'Amount ASC' # String | Order by an any element + order: Amount ASC # String | Order by an any element } begin @@ -5853,7 +6318,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] @@ -5902,8 +6367,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -batch_payment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for BatchPayment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +batch_payment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for BatchPayment begin #Retrieves a specific batch payment using a unique batch payment Id result = api_instance.get_batch_payment(xero_tenant_id, batch_payment_id) @@ -5919,7 +6384,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **batch_payment_id** | [**String**](.md)| Unique identifier for BatchPayment | + **batch_payment_id** | **String**| Unique identifier for BatchPayment | ### Return type @@ -5966,8 +6431,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -batch_payment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for BatchPayment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +batch_payment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for BatchPayment begin #Retrieves history from a specific batch payment result = api_instance.get_batch_payment_history(xero_tenant_id, batch_payment_id) @@ -5983,7 +6448,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **batch_payment_id** | [**String**](.md)| Unique identifier for BatchPayment | + **batch_payment_id** | **String**| Unique identifier for BatchPayment | ### Return type @@ -6030,13 +6495,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"AUTHORISED\"', # String | Filter by an any element + where: Status=="AUTHORISED", # String | Filter by an any element - order: 'Date ASC' # String | Order by an any element + order: Date ASC # String | Order by an any element } begin @@ -6054,7 +6519,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] @@ -6103,8 +6568,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -branding_theme_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Branding Theme +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +branding_theme_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Branding Theme begin #Retrieves a specific branding theme using a unique branding theme Id result = api_instance.get_branding_theme(xero_tenant_id, branding_theme_id) @@ -6120,7 +6585,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **branding_theme_id** | [**String**](.md)| Unique identifier for a Branding Theme | + **branding_theme_id** | **String**| Unique identifier for a Branding Theme | ### Return type @@ -6167,8 +6632,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -branding_theme_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Branding Theme +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +branding_theme_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Branding Theme begin #Retrieves the payment services for a specific branding theme result = api_instance.get_branding_theme_payment_services(xero_tenant_id, branding_theme_id) @@ -6184,7 +6649,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **branding_theme_id** | [**String**](.md)| Unique identifier for a Branding Theme | + **branding_theme_id** | **String**| Unique identifier for a Branding Theme | ### Return type @@ -6231,7 +6696,7 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant begin #Retrieves all the branding themes result = api_instance.get_branding_themes(xero_tenant_id) @@ -6293,12 +6758,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -budget_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Budgets +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +budget_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Budgets opts = { - date_to: Date.parse('2019-10-31'), # Date | Filter by start date + date_to: 2019-10-31, # Date | Filter by start date - date_from: Date.parse('2019-10-31') # Date | Filter by end date + date_from: 2019-10-31 # Date | Filter by end date } begin @@ -6316,7 +6781,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **budget_id** | [**String**](.md)| Unique identifier for Budgets | + **budget_id** | **String**| Unique identifier for Budgets | **date_to** | **Date**| Filter by start date | [optional] **date_from** | **Date**| Filter by end date | [optional] @@ -6365,13 +6830,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - i_ds: ['"00000000-0000-0000-0000-000000000000"'], # Array | Filter by BudgetID. Allows you to retrieve a specific individual budget. + ids: "00000000-0000-0000-0000-000000000000", # Array | Filter by BudgetID. Allows you to retrieve a specific individual budget. - date_to: Date.parse('2019-10-31'), # Date | Filter by start date + date_to: 2019-10-31, # Date | Filter by start date - date_from: Date.parse('2019-10-31') # Date | Filter by end date + date_from: 2019-10-31 # Date | Filter by end date } begin @@ -6389,7 +6854,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **i_ds** | [**Array<String>**](String.md)| Filter by BudgetID. Allows you to retrieve a specific individual budget. | [optional] + **ids** | [**Array<String>**](String.md)| Filter by BudgetID. Allows you to retrieve a specific individual budget. | [optional] **date_to** | **Date**| Filter by start date | [optional] **date_from** | **Date**| Filter by end date | [optional] @@ -6438,8 +6903,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact begin #Retrieves a specific contacts in a Xero organisation using a unique contact Id result = api_instance.get_contact(xero_tenant_id, contact_id) @@ -6455,7 +6920,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_id** | [**String**](.md)| Unique identifier for a Contact | + **contact_id** | **String**| Unique identifier for a Contact | ### Return type @@ -6502,10 +6967,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact -file_name = 'xero-dev.jpg' # String | Name of the attachment -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact +file_name = xero-dev.jpg # String | Name of the attachment +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment from a specific contact by file name result = api_instance.get_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, content_type) @@ -6521,7 +6986,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_id** | [**String**](.md)| Unique identifier for a Contact | + **contact_id** | **String**| Unique identifier for a Contact | **file_name** | **String**| Name of the attachment | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | @@ -6570,10 +7035,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact -attachment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Attachment object -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact +attachment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Attachment object +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment from a specific contact using a unique attachment Id result = api_instance.get_contact_attachment_by_id(xero_tenant_id, contact_id, attachment_id, content_type) @@ -6589,8 +7054,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_id** | [**String**](.md)| Unique identifier for a Contact | - **attachment_id** | [**String**](.md)| Unique identifier for Attachment object | + **contact_id** | **String**| Unique identifier for a Contact | + **attachment_id** | **String**| Unique identifier for Attachment object | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | ### Return type @@ -6638,8 +7103,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact begin #Retrieves attachments for a specific contact in a Xero organisation result = api_instance.get_contact_attachments(xero_tenant_id, contact_id) @@ -6655,7 +7120,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_id** | [**String**](.md)| Unique identifier for a Contact | + **contact_id** | **String**| Unique identifier for a Contact | ### Return type @@ -6702,8 +7167,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_number = 'SB2' # String | This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_number = SB2 # String | This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). begin #Retrieves a specific contact by contact number in a Xero organisation result = api_instance.get_contact_by_contact_number(xero_tenant_id, contact_number) @@ -6766,8 +7231,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact begin #Retrieves CIS settings for a specific contact in a Xero organisation result = api_instance.get_contact_cis_settings(xero_tenant_id, contact_id) @@ -6783,7 +7248,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_id** | [**String**](.md)| Unique identifier for a Contact | + **contact_id** | **String**| Unique identifier for a Contact | ### Return type @@ -6830,8 +7295,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_group_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact Group +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_group_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact Group begin #Retrieves a specific contact group by using a unique contact group Id result = api_instance.get_contact_group(xero_tenant_id, contact_group_id) @@ -6847,7 +7312,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_group_id** | [**String**](.md)| Unique identifier for a Contact Group | + **contact_group_id** | **String**| Unique identifier for a Contact Group | ### Return type @@ -6894,11 +7359,11 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - where: 'Status==\"ACTIVE\"', # String | Filter by an any element + where: Status=="ACTIVE", # String | Filter by an any element - order: 'Name ASC' # String | Order by an any element + order: Name ASC # String | Order by an any element } begin @@ -6964,8 +7429,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact begin #Retrieves history records for a specific contact result = api_instance.get_contact_history(xero_tenant_id, contact_id) @@ -6981,7 +7446,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_id** | [**String**](.md)| Unique identifier for a Contact | + **contact_id** | **String**| Unique identifier for a Contact | ### Return type @@ -7028,23 +7493,23 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'ContactStatus=="ACTIVE"', # String | Filter by an any element + where: ContactStatus=="ACTIVE", # String | Filter by an any element - order: 'Name ASC', # String | Order by an any element + order: Name ASC, # String | Order by an any element - i_ds: ['"00000000-0000-0000-0000-000000000000"'], # Array | Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. + ids: "00000000-0000-0000-0000-000000000000", # Array | Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. page: 1, # Integer | e.g. page=1 - Up to 100 contacts will be returned in a single API call. include_archived: true, # Boolean | e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response - summary_only: false, # Boolean | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. + summary_only: true, # Boolean | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. - search_term: 'Joe Bloggs' # String | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. + search_term: Joe Bloggs # String | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. } begin @@ -7062,10 +7527,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] - **i_ds** | [**Array<String>**](String.md)| Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. | [optional] + **ids** | [**Array<String>**](String.md)| Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. | [optional] **page** | **Integer**| e.g. page=1 - Up to 100 contacts will be returned in a single API call. | [optional] **include_archived** | **Boolean**| e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response | [optional] **summary_only** | **Boolean**| Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. | [optional] [default to false] @@ -7116,8 +7581,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +credit_note_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Credit Note opts = { unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -7137,7 +7602,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | + **credit_note_id** | **String**| Unique identifier for a Credit Note | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] ### Return type @@ -7185,8 +7650,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +credit_note_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Credit Note begin #Retrieves credit notes as PDF files result = api_instance.get_credit_note_as_pdf(xero_tenant_id, credit_note_id) @@ -7202,7 +7667,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | + **credit_note_id** | **String**| Unique identifier for a Credit Note | ### Return type @@ -7249,10 +7714,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note -file_name = 'xero-dev.jpg' # String | Name of the attachment -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +credit_note_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Credit Note +file_name = xero-dev.jpg # String | Name of the attachment +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment on a specific credit note by file name result = api_instance.get_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, content_type) @@ -7268,7 +7733,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | + **credit_note_id** | **String**| Unique identifier for a Credit Note | **file_name** | **String**| Name of the attachment | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | @@ -7317,10 +7782,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note -attachment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Attachment object -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +credit_note_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Credit Note +attachment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Attachment object +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment from a specific credit note using a unique attachment Id result = api_instance.get_credit_note_attachment_by_id(xero_tenant_id, credit_note_id, attachment_id, content_type) @@ -7336,8 +7801,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | - **attachment_id** | [**String**](.md)| Unique identifier for Attachment object | + **credit_note_id** | **String**| Unique identifier for a Credit Note | + **attachment_id** | **String**| Unique identifier for Attachment object | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | ### Return type @@ -7385,8 +7850,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +credit_note_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Credit Note begin #Retrieves attachments for a specific credit notes result = api_instance.get_credit_note_attachments(xero_tenant_id, credit_note_id) @@ -7402,7 +7867,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | + **credit_note_id** | **String**| Unique identifier for a Credit Note | ### Return type @@ -7449,8 +7914,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +credit_note_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Credit Note begin #Retrieves history records of a specific credit note result = api_instance.get_credit_note_history(xero_tenant_id, credit_note_id) @@ -7466,7 +7931,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | + **credit_note_id** | **String**| Unique identifier for a Credit Note | ### Return type @@ -7513,13 +7978,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"DRAFT\"', # String | Filter by an any element + where: Status=="DRAFT", # String | Filter by an any element - order: 'CreditNoteNumber ASC', # String | Order by an any element + order: CreditNoteNumber ASC, # String | Order by an any element page: 1, # Integer | e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note @@ -7541,7 +8006,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note | [optional] @@ -7592,11 +8057,11 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - where: 'Code==\"USD\"', # String | Filter by an any element + where: Code=="USD", # String | Filter by an any element - order: 'Code ASC' # String | Order by an any element + order: Code ASC # String | Order by an any element } begin @@ -7662,8 +8127,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -employee_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Employee +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +employee_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Employee begin #Retrieves a specific employee used in Xero payrun using a unique employee Id result = api_instance.get_employee(xero_tenant_id, employee_id) @@ -7679,7 +8144,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Unique identifier for a Employee | + **employee_id** | **String**| Unique identifier for a Employee | ### Return type @@ -7726,13 +8191,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"ACTIVE\"', # String | Filter by an any element + where: Status=="ACTIVE", # String | Filter by an any element - order: 'LastName ASC' # String | Order by an any element + order: LastName ASC # String | Order by an any element } begin @@ -7750,7 +8215,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] @@ -7799,8 +8264,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -expense_claim_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ExpenseClaim +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +expense_claim_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a ExpenseClaim begin #Retrieves a specific expense claim using a unique expense claim Id result = api_instance.get_expense_claim(xero_tenant_id, expense_claim_id) @@ -7816,7 +8281,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **expense_claim_id** | [**String**](.md)| Unique identifier for a ExpenseClaim | + **expense_claim_id** | **String**| Unique identifier for a ExpenseClaim | ### Return type @@ -7863,8 +8328,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -expense_claim_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ExpenseClaim +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +expense_claim_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a ExpenseClaim begin #Retrieves history records of a specific expense claim result = api_instance.get_expense_claim_history(xero_tenant_id, expense_claim_id) @@ -7880,7 +8345,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **expense_claim_id** | [**String**](.md)| Unique identifier for a ExpenseClaim | + **expense_claim_id** | **String**| Unique identifier for a ExpenseClaim | ### Return type @@ -7927,13 +8392,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"SUBMITTED\"', # String | Filter by an any element + where: Status=="SUBMITTED", # String | Filter by an any element - order: 'Status ASC' # String | Order by an any element + order: Status ASC # String | Order by an any element } begin @@ -7951,7 +8416,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] @@ -8000,8 +8465,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Invoice opts = { unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -8021,7 +8486,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | + **invoice_id** | **String**| Unique identifier for an Invoice | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] ### Return type @@ -8069,8 +8534,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Invoice begin #Retrieves invoices or purchase bills as PDF files result = api_instance.get_invoice_as_pdf(xero_tenant_id, invoice_id) @@ -8086,7 +8551,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | + **invoice_id** | **String**| Unique identifier for an Invoice | ### Return type @@ -8133,10 +8598,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice -file_name = 'xero-dev.jpg' # String | Name of the attachment -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Invoice +file_name = xero-dev.jpg # String | Name of the attachment +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves an attachment from a specific invoice or purchase bill by filename result = api_instance.get_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, content_type) @@ -8152,7 +8617,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | + **invoice_id** | **String**| Unique identifier for an Invoice | **file_name** | **String**| Name of the attachment | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | @@ -8201,10 +8666,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice -attachment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Attachment object -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Invoice +attachment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Attachment object +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id result = api_instance.get_invoice_attachment_by_id(xero_tenant_id, invoice_id, attachment_id, content_type) @@ -8220,8 +8685,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | - **attachment_id** | [**String**](.md)| Unique identifier for Attachment object | + **invoice_id** | **String**| Unique identifier for an Invoice | + **attachment_id** | **String**| Unique identifier for Attachment object | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | ### Return type @@ -8269,8 +8734,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Invoice begin #Retrieves attachments for a specific invoice or purchase bill result = api_instance.get_invoice_attachments(xero_tenant_id, invoice_id) @@ -8286,7 +8751,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | + **invoice_id** | **String**| Unique identifier for an Invoice | ### Return type @@ -8333,8 +8798,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Invoice begin #Retrieves history records for a specific invoice result = api_instance.get_invoice_history(xero_tenant_id, invoice_id) @@ -8350,7 +8815,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | + **invoice_id** | **String**| Unique identifier for an Invoice | ### Return type @@ -8397,7 +8862,7 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant begin #Retrieves invoice reminder settings result = api_instance.get_invoice_reminders(xero_tenant_id) @@ -8459,21 +8924,21 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"DRAFT\"', # String | Filter by an any element + where: Status=="DRAFT", # String | Filter by an any element - order: 'InvoiceNumber ASC', # String | Order by an any element + order: InvoiceNumber ASC, # String | Order by an any element - i_ds: ['"00000000-0000-0000-0000-000000000000"'], # Array | Filter by a comma-separated list of InvoicesIDs. + ids: "00000000-0000-0000-0000-000000000000", # Array | Filter by a comma-separated list of InvoicesIDs. - invoice_numbers: ['"INV-001", "INV-002"'], # Array | Filter by a comma-separated list of InvoiceNumbers. + invoice_numbers: "INV-001", "INV-002", # Array | Filter by a comma-separated list of InvoiceNumbers. - contact_i_ds: ['"00000000-0000-0000-0000-000000000000"'], # Array | Filter by a comma-separated list of ContactIDs. + contact_ids: "00000000-0000-0000-0000-000000000000", # Array | Filter by a comma-separated list of ContactIDs. - statuses: ['"DRAFT", "SUBMITTED"'], # Array | Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter. + statuses: "DRAFT", "SUBMITTED", # Array | Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter. page: 1, # Integer | e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice @@ -8483,7 +8948,7 @@ opts = { unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts - summary_only: false # Boolean | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. + summary_only: true # Boolean | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. } begin @@ -8501,12 +8966,12 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] - **i_ds** | [**Array<String>**](String.md)| Filter by a comma-separated list of InvoicesIDs. | [optional] + **ids** | [**Array<String>**](String.md)| Filter by a comma-separated list of InvoicesIDs. | [optional] **invoice_numbers** | [**Array<String>**](String.md)| Filter by a comma-separated list of InvoiceNumbers. | [optional] - **contact_i_ds** | [**Array<String>**](String.md)| Filter by a comma-separated list of ContactIDs. | [optional] + **contact_ids** | [**Array<String>**](String.md)| Filter by a comma-separated list of ContactIDs. | [optional] **statuses** | [**Array<String>**](String.md)| Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter. | [optional] **page** | **Integer**| e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice | [optional] **include_archived** | **Boolean**| e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response | [optional] @@ -8559,8 +9024,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -item_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Item +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +item_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Item opts = { unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -8580,7 +9045,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **item_id** | [**String**](.md)| Unique identifier for an Item | + **item_id** | **String**| Unique identifier for an Item | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] ### Return type @@ -8628,8 +9093,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -item_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Item +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +item_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Item begin #Retrieves history for a specific item result = api_instance.get_item_history(xero_tenant_id, item_id) @@ -8645,7 +9110,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **item_id** | [**String**](.md)| Unique identifier for an Item | + **item_id** | **String**| Unique identifier for an Item | ### Return type @@ -8692,13 +9157,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'IsSold==true', # String | Filter by an any element + where: IsSold==true, # String | Filter by an any element - order: 'Code ASC', # String | Order by an any element + order: Code ASC, # String | Order by an any element unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -8718,7 +9183,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -8768,8 +9233,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -journal_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Journal +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +journal_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Journal begin #Retrieves a specific journal using a unique journal Id. result = api_instance.get_journal(xero_tenant_id, journal_id) @@ -8785,7 +9250,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **journal_id** | [**String**](.md)| Unique identifier for a Journal | + **journal_id** | **String**| Unique identifier for a Journal | ### Return type @@ -8832,7 +9297,7 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant journal_number = 1000 # Integer | Number of a Journal begin #Retrieves a specific journal using a unique journal number. @@ -8896,9 +9361,9 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned offset: 10, # Integer | Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned @@ -8920,7 +9385,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **offset** | **Integer**| Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned | [optional] **payments_only** | **Boolean**| Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default. | [optional] @@ -8969,8 +9434,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -linked_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a LinkedTransaction +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +linked_transaction_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a LinkedTransaction begin #Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id result = api_instance.get_linked_transaction(xero_tenant_id, linked_transaction_id) @@ -8986,7 +9451,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **linked_transaction_id** | [**String**](.md)| Unique identifier for a LinkedTransaction | + **linked_transaction_id** | **String**| Unique identifier for a LinkedTransaction | ### Return type @@ -9033,19 +9498,19 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { page: 1, # Integer | Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1. - linked_transaction_id: '00000000-0000-0000-0000-000000000000', # String | The Xero identifier for an Linked Transaction + linked_transaction_id: 00000000-0000-0000-0000-000000000000, # String | The Xero identifier for an Linked Transaction - source_transaction_id: '00000000-0000-0000-0000-000000000000', # String | Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice + source_transaction_id: 00000000-0000-0000-0000-000000000000, # String | Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice - contact_id: '00000000-0000-0000-0000-000000000000', # String | Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer. + contact_id: 00000000-0000-0000-0000-000000000000, # String | Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer. - status: 'APPROVED', # String | Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status + status: APPROVED, # String | Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status - target_transaction_id: '00000000-0000-0000-0000-000000000000' # String | Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice + target_transaction_id: 00000000-0000-0000-0000-000000000000 # String | Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice } begin @@ -9064,11 +9529,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **page** | **Integer**| Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1. | [optional] - **linked_transaction_id** | [**String**](.md)| The Xero identifier for an Linked Transaction | [optional] - **source_transaction_id** | [**String**](.md)| Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice | [optional] - **contact_id** | [**String**](.md)| Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer. | [optional] + **linked_transaction_id** | **String**| The Xero identifier for an Linked Transaction | [optional] + **source_transaction_id** | **String**| Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice | [optional] + **contact_id** | **String**| Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer. | [optional] **status** | **String**| Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status | [optional] - **target_transaction_id** | [**String**](.md)| Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice | [optional] + **target_transaction_id** | **String**| Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice | [optional] ### Return type @@ -9115,8 +9580,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ManualJournal +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +manual_journal_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a ManualJournal begin #Retrieves a specific manual journal result = api_instance.get_manual_journal(xero_tenant_id, manual_journal_id) @@ -9132,7 +9597,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **manual_journal_id** | [**String**](.md)| Unique identifier for a ManualJournal | + **manual_journal_id** | **String**| Unique identifier for a ManualJournal | ### Return type @@ -9179,10 +9644,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ManualJournal -file_name = 'xero-dev.jpg' # String | Name of the attachment -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +manual_journal_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a ManualJournal +file_name = xero-dev.jpg # String | Name of the attachment +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment from a specific manual journal by file name result = api_instance.get_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, content_type) @@ -9198,7 +9663,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **manual_journal_id** | [**String**](.md)| Unique identifier for a ManualJournal | + **manual_journal_id** | **String**| Unique identifier for a ManualJournal | **file_name** | **String**| Name of the attachment | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | @@ -9247,10 +9712,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ManualJournal -attachment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Attachment object -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +manual_journal_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a ManualJournal +attachment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Attachment object +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id result = api_instance.get_manual_journal_attachment_by_id(xero_tenant_id, manual_journal_id, attachment_id, content_type) @@ -9266,8 +9731,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **manual_journal_id** | [**String**](.md)| Unique identifier for a ManualJournal | - **attachment_id** | [**String**](.md)| Unique identifier for Attachment object | + **manual_journal_id** | **String**| Unique identifier for a ManualJournal | + **attachment_id** | **String**| Unique identifier for Attachment object | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | ### Return type @@ -9315,8 +9780,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ManualJournal +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +manual_journal_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a ManualJournal begin #Retrieves attachment for a specific manual journal result = api_instance.get_manual_journal_attachments(xero_tenant_id, manual_journal_id) @@ -9332,7 +9797,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **manual_journal_id** | [**String**](.md)| Unique identifier for a ManualJournal | + **manual_journal_id** | **String**| Unique identifier for a ManualJournal | ### Return type @@ -9379,13 +9844,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"DRAFT\"', # String | Filter by an any element + where: Status=="DRAFT", # String | Filter by an any element - order: 'Date ASC', # String | Order by an any element + order: Date ASC, # String | Order by an any element page: 1 # Integer | e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment } @@ -9405,7 +9870,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment | [optional] @@ -9455,8 +9920,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ManualJournal +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +manual_journal_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a ManualJournal begin #Retrieves history for a specific manual journal result = api_instance.get_manual_journals_history(xero_tenant_id, manual_journal_id) @@ -9472,7 +9937,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **manual_journal_id** | [**String**](.md)| Unique identifier for a ManualJournal | + **manual_journal_id** | **String**| Unique identifier for a ManualJournal | ### Return type @@ -9519,8 +9984,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Invoice begin #Retrieves a URL to an online invoice result = api_instance.get_online_invoice(xero_tenant_id, invoice_id) @@ -9536,7 +10001,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | + **invoice_id** | **String**| Unique identifier for an Invoice | ### Return type @@ -9583,7 +10048,7 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant begin #Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation. result = api_instance.get_organisation_actions(xero_tenant_id) @@ -9645,8 +10110,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -organisation_id = '00000000-0000-0000-0000-000000000000' # String | The unique Xero identifier for an organisation +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +organisation_id = 00000000-0000-0000-0000-000000000000 # String | The unique Xero identifier for an organisation begin #Retrieves the CIS settings for the Xero organistaion. result = api_instance.get_organisation_cis_settings(xero_tenant_id, organisation_id) @@ -9662,7 +10127,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **organisation_id** | [**String**](.md)| The unique Xero identifier for an organisation | + **organisation_id** | **String**| The unique Xero identifier for an organisation | ### Return type @@ -9709,7 +10174,7 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant begin #Retrieves Xero organisation details result = api_instance.get_organisations(xero_tenant_id) @@ -9771,8 +10236,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -overpayment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Overpayment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +overpayment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Overpayment begin #Retrieves a specific overpayment using a unique overpayment Id result = api_instance.get_overpayment(xero_tenant_id, overpayment_id) @@ -9788,7 +10253,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **overpayment_id** | [**String**](.md)| Unique identifier for a Overpayment | + **overpayment_id** | **String**| Unique identifier for a Overpayment | ### Return type @@ -9835,8 +10300,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -overpayment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Overpayment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +overpayment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Overpayment begin #Retrieves history records of a specific overpayment result = api_instance.get_overpayment_history(xero_tenant_id, overpayment_id) @@ -9852,7 +10317,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **overpayment_id** | [**String**](.md)| Unique identifier for a Overpayment | + **overpayment_id** | **String**| Unique identifier for a Overpayment | ### Return type @@ -9899,13 +10364,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"AUTHORISED\"', # String | Filter by an any element + where: Status=="AUTHORISED", # String | Filter by an any element - order: 'Status ASC', # String | Order by an any element + order: Status ASC, # String | Order by an any element page: 1, # Integer | e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment @@ -9927,7 +10392,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment | [optional] @@ -9978,8 +10443,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -payment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Payment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +payment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Payment begin #Retrieves a specific payment for invoices and credit notes using a unique payment Id result = api_instance.get_payment(xero_tenant_id, payment_id) @@ -9995,7 +10460,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **payment_id** | [**String**](.md)| Unique identifier for a Payment | + **payment_id** | **String**| Unique identifier for a Payment | ### Return type @@ -10042,8 +10507,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -payment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Payment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +payment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Payment begin #Retrieves history records of a specific payment result = api_instance.get_payment_history(xero_tenant_id, payment_id) @@ -10059,7 +10524,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **payment_id** | [**String**](.md)| Unique identifier for a Payment | + **payment_id** | **String**| Unique identifier for a Payment | ### Return type @@ -10106,7 +10571,7 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant begin #Retrieves payment services result = api_instance.get_payment_services(xero_tenant_id) @@ -10168,13 +10633,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"AUTHORISED\"', # String | Filter by an any element + where: Status=="AUTHORISED", # String | Filter by an any element - order: 'Amount ASC', # String | Order by an any element + order: Amount ASC, # String | Order by an any element page: 1 # Integer | Up to 100 payments will be returned in a single API call } @@ -10194,7 +10659,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| Up to 100 payments will be returned in a single API call | [optional] @@ -10244,8 +10709,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -prepayment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a PrePayment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +prepayment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a PrePayment begin #Allows you to retrieve a specified prepayments result = api_instance.get_prepayment(xero_tenant_id, prepayment_id) @@ -10261,7 +10726,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **prepayment_id** | [**String**](.md)| Unique identifier for a PrePayment | + **prepayment_id** | **String**| Unique identifier for a PrePayment | ### Return type @@ -10308,8 +10773,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -prepayment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a PrePayment +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +prepayment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a PrePayment begin #Retrieves history record for a specific prepayment result = api_instance.get_prepayment_history(xero_tenant_id, prepayment_id) @@ -10325,7 +10790,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **prepayment_id** | [**String**](.md)| Unique identifier for a PrePayment | + **prepayment_id** | **String**| Unique identifier for a PrePayment | ### Return type @@ -10372,13 +10837,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"AUTHORISED\"', # String | Filter by an any element + where: Status=="AUTHORISED", # String | Filter by an any element - order: 'Reference ASC', # String | Order by an any element + order: Reference ASC, # String | Order by an any element page: 1, # Integer | e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment @@ -10400,7 +10865,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment | [optional] @@ -10451,8 +10916,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Purchase Order +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +purchase_order_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Purchase Order begin #Retrieves a specific purchase order using a unique purchase order Id result = api_instance.get_purchase_order(xero_tenant_id, purchase_order_id) @@ -10468,7 +10933,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **purchase_order_id** | [**String**](.md)| Unique identifier for an Purchase Order | + **purchase_order_id** | **String**| Unique identifier for an Purchase Order | ### Return type @@ -10515,8 +10980,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Purchase Order +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +purchase_order_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Purchase Order begin #Retrieves specific purchase order as PDF files using a unique purchase order Id result = api_instance.get_purchase_order_as_pdf(xero_tenant_id, purchase_order_id) @@ -10532,7 +10997,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **purchase_order_id** | [**String**](.md)| Unique identifier for an Purchase Order | + **purchase_order_id** | **String**| Unique identifier for an Purchase Order | ### Return type @@ -10579,10 +11044,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Purchase Order -file_name = 'xero-dev.jpg' # String | Name of the attachment -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +purchase_order_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Purchase Order +file_name = xero-dev.jpg # String | Name of the attachment +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment for a specific purchase order by filename result = api_instance.get_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, content_type) @@ -10598,7 +11063,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **purchase_order_id** | [**String**](.md)| Unique identifier for an Purchase Order | + **purchase_order_id** | **String**| Unique identifier for an Purchase Order | **file_name** | **String**| Name of the attachment | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | @@ -10647,10 +11112,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Purchase Order -attachment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Attachment object -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +purchase_order_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Purchase Order +attachment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Attachment object +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves specific attachment for a specific purchase order using a unique attachment Id result = api_instance.get_purchase_order_attachment_by_id(xero_tenant_id, purchase_order_id, attachment_id, content_type) @@ -10666,8 +11131,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **purchase_order_id** | [**String**](.md)| Unique identifier for an Purchase Order | - **attachment_id** | [**String**](.md)| Unique identifier for Attachment object | + **purchase_order_id** | **String**| Unique identifier for an Purchase Order | + **attachment_id** | **String**| Unique identifier for Attachment object | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | ### Return type @@ -10715,8 +11180,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Purchase Order +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +purchase_order_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Purchase Order begin #Retrieves attachments for a specific purchase order result = api_instance.get_purchase_order_attachments(xero_tenant_id, purchase_order_id) @@ -10732,7 +11197,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **purchase_order_id** | [**String**](.md)| Unique identifier for an Purchase Order | + **purchase_order_id** | **String**| Unique identifier for an Purchase Order | ### Return type @@ -10779,8 +11244,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -purchase_order_number = 'PO1234' # String | Unique identifier for a PurchaseOrder +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +purchase_order_number = PO1234 # String | Unique identifier for a PurchaseOrder begin #Retrieves a specific purchase order using purchase order number result = api_instance.get_purchase_order_by_number(xero_tenant_id, purchase_order_number) @@ -10843,8 +11308,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Purchase Order +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +purchase_order_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Purchase Order begin #Retrieves history for a specific purchase order result = api_instance.get_purchase_order_history(xero_tenant_id, purchase_order_id) @@ -10860,7 +11325,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **purchase_order_id** | [**String**](.md)| Unique identifier for an Purchase Order | + **purchase_order_id** | **String**| Unique identifier for an Purchase Order | ### Return type @@ -10907,17 +11372,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - status: 'SUBMITTED', # String | Filter by purchase order status + status: DRAFT, # String | Filter by purchase order status - date_from: '2019-12-01', # String | Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 + date_from: 2019-12-01, # String | Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 - date_to: '2019-12-31', # String | Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 + date_to: 2019-12-31, # String | Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 - order: 'PurchaseOrderNumber ASC', # String | Order by an any element + order: PurchaseOrderNumber ASC, # String | Order by an any element page: 1 # Integer | To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned. } @@ -10937,7 +11402,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **status** | **String**| Filter by purchase order status | [optional] **date_from** | **String**| Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 | [optional] **date_to** | **String**| Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 | [optional] @@ -10989,8 +11454,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -quote_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Quote +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +quote_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Quote begin #Retrieves a specific quote using a unique quote Id result = api_instance.get_quote(xero_tenant_id, quote_id) @@ -11006,7 +11471,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **quote_id** | [**String**](.md)| Unique identifier for an Quote | + **quote_id** | **String**| Unique identifier for an Quote | ### Return type @@ -11053,8 +11518,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -quote_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Quote +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +quote_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Quote begin #Retrieves a specific quote as a PDF file using a unique quote Id result = api_instance.get_quote_as_pdf(xero_tenant_id, quote_id) @@ -11070,7 +11535,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **quote_id** | [**String**](.md)| Unique identifier for an Quote | + **quote_id** | **String**| Unique identifier for an Quote | ### Return type @@ -11117,10 +11582,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -quote_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Quote -file_name = 'xero-dev.jpg' # String | Name of the attachment -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +quote_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Quote +file_name = xero-dev.jpg # String | Name of the attachment +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment from a specific quote by filename result = api_instance.get_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, content_type) @@ -11136,7 +11601,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **quote_id** | [**String**](.md)| Unique identifier for an Quote | + **quote_id** | **String**| Unique identifier for an Quote | **file_name** | **String**| Name of the attachment | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | @@ -11185,10 +11650,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -quote_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Quote -attachment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Attachment object -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +quote_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Quote +attachment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Attachment object +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment from a specific quote using a unique attachment Id result = api_instance.get_quote_attachment_by_id(xero_tenant_id, quote_id, attachment_id, content_type) @@ -11204,8 +11669,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **quote_id** | [**String**](.md)| Unique identifier for an Quote | - **attachment_id** | [**String**](.md)| Unique identifier for Attachment object | + **quote_id** | **String**| Unique identifier for an Quote | + **attachment_id** | **String**| Unique identifier for Attachment object | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | ### Return type @@ -11253,8 +11718,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -quote_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Quote +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +quote_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Quote begin #Retrieves attachments for a specific quote result = api_instance.get_quote_attachments(xero_tenant_id, quote_id) @@ -11270,7 +11735,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **quote_id** | [**String**](.md)| Unique identifier for an Quote | + **quote_id** | **String**| Unique identifier for an Quote | ### Return type @@ -11317,8 +11782,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -quote_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Quote +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +quote_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Quote begin #Retrieves history records of a specific quote result = api_instance.get_quote_history(xero_tenant_id, quote_id) @@ -11334,7 +11799,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **quote_id** | [**String**](.md)| Unique identifier for an Quote | + **quote_id** | **String**| Unique identifier for an Quote | ### Return type @@ -11381,27 +11846,27 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - date_from: Date.parse('2019-10-31'), # Date | Filter for quotes after a particular date + date_from: 2019-10-31, # Date | Filter for quotes after a particular date - date_to: Date.parse('2019-10-31'), # Date | Filter for quotes before a particular date + date_to: 2019-10-31, # Date | Filter for quotes before a particular date - expiry_date_from: Date.parse('2019-10-31'), # Date | Filter for quotes expiring after a particular date + expiry_date_from: 2019-10-31, # Date | Filter for quotes expiring after a particular date - expiry_date_to: Date.parse('2019-10-31'), # Date | Filter for quotes before a particular date + expiry_date_to: 2019-10-31, # Date | Filter for quotes before a particular date - contact_id: '00000000-0000-0000-0000-000000000000', # String | Filter for quotes belonging to a particular contact + contact_id: 00000000-0000-0000-0000-000000000000, # String | Filter for quotes belonging to a particular contact - status: 'DRAFT', # String | Filter for quotes of a particular Status + status: DRAFT, # String | Filter for quotes of a particular Status page: 1, # Integer | e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote - order: 'Status ASC', # String | Order by an any element + order: Status ASC, # String | Order by an any element - quote_number: 'QU-0001' # String | Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001) + quote_number: QU-0001 # String | Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001) } begin @@ -11419,12 +11884,12 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **date_from** | **Date**| Filter for quotes after a particular date | [optional] **date_to** | **Date**| Filter for quotes before a particular date | [optional] **expiry_date_from** | **Date**| Filter for quotes expiring after a particular date | [optional] **expiry_date_to** | **Date**| Filter for quotes before a particular date | [optional] - **contact_id** | [**String**](.md)| Filter for quotes belonging to a particular contact | [optional] + **contact_id** | **String**| Filter for quotes belonging to a particular contact | [optional] **status** | **String**| Filter for quotes of a particular Status | [optional] **page** | **Integer**| e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote | [optional] **order** | **String**| Order by an any element | [optional] @@ -11475,8 +11940,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Receipt +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +receipt_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Receipt opts = { unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -11496,7 +11961,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **receipt_id** | [**String**](.md)| Unique identifier for a Receipt | + **receipt_id** | **String**| Unique identifier for a Receipt | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] ### Return type @@ -11544,10 +12009,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Receipt -file_name = 'xero-dev.jpg' # String | Name of the attachment -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +receipt_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Receipt +file_name = xero-dev.jpg # String | Name of the attachment +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment from a specific expense claim receipts by file name result = api_instance.get_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, content_type) @@ -11563,7 +12028,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **receipt_id** | [**String**](.md)| Unique identifier for a Receipt | + **receipt_id** | **String**| Unique identifier for a Receipt | **file_name** | **String**| Name of the attachment | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | @@ -11612,10 +12077,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Receipt -attachment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Attachment object -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +receipt_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Receipt +attachment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Attachment object +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id result = api_instance.get_receipt_attachment_by_id(xero_tenant_id, receipt_id, attachment_id, content_type) @@ -11631,8 +12096,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **receipt_id** | [**String**](.md)| Unique identifier for a Receipt | - **attachment_id** | [**String**](.md)| Unique identifier for Attachment object | + **receipt_id** | **String**| Unique identifier for a Receipt | + **attachment_id** | **String**| Unique identifier for Attachment object | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | ### Return type @@ -11680,8 +12145,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Receipt +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +receipt_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Receipt begin #Retrieves attachments for a specific expense claim receipt result = api_instance.get_receipt_attachments(xero_tenant_id, receipt_id) @@ -11697,7 +12162,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **receipt_id** | [**String**](.md)| Unique identifier for a Receipt | + **receipt_id** | **String**| Unique identifier for a Receipt | ### Return type @@ -11744,8 +12209,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Receipt +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +receipt_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Receipt begin #Retrieves a history record for a specific receipt result = api_instance.get_receipt_history(xero_tenant_id, receipt_id) @@ -11761,7 +12226,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **receipt_id** | [**String**](.md)| Unique identifier for a Receipt | + **receipt_id** | **String**| Unique identifier for a Receipt | ### Return type @@ -11808,13 +12273,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"DRAFT\"', # String | Filter by an any element + where: Status=="DRAFT", # String | Filter by an any element - order: 'ReceiptNumber ASC', # String | Order by an any element + order: ReceiptNumber ASC, # String | Order by an any element unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -11834,7 +12299,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -11884,8 +12349,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Repeating Invoice +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +repeating_invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Repeating Invoice begin #Retrieves a specific repeating invoice by using a unique repeating invoice Id result = api_instance.get_repeating_invoice(xero_tenant_id, repeating_invoice_id) @@ -11901,7 +12366,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **repeating_invoice_id** | [**String**](.md)| Unique identifier for a Repeating Invoice | + **repeating_invoice_id** | **String**| Unique identifier for a Repeating Invoice | ### Return type @@ -11948,10 +12413,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Repeating Invoice -file_name = 'xero-dev.jpg' # String | Name of the attachment -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +repeating_invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Repeating Invoice +file_name = xero-dev.jpg # String | Name of the attachment +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment from a specific repeating invoices by file name result = api_instance.get_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, content_type) @@ -11967,7 +12432,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **repeating_invoice_id** | [**String**](.md)| Unique identifier for a Repeating Invoice | + **repeating_invoice_id** | **String**| Unique identifier for a Repeating Invoice | **file_name** | **String**| Name of the attachment | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | @@ -12016,10 +12481,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Repeating Invoice -attachment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Attachment object -content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +repeating_invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Repeating Invoice +attachment_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Attachment object +content_type = image/jpg # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf begin #Retrieves a specific attachment from a specific repeating invoice result = api_instance.get_repeating_invoice_attachment_by_id(xero_tenant_id, repeating_invoice_id, attachment_id, content_type) @@ -12035,8 +12500,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **repeating_invoice_id** | [**String**](.md)| Unique identifier for a Repeating Invoice | - **attachment_id** | [**String**](.md)| Unique identifier for Attachment object | + **repeating_invoice_id** | **String**| Unique identifier for a Repeating Invoice | + **attachment_id** | **String**| Unique identifier for Attachment object | **content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf | ### Return type @@ -12084,8 +12549,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Repeating Invoice +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +repeating_invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Repeating Invoice begin #Retrieves attachments from a specific repeating invoice result = api_instance.get_repeating_invoice_attachments(xero_tenant_id, repeating_invoice_id) @@ -12101,7 +12566,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **repeating_invoice_id** | [**String**](.md)| Unique identifier for a Repeating Invoice | + **repeating_invoice_id** | **String**| Unique identifier for a Repeating Invoice | ### Return type @@ -12148,8 +12613,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Repeating Invoice +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +repeating_invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Repeating Invoice begin #Retrieves history record for a specific repeating invoice result = api_instance.get_repeating_invoice_history(xero_tenant_id, repeating_invoice_id) @@ -12165,7 +12630,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **repeating_invoice_id** | [**String**](.md)| Unique identifier for a Repeating Invoice | + **repeating_invoice_id** | **String**| Unique identifier for a Repeating Invoice | ### Return type @@ -12212,11 +12677,11 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - where: 'Status==\"DRAFT\"', # String | Filter by an any element + where: Status=="DRAFT", # String | Filter by an any element - order: 'Total ASC' # String | Order by an any element + order: Total ASC # String | Order by an any element } begin @@ -12282,14 +12747,14 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact opts = { - date: Date.parse('2019-10-31'), # Date | The date of the Aged Payables By Contact report + date: 2019-10-31, # Date | The date of the Aged Payables By Contact report - from_date: Date.parse('2019-10-31'), # Date | filter by the from date of the report e.g. 2021-02-01 + from_date: 2019-10-31, # Date | filter by the from date of the report e.g. 2021-02-01 - to_date: Date.parse('2019-10-31') # Date | filter by the to date of the report e.g. 2021-02-28 + to_date: 2019-10-31 # Date | filter by the to date of the report e.g. 2021-02-28 } begin @@ -12307,7 +12772,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_id** | [**String**](.md)| Unique identifier for a Contact | + **contact_id** | **String**| Unique identifier for a Contact | **date** | **Date**| The date of the Aged Payables By Contact report | [optional] **from_date** | **Date**| filter by the from date of the report e.g. 2021-02-01 | [optional] **to_date** | **Date**| filter by the to date of the report e.g. 2021-02-28 | [optional] @@ -12357,14 +12822,14 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact opts = { - date: Date.parse('2019-10-31'), # Date | The date of the Aged Receivables By Contact report + date: 2019-10-31, # Date | The date of the Aged Receivables By Contact report - from_date: Date.parse('2019-10-31'), # Date | filter by the from date of the report e.g. 2021-02-01 + from_date: 2019-10-31, # Date | filter by the from date of the report e.g. 2021-02-01 - to_date: Date.parse('2019-10-31') # Date | filter by the to date of the report e.g. 2021-02-28 + to_date: 2019-10-31 # Date | filter by the to date of the report e.g. 2021-02-28 } begin @@ -12382,7 +12847,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_id** | [**String**](.md)| Unique identifier for a Contact | + **contact_id** | **String**| Unique identifier for a Contact | **date** | **Date**| The date of the Aged Receivables By Contact report | [optional] **from_date** | **Date**| filter by the from date of the report e.g. 2021-02-01 | [optional] **to_date** | **Date**| filter by the to date of the report e.g. 2021-02-28 | [optional] @@ -12432,17 +12897,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - date: Date.parse('2019-11-01'), # Date | The date of the Balance Sheet report + date: 2019-11-01, # Date | The date of the Balance Sheet report periods: 3, # Integer | The number of periods for the Balance Sheet report - timeframe: 'MONTH', # String | The period size to compare to (MONTH, QUARTER, YEAR) + timeframe: MONTH, # String | The period size to compare to (MONTH, QUARTER, YEAR) - tracking_option_id1: '00000000-0000-0000-0000-000000000000', # String | The tracking option 1 for the Balance Sheet report + tracking_option_id1: 00000000-0000-0000-0000-000000000000, # String | The tracking option 1 for the Balance Sheet report - tracking_option_id2: '00000000-0000-0000-0000-000000000000', # String | The tracking option 2 for the Balance Sheet report + tracking_option_id2: 00000000-0000-0000-0000-000000000000, # String | The tracking option 2 for the Balance Sheet report standard_layout: true, # Boolean | The standard layout boolean for the Balance Sheet report @@ -12517,11 +12982,11 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - from_date: Date.parse('2019-10-31'), # Date | filter by the from date of the report e.g. 2021-02-01 + from_date: 2019-10-31, # Date | filter by the from date of the report e.g. 2021-02-01 - to_date: Date.parse('2019-10-31') # Date | filter by the to date of the report e.g. 2021-02-28 + to_date: 2019-10-31 # Date | filter by the to date of the report e.g. 2021-02-28 } begin @@ -12587,9 +13052,9 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - date: Date.parse('2019-03-31'), # Date | The date for the Bank Summary report e.g. 2018-03-31 + date: 2019-03-31, # Date | The date for the Bank Summary report e.g. 2018-03-31 periods: 2, # Integer | The number of periods to compare (integer between 1 and 12) @@ -12660,9 +13125,9 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - date: Date.parse('2019-03-31') # Date | The date for the Bank Summary report e.g. 2018-03-31 + date: 2019-03-31 # Date | The date for the Bank Summary report e.g. 2018-03-31 } begin @@ -12727,8 +13192,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -report_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Report +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +report_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Report begin #Retrieves a specific report using a unique ReportID result = api_instance.get_report_from_id(xero_tenant_id, report_id) @@ -12791,23 +13256,23 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - from_date: Date.parse('2019-10-31'), # Date | filter by the from date of the report e.g. 2021-02-01 + from_date: 2019-10-31, # Date | filter by the from date of the report e.g. 2021-02-01 - to_date: Date.parse('2019-10-31'), # Date | filter by the to date of the report e.g. 2021-02-28 + to_date: 2019-10-31, # Date | filter by the to date of the report e.g. 2021-02-28 periods: 3, # Integer | The number of periods to compare (integer between 1 and 12) - timeframe: 'MONTH', # String | The period size to compare to (MONTH, QUARTER, YEAR) + timeframe: MONTH, # String | The period size to compare to (MONTH, QUARTER, YEAR) - tracking_category_id: '00000000-0000-0000-0000-000000000000', # String | The trackingCategory 1 for the ProfitAndLoss report + tracking_category_id: 00000000-0000-0000-0000-000000000000, # String | The trackingCategory 1 for the ProfitAndLoss report - tracking_category_id2: '00000000-0000-0000-0000-000000000000', # String | The trackingCategory 2 for the ProfitAndLoss report + tracking_category_id2: 00000000-0000-0000-0000-000000000000, # String | The trackingCategory 2 for the ProfitAndLoss report - tracking_option_id: '00000000-0000-0000-0000-000000000000', # String | The tracking option 1 for the ProfitAndLoss report + tracking_option_id: 00000000-0000-0000-0000-000000000000, # String | The tracking option 1 for the ProfitAndLoss report - tracking_option_id2: '00000000-0000-0000-0000-000000000000', # String | The tracking option 2 for the ProfitAndLoss report + tracking_option_id2: 00000000-0000-0000-0000-000000000000, # String | The tracking option 2 for the ProfitAndLoss report standard_layout: true, # Boolean | Return the standard layout for the ProfitAndLoss report @@ -12885,9 +13350,9 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - report_year: '2019' # String | The year of the 1099 report + report_year: 2019 # String | The year of the 1099 report } begin @@ -12952,9 +13417,9 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - date: Date.parse('2019-10-31'), # Date | The date for the Trial Balance report e.g. 2018-03-31 + date: 2019-10-31, # Date | The date for the Trial Balance report e.g. 2018-03-31 payments_only: true # Boolean | Return cash only basis for the Trial Balance report } @@ -13022,7 +13487,7 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant begin #Retrieves a list of the organistaions unique reports that require a uuid to fetch result = api_instance.get_reports_list(xero_tenant_id) @@ -13084,13 +13549,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - where: 'Status==\"ACTIVE\"', # String | Filter by an any element + where: Status=="ACTIVE", # String | Filter by an any element - order: 'Name ASC', # String | Order by an any element + order: Name ASC, # String | Order by an any element - tax_type: 'INPUT' # String | Filter by tax type + tax_type: INPUT # String | Filter by tax type } begin @@ -13157,11 +13622,11 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - where: 'Status==\"ACTIVE\"', # String | Filter by an any element + where: Status=="ACTIVE", # String | Filter by an any element - order: 'Name ASC', # String | Order by an any element + order: Name ASC, # String | Order by an any element include_archived: true # Boolean | e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response } @@ -13230,8 +13695,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -tracking_category_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a TrackingCategory +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +tracking_category_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a TrackingCategory begin #Retrieves specific tracking categories and options using a unique tracking category Id result = api_instance.get_tracking_category(xero_tenant_id, tracking_category_id) @@ -13247,7 +13712,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **tracking_category_id** | [**String**](.md)| Unique identifier for a TrackingCategory | + **tracking_category_id** | **String**| Unique identifier for a TrackingCategory | ### Return type @@ -13294,8 +13759,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -user_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a User +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +user_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a User begin #Retrieves a specific user result = api_instance.get_user(xero_tenant_id, user_id) @@ -13311,7 +13776,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **user_id** | [**String**](.md)| Unique identifier for a User | + **user_id** | **String**| Unique identifier for a User | ### Return type @@ -13358,13 +13823,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'IsSubscriber==true', # String | Filter by an any element + where: IsSubscriber==true, # String | Filter by an any element - order: 'LastName ASC' # String | Order by an any element + order: LastName ASC # String | Order by an any element } begin @@ -13382,7 +13847,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] @@ -13402,7 +13867,7 @@ Name | Type | Description | Notes ## post_setup -> ImportSummaryObject post_setup(xero_tenant_id, setup) +> ImportSummaryObject post_setup(xero_tenant_id, setup, opts) Sets the chart of accounts, the conversion date and conversion balances @@ -13431,11 +13896,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant setup = { "ConversionDate": {}, "ConversionBalances": [], "Accounts": [ { "Code": "200", "Name": "Sales", "Type": "SALES", "ReportingCode": "REV.TRA.GOO" }, { "Code": "400", "Name": "Advertising", "Type": "OVERHEADS", "ReportingCode": "EXP" }, { "Code": "610", "Name": "Accounts Receivable", "Type": "CURRENT", "SystemAccount": "DEBTORS", "ReportingCode": "ASS.CUR.REC.TRA" }, { "Code": "800", "Name": "Accounts Payable", "Type": "CURRLIAB", "SystemAccount": "CREDITORS", "ReportingCode": "LIA.CUR.PAY" } ] } # Setup | Object including an accounts array, a conversion balances array and a conversion date object in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Sets the chart of accounts, the conversion date and conversion balances - result = api_instance.post_setup(xero_tenant_id, setup) + result = api_instance.post_setup(xero_tenant_id, setup, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->post_setup: #{e}" @@ -13449,6 +13918,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **setup** | [**Setup**](Setup.md)| Object including an accounts array, a conversion balances array and a conversion date object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13466,7 +13936,7 @@ Name | Type | Description | Notes ## update_account -> Accounts update_account(xero_tenant_id, account_id, accounts) +> Accounts update_account(xero_tenant_id, account_id, accounts, opts) Updates a chart of accounts @@ -13495,12 +13965,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -account_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Account object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +account_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Account object accounts = { "Accounts":[ { "Code":"123456", "Name":"BarFoo", "AccountID":"99ce6032-0678-4aa0-8148-240c75fee33a", "Type":"EXPENSE", "Description":"GoodBye World", "TaxType":"INPUT", "EnablePaymentsToAccount":false, "ShowInExpenseClaims":false, "Class":"EXPENSE", "ReportingCode":"EXP", "ReportingCodeName":"Expense", "UpdatedDateUTC":"2019-02-21T16:29:47.96-08:00" } ] } # Accounts | Request of type Accounts array with one Account +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a chart of accounts - result = api_instance.update_account(xero_tenant_id, account_id, accounts) + result = api_instance.update_account(xero_tenant_id, account_id, accounts, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_account: #{e}" @@ -13513,8 +13987,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **account_id** | [**String**](.md)| Unique identifier for Account object | + **account_id** | **String**| Unique identifier for Account object | **accounts** | [**Accounts**](Accounts.md)| Request of type Accounts array with one Account | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13532,7 +14007,7 @@ Name | Type | Description | Notes ## update_account_attachment_by_file_name -> Attachments update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) +> Attachments update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, opts) Updates attachment on a specific account by filename @@ -13561,13 +14036,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -account_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Account object -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +account_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Account object +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates attachment on a specific account by filename - result = api_instance.update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) + result = api_instance.update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_account_attachment_by_file_name: #{e}" @@ -13580,9 +14059,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **account_id** | [**String**](.md)| Unique identifier for Account object | + **account_id** | **String**| Unique identifier for Account object | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13629,10 +14109,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transaction +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transaction_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transaction bank_transactions = { "BankTransactions": [ { "Type": "SPEND", "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000", "ContactStatus": "ACTIVE", "Name": "Buzz Lightyear", "FirstName": "Buzz", "LastName": "Lightyear", "EmailAddress": "buzz.Lightyear@email.com", "ContactPersons": [], "BankAccountDetails": "", "Addresses": [ { "AddressType": "STREET", "City": "", "Region": "", "PostalCode": "", "Country": "" }, { "AddressType": "POBOX", "AddressLine1": "", "AddressLine2": "", "AddressLine3": "", "AddressLine4": "", "City": "Palo Alto", "Region": "CA", "PostalCode": "94020", "Country": "United States" } ], "Phones": [ { "PhoneType": "DEFAULT", "PhoneNumber": "847-1294", "PhoneAreaCode": "(626)", "PhoneCountryCode": "" }, { "PhoneType": "DDI", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "FAX", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "MOBILE", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" } ], "UpdatedDateUTC": "2017-08-21T13:49:04.227-07:00", "ContactGroups": [] }, "Lineitems": [], "BankAccount": { "Code": "088", "Name": "Business Wells Fargo", "AccountID": "00000000-0000-0000-0000-000000000000" }, "IsReconciled": false, "Date": "2019-02-25", "Reference": "You just updated", "CurrencyCode": "USD", "CurrencyRate": 1, "Status": "AUTHORISED", "LineAmountTypes": "Inclusive", "TotalTax": 1.74, "BankTransactionID": "00000000-0000-0000-0000-000000000000", "UpdatedDateUTC": "2019-02-26T12:39:27.813-08:00" } ] } # BankTransactions | opts = { + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -13651,8 +14133,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transaction_id** | [**String**](.md)| Xero generated unique identifier for a bank transaction | + **bank_transaction_id** | **String**| Xero generated unique identifier for a bank transaction | **bank_transactions** | [**BankTransactions**](BankTransactions.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] ### Return type @@ -13671,7 +14154,7 @@ Name | Type | Description | Notes ## update_bank_transaction_attachment_by_file_name -> Attachments update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) +> Attachments update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, opts) Updates a specific attachment from a specific bank transaction by filename @@ -13700,13 +14183,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transaction -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transaction_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transaction +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific attachment from a specific bank transaction by filename - result = api_instance.update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) + result = api_instance.update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_bank_transaction_attachment_by_file_name: #{e}" @@ -13719,9 +14206,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transaction_id** | [**String**](.md)| Xero generated unique identifier for a bank transaction | + **bank_transaction_id** | **String**| Xero generated unique identifier for a bank transaction | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13739,7 +14227,7 @@ Name | Type | Description | Notes ## update_bank_transfer_attachment_by_file_name -> Attachments update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) +> Attachments update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, opts) @@ -13768,12 +14256,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_transfer_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transfer -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_transfer_id = 00000000-0000-0000-0000-000000000000 # String | Xero generated unique identifier for a bank transfer +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin - result = api_instance.update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) + result = api_instance.update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_bank_transfer_attachment_by_file_name: #{e}" @@ -13786,9 +14278,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_transfer_id** | [**String**](.md)| Xero generated unique identifier for a bank transfer | + **bank_transfer_id** | **String**| Xero generated unique identifier for a bank transfer | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13806,7 +14299,7 @@ Name | Type | Description | Notes ## update_contact -> Contacts update_contact(xero_tenant_id, contact_id, contacts) +> Contacts update_contact(xero_tenant_id, contact_id, contacts, opts) Updates a specific contact in a Xero organisation @@ -13835,12 +14328,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact contacts = { "Contacts": [{ "ContactID": "00000000-0000-0000-0000-000000000000", "Name": "Thanos" }]} # Contacts | an array of Contacts containing single Contact object with properties to update +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific contact in a Xero organisation - result = api_instance.update_contact(xero_tenant_id, contact_id, contacts) + result = api_instance.update_contact(xero_tenant_id, contact_id, contacts, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_contact: #{e}" @@ -13853,8 +14350,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_id** | [**String**](.md)| Unique identifier for a Contact | + **contact_id** | **String**| Unique identifier for a Contact | **contacts** | [**Contacts**](Contacts.md)| an array of Contacts containing single Contact object with properties to update | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13872,7 +14370,7 @@ Name | Type | Description | Notes ## update_contact_attachment_by_file_name -> Attachments update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) +> Attachments update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, opts) @@ -13901,12 +14399,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin - result = api_instance.update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) + result = api_instance.update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_contact_attachment_by_file_name: #{e}" @@ -13919,9 +14421,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_id** | [**String**](.md)| Unique identifier for a Contact | + **contact_id** | **String**| Unique identifier for a Contact | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13939,7 +14442,7 @@ Name | Type | Description | Notes ## update_contact_group -> ContactGroups update_contact_group(xero_tenant_id, contact_group_id, contact_groups) +> ContactGroups update_contact_group(xero_tenant_id, contact_group_id, contact_groups, opts) Updates a specific contact group @@ -13968,12 +14471,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -contact_group_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact Group +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +contact_group_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Contact Group contact_groups = { "ContactGroups":[ { "Name":"Suppliers" } ] } # ContactGroups | an array of Contact groups with Name of specific group to update +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific contact group - result = api_instance.update_contact_group(xero_tenant_id, contact_group_id, contact_groups) + result = api_instance.update_contact_group(xero_tenant_id, contact_group_id, contact_groups, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_contact_group: #{e}" @@ -13986,8 +14493,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **contact_group_id** | [**String**](.md)| Unique identifier for a Contact Group | + **contact_group_id** | **String**| Unique identifier for a Contact Group | **contact_groups** | [**ContactGroups**](ContactGroups.md)| an array of Contact groups with Name of specific group to update | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14034,10 +14542,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +credit_note_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Credit Note credit_notes = { "CreditNotes": [ { "Type": "ACCPAYCREDIT", "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8" }, "Date": "2019-01-05", "Status": "AUTHORISED", "Reference": "HelloWorld", "LineItems": [ { "Description": "Foobar", "Quantity": 2, "UnitAmount": 20, "AccountCode": "400" } ] } ] } # CreditNotes | an array of Credit Notes containing credit note details to update opts = { + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -14056,8 +14566,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | + **credit_note_id** | **String**| Unique identifier for a Credit Note | **credit_notes** | [**CreditNotes**](CreditNotes.md)| an array of Credit Notes containing credit note details to update | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] ### Return type @@ -14076,7 +14587,7 @@ Name | Type | Description | Notes ## update_credit_note_attachment_by_file_name -> Attachments update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body) +> Attachments update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, opts) Updates attachments on a specific credit note by file name @@ -14105,13 +14616,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +credit_note_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Credit Note +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates attachments on a specific credit note by file name - result = api_instance.update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body) + result = api_instance.update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_credit_note_attachment_by_file_name: #{e}" @@ -14124,9 +14639,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | + **credit_note_id** | **String**| Unique identifier for a Credit Note | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14144,7 +14660,7 @@ Name | Type | Description | Notes ## update_expense_claim -> ExpenseClaims update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims) +> ExpenseClaims update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims, opts) Updates a specific expense claims @@ -14173,12 +14689,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -expense_claim_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ExpenseClaim +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +expense_claim_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a ExpenseClaim expense_claims = { "ExpenseClaims": [ { "Status": "SUBMITTED", "User": { "UserID": "d1164823-0ac1-41ad-987b-b4e30fe0b273" }, "Receipts": [ { "Lineitems": [], "ReceiptID": "dc1c7f6d-0a4c-402f-acac-551d62ce5816" } ] } ] } # ExpenseClaims | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific expense claims - result = api_instance.update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims) + result = api_instance.update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_expense_claim: #{e}" @@ -14191,8 +14711,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **expense_claim_id** | [**String**](.md)| Unique identifier for a ExpenseClaim | + **expense_claim_id** | **String**| Unique identifier for a ExpenseClaim | **expense_claims** | [**ExpenseClaims**](ExpenseClaims.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14239,10 +14760,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Invoice invoices = { "Invoices": [{ Reference: "May the force be with you", "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }]} # Invoices | opts = { + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -14261,8 +14784,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | + **invoice_id** | **String**| Unique identifier for an Invoice | **invoices** | [**Invoices**](Invoices.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] ### Return type @@ -14281,7 +14805,7 @@ Name | Type | Description | Notes ## update_invoice_attachment_by_file_name -> Attachments update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body) +> Attachments update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, opts) Updates an attachment from a specific invoices or purchase bill by filename @@ -14310,13 +14834,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Invoice +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates an attachment from a specific invoices or purchase bill by filename - result = api_instance.update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body) + result = api_instance.update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_invoice_attachment_by_file_name: #{e}" @@ -14329,9 +14857,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | + **invoice_id** | **String**| Unique identifier for an Invoice | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14378,10 +14907,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -item_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Item +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +item_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Item items = { "Items": [ { "Code": "ItemCode123", "Description": "Description 123" } ] } # Items | opts = { + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -14400,8 +14931,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **item_id** | [**String**](.md)| Unique identifier for an Item | + **item_id** | **String**| Unique identifier for an Item | **items** | [**Items**](Items.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] ### Return type @@ -14420,7 +14952,7 @@ Name | Type | Description | Notes ## update_linked_transaction -> LinkedTransactions update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions) +> LinkedTransactions update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions, opts) Updates a specific linked transactions (billable expenses) @@ -14449,12 +14981,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -linked_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a LinkedTransaction +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +linked_transaction_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a LinkedTransaction linked_transactions = { "LinkedTransactions": [ { "SourceTransactionID": "00000000-0000-0000-0000-000000000000", "SourceLineItemID": "00000000-0000-0000-0000-000000000000" } ] } # LinkedTransactions | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific linked transactions (billable expenses) - result = api_instance.update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions) + result = api_instance.update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_linked_transaction: #{e}" @@ -14467,8 +15003,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **linked_transaction_id** | [**String**](.md)| Unique identifier for a LinkedTransaction | + **linked_transaction_id** | **String**| Unique identifier for a LinkedTransaction | **linked_transactions** | [**LinkedTransactions**](LinkedTransactions.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14486,7 +15023,7 @@ Name | Type | Description | Notes ## update_manual_journal -> ManualJournals update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals) +> ManualJournals update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals, opts) Updates a specific manual journal @@ -14515,12 +15052,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ManualJournal +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +manual_journal_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a ManualJournal manual_journals = { "ManualJournals": [ { "Narration": "Hello Xero", "ManualJournalID": "00000000-0000-0000-0000-000000000000", "JournalLines": [] } ] } # ManualJournals | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific manual journal - result = api_instance.update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals) + result = api_instance.update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_manual_journal: #{e}" @@ -14533,8 +15074,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **manual_journal_id** | [**String**](.md)| Unique identifier for a ManualJournal | + **manual_journal_id** | **String**| Unique identifier for a ManualJournal | **manual_journals** | [**ManualJournals**](ManualJournals.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14552,7 +15094,7 @@ Name | Type | Description | Notes ## update_manual_journal_attachment_by_file_name -> Attachments update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) +> Attachments update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, opts) Updates a specific attachment from a specific manual journal by file name @@ -14581,13 +15123,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -manual_journal_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ManualJournal -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +manual_journal_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a ManualJournal +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific attachment from a specific manual journal by file name - result = api_instance.update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) + result = api_instance.update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_manual_journal_attachment_by_file_name: #{e}" @@ -14600,9 +15146,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **manual_journal_id** | [**String**](.md)| Unique identifier for a ManualJournal | + **manual_journal_id** | **String**| Unique identifier for a ManualJournal | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14649,10 +15196,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant bank_transactions = { "BankTransactions": [ { "Type": "SPEND", "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "Lineitems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "400" } ], "BankAccount": { "Code": "088" } } ] } # BankTransactions | opts = { - summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -14673,6 +15222,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **bank_transactions** | [**BankTransactions**](BankTransactions.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -14721,10 +15271,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant contacts = { "Contacts": [ { "Name": "Bruce Banner", "EmailAddress": "hulk@avengers.com", "Phones": [ { "PhoneType": "MOBILE", "PhoneNumber": "555-1212", "PhoneAreaCode": "415" } ], "PaymentTerms": { "Bills": { "Day": 15, "Type": "OFCURRENTMONTH" }, "Sales": { "Day": 10, "Type": "DAYSAFTERBILLMONTH" } } } ] } # Contacts | opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -14743,6 +15295,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **contacts** | [**Contacts**](Contacts.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -14790,10 +15343,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant credit_notes = { "CreditNotes":[ { "Type":"ACCPAYCREDIT", "Contact":{ "ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8" }, "Date":"2019-01-05", "Status":"AUTHORISED", "Reference": "HelloWorld", "LineItems":[ { "Description":"Foobar", "Quantity":2.0, "UnitAmount":20.0, "AccountCode":"400" } ] } ] } # CreditNotes | an array of Credit Notes with a single CreditNote object. opts = { - summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -14814,6 +15369,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **credit_notes** | [**CreditNotes**](CreditNotes.md)| an array of Credit Notes with a single CreditNote object. | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -14862,10 +15418,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant employees = { "Employees": [ { "FirstName": "Nick", "LastName": "Fury", "ExternalLink": { "Url": "http://twitter.com/#!/search/Nick+Fury" } } ] } # Employees | Employees with array of Employee object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -14884,6 +15442,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **employees** | [**Employees**](Employees.md)| Employees with array of Employee object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -14931,10 +15490,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant invoices = { "Invoices": [ { "Type": "ACCREC", "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8" }, "LineItems": [ { "Description": "Acme Tires", "Quantity": 2, "UnitAmount": 20, "AccountCode": "200", "TaxType": "NONE", "LineAmount": 40 } ], "Date": "2019-03-11", "DueDate": "2018-12-10", "Reference": "Website Design", "Status": "AUTHORISED" } ] } # Invoices | opts = { - summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -14955,6 +15516,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **invoices** | [**Invoices**](Invoices.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -15003,10 +15565,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant items = { "Items": [ { "Code": "ItemCode123", "Name": "ItemName XYZ", "Description": "Item Description ABC" } ] } # Items | opts = { - summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -15027,6 +15591,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **items** | [**Items**](Items.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -15075,10 +15640,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant manual_journals = { "ManualJournals": [ { "Narration": "Journal Desc", "JournalLines": [ { "LineAmount": 100, "AccountCode": "400", "Description": "Money Movement" }, { "LineAmount": -100, "AccountCode": "400", "Description": "Prepayment of things", "Tracking": [ { "Name": "North", "Option": "Region" } ] } ], "Date": "2019-03-14" } ] } # ManualJournals | ManualJournals array with ManualJournal object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -15097,6 +15664,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **manual_journals** | [**ManualJournals**](ManualJournals.md)| ManualJournals array with ManualJournal object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -15144,10 +15712,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant purchase_orders = { "PurchaseOrders": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "710" } ], "Date": "2019-03-13" } ] } # PurchaseOrders | opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -15166,6 +15736,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **purchase_orders** | [**PurchaseOrders**](PurchaseOrders.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -15213,10 +15784,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant quotes = { "Quotes": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "12775" } ], "Date": "2020-02-01" } ] } # Quotes | opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -15235,6 +15808,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **quotes** | [**Quotes**](Quotes.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -15282,10 +15856,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant repeating_invoices = { "RepeatingInvoices": [ { "Schedule": { "Period": 1, "Unit": "MONTHLY", "DueDate": 10, "DueDateType": "OFFOLLOWINGMONTH", "StartDate": "\/Date(1555286400000+0000)\/" }, "Type": "ACCREC", "Reference": "[Week]", "ApprovedForSending": false, "SendCopy": false, "MarkAsSent": false, "IncludePDF": false, "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8", "Name": "Liam Gallagher" }, "Status": "AUTHORISED", "LineAmountTypes": "Exclusive", "LineItems": [ { "Description": "Guitars Fender Strat", "UnitAmount": 5000.00, "TaxType": "OUTPUT2", "TaxAmount": 750.00, "LineAmount": 5000.00, "AccountCode": "200", "Tracking": [], "Quantity": 1.0000, "LineItemID": "13a8353c-d2af-4d5b-920c-438449f08900", "DiscountEnteredAsPercent": true } ], "CurrencyCode": "NZD" } ] } # RepeatingInvoices | RepeatingInvoices with an array of repeating invoice objects in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -15304,6 +15880,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **repeating_invoices** | [**RepeatingInvoices**](RepeatingInvoices.md)| RepeatingInvoices with an array of repeating invoice objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] ### Return type @@ -15322,7 +15899,7 @@ Name | Type | Description | Notes ## update_purchase_order -> PurchaseOrders update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders) +> PurchaseOrders update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders, opts) Updates a specific purchase order @@ -15351,12 +15928,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Purchase Order +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +purchase_order_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Purchase Order purchase_orders = { "PurchaseOrders": [ { "AttentionTo": "Peter Parker", "LineItems": [], "Contact": {} } ] } # PurchaseOrders | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific purchase order - result = api_instance.update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders) + result = api_instance.update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_purchase_order: #{e}" @@ -15369,8 +15950,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **purchase_order_id** | [**String**](.md)| Unique identifier for an Purchase Order | + **purchase_order_id** | **String**| Unique identifier for an Purchase Order | **purchase_orders** | [**PurchaseOrders**](PurchaseOrders.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15388,7 +15970,7 @@ Name | Type | Description | Notes ## update_purchase_order_attachment_by_file_name -> Attachments update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) +> Attachments update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, opts) Updates a specific attachment for a specific purchase order by filename @@ -15417,13 +15999,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -purchase_order_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Purchase Order -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +purchase_order_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Purchase Order +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific attachment for a specific purchase order by filename - result = api_instance.update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) + result = api_instance.update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_purchase_order_attachment_by_file_name: #{e}" @@ -15436,9 +16022,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **purchase_order_id** | [**String**](.md)| Unique identifier for an Purchase Order | + **purchase_order_id** | **String**| Unique identifier for an Purchase Order | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15456,7 +16043,7 @@ Name | Type | Description | Notes ## update_quote -> Quotes update_quote(xero_tenant_id, quote_id, quotes) +> Quotes update_quote(xero_tenant_id, quote_id, quotes, opts) Updates a specific quote @@ -15485,12 +16072,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -quote_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Quote +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +quote_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Quote quotes = { "Quotes": [ { "Reference": "I am an update", "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "Date": "2020-02-01" } ] } # Quotes | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific quote - result = api_instance.update_quote(xero_tenant_id, quote_id, quotes) + result = api_instance.update_quote(xero_tenant_id, quote_id, quotes, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_quote: #{e}" @@ -15503,8 +16094,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **quote_id** | [**String**](.md)| Unique identifier for an Quote | + **quote_id** | **String**| Unique identifier for an Quote | **quotes** | [**Quotes**](Quotes.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15522,7 +16114,7 @@ Name | Type | Description | Notes ## update_quote_attachment_by_file_name -> Attachments update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) +> Attachments update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, opts) Updates a specific attachment from a specific quote by filename @@ -15551,13 +16143,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -quote_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Quote -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +quote_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for an Quote +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific attachment from a specific quote by filename - result = api_instance.update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) + result = api_instance.update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_quote_attachment_by_file_name: #{e}" @@ -15570,9 +16166,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **quote_id** | [**String**](.md)| Unique identifier for an Quote | + **quote_id** | **String**| Unique identifier for an Quote | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15619,10 +16216,12 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Receipt +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +receipt_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Receipt receipts = { "Receipts": [ { "Lineitems": [], "User": { "UserID": "00000000-0000-0000-0000-000000000000" }, "Reference": "Foobar" } ] } # Receipts | opts = { + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts } @@ -15641,8 +16240,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **receipt_id** | [**String**](.md)| Unique identifier for a Receipt | + **receipt_id** | **String**| Unique identifier for a Receipt | **receipts** | [**Receipts**](Receipts.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] ### Return type @@ -15661,7 +16261,7 @@ Name | Type | Description | Notes ## update_receipt_attachment_by_file_name -> Attachments update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) +> Attachments update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, opts) Updates a specific attachment on a specific expense claim receipts by file name @@ -15690,13 +16290,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -receipt_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Receipt -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +receipt_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Receipt +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific attachment on a specific expense claim receipts by file name - result = api_instance.update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) + result = api_instance.update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_receipt_attachment_by_file_name: #{e}" @@ -15709,9 +16313,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **receipt_id** | [**String**](.md)| Unique identifier for a Receipt | + **receipt_id** | **String**| Unique identifier for a Receipt | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15729,7 +16334,7 @@ Name | Type | Description | Notes ## update_repeating_invoice -> RepeatingInvoices update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_invoices) +> RepeatingInvoices update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_invoices, opts) Deletes a specific repeating invoice template @@ -15758,12 +16363,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Repeating Invoice +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +repeating_invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Repeating Invoice repeating_invoices = { "Schedule": { "Period": 1, "Unit": "MONTHLY", "DueDate": 10, "DueDateType": "OFFOLLOWINGMONTH", "StartDate": "\/Date(1555286400000+0000)\/", "EndDate": "\/Date(1569801600000+0000)\/", "NextScheduledDate": "\/Date(1555286400000+0000)\/" }, "RepeatingInvoiceID": "428c0d75-909f-4b04-8403-a48dc27283b0", "Type": "ACCREC", "Reference": "[Week]", "HasAttachments": true, "ApprovedForSending": false, "SendCopy": false, "MarkAsSent": false, "IncludePDF": false, "ID": "428c0d75-909f-4b04-8403-a48dc27283b0", "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8", "Name": "Liam Gallagher", "Addresses": [], "Phones": [], "ContactGroups": [], "ContactPersons": [], "HasValidationErrors": false }, "Status": "DELETED", "LineAmountTypes": "Exclusive", "LineItems": [ { "Description": "Guitars Fender Strat", "UnitAmount": 5000.00, "TaxType": "OUTPUT2", "TaxAmount": 750.00, "LineAmount": 5000.00, "AccountCode": "200", "Tracking": [], "Quantity": 1.0000, "LineItemID": "13a8353c-d2af-4d5b-920c-438449f08900", "DiscountEnteredAsPercent": true } ], "SubTotal": 5000.00, "TotalTax": 750.00, "Total": 5750.00, "CurrencyCode": "NZD" } # RepeatingInvoices | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Deletes a specific repeating invoice template - result = api_instance.update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_invoices) + result = api_instance.update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_invoices, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_repeating_invoice: #{e}" @@ -15776,8 +16385,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **repeating_invoice_id** | [**String**](.md)| Unique identifier for a Repeating Invoice | + **repeating_invoice_id** | **String**| Unique identifier for a Repeating Invoice | **repeating_invoices** | [**RepeatingInvoices**](RepeatingInvoices.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15795,7 +16405,7 @@ Name | Type | Description | Notes ## update_repeating_invoice_attachment_by_file_name -> Attachments update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) +> Attachments update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, opts) Updates a specific attachment from a specific repeating invoices by file name @@ -15824,13 +16434,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Repeating Invoice -file_name = 'xero-dev.jpg' # String | Name of the attachment -body = 'body_example' # String | Byte array of file in body of request +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +repeating_invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Repeating Invoice +file_name = xero-dev.jpg # String | Name of the attachment +body = BYTE_ARRAY_DATA_HERE # String | Byte array of file in body of request +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific attachment from a specific repeating invoices by file name - result = api_instance.update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) + result = api_instance.update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_repeating_invoice_attachment_by_file_name: #{e}" @@ -15843,9 +16457,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **repeating_invoice_id** | [**String**](.md)| Unique identifier for a Repeating Invoice | + **repeating_invoice_id** | **String**| Unique identifier for a Repeating Invoice | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15863,7 +16478,7 @@ Name | Type | Description | Notes ## update_tax_rate -> TaxRates update_tax_rate(xero_tenant_id, tax_rates) +> TaxRates update_tax_rate(xero_tenant_id, tax_rates, opts) Updates tax rates @@ -15892,11 +16507,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant tax_rates = { "TaxRates": [ { "Name": "State Tax NY", "TaxComponents": [ { "Name": "State Tax", "Rate": 2.25 } ], "Status": "DELETED", "ReportTaxType": "INPUT" } ] } # TaxRates | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates tax rates - result = api_instance.update_tax_rate(xero_tenant_id, tax_rates) + result = api_instance.update_tax_rate(xero_tenant_id, tax_rates, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_tax_rate: #{e}" @@ -15910,6 +16529,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **tax_rates** | [**TaxRates**](TaxRates.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15927,7 +16547,7 @@ Name | Type | Description | Notes ## update_tracking_category -> TrackingCategories update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category) +> TrackingCategories update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category, opts) Updates a specific tracking category @@ -15956,12 +16576,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -tracking_category_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a TrackingCategory +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +tracking_category_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a TrackingCategory tracking_category = { "Name": "Avengers" } # TrackingCategory | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific tracking category - result = api_instance.update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category) + result = api_instance.update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_tracking_category: #{e}" @@ -15974,8 +16598,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **tracking_category_id** | [**String**](.md)| Unique identifier for a TrackingCategory | + **tracking_category_id** | **String**| Unique identifier for a TrackingCategory | **tracking_category** | [**TrackingCategory**](TrackingCategory.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15993,7 +16618,7 @@ Name | Type | Description | Notes ## update_tracking_options -> TrackingOptions update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option) +> TrackingOptions update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option, opts) Updates a specific option for a specific tracking category @@ -16022,13 +16647,17 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -tracking_category_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a TrackingCategory -tracking_option_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Tracking Option +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +tracking_category_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a TrackingCategory +tracking_option_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Tracking Option tracking_option = { name: "Vision" } # TrackingOption | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific option for a specific tracking category - result = api_instance.update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option) + result = api_instance.update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_tracking_options: #{e}" @@ -16041,9 +16670,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **tracking_category_id** | [**String**](.md)| Unique identifier for a TrackingCategory | - **tracking_option_id** | [**String**](.md)| Unique identifier for a Tracking Option | + **tracking_category_id** | **String**| Unique identifier for a TrackingCategory | + **tracking_option_id** | **String**| Unique identifier for a Tracking Option | **tracking_option** | [**TrackingOption**](TrackingOption.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type diff --git a/docs/accounting/Allocation.md b/docs/accounting/Allocation.md index 19584807..fc0471cd 100644 --- a/docs/accounting/Allocation.md +++ b/docs/accounting/Allocation.md @@ -4,12 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**allocation_id** | **String** | Xero generated unique identifier | [optional] **invoice** | [**Invoice**](Invoice.md) | | **overpayment** | [**Overpayment**](Overpayment.md) | | [optional] **prepayment** | [**Prepayment**](Prepayment.md) | | [optional] **credit_note** | [**CreditNote**](CreditNote.md) | | [optional] **amount** | **BigDecimal** | the amount being applied to the invoice | **date** | **Date** | the date the allocation is applied YYYY-MM-DD. | +**is_deleted** | **Boolean** | A flag that returns true when the allocation is succesfully deleted | [optional] **status_attribute_string** | **String** | A string to indicate if a invoice status | [optional] **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional] @@ -18,12 +20,14 @@ Name | Type | Description | Notes ```ruby require 'XeroRuby::Accounting' -instance = XeroRuby::Accounting::Allocation.new(invoice: null, +instance = XeroRuby::Accounting::Allocation.new(allocation_id: null, + invoice: null, overpayment: null, prepayment: null, credit_note: null, amount: null, date: null, + is_deleted: null, status_attribute_string: null, validation_errors: null) ``` diff --git a/docs/accounting/Contact.md b/docs/accounting/Contact.md index 189b6e4d..40a79147 100644 --- a/docs/accounting/Contact.md +++ b/docs/accounting/Contact.md @@ -14,7 +14,6 @@ Name | Type | Description | Notes **last_name** | **String** | Last name of contact person (max length = 255) | [optional] **company_number** | **String** | Company registration number (max length = 50) | [optional] **email_address** | **String** | Email address of contact person (umlauts not supported) (max length = 255) | [optional] -**skype_user_name** | **String** | Skype user name of contact | [optional] **contact_persons** | [**Array<ContactPerson>**](ContactPerson.md) | See contact persons | [optional] **bank_account_details** | **String** | Bank account number of contact | [optional] **tax_number** | **String** | Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50) | [optional] @@ -63,7 +62,6 @@ instance = XeroRuby::Accounting::Contact.new(contact_id: null, last_name: null, company_number: null, email_address: null, - skype_user_name: null, contact_persons: null, bank_account_details: null, tax_number: null, diff --git a/docs/accounting/TenNinetyNineContact.md b/docs/accounting/TenNinetyNineContact.md index 69bc3ce8..95cfa1a2 100644 --- a/docs/accounting/TenNinetyNineContact.md +++ b/docs/accounting/TenNinetyNineContact.md @@ -26,6 +26,9 @@ Name | Type | Description | Notes **street_address** | **String** | Contact address on 1099 Form | [optional] **tax_id** | **String** | Contact tax id on 1099 Form | [optional] **contact_id** | **String** | Contact contact id | [optional] +**legal_name** | **String** | Contact legal name | [optional] +**business_name** | **String** | Contact business name | [optional] +**federal_tax_classification** | **String** | Contact federal tax classification | [optional] ## Code Sample @@ -53,7 +56,10 @@ instance = XeroRuby::Accounting::TenNinetyNineContact.new(box1: null, email: null, street_address: null, tax_id: null, - contact_id: null) + contact_id: null, + legal_name: null, + business_name: null, + federal_tax_classification: null) ``` diff --git a/docs/accounting/index.html b/docs/accounting/index.html deleted file mode 100644 index 229941cd..00000000 --- a/docs/accounting/index.html +++ /dev/null @@ -1,43976 +0,0 @@ - - - - - Xero Accounting API - - - - - - xero-ruby Accounting SDK Docs - - - - - - - - - - - - - - - - - - -
- -
- -
-
- - -
-
- -
-
- -
-
-
-
-
- -
-
-
-
-

Xero Accounting API

-
-
-
- -
-
-

Accounting

-
-
-
-

createAccount

-

Creates a new chart of accounts

-
-
-
-

-

-

-
- 
/Accounts
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-account = { 
-  code: "123456",
-  name: "FooBar",
-  type:  XeroRuby::Accounting::AccountType::EXPENSE,
-  description: "Hello World"
-}  
-
-begin
-  response = xero_client.accounting_api.create_account(xero_tenant_id, account)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_account: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
account * -
-
- - Account - -
- Account object in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createAccountAttachmentByFileName

-

Creates an attachment on a specific account

-
-
-
-

-

-

-
- 
/Accounts/{AccountID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-account_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_account_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
AccountID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Account object -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createBankTransactionAttachmentByFileName

-

Creates an attachment for a specific bank transaction by filename

-
-
-
-

-

-

-
- 
/BankTransactions/{BankTransactionID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transaction_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_bank_transaction_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
BankTransactionID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transaction -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createBankTransactionHistoryRecord

-

Creates a history record for a specific bank transactions

-
-
-
-

-

-

-
- 
/BankTransactions/{BankTransactionID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transaction_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_bank_transaction_history_record: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BankTransactionID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transaction -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createBankTransactions

-

Creates one or more spent or received money transaction

-
-
-
-

-

-

-
- 
/BankTransactions
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-unitdp = 4
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-line_item = { 
-  description: "Foobar",
-  quantity: 1.0,
-  unit_amount: 20.0,
-  account_code: "000"
-}    
-line_items = []
-line_items << line_item
-
-bank_account = { 
-  account_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-bank_transaction = { 
-  type:  XeroRuby::Accounting::BankTransaction::RECEIVE,
-  contact: contact,
-  lineItems: lineItems,
-  bank_account:  bank_account
-}  
-
-bankTransactions = {  
-  bank_transactions: [bank_transaction]
-} 
-
-begin
-  response = xero_client.accounting_api.create_bank_transactions(xero_tenant_id, bankTransactions, summarize_errors, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_bank_transactions: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
bankTransactions * -
-
- - BankTransactions - -
- BankTransactions with an array of BankTransaction objects in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

createBankTransfer

-

Creates a bank transfer

-
-
-
-

-

-

-
- 
/BankTransfers
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-fromBankAccount = { 
-  account_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-toBankAccount = { 
-  account_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-bank_transfer = { 
-  from_bank_account: fromBankAccount,
-  to_bank_account: toBankAccount,
-  amount: 1.0
-}  
-
-bankTransfers = {  
-  bank_transfers: [bank_transfer]
-} 
-
-begin
-  response = xero_client.accounting_api.create_bank_transfer(xero_tenant_id, bankTransfers)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_bank_transfer: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
bankTransfers * -
-
- - BankTransfers - -
- BankTransfers with array of BankTransfer objects in request body -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createBankTransferAttachmentByFileName

-

-
-
-
-

-

-

-
- 
/BankTransfers/{BankTransferID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transfer_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_bank_transfer_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
BankTransferID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transfer -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createBankTransferHistoryRecord

-

Creates a history record for a specific bank transfer

-
-
-
-

-

-

-
- 
/BankTransfers/{BankTransferID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transfer_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_bank_transfer_history_record: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BankTransferID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transfer -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createBatchPayment

-

Creates one or many batch payments for invoices

-
-
-
-

-

-

-
- 
/BatchPayments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-curr_date = 'YYYY-MM-DD'
-
-payment_account = { 
-  account_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-bank_account = { 
-  account_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-invoice = { 
-  invoice_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-payment = { 
-  account:  bank_account,
-  date:  curr_date,
-  amount: 1.0,
-  invoice: invoice
-}    
-payments = []
-payments << payment
-
-batch_payment = { 
-  account:  payment_account,
-  reference: "hello foobar",
-  date:  curr_date,
-  payments: payments
-}  
-
-batchPayments = {  
-  batch_payments: [batch_payment]
-} 
-
-begin
-  response = xero_client.accounting_api.create_batch_payment(xero_tenant_id, batchPayments, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_batch_payment: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
batchPayments * -
-
- - BatchPayments - -
- BatchPayments with an array of Payments in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

createBatchPaymentHistoryRecord

-

Creates a history record for a specific batch payment

-
-
-
-

-

-

-
- 
/BatchPayments/{BatchPaymentID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-batch_payment_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_batch_payment_history_record(xero_tenant_id, batch_payment_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_batch_payment_history_record: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BatchPaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for BatchPayment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createBrandingThemePaymentServices

-

Creates a new custom payment service for a specific branding theme

-
-
-
-

-

-

-
- 
/BrandingThemes/{BrandingThemeID}/PaymentServices
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-branding_theme_id = '00000000-0000-0000-0000-000000000000'
-
-payment_service = { 
-  payment_service_id: "00000000-0000-0000-0000-000000000000",
-  payment_service_name: "ACME Payments",
-  payment_service_url: "https://www.payupnow.com/",
-  pay_now_text: "Pay Now"
-}  
-
-paymentServices = {  
-  paymentServices: [paymentService]
-} 
-
-begin
-  response = xero_client.accounting_api.create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, paymentServices)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_branding_theme_payment_services: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
paymentservicesGrant read-write access to payment services
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BrandingThemeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Branding Theme -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
paymentServices * -
-
- - PaymentServices - -
- PaymentServices array with PaymentService object in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createContactAttachmentByFileName

-

-
-
-
-

-

-

-
- 
/Contacts/{ContactID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_contact_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
ContactID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createContactGroup

-

Creates a contact group

-
-
-
-

-

-

-
- 
/ContactGroups
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-contact_group = { 
-  name: "VIPs"
-}  
-
-contactGroups = {  
-  contact_groups: [contact_group]
-} 
-
-begin
-  response = xero_client.accounting_api.create_contact_group(xero_tenant_id, contactGroups)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_contact_group: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
contactGroups * -
-
- - ContactGroups - -
- ContactGroups with an array of names in request body -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createContactGroupContacts

-

Creates contacts to a specific contact group

-
-
-
-

-

-

-
- 
/ContactGroups/{ContactGroupID}/Contacts
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_group_id = '00000000-0000-0000-0000-000000000000'
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-contacts = {  
-  contacts: [contact]
-} 
-
-begin
-  response = xero_client.accounting_api.create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_contact_group_contacts: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ContactGroupID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact Group -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
contacts * -
-
- - Contacts - -
- Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createContactHistory

-

Creates a new history record for a specific contact

-
-
-
-

-

-

-
- 
/Contacts/{ContactID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_contact_history(xero_tenant_id, contact_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_contact_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ContactID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createContacts

-

Creates multiple contacts (bulk) in a Xero organisation

-
-
-
-

-

-

-
- 
/Contacts
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-
-phone = { 
-  phone_number: "555-1212",
-  phone_type:  XeroRuby::Accounting::PhoneType::MOBILE
-}    
-phones = []
-phones << phone
-
-contact = { 
-  name: "Bruce Banner",
-  email_address: "hulk@avengers.com",
-  phones: phones
-}  
-
-contacts = {  
-  contacts: [contact]
-} 
-
-begin
-  response = xero_client.accounting_api.create_contacts(xero_tenant_id, contacts, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_contacts: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
contacts * -
-
- - Contacts - -
- Contacts with an array of Contact objects to create in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

createCreditNoteAllocation

-

Creates allocation for a specific credit note

-
-
-
-

-

-

-
- 
/CreditNotes/{CreditNoteID}/Allocations
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-credit_note_id = '00000000-0000-0000-0000-000000000000'
-summarize_errors = true
-curr_date = 'YYYY-MM-DD'
-
-invoice = { 
-  invoiceID: "00000000-0000-0000-0000-000000000000"
-}  
-
-allocation = { 
-  amount: 1.0,
-  date:  curr_date,
-  invoice: invoice
-}  
-
-allocations = {  
-  allocations: [allocation]
-} 
-
-begin
-  response = xero_client.accounting_api.create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_credit_note_allocation: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
CreditNoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Credit Note -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
allocations * -
-
- - Allocations - -
- Allocations with array of Allocation object in body of request. -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

createCreditNoteAttachmentByFileName

-

Creates an attachment for a specific credit note

-
-
-
-

-

-

-
- 
/CreditNotes/{CreditNoteID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-credit_note_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-include_online = true
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, include_online)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_credit_note_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
CreditNoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Credit Note -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
IncludeOnline - - -
-
-
- - Boolean - - -
-Allows an attachment to be seen by the end customer within their online invoice -
-
-
-
-
-
-
-
-
-
-
-

createCreditNoteHistory

-

Retrieves history records of a specific credit note

-
-
-
-

-

-

-
- 
/CreditNotes/{CreditNoteID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-credit_note_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_credit_note_history(xero_tenant_id, credit_note_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_credit_note_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
CreditNoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Credit Note -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createCreditNotes

-

Creates a new credit note

-
-
-
-

-

-

-
- 
/CreditNotes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-unitdp = 4
-curr_date = 'YYYY-MM-DD'
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-line_item = { 
-  description: "Foobar",
-  quantity: 1.0,
-  unit_amount: 20.0,
-  account_code: "000"
-}    
-line_items = []
-line_items << line_item
-
-credit_note = { 
-  type:  XeroRuby::Accounting::CreditNote::ACCPAYCREDIT,
-  contact: contact,
-  date:  curr_date,
-  line_items:  line_items
-}  
-
-creditNotes = {  
-  credit_notes: [credit_note]
-} 
-
-begin
-  response = xero_client.accounting_api.create_credit_notes(xero_tenant_id, creditNotes, summarize_errors, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_credit_notes: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
creditNotes * -
-
- - CreditNotes - -
- Credit Notes with array of CreditNote object in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

createCurrency

-

Create a new currency for a Xero organisation

-
-
-
-

-

-

-
- 
/Currencies
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-currency = { 
-  code:  XeroRuby::Accounting::CurrencyCode::USD,
-  description: "United States Dollar"
-}  
-
-begin
-  response = xero_client.accounting_api.create_currency(xero_tenant_id, currency)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_currency: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
currency * -
-
- - Currency - -
- Currency object in the body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployees

-

Creates new employees used in Xero payrun

-
-
-
-

-

-

-
- 
/Employees
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-
-employee = { 
-  first_name: "Nick",
-  last_name: "Fury"
-}  
-
-employees = {  
-  employees: [employee]
-} 
-
-begin
-  response = xero_client.accounting_api.create_employees(xero_tenant_id, employees, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employees: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employees * -
-
- - Employees - -
- Employees with array of Employee object in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

createExpenseClaimHistory

-

Creates a history record for a specific expense claim

-
-
-
-

-

-

-
- 
/ExpenseClaims/{ExpenseClaimID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-expense_claim_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_expense_claim_history(xero_tenant_id, expense_claim_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_expense_claim_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ExpenseClaimID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a ExpenseClaim -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createExpenseClaims

-

Creates expense claims

-
-
-
-

-

-

-
- 
/ExpenseClaims
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-curr_date = 'YYYY-MM-DD'
-
-user = { 
-  user_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-receipt = { 
-  receipt_id: "00000000-0000-0000-0000-000000000000",
-  date:  curr_date
-}    
-receipts = []
-receipts << receipt
-
-expense_claim = { 
-  status:  XeroRuby::Accounting::ExpenseClaim::SUBMITTED,
-  user: user,
-  receipts: receipts
-}  
-
-expenseClaims = {  
-  expense_claims: [expense_claim]
-} 
-
-begin
-  response = xero_client.accounting_api.create_expense_claims(xero_tenant_id, expenseClaims)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_expense_claims: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
expenseClaims * -
-
- - ExpenseClaims - -
- ExpenseClaims with array of ExpenseClaim object in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createInvoiceAttachmentByFileName

-

Creates an attachment for a specific invoice or purchase bill by filename

-
-
-
-

-

-

-
- 
/Invoices/{InvoiceID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-invoice_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-include_online = true
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, include_online)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_invoice_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
InvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Invoice -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
IncludeOnline - - -
-
-
- - Boolean - - -
-Allows an attachment to be seen by the end customer within their online invoice -
-
-
-
-
-
-
-
-
-
-
-

createInvoiceHistory

-

Creates a history record for a specific invoice

-
-
-
-

-

-

-
- 
/Invoices/{InvoiceID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-invoice_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_invoice_history(xero_tenant_id, invoice_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_invoice_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
InvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Invoice -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createInvoices

-

Creates one or more sales invoices or purchase bills

-
-
-
-

-

-

-
- 
/Invoices
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-unitdp = 4
-date_value = 'YYYY-MM-DD'
-due_date_value = 'YYYY-MM-DD'
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-line_item_tracking = { 
-  tracking_category_id: "00000000-0000-0000-0000-000000000000",
-  tracking_option_id: "00000000-0000-0000-0000-000000000000"
-}    
-line_item_trackings = []
-line_item_trackings << line_item_tracking
-
-line_item = { 
-  description: "Foobar",
-  quantity: 1.0,
-  unit_amount: 20.0,
-  account_code: "000",
-  tracking: lineItemTrackings
-}    
-line_items = []
-line_items << line_item
-
-invoice = { 
-  type:  XeroRuby::Accounting::Invoice::ACCREC,
-  contact: contact,
-  date:  date_value,
-  due_date:  due_date_value,
-  line_items:  line_items,
-  reference: "Website Design",
-  status:  XeroRuby::Accounting::Invoice::DRAFT
-}  
-
-invoices = {  
-  invoices: [invoice]
-} 
-
-begin
-  response = xero_client.accounting_api.create_invoices(xero_tenant_id, invoices, summarize_errors, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_invoices: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
invoices * -
-
- - Invoices - -
- Invoices with an array of invoice objects in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

createItemHistory

-

Creates a history record for a specific item

-
-
-
-

-

-

-
- 
/Items/{ItemID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-item_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_item_history(xero_tenant_id, item_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_item_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ItemID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Item -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createItems

-

Creates one or more items

-
-
-
-

-

-

-
- 
/Items
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-unitdp = 4
-
-purchase_details = { 
-  cogs_account_code: "500"
-}  
-
-item = { 
-  code: "abcXYZ123",
-  name: "HelloWorld",
-  description: "Foobar",
-  inventory_asset_account_code: "140",
-  purchase_details:  purchase_details
-}  
-
-items = {  
-  items: [item]
-} 
-
-begin
-  response = xero_client.accounting_api.create_items(xero_tenant_id, items, summarize_errors, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_items: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
items * -
-
- - Items - -
- Items with an array of Item objects in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

createLinkedTransaction

-

Creates linked transactions (billable expenses)

-
-
-
-

-

-

-
- 
/LinkedTransactions
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-linked_transaction = { 
-  source_transaction_id: "00000000-0000-0000-0000-000000000000",
-  source_line_item_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-begin
-  response = xero_client.accounting_api.create_linked_transaction(xero_tenant_id, linkedTransaction)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_linked_transaction: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
linkedTransaction * -
-
- - LinkedTransaction - -
- LinkedTransaction object in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createManualJournalAttachmentByFileName

-

Creates a specific attachment for a specific manual journal by file name

-
-
-
-

-

-

-
- 
/ManualJournals/{ManualJournalID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-manual_journal_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_manual_journal_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
ManualJournalID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a ManualJournal -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createManualJournalHistoryRecord

-

Creates a history record for a specific manual journal

-
-
-
-

-

-

-
- 
/ManualJournals/{ManualJournalID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-manual_journal_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_manual_journal_history_record(xero_tenant_id, manual_journal_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_manual_journal_history_record: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ManualJournalID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a ManualJournal -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createManualJournals

-

Creates one or more manual journals

-
-
-
-

-

-

-
- 
/ManualJournals
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-date_value = 'YYYY-MM-DD'  
-manual_journal_lines = []
-
-credit = { 
-  line_amount: 100.0,
-  account_code: "400",
-  description: "Hello there"
-}  
-manual_journal_lines << credit
-
-debit = { 
-  line_amount: -100.0,
-  account_code: "120",
-  description: "Hello there"
-}  
-manual_journal_lines << debit
-
-manual_journal = { 
-  narration: "Foobar",
-  date:  date_value,
-  journal_lines:  manual_journal_lines
-}  
-
-manualJournals = {  
-  manual_journals: [manual_journal]
-} 
-
-begin
-  response = xero_client.accounting_api.create_manual_journals(xero_tenant_id, manualJournals, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_manual_journals: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
manualJournals * -
-
- - ManualJournals - -
- ManualJournals array with ManualJournal object in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

createOverpaymentAllocations

-

Creates a single allocation for a specific overpayment

-
-
-
-

-

-

-
- 
/Overpayments/{OverpaymentID}/Allocations
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-overpayment_id = '00000000-0000-0000-0000-000000000000'
-summarize_errors = true
-curr_date = 'YYYY-MM-DD'
-
-invoice = { 
-  invoice_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-allocation = { 
-  amount: 1.0,
-  date:  curr_date,
-  invoice: invoice
-}  
-
-allocations = {  
-  allocations: [allocation]
-} 
-
-begin
-  response = xero_client.accounting_api.create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_overpayment_allocations: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
OverpaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Overpayment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
allocations * -
-
- - Allocations - -
- Allocations array with Allocation object in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

createOverpaymentHistory

-

Creates a history record for a specific overpayment

-
-
-
-

-

-

-
- 
/Overpayments/{OverpaymentID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-overpayment_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_overpayment_history(xero_tenant_id, overpayment_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_overpayment_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
OverpaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Overpayment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createPayment

-

Creates a single payment for invoice or credit notes

-
-
-
-

-

-

-
- 
/Payments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-date_value = 'YYYY-MM-DD'
-
-invoice = { 
-  invoice_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-account = { 
-  account_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-payment = { 
-  invoice: invoice,
-  account: account,
-  amount: 1.0,
-  date:  date_value
-}  
-
-payments = {  
-  payments: [payment]
-} 
-
-begin
-  response = xero_client.accounting_api.create_payment(xero_tenant_id, payment)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_payment: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
payment * -
-
- - Payment - -
- Request body with a single Payment object -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createPaymentHistory

-

Creates a history record for a specific payment

-
-
-
-

-

-

-
- 
/Payments/{PaymentID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-payment_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_payment_history(xero_tenant_id, payment_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_payment_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Payment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createPaymentService

-

Creates a payment service

-
-
-
-

-

-

-
- 
/PaymentServices
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-payment_service = { 
-  payment_service_name: "ACME Payments",
-  payment_service_url: "https://www.payupnow.com/",
-  pay_now_text: "Pay Now"
-}  
-
-paymentServices = {  
-  paymentServices: [paymentService]
-} 
-
-begin
-  response = xero_client.accounting_api.create_payment_service(xero_tenant_id, paymentServices)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_payment_service: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
paymentservicesGrant read-write access to payment services
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
paymentServices * -
-
- - PaymentServices - -
- PaymentServices array with PaymentService object in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createPayments

-

Creates multiple payments for invoices or credit notes

-
-
-
-

-

-

-
- 
/Payments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-date_value = 'YYYY-MM-DD'
-
-invoice = { 
-  invoice_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-account = { 
-  account_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-payment = { 
-  invoice: invoice,
-  account: account,
-  amount: 1.0,
-  date:  date_value
-}  
-
-payments = {  
-  payments: [payment]
-} 
-
-begin
-  response = xero_client.accounting_api.create_payments(xero_tenant_id, payments, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_payments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
payments * -
-
- - Payments - -
- Payments array with Payment object in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

createPrepaymentAllocations

-

Allows you to create an Allocation for prepayments

-
-
-
-

-

-

-
- 
/Prepayments/{PrepaymentID}/Allocations
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-prepayment_id = '00000000-0000-0000-0000-000000000000'
-summarize_errors = true
-curr_date = 'YYYY-MM-DD'
-
-invoice = { 
-  invoice_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-allocation = { 
-  invoice: invoice,
-  amount: 1.0,
-  date:  curr_date
-}  
-
-allocations = {  
-  allocations: [allocation]
-} 
-
-begin
-  response = xero_client.accounting_api.create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_prepayment_allocations: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PrepaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a PrePayment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
allocations * -
-
- - Allocations - -
- Allocations with an array of Allocation object in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

createPrepaymentHistory

-

Creates a history record for a specific prepayment

-
-
-
-

-

-

-
- 
/Prepayments/{PrepaymentID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-prepayment_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_prepayment_history(xero_tenant_id, prepayment_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_prepayment_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PrepaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a PrePayment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createPurchaseOrderAttachmentByFileName

-

Creates attachment for a specific purchase order

-
-
-
-

-

-

-
- 
/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-purchase_order_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_purchase_order_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
PurchaseOrderID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Purchase Order -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createPurchaseOrderHistory

-

Creates a history record for a specific purchase orders

-
-
-
-

-

-

-
- 
/PurchaseOrders/{PurchaseOrderID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-purchase_order_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_purchase_order_history(xero_tenant_id, purchase_order_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_purchase_order_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PurchaseOrderID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Purchase Order -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createPurchaseOrders

-

Creates one or more purchase orders

-
-
-
-

-

-

-
- 
/PurchaseOrders
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-date_value = 'YYYY-MM-DD'
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-line_item = { 
-  description: "Foobar",
-  quantity: 1.0,
-  unit_amount: 20.0,
-  account_code: "000"
-}    
-line_items = []
-line_items << line_item
-
-purchase_order = { 
-  contact: contact,
-  line_items:  line_items,
-  date:  date_value
-}  
-
-purchaseOrders = {  
-  purchase_orders: [purchase_order]
-} 
-
-begin
-  response = xero_client.accounting_api.create_purchase_orders(xero_tenant_id, purchaseOrders, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_purchase_orders: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
purchaseOrders * -
-
- - PurchaseOrders - -
- PurchaseOrders with an array of PurchaseOrder object in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

createQuoteAttachmentByFileName

-

Creates attachment for a specific quote

-
-
-
-

-

-

-
- 
/Quotes/{QuoteID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-quote_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_quote_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
QuoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Quote -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createQuoteHistory

-

Creates a history record for a specific quote

-
-
-
-

-

-

-
- 
/Quotes/{QuoteID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-quote_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_quote_history(xero_tenant_id, quote_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_quote_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
QuoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Quote -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createQuotes

-

Create one or more quotes

-
-
-
-

-

-

-
- 
/Quotes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-date_value = 'YYYY-MM-DD'
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-line_item = { 
-  description: "Foobar",
-  quantity: 1.0,
-  unit_amount: 20.0,
-  account_code: "000"
-}    
-line_items = []
-line_items << line_item
-
-quote = { 
-  contact: contact,
-  line_items:  line_items,
-  date:  date_value
-}  
-
-quotes = {  
-  quotes: [quote]
-} 
-
-begin
-  response = xero_client.accounting_api.create_quotes(xero_tenant_id, quotes, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_quotes: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
quotes * -
-
- - Quotes - -
- Quotes with an array of Quote object in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

createReceipt

-

Creates draft expense claim receipts for any user

-
-
-
-

-

-

-
- 
/Receipts
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-unitdp = 4
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-user = { 
-  user_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-line_item = { 
-  description: "Foobar",
-  quantity: 1.0,
-  unit_amount: 20.0,
-  account_code: "000"
-}    
-line_items = []
-line_items << line_item
-
-receipt = { 
-  contact: contact,
-  user: user,
-  line_items:  line_items,
-  line_amount_types:  XeroRuby::Accounting::INCLUSIVE,
-  status:  XeroRuby::Accounting::Receipt::DRAFT
-}  
-
-receipts = {  
-  receipts: [receipt]
-} 
-
-begin
-  response = xero_client.accounting_api.create_receipt(xero_tenant_id, receipts, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_receipt: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
receipts * -
-
- - Receipts - -
- Receipts with an array of Receipt object in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

createReceiptAttachmentByFileName

-

Creates an attachment on a specific expense claim receipts by file name

-
-
-
-

-

-

-
- 
/Receipts/{ReceiptID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-receipt_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_receipt_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
ReceiptID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Receipt -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createReceiptHistory

-

Creates a history record for a specific receipt

-
-
-
-

-

-

-
- 
/Receipts/{ReceiptID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-receipt_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_receipt_history(xero_tenant_id, receipt_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_receipt_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ReceiptID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Receipt -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createRepeatingInvoiceAttachmentByFileName

-

Creates an attachment from a specific repeating invoices by file name

-
-
-
-

-

-

-
- 
/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-repeating_invoice_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_repeating_invoice_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
RepeatingInvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Repeating Invoice -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createRepeatingInvoiceHistory

-

Creates a history record for a specific repeating invoice

-
-
-
-

-

-

-
- 
/RepeatingInvoices/{RepeatingInvoiceID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-repeating_invoice_id = '00000000-0000-0000-0000-000000000000'
-
-history_record = { 
-  details: "Hello World"
-}  
-
-historyRecords = {  
-  history_records: [history_record]
-} 
-
-begin
-  response = xero_client.accounting_api.create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, historyRecords)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_repeating_invoice_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
RepeatingInvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Repeating Invoice -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
historyRecords * -
-
- - HistoryRecords - -
- HistoryRecords containing an array of HistoryRecord objects in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createRepeatingInvoices

-

Creates one or more repeating invoice templates

-
-
-
-

-

-

-
- 
/RepeatingInvoices
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-
-begin
-  response = xero_client.accounting_api.create_repeating_invoices(xero_tenant_id, repeatingInvoices, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_repeating_invoices: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
repeatingInvoices * -
-
- - RepeatingInvoices - -
- RepeatingInvoices with an array of repeating invoice objects in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

createTaxRates

-

Creates one or more tax rates

-
-
-
-

-

-

-
- 
/TaxRates
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-tax_component = { 
-  name: "State Tax",
-  rate: 2.25
-}    
-taxComponent = []
-tax_components << tax_component
-
-tax_rate = { 
-  name: "CA State Tax",
-  taxComponents: taxComponents,
-
-taxRates = {  
-  tax_rates: [tax_rate]
-} 
-
-begin
-  response = xero_client.accounting_api.create_tax_rates(xero_tenant_id, taxRates)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_tax_rates: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
taxRates * -
-
- - TaxRates - -
- TaxRates array with TaxRate object in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createTrackingCategory

-

Create tracking categories

-
-
-
-

-

-

-
- 
/TrackingCategories
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-trackingCategory = { 
-  name: "Foobar"
-}  
-
-begin
-  response = xero_client.accounting_api.create_tracking_category(xero_tenant_id, trackingCategory)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_tracking_category: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
trackingCategory * -
-
- - TrackingCategory - -
- TrackingCategory object in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createTrackingOptions

-

Creates options for a specific tracking category

-
-
-
-

-

-

-
- 
/TrackingCategories/{TrackingCategoryID}/Options
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-tracking_category_id = '00000000-0000-0000-0000-000000000000'
-
-trackingOption = { 
-  name: "Foobar"
-}  
-
-begin
-  response = xero_client.accounting_api.create_tracking_options(xero_tenant_id, tracking_category_id, trackingOption)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_tracking_options: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TrackingCategoryID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a TrackingCategory -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
trackingOption * -
-
- - TrackingOption - -
- TrackingOption object in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

deleteAccount

-

Deletes a chart of accounts

-
-
-
-

-

-

-
- 
/Accounts/{AccountID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-account_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.delete_account(xero_tenant_id, account_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_account: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
AccountID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Account object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteBatchPayment

-

Updates a specific batch payment for invoices and credit notes

-
-
-
-

-

-

-
- 
/BatchPayments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-batchPaymentDelete = { 
-  status: "DELETED"
-}  
-  batch_payment_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-begin
-  response = xero_client.accounting_api.delete_batch_payment(xero_tenant_id, batchPaymentDelete)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_batch_payment: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
batchPaymentDelete * -
-
- - BatchPaymentDelete - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

deleteBatchPaymentByUrlParam

-

Updates a specific batch payment for invoices and credit notes

-
-
-
-

-

-

-
- 
/BatchPayments/{BatchPaymentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-batch_payment_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batchPaymentDeleteByUrlParam)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_batch_payment_by_url_param: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BatchPaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for BatchPayment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
batchPaymentDeleteByUrlParam * -
-
- - BatchPaymentDeleteByUrlParam - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

deleteContactGroupContact

-

Deletes a specific contact from a contact group using a unique contact Id

-
-
-
-

-

-

-
- 
/ContactGroups/{ContactGroupID}/Contacts/{ContactID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_group_id = '00000000-0000-0000-0000-000000000000'
-contact_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_contact_group_contact: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
ContactGroupID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact Group -
-
-
- Required -
-
-
-
ContactID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteContactGroupContacts

-

Deletes all contacts from a specific contact group

-
-
-
-

-

-

-
- 
/ContactGroups/{ContactGroupID}/Contacts
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_group_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.delete_contact_group_contacts(xero_tenant_id, contact_group_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_contact_group_contacts: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ContactGroupID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact Group -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteItem

-

Deletes a specific item

-
-
-
-

-

-

-
- 
/Items/{ItemID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-item_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.delete_item(xero_tenant_id, item_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_item: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ItemID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Item -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteLinkedTransaction

-

Deletes a specific linked transactions (billable expenses)

-
-
-
-

-

-

-
- 
/LinkedTransactions/{LinkedTransactionID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-linked_transaction_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.delete_linked_transaction(xero_tenant_id, linked_transaction_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_linked_transaction: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
LinkedTransactionID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a LinkedTransaction -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deletePayment

-

Updates a specific payment for invoices and credit notes

-
-
-
-

-

-

-
- 
/Payments/{PaymentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-payment_id = '00000000-0000-0000-0000-000000000000'
-
-paymentDelete = { 
-  status: "DELETED"
-}  
-
-begin
-  response = xero_client.accounting_api.delete_payment(xero_tenant_id, payment_id, paymentDelete)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_payment: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Payment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
paymentDelete * -
-
- - PaymentDelete - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

deleteTrackingCategory

-

Deletes a specific tracking category

-
-
-
-

-

-

-
- 
/TrackingCategories/{TrackingCategoryID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-tracking_category_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.delete_tracking_category(xero_tenant_id, tracking_category_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_tracking_category: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TrackingCategoryID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a TrackingCategory -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteTrackingOptions

-

Deletes a specific option for a specific tracking category

-
-
-
-

-

-

-
- 
/TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-tracking_category_id = '00000000-0000-0000-0000-000000000000'
-tracking_option_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.delete_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_tracking_options: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
TrackingCategoryID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a TrackingCategory -
-
-
- Required -
-
-
-
TrackingOptionID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Tracking Option -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

emailInvoice

-

Sends a copy of a specific invoice to related contact via email

-
-
-
-

-

-

-
- 
/Invoices/{InvoiceID}/Email
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-invoice_id = '00000000-0000-0000-0000-000000000000'
-
-requestEmpty = { }
-
-begin
-  response = xero_client.accounting_api.email_invoice(xero_tenant_id, invoice_id, requestEmpty)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling email_invoice: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
InvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Invoice -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
requestEmpty * -
-
- - RequestEmpty - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

getAccount

-

Retrieves a single chart of accounts by using a unique account Id

-
-
-
-

-

-

-
- 
/Accounts/{AccountID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-account_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_account(xero_tenant_id, account_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_account: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
AccountID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Account object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getAccountAttachmentByFileName

-

Retrieves an attachment for a specific account by filename

-
-
-
-

-

-

-
- 
/Accounts/{AccountID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-account_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_account_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
AccountID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Account object -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getAccountAttachmentById

-

Retrieves a specific attachment from a specific account using a unique attachment Id

-
-
-
-

-

-

-
- 
/Accounts/{AccountID}/Attachments/{AttachmentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-account_id = '00000000-0000-0000-0000-000000000000'
-attachment_id = '00000000-0000-0000-0000-000000000000'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_account_attachment_by_id(xero_tenant_id, account_id, attachment_id, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_account_attachment_by_id: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
AccountID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Account object -
-
-
- Required -
-
-
-
AttachmentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Attachment object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getAccountAttachments

-

Retrieves attachments for a specific accounts by using a unique account Id

-
-
-
-

-

-

-
- 
/Accounts/{AccountID}/Attachments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-account_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_account_attachments(xero_tenant_id, account_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_account_attachments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
AccountID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Account object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getAccounts

-

Retrieves the full chart of accounts

-
-
-
-

-

-

-
- 
/Accounts
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status==#{XeroRuby::Accounting::Account::ACTIVE}'
-order = 'Name ASC'
-
-begin
-  response = xero_client.accounting_api.get_accounts(xero_tenant_id, if_modified_since, where, order)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_accounts: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
-
-
-
-
-
-
-

getBankTransaction

-

Retrieves a single spent or received money transaction by using a unique bank transaction Id

-
-
-
-

-

-

-
- 
/BankTransactions/{BankTransactionID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transaction_id = '00000000-0000-0000-0000-000000000000'
-unitdp = 4
-
-begin
-  response = xero_client.accounting_api.get_bank_transaction(xero_tenant_id, bank_transaction_id, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_bank_transaction: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BankTransactionID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transaction -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

getBankTransactionAttachmentByFileName

-

Retrieves a specific attachment from a specific bank transaction by filename

-
-
-
-

-

-

-
- 
/BankTransactions/{BankTransactionID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transaction_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_bank_transaction_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
BankTransactionID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transaction -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBankTransactionAttachmentById

-

Retrieves specific attachments from a specific BankTransaction using a unique attachment Id

-
-
-
-

-

-

-
- 
/BankTransactions/{BankTransactionID}/Attachments/{AttachmentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transaction_id = '00000000-0000-0000-0000-000000000000'
-attachment_id = '00000000-0000-0000-0000-000000000000'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_bank_transaction_attachment_by_id(xero_tenant_id, bank_transaction_id, attachment_id, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_bank_transaction_attachment_by_id: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
BankTransactionID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transaction -
-
-
- Required -
-
-
-
AttachmentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Attachment object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBankTransactionAttachments

-

Retrieves any attachments from a specific bank transactions

-
-
-
-

-

-

-
- 
/BankTransactions/{BankTransactionID}/Attachments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transaction_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_bank_transaction_attachments(xero_tenant_id, bank_transaction_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_bank_transaction_attachments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BankTransactionID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transaction -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBankTransactions

-

Retrieves any spent or received money transactions

-
-
-
-

-

-

-
- 
/BankTransactions
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status==#{XeroRuby::Accounting::BankTransaction::AUTHORISED}'
-order = 'Type ASC'
-page = 1
-unitdp = 4
-
-begin
-  response = xero_client.accounting_api.get_bank_transactions(xero_tenant_id, if_modified_since, where, order, page, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_bank_transactions: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-Up to 100 bank transactions will be returned in a single API call with line items details -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

getBankTransactionsHistory

-

Retrieves history from a specific bank transaction using a unique bank transaction Id

-
-
-
-

-

-

-
- 
/BankTransactions/{BankTransactionID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transaction_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_bank_transactions_history(xero_tenant_id, bank_transaction_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_bank_transactions_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BankTransactionID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transaction -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBankTransfer

-

Retrieves specific bank transfers by using a unique bank transfer Id

-
-
-
-

-

-

-
- 
/BankTransfers/{BankTransferID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transfer_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_bank_transfer(xero_tenant_id, bank_transfer_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_bank_transfer: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BankTransferID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transfer -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBankTransferAttachmentByFileName

-

Retrieves a specific attachment on a specific bank transfer by file name

-
-
-
-

-

-

-
- 
/BankTransfers/{BankTransferID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transfer_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_bank_transfer_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
BankTransferID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transfer -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBankTransferAttachmentById

-

Retrieves a specific attachment from a specific bank transfer using a unique attachment ID

-
-
-
-

-

-

-
- 
/BankTransfers/{BankTransferID}/Attachments/{AttachmentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transfer_id = '00000000-0000-0000-0000-000000000000'
-attachment_id = '00000000-0000-0000-0000-000000000000'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_bank_transfer_attachment_by_id(xero_tenant_id, bank_transfer_id, attachment_id, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_bank_transfer_attachment_by_id: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
BankTransferID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transfer -
-
-
- Required -
-
-
-
AttachmentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Attachment object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBankTransferAttachments

-

Retrieves attachments from a specific bank transfer

-
-
-
-

-

-

-
- 
/BankTransfers/{BankTransferID}/Attachments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transfer_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_bank_transfer_attachments(xero_tenant_id, bank_transfer_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_bank_transfer_attachments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BankTransferID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transfer -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBankTransferHistory

-

Retrieves history from a specific bank transfer using a unique bank transfer Id

-
-
-
-

-

-

-
- 
/BankTransfers/{BankTransferID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transfer_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_bank_transfer_history(xero_tenant_id, bank_transfer_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_bank_transfer_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BankTransferID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transfer -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBankTransfers

-

Retrieves all bank transfers

-
-
-
-

-

-

-
- 
/BankTransfers
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'HasAttachments==true'
-order = 'Amount ASC'
-
-begin
-  response = xero_client.accounting_api.get_bank_transfers(xero_tenant_id, if_modified_since, where, order)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_bank_transfers: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
-
-
-
-
-
-
-

getBatchPayment

-

Retrieves a specific batch payment using a unique batch payment Id

-
-
-
-

-

-

-
- 
/BatchPayments/{BatchPaymentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-batch_payment_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_batch_payment(xero_tenant_id, batch_payment_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_batch_payment: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BatchPaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for BatchPayment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBatchPaymentHistory

-

Retrieves history from a specific batch payment

-
-
-
-

-

-

-
- 
/BatchPayments/{BatchPaymentID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-batch_payment_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_batch_payment_history(xero_tenant_id, batch_payment_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_batch_payment_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BatchPaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for BatchPayment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBatchPayments

-

Retrieves either one or many batch payments for invoices

-
-
-
-

-

-

-
- 
/BatchPayments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status==#{XeroRuby::Accounting::BatchPayment::AUTHORISED}'
-order = 'Date ASC'
-
-begin
-  response = xero_client.accounting_api.get_batch_payments(xero_tenant_id, if_modified_since, where, order)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_batch_payments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
-
-
-
-
-
-
-

getBrandingTheme

-

Retrieves a specific branding theme using a unique branding theme Id

-
-
-
-

-

-

-
- 
/BrandingThemes/{BrandingThemeID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-branding_theme_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_branding_theme(xero_tenant_id, branding_theme_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_branding_theme: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BrandingThemeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Branding Theme -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBrandingThemePaymentServices

-

Retrieves the payment services for a specific branding theme

-
-
-
-

-

-

-
- 
/BrandingThemes/{BrandingThemeID}/PaymentServices
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-branding_theme_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_branding_theme_payment_services(xero_tenant_id, branding_theme_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_branding_theme_payment_services: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
paymentservicesGrant read-write access to payment services
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BrandingThemeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Branding Theme -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBrandingThemes

-

Retrieves all the branding themes

-
-
-
-

-

-

-
- 
/BrandingThemes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-begin
-  response = xero_client.accounting_api.get_branding_themes(xero_tenant_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_branding_themes: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBudget

-

Retrieves a specific budget, which includes budget lines

-
-
-
-

-

-

-
- 
/Budgets/{BudgetID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-budget_id = '00000000-0000-0000-0000-000000000000'
-date_to = "2019-10-31"
-date_from = "2019-10-31"
-
-begin
-  response = xero_client.accounting_api.get_budget(xero_tenant_id, budget_id, date_to, date_from)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_budget: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.budgets.read
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BudgetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Budgets -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
DateTo - - -
-
-
- - date - - - (date) - - -
-Filter by start date -
-
-
-
-
DateFrom - - -
-
-
- - date - - - (date) - - -
-Filter by end date -
-
-
-
-
-
-
-
-
-
-
-

getBudgets

-

Retrieve a list of budgets

-
-
-
-

-

-

-
- 
/Budgets
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-ids = ["00000000-0000-0000-0000-000000000000"]
-date_to = "2019-10-31"
-date_from = "2019-10-31"
-
-begin
-  response = xero_client.accounting_api.get_budgets(xero_tenant_id, ids, date_to, date_from)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_budgets: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.budgets.read
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
IDs - - -
-
-
- - array[UUID] - - - (uuid) - - -
-Filter by BudgetID. Allows you to retrieve a specific individual budget. -
-
-
-
-
DateTo - - -
-
-
- - date - - - (date) - - -
-Filter by start date -
-
-
-
-
DateFrom - - -
-
-
- - date - - - (date) - - -
-Filter by end date -
-
-
-
-
-
-
-
-
-
-
-

getContact

-

Retrieves a specific contacts in a Xero organisation using a unique contact Id

-
-
-
-

-

-

-
- 
/Contacts/{ContactID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_contact(xero_tenant_id, contact_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_contact: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
accounting.contacts.readGrant read-only access to contacts and contact groups
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ContactID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getContactAttachmentByFileName

-

Retrieves a specific attachment from a specific contact by file name

-
-
-
-

-

-

-
- 
/Contacts/{ContactID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_contact_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
ContactID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getContactAttachmentById

-

Retrieves a specific attachment from a specific contact using a unique attachment Id

-
-
-
-

-

-

-
- 
/Contacts/{ContactID}/Attachments/{AttachmentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_id = '00000000-0000-0000-0000-000000000000'
-attachment_id = '00000000-0000-0000-0000-000000000000'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_contact_attachment_by_id(xero_tenant_id, contact_id, attachment_id, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_contact_attachment_by_id: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
ContactID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact -
-
-
- Required -
-
-
-
AttachmentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Attachment object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getContactAttachments

-

Retrieves attachments for a specific contact in a Xero organisation

-
-
-
-

-

-

-
- 
/Contacts/{ContactID}/Attachments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_contact_attachments(xero_tenant_id, contact_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_contact_attachments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ContactID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getContactByContactNumber

-

Retrieves a specific contact by contact number in a Xero organisation

-
-
-
-

-

-

-
- 
/Contacts/{ContactNumber}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_number = 'SB2'
-
-begin
-  response = xero_client.accounting_api.get_contact_by_contact_number(xero_tenant_id, contact_number)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_contact_by_contact_number: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
accounting.contacts.readGrant read-only access to contacts and contact groups
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ContactNumber* - - -
-
-
- - String - - -
-This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getContactCISSettings

-

Retrieves CIS settings for a specific contact in a Xero organisation

-
-
-
-

-

-

-
- 
/Contacts/{ContactID}/CISSettings
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_contact_cis_settings(xero_tenant_id, contact_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_contact_cis_settings: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ContactID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getContactGroup

-

Retrieves a specific contact group by using a unique contact group Id

-
-
-
-

-

-

-
- 
/ContactGroups/{ContactGroupID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_group_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_contact_group(xero_tenant_id, contact_group_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_contact_group: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
accounting.contacts.readGrant read-only access to contacts and contact groups
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ContactGroupID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact Group -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getContactGroups

-

Retrieves the contact Id and name of each contact group

-
-
-
-

-

-

-
- 
/ContactGroups
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-where = 'Status==#{XeroRuby::Accounting::ContactGroup::ACTIVE}'
-order = 'Name ASC'
-
-begin
-  response = xero_client.accounting_api.get_contact_groups(xero_tenant_id, where, order)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_contact_groups: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
accounting.contacts.readGrant read-only access to contacts and contact groups
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
-
-
-
-
-
-
-

getContactHistory

-

Retrieves history records for a specific contact

-
-
-
-

-

-

-
- 
/Contacts/{ContactID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_contact_history(xero_tenant_id, contact_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_contact_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
accounting.contacts.readGrant read-only access to contacts and contact groups
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ContactID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getContacts

-

Retrieves all contacts in a Xero organisation

-
-
-
-

-

-

-
- 
/Contacts
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'ContactStatus==#{XeroRuby::Accounting::Contact::ACTIVE}'
-order = 'Name ASC'
-ids = ["00000000-0000-0000-0000-000000000000"]
-page = 1
-include_archived = true
-summary_only = true
-search_term = 'Joe Bloggs'
-
-begin
-  response = xero_client.accounting_api.get_contacts(xero_tenant_id, if_modified_since, where, order, ids, page, include_archived, summary_only, search_term)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_contacts: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
accounting.contacts.readGrant read-only access to contacts and contact groups
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
IDs - - -
-
-
- - array[UUID] - - - (uuid) - - -
-Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 - Up to 100 contacts will be returned in a single API call. -
-
-
-
-
includeArchived - - -
-
-
- - Boolean - - -
-e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response -
-
-
-
-
summaryOnly - - -
-
-
- - Boolean - - -
-Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. -
-
-
-
-
searchTerm - - -
-
-
- - String - - -
-Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. -
-
-
-
-
-
-
-
-
-
-
-

getCreditNote

-

Retrieves a specific credit note using a unique credit note Id

-
-
-
-

-

-

-
- 
/CreditNotes/{CreditNoteID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-credit_note_id = '00000000-0000-0000-0000-000000000000'
-unitdp = 4
-
-begin
-  response = xero_client.accounting_api.get_credit_note(xero_tenant_id, credit_note_id, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_credit_note: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
CreditNoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Credit Note -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

getCreditNoteAsPdf

-

Retrieves credit notes as PDF files

-
-
-
-

-

-

-
- 
/CreditNotes/{CreditNoteID}/pdf
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-credit_note_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_credit_note_as_pdf(xero_tenant_id, credit_note_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_credit_note_as_pdf: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
CreditNoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Credit Note -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getCreditNoteAttachmentByFileName

-

Retrieves a specific attachment on a specific credit note by file name

-
-
-
-

-

-

-
- 
/CreditNotes/{CreditNoteID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-credit_note_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_credit_note_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
CreditNoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Credit Note -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getCreditNoteAttachmentById

-

Retrieves a specific attachment from a specific credit note using a unique attachment Id

-
-
-
-

-

-

-
- 
/CreditNotes/{CreditNoteID}/Attachments/{AttachmentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-credit_note_id = '00000000-0000-0000-0000-000000000000'
-attachment_id = '00000000-0000-0000-0000-000000000000'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_credit_note_attachment_by_id(xero_tenant_id, credit_note_id, attachment_id, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_credit_note_attachment_by_id: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
CreditNoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Credit Note -
-
-
- Required -
-
-
-
AttachmentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Attachment object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getCreditNoteAttachments

-

Retrieves attachments for a specific credit notes

-
-
-
-

-

-

-
- 
/CreditNotes/{CreditNoteID}/Attachments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-credit_note_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_credit_note_attachments(xero_tenant_id, credit_note_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_credit_note_attachments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
CreditNoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Credit Note -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getCreditNoteHistory

-

Retrieves history records of a specific credit note

-
-
-
-

-

-

-
- 
/CreditNotes/{CreditNoteID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-credit_note_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_credit_note_history(xero_tenant_id, credit_note_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_credit_note_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
CreditNoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Credit Note -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getCreditNotes

-

Retrieves any credit notes

-
-
-
-

-

-

-
- 
/CreditNotes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status==#{XeroRuby::Accounting::CreditNote::DRAFT}'
-order = 'CreditNoteNumber ASC'
-page = 1
-unitdp = 4
-
-begin
-  response = xero_client.accounting_api.get_credit_notes(xero_tenant_id, if_modified_since, where, order, page, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_credit_notes: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

getCurrencies

-

Retrieves currencies for your Xero organisation

-
-
-
-

-

-

-
- 
/Currencies
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-where = 'Code==#{XeroRuby::Accounting::CurrencyCode::USD}'
-order = 'Code ASC'
-
-begin
-  response = xero_client.accounting_api.get_currencies(xero_tenant_id, where, order)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_currencies: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
-
-
-
-
-
-
-

getEmployee

-

Retrieves a specific employee used in Xero payrun using a unique employee Id

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-employee_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_employee(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Employee -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployees

-

Retrieves employees used in Xero payrun

-
-
-
-

-

-

-
- 
/Employees
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status==#{XeroRuby::Accounting::Employee::ACTIVE}'
-order = 'LastName ASC'
-
-begin
-  response = xero_client.accounting_api.get_employees(xero_tenant_id, if_modified_since, where, order)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employees: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
-
-
-
-
-
-
-

getExpenseClaim

-

Retrieves a specific expense claim using a unique expense claim Id

-
-
-
-

-

-

-
- 
/ExpenseClaims/{ExpenseClaimID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-expense_claim_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_expense_claim(xero_tenant_id, expense_claim_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_expense_claim: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ExpenseClaimID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a ExpenseClaim -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getExpenseClaimHistory

-

Retrieves history records of a specific expense claim

-
-
-
-

-

-

-
- 
/ExpenseClaims/{ExpenseClaimID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-expense_claim_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_expense_claim_history(xero_tenant_id, expense_claim_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_expense_claim_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ExpenseClaimID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a ExpenseClaim -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getExpenseClaims

-

Retrieves expense claims

-
-
-
-

-

-

-
- 
/ExpenseClaims
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status==#{XeroRuby::Accounting::ExpenseClaim::SUBMITTED}'
-order = 'Status ASC'
-
-begin
-  response = xero_client.accounting_api.get_expense_claims(xero_tenant_id, if_modified_since, where, order)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_expense_claims: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
-
-
-
-
-
-
-

getInvoice

-

Retrieves a specific sales invoice or purchase bill using a unique invoice Id

-
-
-
-

-

-

-
- 
/Invoices/{InvoiceID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-invoice_id = '00000000-0000-0000-0000-000000000000'
-unitdp = 4
-
-begin
-  response = xero_client.accounting_api.get_invoice(xero_tenant_id, invoice_id, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_invoice: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
InvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Invoice -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

getInvoiceAsPdf

-

Retrieves invoices or purchase bills as PDF files

-
-
-
-

-

-

-
- 
/Invoices/{InvoiceID}/pdf
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-invoice_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_invoice_as_pdf(xero_tenant_id, invoice_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_invoice_as_pdf: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
InvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Invoice -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getInvoiceAttachmentByFileName

-

Retrieves an attachment from a specific invoice or purchase bill by filename

-
-
-
-

-

-

-
- 
/Invoices/{InvoiceID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-invoice_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_invoice_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
InvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Invoice -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getInvoiceAttachmentById

-

Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id

-
-
-
-

-

-

-
- 
/Invoices/{InvoiceID}/Attachments/{AttachmentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-invoice_id = '00000000-0000-0000-0000-000000000000'
-attachment_id = '00000000-0000-0000-0000-000000000000'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_invoice_attachment_by_id(xero_tenant_id, invoice_id, attachment_id, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_invoice_attachment_by_id: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
InvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Invoice -
-
-
- Required -
-
-
-
AttachmentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Attachment object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getInvoiceAttachments

-

Retrieves attachments for a specific invoice or purchase bill

-
-
-
-

-

-

-
- 
/Invoices/{InvoiceID}/Attachments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-invoice_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_invoice_attachments(xero_tenant_id, invoice_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_invoice_attachments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
InvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Invoice -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getInvoiceHistory

-

Retrieves history records for a specific invoice

-
-
-
-

-

-

-
- 
/Invoices/{InvoiceID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-invoice_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_invoice_history(xero_tenant_id, invoice_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_invoice_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
InvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Invoice -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getInvoiceReminders

-

Retrieves invoice reminder settings

-
-
-
-

-

-

-
- 
/InvoiceReminders/Settings
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-begin
-  response = xero_client.accounting_api.get_invoice_reminders(xero_tenant_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_invoice_reminders: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getInvoices

-

Retrieves sales invoices or purchase bills

-
-
-
-

-

-

-
- 
/Invoices
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status==#{XeroRuby::Accounting::Invoice::DRAFT}'
-order = 'InvoiceNumber ASC'
-ids = ["00000000-0000-0000-0000-000000000000"]
-invoice_numbers = ["INV-001", "INV-002"]
-contact_ids = ["00000000-0000-0000-0000-000000000000"]
-statuses = ["DRAFT", "SUBMITTED"]
-page = 1
-include_archived = true
-created_by_my_app = false
-unitdp = 4
-summary_only = true
-
-begin
-  response = xero_client.accounting_api.get_invoices(xero_tenant_id, if_modified_since, where, order, ids, invoice_numbers, contact_ids, statuses, page, include_archived, created_by_my_app, unitdp, summary_only)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_invoices: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
IDs - - -
-
-
- - array[UUID] - - - (uuid) - - -
-Filter by a comma-separated list of InvoicesIDs. -
-
-
-
-
InvoiceNumbers - - -
-
-
- - array[String] - - -
-Filter by a comma-separated list of InvoiceNumbers. -
-
-
-
-
ContactIDs - - -
-
-
- - array[UUID] - - - (uuid) - - -
-Filter by a comma-separated list of ContactIDs. -
-
-
-
-
Statuses - - -
-
-
- - array[String] - - -
-Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter. -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice -
-
-
-
-
includeArchived - - -
-
-
- - Boolean - - -
-e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response -
-
-
-
-
createdByMyApp - - -
-
-
- - Boolean - - -
-When set to true you'll only retrieve Invoices created by your app -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
summaryOnly - - -
-
-
- - Boolean - - -
-Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. -
-
-
-
-
-
-
-
-
-
-
-

getItem

-

Retrieves a specific item using a unique item Id

-
-
-
-

-

-

-
- 
/Items/{ItemID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-item_id = '00000000-0000-0000-0000-000000000000'
-unitdp = 4
-
-begin
-  response = xero_client.accounting_api.get_item(xero_tenant_id, item_id, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_item: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ItemID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Item -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

getItemHistory

-

Retrieves history for a specific item

-
-
-
-

-

-

-
- 
/Items/{ItemID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-item_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_item_history(xero_tenant_id, item_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_item_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ItemID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Item -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getItems

-

Retrieves items

-
-
-
-

-

-

-
- 
/Items
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'IsSold==true'
-order = 'Code ASC'
-unitdp = 4
-
-begin
-  response = xero_client.accounting_api.get_items(xero_tenant_id, if_modified_since, where, order, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_items: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

getJournal

-

Retrieves a specific journal using a unique journal Id.

-
-
-
-

-

-

-
- 
/Journals/{JournalID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-journal_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_journal(xero_tenant_id, journal_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_journal: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.journals.readGrant read-only access to journals
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
JournalID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Journal -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getJournalByNumber

-

Retrieves a specific journal using a unique journal number.

-
-
-
-

-

-

-
- 
/Journals/{JournalNumber}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-journal_number = 1000
-
-begin
-  response = xero_client.accounting_api.get_journal_by_number(xero_tenant_id, journal_number)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_journal_by_number: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.journals.readGrant read-only access to journals
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
JournalNumber* - - -
-
-
- - Integer - - -
-Number of a Journal -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getJournals

-

Retrieves journals

-
-
-
-

-

-

-
- 
/Journals
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-offset = 10
-payments_only = true
-
-begin
-  response = xero_client.accounting_api.get_journals(xero_tenant_id, if_modified_since, offset, payments_only)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_journals: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.journals.readGrant read-only access to journals
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
offset - - -
-
-
- - Integer - - -
-Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned -
-
-
-
-
paymentsOnly - - -
-
-
- - Boolean - - -
-Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default. -
-
-
-
-
-
-
-
-
-
-
-

getLinkedTransaction

-

Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id

-
-
-
-

-

-

-
- 
/LinkedTransactions/{LinkedTransactionID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-linked_transaction_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_linked_transaction(xero_tenant_id, linked_transaction_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_linked_transaction: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
LinkedTransactionID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a LinkedTransaction -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getLinkedTransactions

-

Retrieves linked transactions (billable expenses)

-
-
-
-

-

-

-
- 
/LinkedTransactions
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-page = 1
-linked_transaction_id = '00000000-0000-0000-0000-000000000000'
-source_transaction_id = '00000000-0000-0000-0000-000000000000'
-contact_id = '00000000-0000-0000-0000-000000000000'
-status = 'APPROVED'
-target_transaction_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_linked_transactions(xero_tenant_id, page, linked_transaction_id, source_transaction_id, contact_id, status, target_transaction_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_linked_transactions: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1. -
-
-
-
-
LinkedTransactionID - - -
-
-
- - UUID - - - (uuid) - - -
-The Xero identifier for an Linked Transaction -
-
-
-
-
SourceTransactionID - - -
-
-
- - UUID - - - (uuid) - - -
-Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice -
-
-
-
-
ContactID - - -
-
-
- - UUID - - - (uuid) - - -
-Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer. -
-
-
-
-
Status - - -
-
-
- - String - - -
-Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status -
-
-
-
-
TargetTransactionID - - -
-
-
- - UUID - - - (uuid) - - -
-Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice -
-
-
-
-
-
-
-
-
-
-
-

getManualJournal

-

Retrieves a specific manual journal

-
-
-
-

-

-

-
- 
/ManualJournals/{ManualJournalID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-manual_journal_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_manual_journal(xero_tenant_id, manual_journal_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_manual_journal: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ManualJournalID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a ManualJournal -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getManualJournalAttachmentByFileName

-

Retrieves a specific attachment from a specific manual journal by file name

-
-
-
-

-

-

-
- 
/ManualJournals/{ManualJournalID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-manual_journal_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_manual_journal_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
ManualJournalID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a ManualJournal -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getManualJournalAttachmentById

-

Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id

-
-
-
-

-

-

-
- 
/ManualJournals/{ManualJournalID}/Attachments/{AttachmentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-manual_journal_id = '00000000-0000-0000-0000-000000000000'
-attachment_id = '00000000-0000-0000-0000-000000000000'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_manual_journal_attachment_by_id(xero_tenant_id, manual_journal_id, attachment_id, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_manual_journal_attachment_by_id: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
ManualJournalID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a ManualJournal -
-
-
- Required -
-
-
-
AttachmentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Attachment object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getManualJournalAttachments

-

Retrieves attachment for a specific manual journal

-
-
-
-

-

-

-
- 
/ManualJournals/{ManualJournalID}/Attachments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-manual_journal_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_manual_journal_attachments(xero_tenant_id, manual_journal_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_manual_journal_attachments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ManualJournalID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a ManualJournal -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getManualJournals

-

Retrieves manual journals

-
-
-
-

-

-

-
- 
/ManualJournals
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status==#{XeroRuby::Accounting::ManualJournal::DRAFT}'
-order = 'Date ASC'
-page = 1
-
-begin
-  response = xero_client.accounting_api.get_manual_journals(xero_tenant_id, if_modified_since, where, order, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_manual_journals: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment -
-
-
-
-
-
-
-
-
-
-
-

getManualJournalsHistory

-

Retrieves history for a specific manual journal

-
-
-
-

-

-

-
- 
/ManualJournals/{ManualJournalID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-manual_journal_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_manual_journals_history(xero_tenant_id, manual_journal_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_manual_journals_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ManualJournalID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a ManualJournal -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getOnlineInvoice

-

Retrieves a URL to an online invoice

-
-
-
-

-

-

-
- 
/Invoices/{InvoiceID}/OnlineInvoice
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-invoice_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_online_invoice(xero_tenant_id, invoice_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_online_invoice: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
InvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Invoice -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getOrganisationActions

-

Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.

-
-
-
-

-

-

-
- 
/Organisation/Actions
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-begin
-  response = xero_client.accounting_api.get_organisation_actions(xero_tenant_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_organisation_actions: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getOrganisationCISSettings

-

Retrieves the CIS settings for the Xero organistaion.

-
-
-
-

-

-

-
- 
/Organisation/{OrganisationID}/CISSettings
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-organisation_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_organisation_cis_settings(xero_tenant_id, organisation_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_organisation_cis_settings: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
OrganisationID* - - -
-
-
- - UUID - - - (uuid) - - -
-The unique Xero identifier for an organisation -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getOrganisations

-

Retrieves Xero organisation details

-
-
-
-

-

-

-
- 
/Organisation
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-begin
-  response = xero_client.accounting_api.get_organisations(xero_tenant_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_organisations: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getOverpayment

-

Retrieves a specific overpayment using a unique overpayment Id

-
-
-
-

-

-

-
- 
/Overpayments/{OverpaymentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-overpayment_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_overpayment(xero_tenant_id, overpayment_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_overpayment: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
OverpaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Overpayment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getOverpaymentHistory

-

Retrieves history records of a specific overpayment

-
-
-
-

-

-

-
- 
/Overpayments/{OverpaymentID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-overpayment_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_overpayment_history(xero_tenant_id, overpayment_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_overpayment_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
OverpaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Overpayment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getOverpayments

-

Retrieves overpayments

-
-
-
-

-

-

-
- 
/Overpayments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status==#{XeroRuby::Accounting::Overpayment::AUTHORISED}'
-order = 'Status ASC'
-page = 1
-unitdp = 4
-
-begin
-  response = xero_client.accounting_api.get_overpayments(xero_tenant_id, if_modified_since, where, order, page, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_overpayments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

getPayment

-

Retrieves a specific payment for invoices and credit notes using a unique payment Id

-
-
-
-

-

-

-
- 
/Payments/{PaymentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-payment_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_payment(xero_tenant_id, payment_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_payment: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Payment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPaymentHistory

-

Retrieves history records of a specific payment

-
-
-
-

-

-

-
- 
/Payments/{PaymentID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-payment_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_payment_history(xero_tenant_id, payment_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_payment_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Payment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPaymentServices

-

Retrieves payment services

-
-
-
-

-

-

-
- 
/PaymentServices
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-begin
-  response = xero_client.accounting_api.get_payment_services(xero_tenant_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_payment_services: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
paymentservicesGrant read-write access to payment services
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPayments

-

Retrieves payments for invoices and credit notes

-
-
-
-

-

-

-
- 
/Payments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status==#{XeroRuby::Accounting::Payment::AUTHORISED}'
-order = 'Amount ASC'
-page = 1
-
-begin
-  response = xero_client.accounting_api.get_payments(xero_tenant_id, if_modified_since, where, order, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_payments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-Up to 100 payments will be returned in a single API call -
-
-
-
-
-
-
-
-
-
-
-

getPrepayment

-

Allows you to retrieve a specified prepayments

-
-
-
-

-

-

-
- 
/Prepayments/{PrepaymentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-prepayment_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_prepayment(xero_tenant_id, prepayment_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_prepayment: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PrepaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a PrePayment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPrepaymentHistory

-

Retrieves history record for a specific prepayment

-
-
-
-

-

-

-
- 
/Prepayments/{PrepaymentID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-prepayment_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_prepayment_history(xero_tenant_id, prepayment_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_prepayment_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PrepaymentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a PrePayment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPrepayments

-

Retrieves prepayments

-
-
-
-

-

-

-
- 
/Prepayments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status==#{XeroRuby::Accounting::Prepayment::AUTHORISED}'
-order = 'Reference ASC'
-page = 1
-unitdp = 4
-
-begin
-  response = xero_client.accounting_api.get_prepayments(xero_tenant_id, if_modified_since, where, order, page, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_prepayments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

getPurchaseOrder

-

Retrieves a specific purchase order using a unique purchase order Id

-
-
-
-

-

-

-
- 
/PurchaseOrders/{PurchaseOrderID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-purchase_order_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_purchase_order(xero_tenant_id, purchase_order_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_purchase_order: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PurchaseOrderID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Purchase Order -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPurchaseOrderAsPdf

-

Retrieves specific purchase order as PDF files using a unique purchase order Id

-
-
-
-

-

-

-
- 
/PurchaseOrders/{PurchaseOrderID}/pdf
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-purchase_order_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_purchase_order_as_pdf(xero_tenant_id, purchase_order_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_purchase_order_as_pdf: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PurchaseOrderID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Purchase Order -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPurchaseOrderAttachmentById

-

Retrieves specific attachment for a specific purchase order using a unique attachment Id

-
-
-
-

-

-

-
- 
/PurchaseOrders/{PurchaseOrderID}/Attachments/{AttachmentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-purchase_order_id = '00000000-0000-0000-0000-000000000000'
-attachment_id = '00000000-0000-0000-0000-000000000000'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_purchase_order_attachment_by_id(xero_tenant_id, purchase_order_id, attachment_id, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_purchase_order_attachment_by_id: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
PurchaseOrderID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Purchase Order -
-
-
- Required -
-
-
-
AttachmentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Attachment object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPurchaseOrderAttachments

-

Retrieves attachments for a specific purchase order

-
-
-
-

-

-

-
- 
/PurchaseOrders/{PurchaseOrderID}/Attachments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-purchase_order_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_purchase_order_attachments(xero_tenant_id, purchase_order_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_purchase_order_attachments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PurchaseOrderID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Purchase Order -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPurchaseOrderByNumber

-

Retrieves a specific purchase order using purchase order number

-
-
-
-

-

-

-
- 
/PurchaseOrders/{PurchaseOrderNumber}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-purchase_order_number = 'PO1234'
-
-begin
-  response = xero_client.accounting_api.get_purchase_order_by_number(xero_tenant_id, purchase_order_number)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_purchase_order_by_number: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PurchaseOrderNumber* - - -
-
-
- - String - - -
-Unique identifier for a PurchaseOrder -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPurchaseOrderHistory

-

Retrieves history for a specific purchase order

-
-
-
-

-

-

-
- 
/PurchaseOrders/{PurchaseOrderID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-purchase_order_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_purchase_order_history(xero_tenant_id, purchase_order_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_purchase_order_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PurchaseOrderID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Purchase Order -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPurchaseOrders

-

Retrieves purchase orders

-
-
-
-

-

-

-
- 
/PurchaseOrders
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-status = 'SUBMITTED'
-date_from = '2019-12-01'
-date_to = '2019-12-31'
-order = 'PurchaseOrderNumber ASC'
-page = 1
-
-begin
-  response = xero_client.accounting_api.get_purchase_orders(xero_tenant_id, if_modified_since, status, date_from, date_to, order, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_purchase_orders: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
Status - - -
-
-
- - String - - -
-Filter by purchase order status -
-
-
-
-
DateFrom - - -
-
-
- - String - - -
-Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 -
-
-
-
-
DateTo - - -
-
-
- - String - - -
-Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned. -
-
-
-
-
-
-
-
-
-
-
-

getPurchaseOrder≠AttachmentByFileName

-

Retrieves a specific attachment for a specific purchase order by filename

-
-
-
-

-

-

-
- 
/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-purchase_order_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_purchase_order≠attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_purchase_order≠attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
PurchaseOrderID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Purchase Order -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getQuote

-

Retrieves a specific quote using a unique quote Id

-
-
-
-

-

-

-
- 
/Quotes/{QuoteID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-quote_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_quote(xero_tenant_id, quote_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_quote: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
QuoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Quote -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getQuoteAsPdf

-

Retrieves a specific quote as a PDF file using a unique quote Id

-
-
-
-

-

-

-
- 
/Quotes/{QuoteID}/pdf
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-quote_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_quote_as_pdf(xero_tenant_id, quote_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_quote_as_pdf: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
QuoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Quote -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getQuoteAttachmentByFileName

-

Retrieves a specific attachment from a specific quote by filename

-
-
-
-

-

-

-
- 
/Quotes/{QuoteID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-quote_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_quote_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
QuoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Quote -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getQuoteAttachmentById

-

Retrieves a specific attachment from a specific quote using a unique attachment Id

-
-
-
-

-

-

-
- 
/Quotes/{QuoteID}/Attachments/{AttachmentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-quote_id = '00000000-0000-0000-0000-000000000000'
-attachment_id = '00000000-0000-0000-0000-000000000000'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_quote_attachment_by_id(xero_tenant_id, quote_id, attachment_id, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_quote_attachment_by_id: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
QuoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Quote -
-
-
- Required -
-
-
-
AttachmentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Attachment object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getQuoteAttachments

-

Retrieves attachments for a specific quote

-
-
-
-

-

-

-
- 
/Quotes/{QuoteID}/Attachments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-quote_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_quote_attachments(xero_tenant_id, quote_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_quote_attachments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
QuoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Quote -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getQuoteHistory

-

Retrieves history records of a specific quote

-
-
-
-

-

-

-
- 
/Quotes/{QuoteID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-quote_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_quote_history(xero_tenant_id, quote_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_quote_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
QuoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Quote -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getQuotes

-

Retrieves sales quotes

-
-
-
-

-

-

-
- 
/Quotes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-date_from = "2019-10-31"
-date_to = "2019-10-31"
-expiry_date_from = "2019-10-31"
-expiry_date_to = "2019-10-31"
-contact_id = '00000000-0000-0000-0000-000000000000'
-status = 'DRAFT'
-page = 1
-order = 'Status ASC'
-quote_number = 'QU-0001'
-
-begin
-  response = xero_client.accounting_api.get_quotes(xero_tenant_id, if_modified_since, date_from, date_to, expiry_date_from, expiry_date_to, contact_id, status, page, order, quote_number)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_quotes: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
DateFrom - - -
-
-
- - date - - - (date) - - -
-Filter for quotes after a particular date -
-
-
-
-
DateTo - - -
-
-
- - date - - - (date) - - -
-Filter for quotes before a particular date -
-
-
-
-
ExpiryDateFrom - - -
-
-
- - date - - - (date) - - -
-Filter for quotes expiring after a particular date -
-
-
-
-
ExpiryDateTo - - -
-
-
- - date - - - (date) - - -
-Filter for quotes before a particular date -
-
-
-
-
ContactID - - -
-
-
- - UUID - - - (uuid) - - -
-Filter for quotes belonging to a particular contact -
-
-
-
-
Status - - -
-
-
- - String - - -
-Filter for quotes of a particular Status -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
QuoteNumber - - -
-
-
- - String - - -
-Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001) -
-
-
-
-
-
-
-
-
-
-
-

getReceipt

-

Retrieves a specific draft expense claim receipt by using a unique receipt Id

-
-
-
-

-

-

-
- 
/Receipts/{ReceiptID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-receipt_id = '00000000-0000-0000-0000-000000000000'
-unitdp = 4
-
-begin
-  response = xero_client.accounting_api.get_receipt(xero_tenant_id, receipt_id, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_receipt: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ReceiptID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Receipt -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

getReceiptAttachmentByFileName

-

Retrieves a specific attachment from a specific expense claim receipts by file name

-
-
-
-

-

-

-
- 
/Receipts/{ReceiptID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-receipt_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_receipt_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
ReceiptID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Receipt -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getReceiptAttachmentById

-

Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id

-
-
-
-

-

-

-
- 
/Receipts/{ReceiptID}/Attachments/{AttachmentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-receipt_id = '00000000-0000-0000-0000-000000000000'
-attachment_id = '00000000-0000-0000-0000-000000000000'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_receipt_attachment_by_id(xero_tenant_id, receipt_id, attachment_id, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_receipt_attachment_by_id: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
ReceiptID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Receipt -
-
-
- Required -
-
-
-
AttachmentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Attachment object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getReceiptAttachments

-

Retrieves attachments for a specific expense claim receipt

-
-
-
-

-

-

-
- 
/Receipts/{ReceiptID}/Attachments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-receipt_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_receipt_attachments(xero_tenant_id, receipt_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_receipt_attachments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ReceiptID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Receipt -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getReceiptHistory

-

Retrieves a history record for a specific receipt

-
-
-
-

-

-

-
- 
/Receipts/{ReceiptID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-receipt_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_receipt_history(xero_tenant_id, receipt_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_receipt_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ReceiptID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Receipt -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getReceipts

-

Retrieves draft expense claim receipts for any user

-
-
-
-

-

-

-
- 
/Receipts
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status==#{XeroRuby::Accounting::Receipt::DRAFT}'
-order = 'ReceiptNumber ASC'
-unitdp = 4
-
-begin
-  response = xero_client.accounting_api.get_receipts(xero_tenant_id, if_modified_since, where, order, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_receipts: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

getRepeatingInvoice

-

Retrieves a specific repeating invoice by using a unique repeating invoice Id

-
-
-
-

-

-

-
- 
/RepeatingInvoices/{RepeatingInvoiceID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-repeating_invoice_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_repeating_invoice(xero_tenant_id, repeating_invoice_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_repeating_invoice: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
RepeatingInvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Repeating Invoice -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getRepeatingInvoiceAttachmentByFileName

-

Retrieves a specific attachment from a specific repeating invoices by file name

-
-
-
-

-

-

-
- 
/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-repeating_invoice_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_repeating_invoice_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
RepeatingInvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Repeating Invoice -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getRepeatingInvoiceAttachmentById

-

Retrieves a specific attachment from a specific repeating invoice

-
-
-
-

-

-

-
- 
/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-repeating_invoice_id = '00000000-0000-0000-0000-000000000000'
-attachment_id = '00000000-0000-0000-0000-000000000000'
-content_type = 'image/jpg'
-
-begin
-  response = xero_client.accounting_api.get_repeating_invoice_attachment_by_id(xero_tenant_id, repeating_invoice_id, attachment_id, content_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_repeating_invoice_attachment_by_id: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
RepeatingInvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Repeating Invoice -
-
-
- Required -
-
-
-
AttachmentID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Attachment object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
contentType* - - -
-
-
- - String - - -
-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getRepeatingInvoiceAttachments

-

Retrieves attachments from a specific repeating invoice

-
-
-
-

-

-

-
- 
/RepeatingInvoices/{RepeatingInvoiceID}/Attachments
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-repeating_invoice_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_repeating_invoice_attachments(xero_tenant_id, repeating_invoice_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_repeating_invoice_attachments: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.attachmentsGrant read-write access to attachments
accounting.attachments.readGrant read-only access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
RepeatingInvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Repeating Invoice -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getRepeatingInvoiceHistory

-

Retrieves history record for a specific repeating invoice

-
-
-
-

-

-

-
- 
/RepeatingInvoices/{RepeatingInvoiceID}/History
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-repeating_invoice_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_repeating_invoice_history(xero_tenant_id, repeating_invoice_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_repeating_invoice_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
RepeatingInvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Repeating Invoice -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getRepeatingInvoices

-

Retrieves repeating invoices

-
-
-
-

-

-

-
- 
/RepeatingInvoices
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-where = 'Status==#{XeroRuby::Accounting::RepeatingInvoice::DRAFT}'
-order = 'Total ASC'
-
-begin
-  response = xero_client.accounting_api.get_repeating_invoices(xero_tenant_id, where, order)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_repeating_invoices: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.readGrant read-only access to invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
-
-
-
-
-
-
-

getReportAgedPayablesByContact

-

Retrieves report for aged payables by contact

-
-
-
-

-

-

-
- 
/Reports/AgedPayablesByContact
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_id = '00000000-0000-0000-0000-000000000000'
-date = "2019-10-31"
-from_date = "2019-10-31"
-to_date = "2019-10-31"
-
-begin
-  response = xero_client.accounting_api.get_report_aged_payables_by_contact(xero_tenant_id, contact_id, date, from_date, to_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_report_aged_payables_by_contact: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.reports.readGrant read-only access to accounting reports
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
contactId* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact -
-
-
- Required -
-
-
-
date - - -
-
-
- - date - - - (date) - - -
-The date of the Aged Payables By Contact report -
-
-
-
-
fromDate - - -
-
-
- - date - - - (date) - - -
-filter by the from date of the report e.g. 2021-02-01 -
-
-
-
-
toDate - - -
-
-
- - date - - - (date) - - -
-filter by the to date of the report e.g. 2021-02-28 -
-
-
-
-
-
-
-
-
-
-
-

getReportAgedReceivablesByContact

-

Retrieves report for aged receivables by contact

-
-
-
-

-

-

-
- 
/Reports/AgedReceivablesByContact
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_id = '00000000-0000-0000-0000-000000000000'
-date = "2019-10-31"
-from_date = "2019-10-31"
-to_date = "2019-10-31"
-
-begin
-  response = xero_client.accounting_api.get_report_aged_receivables_by_contact(xero_tenant_id, contact_id, date, from_date, to_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_report_aged_receivables_by_contact: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.reports.readGrant read-only access to accounting reports
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
contactId* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact -
-
-
- Required -
-
-
-
date - - -
-
-
- - date - - - (date) - - -
-The date of the Aged Receivables By Contact report -
-
-
-
-
fromDate - - -
-
-
- - date - - - (date) - - -
-filter by the from date of the report e.g. 2021-02-01 -
-
-
-
-
toDate - - -
-
-
- - date - - - (date) - - -
-filter by the to date of the report e.g. 2021-02-28 -
-
-
-
-
-
-
-
-
-
-
-

getReportBalanceSheet

-

Retrieves report for balancesheet

-
-
-
-

-

-

-
- 
/Reports/BalanceSheet
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-date = "2019-11-01"
-periods = 3
-timeframe = 'MONTH'
-tracking_option_id_1 = '00000000-0000-0000-0000-000000000000'
-tracking_option_id_2 = '00000000-0000-0000-0000-000000000000'
-standard_layout = true
-payments_only = false
-
-begin
-  response = xero_client.accounting_api.get_report_balance_sheet(xero_tenant_id, date, periods, timeframe, tracking_option_id_1, tracking_option_id_2, standard_layout, payments_only)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_report_balance_sheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.reports.readGrant read-only access to accounting reports
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
date - - -
-
-
- - date - - - (date) - - -
-The date of the Balance Sheet report -
-
-
-
-
periods - - -
-
-
- - Integer - - -
-The number of periods for the Balance Sheet report -
-
-
-
-
timeframe - - -
-
-
- - String - - -
-The period size to compare to (MONTH, QUARTER, YEAR) -
-
-
-
-
trackingOptionID1 - - -
-
-
- - String - - -
-The tracking option 1 for the Balance Sheet report -
-
-
-
-
trackingOptionID2 - - -
-
-
- - String - - -
-The tracking option 2 for the Balance Sheet report -
-
-
-
-
standardLayout - - -
-
-
- - Boolean - - -
-The standard layout boolean for the Balance Sheet report -
-
-
-
-
paymentsOnly - - -
-
-
- - Boolean - - -
-return a cash basis for the Balance Sheet report -
-
-
-
-
-
-
-
-
-
-
-

getReportBankSummary

-

Retrieves report for bank summary

-
-
-
-

-

-

-
- 
/Reports/BankSummary
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-from_date = "2019-10-31"
-to_date = "2019-10-31"
-
-begin
-  response = xero_client.accounting_api.get_report_bank_summary(xero_tenant_id, from_date, to_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_report_bank_summary: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.reports.readGrant read-only access to accounting reports
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
fromDate - - -
-
-
- - date - - - (date) - - -
-filter by the from date of the report e.g. 2021-02-01 -
-
-
-
-
toDate - - -
-
-
- - date - - - (date) - - -
-filter by the to date of the report e.g. 2021-02-28 -
-
-
-
-
-
-
-
-
-
-
-

getReportBudgetSummary

-

Retrieves report for budget summary

-
-
-
-

-

-

-
- 
/Reports/BudgetSummary
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-date = "2019-03-31"
-periods = 2
-timeframe = 3
-
-begin
-  response = xero_client.accounting_api.get_report_budget_summary(xero_tenant_id, date, periods, timeframe)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_report_budget_summary: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.reports.readGrant read-only access to accounting reports
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
date - - -
-
-
- - date - - - (date) - - -
-The date for the Bank Summary report e.g. 2018-03-31 -
-
-
-
-
periods - - -
-
-
- - Integer - - -
-The number of periods to compare (integer between 1 and 12) -
-
-
-
-
timeframe - - -
-
-
- - Integer - - -
-The period size to compare to (1=month, 3=quarter, 12=year) -
-
-
-
-
-
-
-
-
-
-
-

getReportExecutiveSummary

-

Retrieves report for executive summary

-
-
-
-

-

-

-
- 
/Reports/ExecutiveSummary
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-date = "2019-03-31"
-
-begin
-  response = xero_client.accounting_api.get_report_executive_summary(xero_tenant_id, date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_report_executive_summary: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.reports.readGrant read-only access to accounting reports
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
date - - -
-
-
- - date - - - (date) - - -
-The date for the Bank Summary report e.g. 2018-03-31 -
-
-
-
-
-
-
-
-
-
-
-

getReportFromId

-

Retrieves a specific report using a unique ReportID

-
-
-
-

-

-

-
- 
/Reports/{ReportID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-report_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_report_from_id(xero_tenant_id, report_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_report_from_id: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.reports.readGrant read-only access to accounting reports
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ReportID* - - -
-
-
- - String - - -
-Unique identifier for a Report -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getReportProfitAndLoss

-

Retrieves report for profit and loss

-
-
-
-

-

-

-
- 
/Reports/ProfitAndLoss
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-from_date = "2019-10-31"
-to_date = "2019-10-31"
-periods = 3
-timeframe = 'MONTH'
-tracking_category_id = '00000000-0000-0000-0000-000000000000'
-tracking_category_id_2 = '00000000-0000-0000-0000-000000000000'
-tracking_option_id = '00000000-0000-0000-0000-000000000000'
-tracking_option_id_2 = '00000000-0000-0000-0000-000000000000'
-standard_layout = true
-payments_only = false
-
-begin
-  response = xero_client.accounting_api.get_report_profit_and_loss(xero_tenant_id, from_date, to_date, periods, timeframe, tracking_category_id, tracking_category_id_2, tracking_option_id, tracking_option_id_2, standard_layout, payments_only)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_report_profit_and_loss: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.reports.readGrant read-only access to accounting reports
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
fromDate - - -
-
-
- - date - - - (date) - - -
-filter by the from date of the report e.g. 2021-02-01 -
-
-
-
-
toDate - - -
-
-
- - date - - - (date) - - -
-filter by the to date of the report e.g. 2021-02-28 -
-
-
-
-
periods - - -
-
-
- - Integer - - -
-The number of periods to compare (integer between 1 and 12) -
-
-
-
-
timeframe - - -
-
-
- - String - - -
-The period size to compare to (MONTH, QUARTER, YEAR) -
-
-
-
-
trackingCategoryID - - -
-
-
- - String - - -
-The trackingCategory 1 for the ProfitAndLoss report -
-
-
-
-
trackingCategoryID2 - - -
-
-
- - String - - -
-The trackingCategory 2 for the ProfitAndLoss report -
-
-
-
-
trackingOptionID - - -
-
-
- - String - - -
-The tracking option 1 for the ProfitAndLoss report -
-
-
-
-
trackingOptionID2 - - -
-
-
- - String - - -
-The tracking option 2 for the ProfitAndLoss report -
-
-
-
-
standardLayout - - -
-
-
- - Boolean - - -
-Return the standard layout for the ProfitAndLoss report -
-
-
-
-
paymentsOnly - - -
-
-
- - Boolean - - -
-Return cash only basis for the ProfitAndLoss report -
-
-
-
-
-
-
-
-
-
-
-

getReportTenNinetyNine

-

Retrieve reports for 1099

-
-
-
-

-

-

-
- 
/Reports/TenNinetyNine
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-report_year = '2019'
-
-begin
-  response = xero_client.accounting_api.get_report_ten_ninety_nine(xero_tenant_id, report_year)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_report_ten_ninety_nine: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.reports.readGrant read-only access to accounting reports
accounting.reports.tenninetynine.readGrant read-only access to 1099 reports
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
reportYear - - -
-
-
- - String - - -
-The year of the 1099 report -
-
-
-
-
-
-
-
-
-
-
-

getReportTrialBalance

-

Retrieves report for trial balance

-
-
-
-

-

-

-
- 
/Reports/TrialBalance
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-date = "2019-10-31"
-payments_only = true
-
-begin
-  response = xero_client.accounting_api.get_report_trial_balance(xero_tenant_id, date, payments_only)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_report_trial_balance: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.reports.readGrant read-only access to accounting reports
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
date - - -
-
-
- - date - - - (date) - - -
-The date for the Trial Balance report e.g. 2018-03-31 -
-
-
-
-
paymentsOnly - - -
-
-
- - Boolean - - -
-Return cash only basis for the Trial Balance report -
-
-
-
-
-
-
-
-
-
-
-

getReportsList

-

Retrieves a list of the organistaions unique reports that require a uuid to fetch

-
-
-
-

-

-

-
- 
/Reports
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-begin
-  response = xero_client.accounting_api.get_reports_list(xero_tenant_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_reports_list: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.reports.readGrant read-only access to accounting reports
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getTaxRates

-

Retrieves tax rates

-
-
-
-

-

-

-
- 
/TaxRates
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-where = 'Status==#{XeroRuby::Accounting::TaxRate::ACTIVE}'
-order = 'Name ASC'
-tax_type = 'INPUT'
-
-begin
-  response = xero_client.accounting_api.get_tax_rates(xero_tenant_id, where, order, tax_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_tax_rates: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
TaxType - - -
-
-
- - String - - -
-Filter by tax type -
-
-
-
-
-
-
-
-
-
-
-

getTrackingCategories

-

Retrieves tracking categories and options

-
-
-
-

-

-

-
- 
/TrackingCategories
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-where = 'Status==#{XeroRuby::Accounting::TrackingCategory::ACTIVE}'
-order = 'Name ASC'
-include_archived = true
-
-begin
-  response = xero_client.accounting_api.get_tracking_categories(xero_tenant_id, where, order, include_archived)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_tracking_categories: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
includeArchived - - -
-
-
- - Boolean - - -
-e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response -
-
-
-
-
-
-
-
-
-
-
-

getTrackingCategory

-

Retrieves specific tracking categories and options using a unique tracking category Id

-
-
-
-

-

-

-
- 
/TrackingCategories/{TrackingCategoryID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-tracking_category_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_tracking_category(xero_tenant_id, tracking_category_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_tracking_category: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TrackingCategoryID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a TrackingCategory -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getUser

-

Retrieves a specific user

-
-
-
-

-

-

-
- 
/Users/{UserID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-user_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_user(xero_tenant_id, user_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_user: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
UserID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a User -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getUsers

-

Retrieves users

-
-
-
-

-

-

-
- 
/Users
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'IsSubscriber==true'
-order = 'LastName ASC'
-
-begin
-  response = xero_client.accounting_api.get_users(xero_tenant_id, if_modified_since, where, order)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_users: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
accounting.settings.readGrant read-only access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
-
-
-
-
-
-
-

postSetup

-

Sets the chart of accounts, the conversion date and conversion balances

-
-
-
-

-

-

-
- 
/Setup
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-account = { 
-  code: "123",
-  name: "Business supplies",
-  type:  XeroRuby::Accounting::AccountType::EXPENSE
-}    
-accounts = []
-accounts << account
-
-conversion_date = { 
-  month: 10,
-  year: 2020
-}    
-conversion_balances = []
-
-setup = { 
-  accounts: accounts,
-  conversion_date:  conversion_date,
-  conversion_balances:  conversion_balances
-}  
-
-begin
-  response = xero_client.accounting_api.post_setup(xero_tenant_id, setup)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling post_setup: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
setup * -
-
- - Setup - -
- Object including an accounts array, a conversion balances array and a conversion date object in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateAccount

-

Updates a chart of accounts

-
-
-
-

-

-

-
- 
/Accounts/{AccountID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-account_id = '00000000-0000-0000-0000-000000000000'
-
-account = { 
-  code: "123456",
-  name: "BarFoo",
-  type:  XeroRuby::Accounting::AccountType::EXPENSE,
-  description: "Hello World",
-  tax_type: "NONE"
-}  
-
-accounts = {  
-  accounts: [account]
-} 
-
-begin
-  response = xero_client.accounting_api.update_account(xero_tenant_id, account_id, accounts)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_account: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
AccountID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Account object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
accounts * -
-
- - Accounts - -
- Request of type Accounts array with one Account -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateAccountAttachmentByFileName

-

Updates attachment on a specific account by filename

-
-
-
-

-

-

-
- 
/Accounts/{AccountID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-account_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_account_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
AccountID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Account object -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateBankTransaction

-

Updates a single spent or received money transaction

-
-
-
-

-

-

-
- 
/BankTransactions/{BankTransactionID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transaction_id = '00000000-0000-0000-0000-000000000000'
-unitdp = 4
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-line_item = { 
-  description: "Foobar",
-  quantity: 1.0,
-  unit_amount: 20.0,
-  account_code: "000"
-}    
-line_items = []
-line_items << line_item
-
-bank_account = { 
-  account_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-bank_transaction = { 
-  reference: "You just updated",
-  type:  XeroRuby::Accounting::BankTransaction::RECEIVE,
-  contact: contact,
-  lineItems: lineItems,
-  bank_account:  bank_account
-}  
-
-bankTransactions = {  
-  bank_transactions: [bank_transaction]
-} 
-
-begin
-  response = xero_client.accounting_api.update_bank_transaction(xero_tenant_id, bank_transaction_id, bankTransactions, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_bank_transaction: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
BankTransactionID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transaction -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
bankTransactions * -
-
- - BankTransactions - -
- -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

updateBankTransactionAttachmentByFileName

-

Updates a specific attachment from a specific bank transaction by filename

-
-
-
-

-

-

-
- 
/BankTransactions/{BankTransactionID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transaction_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_bank_transaction_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
BankTransactionID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transaction -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateBankTransferAttachmentByFileName

-

-
-
-
-

-

-

-
- 
/BankTransfers/{BankTransferID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_transfer_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_bank_transfer_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
BankTransferID* - - -
-
-
- - UUID - - - (uuid) - - -
-Xero generated unique identifier for a bank transfer -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateContact

-

Updates a specific contact in a Xero organisation

-
-
-
-

-

-

-
- 
/Contacts/{ContactID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_id = '00000000-0000-0000-0000-000000000000'
-
-contact = { 
-  name: "Thanos",
-  contactID: "00000000-0000-0000-0000-000000000000"
-}  
-
-contacts = {  
-  contacts: [contact]
-} 
-
-begin
-  response = xero_client.accounting_api.update_contact(xero_tenant_id, contact_id, contacts)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_contact: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ContactID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
contacts * -
-
- - Contacts - -
- an array of Contacts containing single Contact object with properties to update -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateContactAttachmentByFileName

-

-
-
-
-

-

-

-
- 
/Contacts/{ContactID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_contact_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
ContactID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateContactGroup

-

Updates a specific contact group

-
-
-
-

-

-

-
- 
/ContactGroups/{ContactGroupID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_group_id = '00000000-0000-0000-0000-000000000000'
-
-contact_group = { 
-  name: "Vendor"
-}  
-
-contactGroups = {  
-  contact_groups: [contact_group]
-} 
-
-begin
-  response = xero_client.accounting_api.update_contact_group(xero_tenant_id, contact_group_id, contactGroups)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_contact_group: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ContactGroupID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Contact Group -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
contactGroups * -
-
- - ContactGroups - -
- an array of Contact groups with Name of specific group to update -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateCreditNote

-

Updates a specific credit note

-
-
-
-

-

-

-
- 
/CreditNotes/{CreditNoteID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-credit_note_id = '00000000-0000-0000-0000-000000000000'
-unitdp = 4
-curr_date = 'YYYY-MM-DD'
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-line_item = { 
-  description: "Foobar",
-  quantity: 1.0,
-  unit_amount: 20.0,
-  account_code: "000"
-}    
-line_items = []
-line_items << line_item
-
-credit_note = { 
-  type:  XeroRuby::Accounting::CreditNote::ACCPAYCREDIT,
-  status:  XeroRuby::Accounting::CreditNote::AUTHORISED,
-  reference: "My ref.",
-  contact: contact,
-  date:  curr_date,
-  line_items:  line_items
-}  
-
-creditNotes = {  
-  credit_notes: [credit_note]
-} 
-
-begin
-  response = xero_client.accounting_api.update_credit_note(xero_tenant_id, credit_note_id, creditNotes, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_credit_note: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
CreditNoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Credit Note -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
creditNotes * -
-
- - CreditNotes - -
- an array of Credit Notes containing credit note details to update -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

updateCreditNoteAttachmentByFileName

-

Updates attachments on a specific credit note by file name

-
-
-
-

-

-

-
- 
/CreditNotes/{CreditNoteID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-credit_note_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_credit_note_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
CreditNoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Credit Note -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateExpenseClaim

-

Updates a specific expense claims

-
-
-
-

-

-

-
- 
/ExpenseClaims/{ExpenseClaimID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-expense_claim_id = '00000000-0000-0000-0000-000000000000'
-curr_date = 'YYYY-MM-DD'
-
-user = { 
-  user_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-receipt = { 
-  receipt_id: "00000000-0000-0000-0000-000000000000",
-  date:  curr_date
-}    
-receipts = []
-receipts << receipt
-
-expense_claim = { 
-  status:  XeroRuby::Accounting::ExpenseClaim::SUBMITTED,
-  user: user,
-  receipts: receipts
-}  
-
-expenseClaims = {  
-  expense_claims: [expense_claim]
-} 
-
-begin
-  response = xero_client.accounting_api.update_expense_claim(xero_tenant_id, expense_claim_id, expenseClaims)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_expense_claim: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ExpenseClaimID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a ExpenseClaim -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
expenseClaims * -
-
- - ExpenseClaims - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateInvoice

-

Updates a specific sales invoices or purchase bills

-
-
-
-

-

-

-
- 
/Invoices/{InvoiceID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-invoice_id = '00000000-0000-0000-0000-000000000000'
-unitdp = 4
-
-invoice = { 
-  reference: "I am Iron man"
-}  
-
-invoices = {  
-  invoices: [invoice]
-} 
-
-begin
-  response = xero_client.accounting_api.update_invoice(xero_tenant_id, invoice_id, invoices, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_invoice: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
InvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Invoice -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
invoices * -
-
- - Invoices - -
- -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

updateInvoiceAttachmentByFileName

-

Updates an attachment from a specific invoices or purchase bill by filename

-
-
-
-

-

-

-
- 
/Invoices/{InvoiceID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-invoice_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_invoice_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
InvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Invoice -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateItem

-

Updates a specific item

-
-
-
-

-

-

-
- 
/Items/{ItemID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-item_id = '00000000-0000-0000-0000-000000000000'
-unitdp = 4
-
-item = { 
-  code: "ItemCode123",
-  description: "Goodbye"
-}  
-
-items = {  
-  items: [item]
-} 
-
-begin
-  response = xero_client.accounting_api.update_item(xero_tenant_id, item_id, items, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_item: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ItemID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Item -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
items * -
-
- - Items - -
- -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

updateLinkedTransaction

-

Updates a specific linked transactions (billable expenses)

-
-
-
-

-

-

-
- 
/LinkedTransactions/{LinkedTransactionID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-linked_transaction_id = '00000000-0000-0000-0000-000000000000'
-
-linked_transaction = { 
-  source_line_item_id: "00000000-0000-0000-0000-000000000000",
-  contactID: "00000000-0000-0000-0000-000000000000"
-}  
-
-linkedTransactions = {  
-  linked_transactions: [linked_transaction]
-} 
-
-begin
-  response = xero_client.accounting_api.update_linked_transaction(xero_tenant_id, linked_transaction_id, linkedTransactions)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_linked_transaction: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
LinkedTransactionID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a LinkedTransaction -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
linkedTransactions * -
-
- - LinkedTransactions - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateManualJournal

-

Updates a specific manual journal

-
-
-
-

-

-

-
- 
/ManualJournals/{ManualJournalID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-manual_journal_id = '00000000-0000-0000-0000-000000000000'
-date_value = 'YYYY-MM-DD'  
-manual_journal_lines = []
-
-credit = { 
-  line_amount: 100.0,
-  account_code: "400",
-  description: "Hello there"
-}  
-manual_journal_lines << credit
-
-debit = { 
-  line_amount: -100.0,
-  account_code: "120",
-  description: "Hello there"
-}  
-manual_journal_lines << debit
-
-manual_journal = { 
-  narration: "Foobar",
-  date:  date_value,
-  journal_lines:  manual_journal_lines
-}  
-
-manualJournals = {  
-  manual_journals: [manual_journal]
-} 
-
-begin
-  response = xero_client.accounting_api.update_manual_journal(xero_tenant_id, manual_journal_id, manualJournals)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_manual_journal: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ManualJournalID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a ManualJournal -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
manualJournals * -
-
- - ManualJournals - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateManualJournalAttachmentByFileName

-

Updates a specific attachment from a specific manual journal by file name

-
-
-
-

-

-

-
- 
/ManualJournals/{ManualJournalID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-manual_journal_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_manual_journal_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
ManualJournalID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a ManualJournal -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateOrCreateBankTransactions

-

Updates or creates one or more spent or received money transaction

-
-
-
-

-

-

-
- 
/BankTransactions
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-unitdp = 4
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-line_item = { 
-  description: "Foobar",
-  quantity: 1.0,
-  unit_amount: 20.0,
-  account_code: "000"
-}    
-line_items = []
-line_items << line_item
-
-bank_account = { 
-  account_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-bank_transaction = { 
-  type:  XeroRuby::Accounting::BankTransaction::RECEIVE,
-  contact: contact,
-  lineItems: lineItems,
-  bank_account:  bank_account
-}  
-
-bankTransactions = {  
-  bank_transactions: [bank_transaction]
-} 
-
-begin
-  response = xero_client.accounting_api.update_or_create_bank_transactions(xero_tenant_id, bankTransactions, summarize_errors, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_or_create_bank_transactions: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
bankTransactions * -
-
- - BankTransactions - -
- -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

updateOrCreateContacts

-

Updates or creates one or more contacts in a Xero organisation

-
-
-
-

-

-

-
- 
/Contacts
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-
-phone = { 
-  phone_number: "555-1212",
-  phone_type:  XeroRuby::Accounting::PhoneType::MOBILE
-}    
-phones = []
-phones << phone
-
-contact = { 
-  name: "Bruce Banner",
-  email_address: "hulk@avengers.com",
-  phones: phones
-}  
-
-contacts = {  
-  contacts: [contact]
-} 
-
-begin
-  response = xero_client.accounting_api.update_or_create_contacts(xero_tenant_id, contacts, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_or_create_contacts: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.contactsGrant read-write access to contacts and contact groups
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
contacts * -
-
- - Contacts - -
- -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

updateOrCreateCreditNotes

-

Updates or creates one or more credit notes

-
-
-
-

-

-

-
- 
/CreditNotes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-unitdp = 4
-curr_date = 'YYYY-MM-DD'
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-line_item = { 
-  description: "Foobar",
-  quantity: 1.0,
-  unit_amount: 20.0,
-  account_code: "000"
-}    
-line_items = []
-line_items << line_item
-
-credit_note = { 
-  type:  XeroRuby::Accounting::CreditNote::ACCPAYCREDIT,
-  contact: contact,
-  date:  curr_date,
-  line_items:  line_items
-}  
-
-creditNotes = {  
-  credit_notes: [credit_note]
-} 
-
-begin
-  response = xero_client.accounting_api.update_or_create_credit_notes(xero_tenant_id, creditNotes, summarize_errors, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_or_create_credit_notes: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
creditNotes * -
-
- - CreditNotes - -
- an array of Credit Notes with a single CreditNote object. -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

updateOrCreateEmployees

-

Creates a single new employees used in Xero payrun

-
-
-
-

-

-

-
- 
/Employees
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-
-employee = { 
-  first_name: "Nick",
-  last_name: "Fury"
-}  
-
-employees = {  
-  employees: [employee]
-} 
-
-begin
-  response = xero_client.accounting_api.update_or_create_employees(xero_tenant_id, employees, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_or_create_employees: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employees * -
-
- - Employees - -
- Employees with array of Employee object in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

updateOrCreateInvoices

-

Updates or creates one or more sales invoices or purchase bills

-
-
-
-

-

-

-
- 
/Invoices
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-unitdp = 4
-date_value = 'YYYY-MM-DD'
-due_date_value = 'YYYY-MM-DD'
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-line_item = { 
-  description: "Foobar",
-  quantity: 1.0,
-  unit_amount: 20.0,
-  account_code: "000"
-}    
-line_items = []
-line_items << line_item
-
-invoice = { 
-  type:  XeroRuby::Accounting::Invoice::ACCREC,
-  contact: contact,
-  date:  date_value,
-  due_date:  due_date_value,
-  line_items:  line_items,
-  reference: "Website Design",
-  status:  XeroRuby::Accounting::Invoice::DRAFT
-}  
-
-invoices = {  
-  invoices: [invoice]
-} 
-
-begin
-  response = xero_client.accounting_api.update_or_create_invoices(xero_tenant_id, invoices, summarize_errors, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_or_create_invoices: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
invoices * -
-
- - Invoices - -
- -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

updateOrCreateItems

-

Updates or creates one or more items

-
-
-
-

-

-

-
- 
/Items
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-unitdp = 4
-
-item = { 
-  code: "abcXYZ123",
-  name: "HelloWorld",
-  description: "Foobar"
-}  
-
-items = {  
-  items: [item]
-} 
-
-begin
-  response = xero_client.accounting_api.update_or_create_items(xero_tenant_id, items, summarize_errors, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_or_create_items: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
items * -
-
- - Items - -
- -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

updateOrCreateManualJournals

-

Updates or creates a single manual journal

-
-
-
-

-

-

-
- 
/ManualJournals
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-date_value = 'YYYY-MM-DD'  
-manual_journal_lines = []
-
-credit = { 
-  line_amount: 100.0,
-  account_code: "400",
-  description: "Hello there"
-}  
-manual_journal_lines << credit
-
-debit = { 
-  line_amount: -100.0,
-  account_code: "120",
-  description: "Hello there"
-}  
-manual_journal_lines << debit
-
-manual_journal = { 
-  narration: "Foobar",
-  date:  date_value,
-  journal_lines:  manual_journal_lines
-}  
-
-manualJournals = {  
-  manual_journals: [manual_journal]
-} 
-
-begin
-  response = xero_client.accounting_api.update_or_create_manual_journals(xero_tenant_id, manualJournals, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_or_create_manual_journals: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
manualJournals * -
-
- - ManualJournals - -
- ManualJournals array with ManualJournal object in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

updateOrCreatePurchaseOrders

-

Updates or creates one or more purchase orders

-
-
-
-

-

-

-
- 
/PurchaseOrders
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-date_value = 'YYYY-MM-DD'
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-line_item = { 
-  description: "Foobar",
-  quantity: 1.0,
-  unit_amount: 20.0,
-  account_code: "000"
-}    
-line_items = []
-line_items << line_item
-
-purchase_order = { 
-  contact: contact,
-  line_items:  line_items,
-  date:  date_value
-}  
-
-purchaseOrders = {  
-  purchase_orders: [purchase_order]
-} 
-
-begin
-  response = xero_client.accounting_api.update_or_create_purchase_orders(xero_tenant_id, purchaseOrders, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_or_create_purchase_orders: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
purchaseOrders * -
-
- - PurchaseOrders - -
- -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

updateOrCreateQuotes

-

Updates or creates one or more quotes

-
-
-
-

-

-

-
- 
/Quotes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-date_value = 'YYYY-MM-DD'
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-line_item = { 
-  description: "Foobar",
-  quantity: 1.0,
-  unit_amount: 20.0,
-  account_code: "000"
-}    
-line_items = []
-line_items << line_item
-
-quote = { 
-  contact: contact,
-  line_items:  line_items,
-  date:  date_value
-}  
-
-quotes = {  
-  quotes: [quote]
-} 
-
-begin
-  response = xero_client.accounting_api.update_or_create_quotes(xero_tenant_id, quotes, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_or_create_quotes: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
quotes * -
-
- - Quotes - -
- -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

updateOrCreateRepeatingInvoices

-

Creates or deletes one or more repeating invoice templates

-
-
-
-

-

-

-
- 
/RepeatingInvoices
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-summarize_errors = true
-
-begin
-  response = xero_client.accounting_api.update_or_create_repeating_invoices(xero_tenant_id, repeatingInvoices, summarize_errors)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_or_create_repeating_invoices: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
repeatingInvoices * -
-
- - RepeatingInvoices - -
- RepeatingInvoices with an array of repeating invoice objects in body of request -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
summarizeErrors - - -
-
-
- - Boolean - - -
-If false return 200 OK and mix of successfully created objects and any with validation errors -
-
-
-
-
-
-
-
-
-
-
-

updatePurchaseOrder

-

Updates a specific purchase order

-
-
-
-

-

-

-
- 
/PurchaseOrders/{PurchaseOrderID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-purchase_order_id = '00000000-0000-0000-0000-000000000000'
-
-purchase_order = { 
-  attentionTo: "Peter Parker"
-}  
-
-purchaseOrders = {  
-  purchase_orders: [purchase_order]
-} 
-
-begin
-  response = xero_client.accounting_api.update_purchase_order(xero_tenant_id, purchase_order_id, purchaseOrders)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_purchase_order: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PurchaseOrderID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Purchase Order -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
purchaseOrders * -
-
- - PurchaseOrders - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updatePurchaseOrderAttachmentByFileName

-

Updates a specific attachment for a specific purchase order by filename

-
-
-
-

-

-

-
- 
/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-purchase_order_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_purchase_order_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
PurchaseOrderID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Purchase Order -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateQuote

-

Updates a specific quote

-
-
-
-

-

-

-
- 
/Quotes/{QuoteID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-quote_id = '00000000-0000-0000-0000-000000000000'
-date_value = 'YYYY-MM-DD'
-
-contact = { 
-  contact_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-quote = { 
-  reference: "I am an update",
-  contact: contact,
-  date:  date_value
-}  
-
-quotes = {  
-  quotes: [quote]
-} 
-
-begin
-  response = xero_client.accounting_api.update_quote(xero_tenant_id, quote_id, quotes)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_quote: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
QuoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Quote -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
quotes * -
-
- - Quotes - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateQuoteAttachmentByFileName

-

Updates a specific attachment from a specific quote by filename

-
-
-
-

-

-

-
- 
/Quotes/{QuoteID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-quote_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_quote_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
QuoteID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for an Quote -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateReceipt

-

Updates a specific draft expense claim receipts

-
-
-
-

-

-

-
- 
/Receipts/{ReceiptID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-receipt_id = '00000000-0000-0000-0000-000000000000'
-unitdp = 4
-dateValue = 'YYYY-MM-DD'
-
-user = { 
-  user_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-receipt = { 
-  user: user,
-  reference: "Foobar",
-  date: dateValue
-}  
-
-receipts = {  
-  receipts: [receipt]
-} 
-
-begin
-  response = xero_client.accounting_api.update_receipt(xero_tenant_id, receipt_id, receipts, unitdp)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_receipt: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ReceiptID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Receipt -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
receipts * -
-
- - Receipts - -
- -
-
-
- Required -
-
- -
-
Query parameters
- - - - - - - - - -
NameDescription
unitdp - - -
-
-
- - Integer - - -
-e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts -
-
-
-
-
-
-
-
-
-
-
-

updateReceiptAttachmentByFileName

-

Updates a specific attachment on a specific expense claim receipts by file name

-
-
-
-

-

-

-
- 
/Receipts/{ReceiptID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-receipt_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_receipt_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
ReceiptID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Receipt -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateRepeatingInvoice

-

Deletes a specific repeating invoice template

-
-
-
-

-

-

-
- 
/RepeatingInvoices/{RepeatingInvoiceID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-repeating_invoice_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeatingInvoices)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_repeating_invoice: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
RepeatingInvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Repeating Invoice -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
repeatingInvoices * -
-
- - RepeatingInvoices - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateRepeatingInvoiceAttachmentByFileName

-

Updates a specific attachment from a specific repeating invoices by file name

-
-
-
-

-

-

-
- 
/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-repeating_invoice_id = '00000000-0000-0000-0000-000000000000'
-file_name = 'xero-dev.jpg'
-body = File.read('assets/images/xero-api.png')
-begin
-  response = xero_client.accounting_api.update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_repeating_invoice_attachment_by_file_name: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.attachmentsGrant read-write access to attachments
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
RepeatingInvoiceID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Repeating Invoice -
-
-
- Required -
-
-
-
FileName* - - -
-
-
- - String - - -
-Name of the attachment -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
body * -
-
- - byte[] - -
- Byte array of file in body of request -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateTaxRate

-

Updates tax rates

-
-
-
-

-

-

-
- 
/TaxRates
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-tax_component = { 
-  name: "State Tax",
-  rate: 2.25
-}    
-taxComponents = []
-tax_components << tax_component
-
-tax_rate = { 
-  name: "CA State Tax",
-  taxComponents: taxComponents,
-
-taxRates = {  
-  tax_rates: [tax_rate]
-} 
-
-begin
-  response = xero_client.accounting_api.update_tax_rate(xero_tenant_id, taxRates)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_tax_rate: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
taxRates * -
-
- - TaxRates - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateTrackingCategory

-

Updates a specific tracking category

-
-
-
-

-

-

-
- 
/TrackingCategories/{TrackingCategoryID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-tracking_category_id = '00000000-0000-0000-0000-000000000000'
-
-trackingCategory = { 
-  name: "Foobar"
-}  
-
-begin
-  response = xero_client.accounting_api.update_tracking_category(xero_tenant_id, tracking_category_id, trackingCategory)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_tracking_category: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TrackingCategoryID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a TrackingCategory -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
trackingCategory * -
-
- - TrackingCategory - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateTrackingOptions

-

Updates a specific option for a specific tracking category

-
-
-
-

-

-

-
- 
/TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-tracking_category_id = '00000000-0000-0000-0000-000000000000'
-tracking_option_id = '00000000-0000-0000-0000-000000000000'
-
-trackingOption = { 
-  name: "Foobar"
-}  
-
-begin
-  response = xero_client.accounting_api.update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, trackingOption)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_tracking_options: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
accounting.settingsGrant read-write access to organisation and account settings
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
TrackingCategoryID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a TrackingCategory -
-
-
- Required -
-
-
-
TrackingOptionID* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for a Tracking Option -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
trackingOption * -
-
- - TrackingOption - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
- -
-
-
- - - - - - - - - - - - - - diff --git a/docs/app_store/AppStoreApi.md b/docs/app_store/AppStoreApi.md index 7500565a..4aaf04fa 100644 --- a/docs/app_store/AppStoreApi.md +++ b/docs/app_store/AppStoreApi.md @@ -42,7 +42,7 @@ api_instance = xero_client. -subscription_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Subscription object +subscription_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Subscription object begin #Retrieves a subscription for a given subscriptionId result = api_instance.get_subscription(subscription_id) @@ -57,7 +57,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | [**String**](.md)| Unique identifier for Subscription object | + **subscription_id** | **String**| Unique identifier for Subscription object | ### Return type @@ -104,7 +104,7 @@ api_instance = xero_client. -subscription_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Subscription object +subscription_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Subscription object begin #Gets all usage records related to the subscription result = api_instance.get_usage_records(subscription_id) @@ -119,7 +119,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | [**String**](.md)| Unique identifier for Subscription object | + **subscription_id** | **String**| Unique identifier for Subscription object | ### Return type @@ -137,7 +137,7 @@ Name | Type | Description | Notes ## post_usage_records -> UsageRecord post_usage_records(subscription_id, subscription_item_id, create_usage_record) +> UsageRecord post_usage_records(subscription_id, subscription_item_id, create_usage_record, opts) Send metered usage belonging to this subscription and subscription item @@ -166,12 +166,16 @@ api_instance = xero_client. -subscription_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Subscription object -subscription_item_id = '00000000-0000-0000-0000-000000000000' # String | The unique identifier of the subscriptionItem +subscription_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Subscription object +subscription_item_id = 00000000-0000-0000-0000-000000000000 # String | The unique identifier of the subscriptionItem create_usage_record = { "timestamp": "2022-01-21T13:01:00", "quantity": 10 } # CreateUsageRecord | Contains the quantity for the usage record to create +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Send metered usage belonging to this subscription and subscription item - result = api_instance.post_usage_records(subscription_id, subscription_item_id, create_usage_record) + result = api_instance.post_usage_records(subscription_id, subscription_item_id, create_usage_record, opts) p result rescue XeroRuby::AppStore::ApiError => e puts "Exception when calling AppStoreApi->post_usage_records: #{e}" @@ -183,9 +187,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | [**String**](.md)| Unique identifier for Subscription object | - **subscription_item_id** | [**String**](.md)| The unique identifier of the subscriptionItem | + **subscription_id** | **String**| Unique identifier for Subscription object | + **subscription_item_id** | **String**| The unique identifier of the subscriptionItem | **create_usage_record** | [**CreateUsageRecord**](CreateUsageRecord.md)| Contains the quantity for the usage record to create | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -203,7 +208,7 @@ Name | Type | Description | Notes ## put_usage_records -> UsageRecord put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record) +> UsageRecord put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record, opts) Update and existing metered usage belonging to this subscription and subscription item @@ -232,13 +237,17 @@ api_instance = xero_client. -subscription_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Subscription object -subscription_item_id = '00000000-0000-0000-0000-000000000000' # String | The unique identifier of the subscriptionItem -usage_record_id = '00000000-0000-0000-0000-000000000000' # String | The unique identifier of the usage record +subscription_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Subscription object +subscription_item_id = 00000000-0000-0000-0000-000000000000 # String | The unique identifier of the subscriptionItem +usage_record_id = 00000000-0000-0000-0000-000000000000 # String | The unique identifier of the usage record update_usage_record = { "quantity": 10 } # UpdateUsageRecord | Contains the quantity for the usage record to update +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Update and existing metered usage belonging to this subscription and subscription item - result = api_instance.put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record) + result = api_instance.put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record, opts) p result rescue XeroRuby::AppStore::ApiError => e puts "Exception when calling AppStoreApi->put_usage_records: #{e}" @@ -250,10 +259,11 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | [**String**](.md)| Unique identifier for Subscription object | - **subscription_item_id** | [**String**](.md)| The unique identifier of the subscriptionItem | - **usage_record_id** | [**String**](.md)| The unique identifier of the usage record | + **subscription_id** | **String**| Unique identifier for Subscription object | + **subscription_item_id** | **String**| The unique identifier of the subscriptionItem | + **usage_record_id** | **String**| The unique identifier of the usage record | **update_usage_record** | [**UpdateUsageRecord**](UpdateUsageRecord.md)| Contains the quantity for the usage record to update | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type diff --git a/docs/app_store/CreateUsageRecord.md b/docs/app_store/CreateUsageRecord.md index 0ae33a55..de010560 100644 --- a/docs/app_store/CreateUsageRecord.md +++ b/docs/app_store/CreateUsageRecord.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **quantity** | **Integer** | The initial quantity for the usage record. Must be a whole number that is greater than or equal to 0 | -**timestamp** | **DateTime** | DateTime in UTC of when the the product was consumed/used | +**timestamp** | **Time** | DateTime in UTC of when the the product was consumed/used | ## Code Sample diff --git a/docs/app_store/ProblemDetails.md b/docs/app_store/ProblemDetails.md index 615f9535..c4a7995f 100644 --- a/docs/app_store/ProblemDetails.md +++ b/docs/app_store/ProblemDetails.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **detail** | **String** | | [optional] -**extensions** | [**Object**](.md) | | [optional] +**extensions** | **Object** | | [optional] **instance** | **String** | | [optional] **status** | **Integer** | | [optional] **title** | **String** | | [optional] diff --git a/docs/app_store/Subscription.md b/docs/app_store/Subscription.md index a9fb0944..1341e5f3 100644 --- a/docs/app_store/Subscription.md +++ b/docs/app_store/Subscription.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**current_period_end** | **DateTime** | End of the current period that the subscription has been invoiced for. | -**end_date** | **DateTime** | If the subscription has been canceled, this is the date when the subscription ends. If null, the subscription is active and has not been cancelled | [optional] +**current_period_end** | **Time** | End of the current period that the subscription has been invoiced for. | +**end_date** | **Time** | If the subscription has been canceled, this is the date when the subscription ends. If null, the subscription is active and has not been cancelled | [optional] **id** | **String** | The unique identifier of the subscription | **organisation_id** | **String** | The Xero generated unique identifier for the organisation | **plans** | [**Array<Plan>**](Plan.md) | List of plans for the subscription. | -**start_date** | **DateTime** | Date when the subscription was first created. | +**start_date** | **Time** | Date when the subscription was first created. | **status** | **String** | Status of the subscription. Available statuses are ACTIVE, CANCELED, and PAST_DUE. | **test_mode** | **Boolean** | Boolean used to indicate if the subscription is in test mode | [optional] diff --git a/docs/app_store/SubscriptionItem.md b/docs/app_store/SubscriptionItem.md index 4485c951..d37bc687 100644 --- a/docs/app_store/SubscriptionItem.md +++ b/docs/app_store/SubscriptionItem.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**end_date** | **DateTime** | Date when the subscription to this product will end | [optional] +**end_date** | **Time** | Date when the subscription to this product will end | [optional] **id** | **String** | The unique identifier of the subscription item. | **price** | [**Price**](Price.md) | | **product** | [**Product**](Product.md) | | **quantity** | **Integer** | The quantity of the item. For a fixed product, it is 1. For a per-seat product, it is a positive integer. For metered products, it is always null. | [optional] -**start_date** | **DateTime** | Date the subscription started, or will start. Note: this could be in the future for downgrades or reduced number of seats that haven't taken effect yet. | +**start_date** | **Time** | Date the subscription started, or will start. Note: this could be in the future for downgrades or reduced number of seats that haven't taken effect yet. | **status** | **String** | Status of the subscription item. Available statuses are ACTIVE, CANCELED, and PENDING_ACTIVATION. | **test_mode** | **Boolean** | If the subscription is a test subscription | [optional] diff --git a/docs/app_store/UsageRecord.md b/docs/app_store/UsageRecord.md index 8a31f325..74cf8024 100644 --- a/docs/app_store/UsageRecord.md +++ b/docs/app_store/UsageRecord.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **subscription_id** | **String** | The unique identifier of the Subscription. | **subscription_item_id** | **String** | The unique identifier of the SubscriptionItem. | **test_mode** | **Boolean** | If the subscription is a test subscription | -**recorded_at** | **DateTime** | The time when this usage was recorded in UTC | +**recorded_at** | **Time** | The time when this usage was recorded in UTC | **usage_record_id** | **String** | The unique identifier of the usageRecord. | **price_per_unit** | **Float** | The price per unit | **product_id** | **String** | The unique identifier of the linked Product | diff --git a/docs/app_store/index.html b/docs/app_store/index.html deleted file mode 100644 index 7e37b0b6..00000000 --- a/docs/app_store/index.html +++ /dev/null @@ -1,3514 +0,0 @@ - - - - - Xero AppStore API - - - - - - xero-ruby AppStore SDK Docs - - - - - - - - - - - - - - - - - - -
- -
- -
-
- - -
-
- -
-
- -
-
-
-
-
- -
-
-
-
-

Xero AppStore API

-
-
-
- -
-
-

AppStore

-
-
-
-

getSubscription

-

Retrieves a subscription for a given subscriptionId

-
-
-
-

-

-

-
- 
/subscriptions/{subscriptionId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-subscription_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_subscription(subscription_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_subscription: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
marketplace.billingGrant read-only access to fixed assets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
subscriptionId* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Subscription object -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getUsageRecords

-

Gets all usage records related to the subscription

-
-
-
-

-

-

-
- 
/subscriptions/{subscriptionId}/usage-records
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-subscription_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_usage_records(subscription_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_usage_records: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
marketplace.billingGrant read-only access to fixed assets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
subscriptionId* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Subscription object -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

postUsageRecords

-

Send metered usage belonging to this subscription and subscription item

-
-
-
-

-

-

-
- 
/subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-subscription_id = '00000000-0000-0000-0000-000000000000'
-subscription_item_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.post_usage_records(subscription_id, subscription_item_id, createUsageRecord)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling post_usage_records: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
marketplace.billingGrant read-only access to fixed assets
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
subscriptionId* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Subscription object -
-
-
- Required -
-
-
-
subscriptionItemId* - - -
-
-
- - UUID - - - (uuid) - - -
-The unique identifier of the subscriptionItem -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
createUsageRecord * -
-
- - CreateUsageRecord - -
- Contains the quantity for the usage record to create -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

putUsageRecords

-

Update and existing metered usage belonging to this subscription and subscription item

-
-
-
-

-

-

-
- 
/subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records/{usageRecordId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-subscription_id = '00000000-0000-0000-0000-000000000000'
-subscription_item_id = '00000000-0000-0000-0000-000000000000'
-usage_record_id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.put_usage_records(subscription_id, subscription_item_id, usage_record_id, updateUsageRecord)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling put_usage_records: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
marketplace.billingGrant read-only access to fixed assets
-

Parameters

-
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
subscriptionId* - - -
-
-
- - UUID - - - (uuid) - - -
-Unique identifier for Subscription object -
-
-
- Required -
-
-
-
subscriptionItemId* - - -
-
-
- - UUID - - - (uuid) - - -
-The unique identifier of the subscriptionItem -
-
-
- Required -
-
-
-
usageRecordId* - - -
-
-
- - UUID - - - (uuid) - - -
-The unique identifier of the usage record -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
updateUsageRecord * -
-
- - UpdateUsageRecord - -
- Contains the quantity for the usage record to update -
-
-
- Required -
-
- -
-
-
-
-
-
- -
-
-
- - - - - - - - - - - - - - diff --git a/docs/assets/AssetApi.md b/docs/assets/AssetApi.md index 398d2787..73c3c51f 100644 --- a/docs/assets/AssetApi.md +++ b/docs/assets/AssetApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description ## create_asset -> Asset create_asset(xero_tenant_id, asset) +> Asset create_asset(xero_tenant_id, asset, opts) adds a fixed asset @@ -46,11 +46,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant asset = { "assetName":"Computer74863", "assetNumber":"123477544", "purchaseDate":"2020-01-01", "purchasePrice":100.0, "disposalPrice":23.23, "assetStatus":"Draft", "bookDepreciationSetting":{ "depreciationMethod":"StraightLine", "averagingMethod":"ActualDays", "depreciationRate":0.5, "depreciationCalculationMethod":"None" }, "bookDepreciationDetail":{ "currentCapitalGain":5.32, "currentGainLoss":3.88, "depreciationStartDate":"2020-01-02", "costLimit":100.0, "currentAccumDepreciationAmount":2.25 }, "AccountingBookValue":99.5 } # Asset | Fixed asset you are creating +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #adds a fixed asset - result = api_instance.create_asset(xero_tenant_id, asset) + result = api_instance.create_asset(xero_tenant_id, asset, opts) p result rescue XeroRuby::Assets::ApiError => e puts "Exception when calling AssetApi->create_asset: #{e}" @@ -64,6 +68,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **asset** | [**Asset**](Asset.md)| Fixed asset you are creating | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -112,8 +117,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + asset_type: { "assetTypeName":"Machinery11004", "fixedAssetAccountId":"3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82", "depreciationExpenseAccountId":"d1602f69-f900-4616-8d34-90af393fa368", "accumulatedDepreciationAccountId":"9195cadd-8645-41e6-9f67-7bcd421defe8", "bookDepreciationSetting":{ "depreciationMethod":"DiminishingValue100", "averagingMethod":"ActualDays", "depreciationRate":0.05, "depreciationCalculationMethod":"None" } } # AssetType | Asset type to add } @@ -132,6 +139,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **asset_type** | [**AssetType**](AssetType.md)| Asset type to add | [optional] ### Return type @@ -181,8 +189,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -id = '00000000-0000-0000-0000-000000000000' # String | fixed asset id for single object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +id = 00000000-0000-0000-0000-000000000000 # String | fixed asset id for single object begin #Retrieves fixed asset by id result = api_instance.get_asset_by_id(xero_tenant_id, id) @@ -198,7 +206,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **id** | [**String**](.md)| fixed asset id for single object | + **id** | **String**| fixed asset id for single object | ### Return type @@ -247,7 +255,7 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant begin #searches fixed asset settings result = api_instance.get_asset_settings(xero_tenant_id) @@ -311,7 +319,7 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant begin #searches fixed asset types result = api_instance.get_asset_types(xero_tenant_id) @@ -375,18 +383,18 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -status = XeroRuby::Assets::AssetStatusQueryParam.new # AssetStatusQueryParam | Required when retrieving a collection of assets. See Asset Status Codes +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +status = # AssetStatusQueryParam | Required when retrieving a collection of assets. See Asset Status Codes opts = { page: 1, # Integer | Results are paged. This specifies which page of the results to return. The default page is 1. page_size: 5, # Integer | The number of records returned per page. By default the number of records returned is 10. - order_by: 'AssetName', # String | Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice. + order_by: AssetType, # String | Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice. - sort_direction: 'ASC', # String | ASC or DESC + sort_direction: asc, # String | ASC or DESC - filter_by: 'Company Car' # String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields. + filter_by: Company Car # String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields. } begin diff --git a/docs/assets/index.html b/docs/assets/index.html deleted file mode 100644 index 19a782c3..00000000 --- a/docs/assets/index.html +++ /dev/null @@ -1,3944 +0,0 @@ - - - - - Xero Assets API - - - - - - xero-ruby Asset SDK Docs - - - - - - - - - - - - - - - - - - -
- -
- -
-
- - -
-
- -
-
- -
-
-
-
-
- -
-
-
-
-

Xero Assets API

-
-
-
- -
-
-

Asset

-
-
-
-

createAsset

-

adds a fixed asset

-
-
-
-

-

Adds an asset to the system

-

-
- 
/Assets
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-asset = { 
-  asset_name: "Other Computer",
-  asset_number: "FA-00210",
-  status:  XeroRuby::Asset::AssetStatus::DRAFT
-}  
-
-begin
-  response = xero_client.accounting_api.create_asset(xero_tenant_id, asset)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_asset: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
assetsGrant read-write access to fixed assets
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
asset * -
-
- - Asset - -
- Fixed asset you are creating -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createAssetType

-

adds a fixed asset type

-
-
-
-

-

Adds an fixed asset type to the system

-

-
- 
/AssetTypes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-book_depreciation_setting = { 
-  depreciation_method: "DiminishingValue100",
-  averaging_method: "ActualDays",
-  deprecitation_rate: 40,
-  depreciation_calculation_method: "None"
-}  
-
-asset_type = { 
-  asset_type_name: "Computer Equipment",
-  fixed_asset_account_id: "00000000-0000-0000-0000-000000000000",
-  depreciation_expense_account_id: "00000000-0000-0000-0000-000000000000",
-  accumulated_depreciation_account_id: "00000000-0000-0000-0000-000000000000",
-  book_depreciation_setting:  book_depreciation_setting
-}  
-
-begin
-  response = xero_client.accounting_api.create_asset_type(xero_tenant_id, assetType)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_asset_type: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
assetsGrant read-write access to fixed assets
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
assetType -
-
- - AssetType - -
- Asset type to add -
-
-
- -
-
-
-
-
-
-
-

getAssetById

-

Retrieves fixed asset by id

-
-
-
-

-

By passing in the appropriate asset id, you can search for -a specific fixed asset in the system

-

-
- 
/Assets/{id}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-id = '00000000-0000-0000-0000-000000000000'
-
-begin
-  response = xero_client.accounting_api.get_asset_by_id(xero_tenant_id, id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_asset_by_id: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
assetsGrant read-write access to fixed assets
assets.readGrant read-only access to fixed assets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
id* - - -
-
-
- - UUID - - - (uuid) - - -
-fixed asset id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getAssetSettings

-

searches fixed asset settings

-
-
-
-

-

By passing in the appropriate options, you can search for available fixed asset types in the system

-

-
- 
/Settings
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-begin
-  response = xero_client.accounting_api.get_asset_settings(xero_tenant_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_asset_settings: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
assetsGrant read-write access to fixed assets
assets.readGrant read-only access to fixed assets
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getAssetTypes

-

searches fixed asset types

-
-
-
-

-

By passing in the appropriate options, you can search for available fixed asset types in the system

-

-
- 
/AssetTypes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-begin
-  response = xero_client.accounting_api.get_asset_types(xero_tenant_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_asset_types: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
assetsGrant read-write access to fixed assets
assets.readGrant read-only access to fixed assets
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getAssets

-

searches fixed asset

-
-
-
-

-

By passing in the appropriate options, you can search for available fixed asset in the system

-

-
- 
/Assets
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-status = 
-page = 1
-page_size = 5
-order_by = 'AssetName'
-sort_direction = 'ASC'
-filter_by = 'Company Car'
-
-begin
-  response = xero_client.accounting_api.get_assets(xero_tenant_id, status, page, page_size, order_by, sort_direction, filter_by)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_assets: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
assetsGrant read-write access to fixed assets
assets.readGrant read-only access to fixed assets
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
status* - - -
-
-
- - AssetStatusQueryParam - - -
-Required when retrieving a collection of assets. See Asset Status Codes -
-
-
- Required -
-
-
-
page - - -
-
-
- - Integer - - -
-Results are paged. This specifies which page of the results to return. The default page is 1. -
-
-
-
-
pageSize - - -
-
-
- - Integer - - -
-The number of records returned per page. By default the number of records returned is 10. -
-
-
-
-
orderBy - - -
-
-
- - String - - -
-Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice. -
-
-
-
-
sortDirection - - -
-
-
- - String - - -
-ASC or DESC -
-
-
-
-
filterBy - - -
-
-
- - String - - -
-A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields. -
-
-
-
-
-
-
-
-
-
- -
-
-
- - - - - - - - - - - - - - diff --git a/docs/files/FilesApi.md b/docs/files/FilesApi.md index 5d175e5b..75155196 100644 --- a/docs/files/FilesApi.md +++ b/docs/files/FilesApi.md @@ -58,9 +58,11 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | File id for single object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +file_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | File id for single object opts = { + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + association: { "ObjectId": "1270bf7c-5d18-473a-9231-1e36c4bd33ed", "ObjectGroup": "Contact", "ObjectType": "Business" } # Association | } @@ -79,7 +81,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **file_id** | [**String**](.md)| File id for single object | + **file_id** | **String**| File id for single object | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **association** | [**Association**](Association.md)| | [optional] ### Return type @@ -129,8 +132,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + folder: { "Name": "My Docs" } # Folder | } @@ -149,6 +154,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **folder** | [**Folder**](Folder.md)| | [optional] ### Return type @@ -198,8 +204,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | File id for single object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +file_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | File id for single object begin #Deletes a specific file api_instance.delete_file(xero_tenant_id, file_id) @@ -214,7 +220,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **file_id** | [**String**](.md)| File id for single object | + **file_id** | **String**| File id for single object | ### Return type @@ -263,9 +269,9 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | File id for single object -object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Object id for single object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +file_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | File id for single object +object_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Object id for single object begin #Deletes an existing file association api_instance.delete_file_association(xero_tenant_id, file_id, object_id) @@ -280,8 +286,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **file_id** | [**String**](.md)| File id for single object | - **object_id** | [**String**](.md)| Object id for single object | + **file_id** | **String**| File id for single object | + **object_id** | **String**| Object id for single object | ### Return type @@ -330,8 +336,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Folder id for single object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +folder_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Folder id for single object begin #Deletes a folder api_instance.delete_folder(xero_tenant_id, folder_id) @@ -346,7 +352,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **folder_id** | [**String**](.md)| Folder id for single object | + **folder_id** | **String**| Folder id for single object | ### Return type @@ -364,7 +370,7 @@ nil (empty response body) ## get_associations_by_object -> Array<Association> get_associations_by_object(xero_tenant_id, object_id) +> Array<Association> get_associations_by_object(xero_tenant_id, object_id, opts) Retrieves an association object using a unique object ID @@ -395,11 +401,21 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Object id for single object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +object_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Object id for single object +opts = { + pagesize: 50, # Integer | pass an optional page size value + + page: 2, # Integer | number of records to skip for pagination + + sort: Name, # String | values to sort by + + direction: ASC # String | direction to sort by +} + begin #Retrieves an association object using a unique object ID - result = api_instance.get_associations_by_object(xero_tenant_id, object_id) + result = api_instance.get_associations_by_object(xero_tenant_id, object_id, opts) p result rescue XeroRuby::Files::ApiError => e puts "Exception when calling FilesApi->get_associations_by_object: #{e}" @@ -412,7 +428,11 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **object_id** | [**String**](.md)| Object id for single object | + **object_id** | **String**| Object id for single object | + **pagesize** | **Integer**| pass an optional page size value | [optional] + **page** | **Integer**| number of records to skip for pagination | [optional] + **sort** | **String**| values to sort by | [optional] + **direction** | **String**| direction to sort by | [optional] ### Return type @@ -461,8 +481,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -object_ids = ['object_ids_example'] # Array | A comma-separated list of object ids +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +object_ids = # Array | A comma-separated list of object ids begin #Retrieves a count of associations for a list of objects. result = api_instance.get_associations_count(xero_tenant_id, object_ids) @@ -525,8 +545,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | File id for single object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +file_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | File id for single object begin #Retrieves a file by a unique file ID result = api_instance.get_file(xero_tenant_id, file_id) @@ -542,7 +562,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **file_id** | [**String**](.md)| File id for single object | + **file_id** | **String**| File id for single object | ### Return type @@ -591,8 +611,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | File id for single object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +file_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | File id for single object begin #Retrieves a specific file associations result = api_instance.get_file_associations(xero_tenant_id, file_id) @@ -608,7 +628,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **file_id** | [**String**](.md)| File id for single object | + **file_id** | **String**| File id for single object | ### Return type @@ -657,8 +677,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | File id for single object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +file_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | File id for single object begin #Retrieves the content of a specific file result = api_instance.get_file_content(xero_tenant_id, file_id) @@ -674,7 +694,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **file_id** | [**String**](.md)| File id for single object | + **file_id** | **String**| File id for single object | ### Return type @@ -721,13 +741,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { pagesize: 50, # Integer | pass an optional page size value page: 2, # Integer | number of records to skip for pagination - sort: 'CreatedDateUTC DESC' # String | values to sort by + sort: Name # String | values to sort by } begin @@ -796,8 +816,8 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Folder id for single object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +folder_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Folder id for single object begin #Retrieves specific folder by using a unique folder ID result = api_instance.get_folder(xero_tenant_id, folder_id) @@ -813,7 +833,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **folder_id** | [**String**](.md)| Folder id for single object | + **folder_id** | **String**| Folder id for single object | ### Return type @@ -862,9 +882,9 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - sort: 'CreatedDateUTC DESC' # String | values to sort by + sort: Name # String | values to sort by } begin @@ -931,7 +951,7 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant begin #Retrieves inbox folder result = api_instance.get_inbox(xero_tenant_id) @@ -995,9 +1015,11 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | File id for single object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +file_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | File id for single object opts = { + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + file_object: { "FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3" } # FileObject | } @@ -1016,7 +1038,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **file_id** | [**String**](.md)| File id for single object | + **file_id** | **String**| File id for single object | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **file_object** | [**FileObject**](FileObject.md)| | [optional] ### Return type @@ -1035,7 +1058,7 @@ Name | Type | Description | Notes ## update_folder -> Folder update_folder(xero_tenant_id, folder_id, folder) +> Folder update_folder(xero_tenant_id, folder_id, folder, opts) Updates an existing folder @@ -1066,12 +1089,16 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Folder id for single object +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +folder_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Folder id for single object folder = { "Name": "Your Docs" } # Folder | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates an existing folder - result = api_instance.update_folder(xero_tenant_id, folder_id, folder) + result = api_instance.update_folder(xero_tenant_id, folder_id, folder, opts) p result rescue XeroRuby::Files::ApiError => e puts "Exception when calling FilesApi->update_folder: #{e}" @@ -1084,8 +1111,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **folder_id** | [**String**](.md)| Folder id for single object | + **folder_id** | **String**| Folder id for single object | **folder** | [**Folder**](Folder.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1132,12 +1160,14 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -body = 'body_example' # String | -name = 'name_example' # String | exact name of the file you are uploading -filename = 'filename_example' # String | +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +body = BYTE_ARRAY_DATA_HERE # String | +name = name_example # String | exact name of the file you are uploading +filename = filename_example # String | opts = { - mime_type: 'mime_type_example' # String | + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + mime_type: mime_type_example # String | } begin @@ -1158,6 +1188,7 @@ Name | Type | Description | Notes **body** | **String**| | **name** | **String**| exact name of the file you are uploading | **filename** | **String**| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **mime_type** | **String**| | [optional] ### Return type @@ -1205,13 +1236,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | pass required folder id to save file to specific folder -body = 'body_example' # String | -name = 'name_example' # String | exact name of the file you are uploading -filename = 'filename_example' # String | +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +folder_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | pass required folder id to save file to specific folder +body = BYTE_ARRAY_DATA_HERE # String | +name = name_example # String | exact name of the file you are uploading +filename = filename_example # String | opts = { - mime_type: 'mime_type_example' # String | + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + mime_type: mime_type_example # String | } begin @@ -1229,10 +1262,11 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **folder_id** | [**String**](.md)| pass required folder id to save file to specific folder | + **folder_id** | **String**| pass required folder id to save file to specific folder | **body** | **String**| | **name** | **String**| exact name of the file you are uploading | **filename** | **String**| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **mime_type** | **String**| | [optional] ### Return type diff --git a/docs/files/UploadObject.md b/docs/files/UploadObject.md deleted file mode 100644 index c86cdef2..00000000 --- a/docs/files/UploadObject.md +++ /dev/null @@ -1,23 +0,0 @@ -# XeroRuby::Files::UploadObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**body** | **String** | | -**name** | **String** | exact name of the file you are uploading | -**filename** | **String** | | -**mime_type** | **String** | | [optional] - -## Code Sample - -```ruby -require 'XeroRuby::Files' - -instance = XeroRuby::Files::UploadObject.new(body: null, - name: null, - filename: null, - mime_type: null) -``` - - diff --git a/docs/files/index.html b/docs/files/index.html deleted file mode 100644 index 1ba335d5..00000000 --- a/docs/files/index.html +++ /dev/null @@ -1,5359 +0,0 @@ - - - - - Xero Files API - - - - - - xero-ruby Files SDK Docs - - - - - - - - - - - - - - - - - - -
- -
- -
-
- - -
-
- -
-
- -
-
-
-
- -
-
-
-

Xero Files API

-
-
-
- -
-
-

Files

-
-
-
-

createFileAssociation

-

Creates a new file association

-
-
-
-

-

By passing in the appropriate options, you can create a new folder

-

-
- 
/Files/{FileId}/Associations
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.create_file_association(xero_tenant_id, file_id, association)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_file_association: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
filesGrant read-write access to files and folders
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
FileId* - - -
-
-
- - UUID - - - (uuid) - - -
-File id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
association -
-
- - Association - -
- -
-
-
- -
-
-
-
-
-
-
-

createFolder

-

Creates a new folder

-
-
-
-

-

By passing in the appropriate properties, you can create a new folder

-

-
- 
/Folders
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-begin
-  response = xero_client.accounting_api.create_folder(xero_tenant_id, folder)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_folder: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
filesGrant read-write access to files and folders
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
folder -
-
- - Folder - -
- -
-
-
- -
-
-
-
-
-
-
-

deleteFile

-

Deletes a specific file

-
-
-
-

-

Delete a specific file

-

-
- 
/Files/{FileId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.delete_file(xero_tenant_id, file_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_file: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
filesGrant read-write access to files and folders
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
FileId* - - -
-
-
- - UUID - - - (uuid) - - -
-File id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteFileAssociation

-

Deletes an existing file association

-
-
-
-

-

By passing in the appropriate options, you can create a new folder

-

-
- 
/Files/{FileId}/Associations/{ObjectId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.delete_file_association(xero_tenant_id, file_id, object_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_file_association: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
filesGrant read-write access to files and folders
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
FileId* - - -
-
-
- - UUID - - - (uuid) - - -
-File id for single object -
-
-
- Required -
-
-
-
ObjectId* - - -
-
-
- - UUID - - - (uuid) - - -
-Object id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteFolder

-

Deletes a folder

-
-
-
-

-

By passing in the appropriate ID, you can delete a folder

-

-
- 
/Folders/{FolderId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.delete_folder(xero_tenant_id, folder_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_folder: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
filesGrant read-write access to files and folders
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
FolderId* - - -
-
-
- - UUID - - - (uuid) - - -
-Folder id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getAssociationsByObject

-

Retrieves an association object using a unique object ID

-
-
-
-

-

By passing in the appropriate options, you can retrieve an association

-

-
- 
/Associations/{ObjectId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_associations_by_object(xero_tenant_id, object_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_associations_by_object: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ObjectId* - - -
-
-
- - UUID - - - (uuid) - - -
-Object id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getAssociationsCount

-

Retrieves a count of associations for a list of objects.

-
-
-
-

-

By passing in the appropriate options, you can retrieve the association count for objects

-

-
- 
/Associations/Count
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-objectIds = []
-
-begin
-  response = xero_client.accounting_api.get_associations_count(xero_tenant_id, objectIds)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_associations_count: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
ObjectIds* - - -
-
-
- - array[UUID] - - - (uuid) - - -
-A comma-separated list of object ids -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getFile

-

Retrieves a file by a unique file ID

-
-
-
-

-

-

-
- 
/Files/{FileId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_file(xero_tenant_id, file_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_file: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
FileId* - - -
-
-
- - UUID - - - (uuid) - - -
-File id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getFileAssociations

-

Retrieves a specific file associations

-
-
-
-

-

By passing in the appropriate options,

-

-
- 
/Files/{FileId}/Associations
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_file_associations(xero_tenant_id, file_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_file_associations: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
FileId* - - -
-
-
- - UUID - - - (uuid) - - -
-File id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getFileContent

-

Retrieves the content of a specific file

-
-
-
-

-

By passing in the appropriate options, retrieve data for specific file

-

-
- 
/Files/{FileId}/Content
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_file_content(xero_tenant_id, file_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_file_content: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
FileId* - - -
-
-
- - UUID - - - (uuid) - - -
-File id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getFiles

-

Retrieves files

-
-
-
-

-

-

-
- 
/Files
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-pagesize = 50
-page = 2
-sort = 'CreatedDateUTC DESC'
-
-begin
-  response = xero_client.accounting_api.get_files(xero_tenant_id, pagesize, page, sort)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_files: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
pagesize - - -
-
-
- - Integer - - -
-pass an optional page size value -
-
-
-
-
page - - -
-
-
- - Integer - - -
-number of records to skip for pagination -
-
-
-
-
sort - - -
-
-
- - String - - -
-values to sort by -
-
-
-
-
-
-
-
-
-
-
-

getFolder

-

Retrieves specific folder by using a unique folder ID

-
-
-
-

-

By passing in the appropriate ID, you can search for specific folder

-

-
- 
/Folders/{FolderId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_folder(xero_tenant_id, folder_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_folder: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
FolderId* - - -
-
-
- - UUID - - - (uuid) - - -
-Folder id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getFolders

-

Retrieves folders

-
-
-
-

-

By passing in the appropriate options, you can search for available folders

-

-
- 
/Folders
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-sort = 'CreatedDateUTC DESC'
-
-begin
-  response = xero_client.accounting_api.get_folders(xero_tenant_id, sort)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_folders: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
sort - - -
-
-
- - String - - -
-values to sort by -
-
-
-
-
-
-
-
-
-
-
-

getInbox

-

Retrieves inbox folder

-
-
-
-

-

Search for the user inbox

-

-
- 
/Inbox
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-
-begin
-  response = xero_client.accounting_api.get_inbox(xero_tenant_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_inbox: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
filesGrant read-write access to files and folders
files.readGrant read-only access to files and folders
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

updateFile

-

Update a file

-
-
-
-

-

Updates file properties of a single file

-

-
- 
/Files/{FileId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.update_file(xero_tenant_id, file_id, fileObject)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_file: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
filesGrant read-write access to files and folders
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
FileId* - - -
-
-
- - UUID - - - (uuid) - - -
-File id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
fileObject -
-
- - FileObject - -
- -
-
-
- -
-
-
-
-
-
-
-

updateFolder

-

Updates an existing folder

-
-
-
-

-

By passing in the appropriate ID and properties, you can update a folder

-

-
- 
/Folders/{FolderId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.update_folder(xero_tenant_id, folder_id, folder)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_folder: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
filesGrant read-write access to files and folders
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
FolderId* - - -
-
-
- - UUID - - - (uuid) - - -
-Folder id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
folder * -
-
- - Folder - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

uploadFile

-

Uploads a File to the inbox

-
-
-
-

-

-

-
- 
/Files
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-body = BYTE_ARRAY_DATA_HERE
-name = 'name_example'
-filename = 'filename_example'
-mimeType = 'mimeType_example'
-
-begin
-  response = xero_client.accounting_api.upload_file(xero_tenant_id, body, name, filename, mimeType)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling upload_file: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
filesGrant read-write access to files and folders
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Form parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
body* - - -
-
-
- - byte[] - - - (byte) - - -
- -
-
-
- Required -
-
-
-
name* - - -
-
-
- - String - - -
-exact name of the file you are uploading -
-
-
- Required -
-
-
-
filename* - - -
-
-
- - String - - -
- -
-
-
- Required -
-
-
-
mimeType - - -
-
-
- - String - - -
- -
-
-
-
-
-
-
-
-
-
-
-

uploadFileToFolder

-

Uploads a File to a specific folder

-
-
-
-

-

-

-
- 
/Files/{FolderId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-body = BYTE_ARRAY_DATA_HERE
-name = 'name_example'
-filename = 'filename_example'
-mimeType = 'mimeType_example'
-
-begin
-  response = xero_client.accounting_api.upload_file_to_folder(xero_tenant_id, folder_id, body, name, filename, mimeType)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling upload_file_to_folder: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
filesGrant read-write access to files and folders
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
FolderId* - - -
-
-
- - UUID - - - (uuid) - - -
-pass required folder id to save file to specific folder -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Form parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
body* - - -
-
-
- - byte[] - - - (byte) - - -
- -
-
-
- Required -
-
-
-
name* - - -
-
-
- - String - - -
-exact name of the file you are uploading -
-
-
- Required -
-
-
-
filename* - - -
-
-
- - String - - -
- -
-
-
- Required -
-
-
-
mimeType - - -
-
-
- - String - - -
- -
-
-
-
-
-
-
-
-
-
- -
-
-
- - - - - - - - - - - - - - diff --git a/docs/finance/AccountUsage.md b/docs/finance/AccountUsage.md index 28438745..abca60ec 100644 --- a/docs/finance/AccountUsage.md +++ b/docs/finance/AccountUsage.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **account_name** | **String** | The name of the account | [optional] **reporting_code** | **String** | Shown if set | [optional] **reporting_code_name** | **String** | Shown if set | [optional] -**report_code_updated_date_utc** | **DateTime** | Last modified date UTC format | [optional] +**report_code_updated_date_utc** | **Time** | Last modified date UTC format | [optional] ## Code Sample diff --git a/docs/finance/CurrentStatementResponse.md b/docs/finance/CurrentStatementResponse.md index c71c3f67..9760e95a 100644 --- a/docs/finance/CurrentStatementResponse.md +++ b/docs/finance/CurrentStatementResponse.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **end_date** | **Date** | Looking at the most recent bank statement, this field indicates the last date which transactions on this statement pertain to. This date is represented in ISO 8601 format. | [optional] **start_balance** | **BigDecimal** | Looking at the most recent bank statement, this field indicates the balance before the transactions on the statement are applied (note, this is not always populated by the bank in every single instance (~10%)). | [optional] **end_balance** | **BigDecimal** | Looking at the most recent bank statement, this field indicates the balance after the transactions on the statement are applied (note, this is not always populated by the bank in every single instance (~10%)). | [optional] -**imported_date_time_utc** | **DateTime** | Looking at the most recent bank statement, this field indicates when the document was imported into Xero. This date is represented in ISO 8601 format. | [optional] +**imported_date_time_utc** | **Time** | Looking at the most recent bank statement, this field indicates when the document was imported into Xero. This date is represented in ISO 8601 format. | [optional] **import_source_type** | **String** | Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, indirect bank feed, file upload, or manual keying). | [optional] ## Code Sample diff --git a/docs/finance/FinanceApi.md b/docs/finance/FinanceApi.md index 26f0c978..08c7fa2b 100644 --- a/docs/finance/FinanceApi.md +++ b/docs/finance/FinanceApi.md @@ -52,11 +52,11 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - start_month: '2020-09', # String | date, yyyy-MM If no parameter is provided, the month 12 months prior to the end month will be used. Account usage for up to 12 months from this date will be returned. + start_month: 2020-09, # String | date, yyyy-MM If no parameter is provided, the month 12 months prior to the end month will be used. Account usage for up to 12 months from this date will be returned. - end_month: '2021-09' # String | date, yyyy-MM If no parameter is provided, the current month will be used. Account usage for up to 12 months prior to this date will be returned. + end_month: 2021-09 # String | date, yyyy-MM If no parameter is provided, the current month will be used. Account usage for up to 12 months prior to this date will be returned. } begin @@ -124,9 +124,9 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - end_date: '2021-09-15' # String | date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a change is visible from this API. + end_date: 2021-09-15 # String | date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a change is visible from this API. } begin @@ -193,9 +193,9 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - end_date: '2021-09-15' # String | date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any reports that were published within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a published report is visible from this API. + end_date: 2021-09-15 # String | date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any reports that were published within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a published report is visible from this API. } begin @@ -262,9 +262,9 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - data_month: '2021-09' # String | date, yyyy-MM The specified month must be complete (in the past); The current month cannot be specified since it is not complete. If no parameter is provided, the month immediately previous to the current month will be used. Any user activities occurring within the specified month will be returned. Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API. + data_month: 2021-09 # String | date, yyyy-MM The specified month must be complete (in the past); The current month cannot be specified since it is not complete. If no parameter is provided, the month immediately previous to the current month will be used. Any user activities occurring within the specified month will be returned. Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API. } begin @@ -331,10 +331,10 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -bank_account_id = 'bank_account_id_example' # String | string, GUID Bank account Id -from_date = '2020-07-01' # String | date, yyyy-MM-dd Specifies the start date of the query period. The maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected. -to_date = '2021-06-30' # String | date, yyyy-MM-dd Specifies the end date of the query period. If the end date is a future date, the request will be rejected. +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant +bank_account_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | string, GUID Bank account Id +from_date = 2020-07-01 # String | date, yyyy-MM-dd Specifies the start date of the query period. The maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected. +to_date = 2021-06-30 # String | date, yyyy-MM-dd Specifies the end date of the query period. If the end date is a future date, the request will be rejected. opts = { summary_only: true # Boolean | boolean, true/false The default value is true if no parameter is provided. In summary mode, the response will exclude the computation-heavy LineItems fields from bank transaction, invoice, credit note, prepayment and overpayment data, making the API calls quicker and more efficient. } @@ -354,7 +354,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **bank_account_id** | [**String**](.md)| string, GUID Bank account Id | + **bank_account_id** | **String**| string, GUID Bank account Id | **from_date** | **String**| date, yyyy-MM-dd Specifies the start date of the query period. The maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected. | **to_date** | **String**| date, yyyy-MM-dd Specifies the end date of the query period. If the end date is a future date, the request will be rejected. | **summary_only** | **Boolean**| boolean, true/false The default value is true if no parameter is provided. In summary mode, the response will exclude the computation-heavy LineItems fields from bank transaction, invoice, credit note, prepayment and overpayment data, making the API calls quicker and more efficient. | [optional] @@ -406,13 +406,13 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - balance_date: '2021-09-15', # String | date, yyyy-MM-dd If no parameter is provided, the current date will be used. The ‘balance date’ will return transactions based on the accounting date entered by the user. Transactions before the balanceDate will be included. The user has discretion as to which accounting period the transaction relates to. The ‘balance date’ will control the latest maximum date of transactions included in the aggregate numbers. Balance date does not affect the CurrentStatement object, as this will always return the most recent statement before asAtSystemDate (if specified) + balance_date: 2021-09-15, # String | date, yyyy-MM-dd If no parameter is provided, the current date will be used. The ‘balance date’ will return transactions based on the accounting date entered by the user. Transactions before the balanceDate will be included. The user has discretion as to which accounting period the transaction relates to. The ‘balance date’ will control the latest maximum date of transactions included in the aggregate numbers. Balance date does not affect the CurrentStatement object, as this will always return the most recent statement before asAtSystemDate (if specified) - as_at_system_date: '2021-09-15', # String | date, yyyy-MM-dd If no parameter is provided, the current date will be used. The ‘as at’ date will return transactions based on the creation date. It reflects the date the transactions were entered into Xero, not the accounting date. The ‘as at’ date can not be overridden by the user. This can be used to estimate a ‘historical frequency of reconciliation’. The ‘as at’ date will affect the current statement in the response, as any candidate statements created after this date will be filtered out. Thus the current statement returned will be the most recent statement prior to the specified ‘as at’ date. Be aware that neither the begin date, nor the balance date, will affect the current statement. Note; information is only presented when system architecture allows, meaning historical cash validation information will be an estimate. In addition, delete events are not aware of the ‘as at’ functionality in this endpoint, meaning that transactions deleted at the time the API is accessed will be considered to always have been deleted. + as_at_system_date: 2021-09-15, # String | date, yyyy-MM-dd If no parameter is provided, the current date will be used. The ‘as at’ date will return transactions based on the creation date. It reflects the date the transactions were entered into Xero, not the accounting date. The ‘as at’ date can not be overridden by the user. This can be used to estimate a ‘historical frequency of reconciliation’. The ‘as at’ date will affect the current statement in the response, as any candidate statements created after this date will be filtered out. Thus the current statement returned will be the most recent statement prior to the specified ‘as at’ date. Be aware that neither the begin date, nor the balance date, will affect the current statement. Note; information is only presented when system architecture allows, meaning historical cash validation information will be an estimate. In addition, delete events are not aware of the ‘as at’ functionality in this endpoint, meaning that transactions deleted at the time the API is accessed will be considered to always have been deleted. - begin_date: '2021-09-15' # String | date, yyyy-MM-dd If no parameter is provided, the aggregate results will be drawn from the user’s total history. The ‘begin date’ will return transactions based on the accounting date entered by the user. Transactions after the beginDate will be included. The user has discretion as to which accounting period the transaction relates to. + begin_date: 2021-09-15 # String | date, yyyy-MM-dd If no parameter is provided, the aggregate results will be drawn from the user’s total history. The ‘begin date’ will return transactions based on the accounting date entered by the user. Transactions after the beginDate will be included. The user has discretion as to which accounting period the transaction relates to. } begin @@ -481,9 +481,9 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - balance_date: '2020-06-30' # String | Specifies the date for balance sheet report. Format yyyy-MM-dd. If no parameter is provided, the current date will be used. + balance_date: 2020-06-30 # String | Specifies the date for balance sheet report. Format yyyy-MM-dd. If no parameter is provided, the current date will be used. } begin @@ -550,11 +550,11 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - start_date: '2020-09-15', # String | Date e.g. yyyy-MM-dd Specifies the start date for cash flow report. If no parameter is provided, the date of 12 months before the end date will be used. + start_date: 2020-09-15, # String | Date e.g. yyyy-MM-dd Specifies the start date for cash flow report. If no parameter is provided, the date of 12 months before the end date will be used. - end_date: '2021-09-15' # String | Date e.g. yyyy-MM-dd Specifies the end date for cash flow report. If no parameter is provided, the current date will be used. + end_date: 2021-09-15 # String | Date e.g. yyyy-MM-dd Specifies the end date for cash flow report. If no parameter is provided, the current date will be used. } begin @@ -622,15 +622,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - contact_ids: ['[\"00000000-0000-0000-0000-000000000000\",\"00000000-0000-0000-0000-000000000000\"]'], # Array | Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included + contact_ids: ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000"], # Array | Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included include_manual_journals: true, # Boolean | Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included. - start_date: '2020-09-15', # String | Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency. + start_date: 2020-09-15, # String | Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency. - end_date: '2020-09-15' # String | Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency. + end_date: 2020-09-15 # String | Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency. } begin @@ -700,15 +700,15 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - contact_ids: ['[\"00000000-0000-0000-0000-000000000000\",\"00000000-0000-0000-0000-000000000000\"]'], # Array | Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included + contact_ids: ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000"], # Array | Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included include_manual_journals: true, # Boolean | Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included. - start_date: '2020-09-15', # String | Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency. + start_date: 2020-09-15, # String | Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency. - end_date: '2020-09-15' # String | Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency. + end_date: 2020-09-15 # String | Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency. } begin @@ -778,11 +778,11 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - start_date: '2020-09-15', # String | Date e.g. yyyy-MM-dd Specifies the start date for profit and loss report If no parameter is provided, the date of 12 months before the end date will be used. + start_date: 2020-09-15, # String | Date e.g. yyyy-MM-dd Specifies the start date for profit and loss report If no parameter is provided, the date of 12 months before the end date will be used. - end_date: '2021-09-15' # String | Date e.g. yyyy-MM-dd Specifies the end date for profit and loss report If no parameter is provided, the current date will be used. + end_date: 2021-09-15 # String | Date e.g. yyyy-MM-dd Specifies the end date for profit and loss report If no parameter is provided, the current date will be used. } begin @@ -850,9 +850,9 @@ api_instance = xero_client. -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +xero_tenant_id = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant opts = { - end_date: '2021-09-15' # String | Date e.g. yyyy-MM-dd Specifies the end date for trial balance report If no parameter is provided, the current date will be used. + end_date: 2021-09-15 # String | Date e.g. yyyy-MM-dd Specifies the end date for trial balance report If no parameter is provided, the current date will be used. } begin diff --git a/docs/finance/HistoryRecordResponse.md b/docs/finance/HistoryRecordResponse.md index 2ffd3c31..6cbad684 100644 --- a/docs/finance/HistoryRecordResponse.md +++ b/docs/finance/HistoryRecordResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **changes** | **String** | The type of change recorded against the document | [optional] **date_utc_string** | **String** | UTC date that the history record was created | [optional] -**date_utc** | **DateTime** | UTC date that the history record was created | [optional] +**date_utc** | **Time** | UTC date that the history record was created | [optional] **user** | **String** | The users first and last name | [optional] **details** | **String** | Description of the change event or transaction | [optional] diff --git a/docs/finance/LockHistoryModel.md b/docs/finance/LockHistoryModel.md index e52a8696..fc6bb269 100644 --- a/docs/finance/LockHistoryModel.md +++ b/docs/finance/LockHistoryModel.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **hard_lock_date** | **Date** | Date the account hard lock was set | [optional] **soft_lock_date** | **Date** | Date the account soft lock was set | [optional] -**updated_date_utc** | **DateTime** | The system date time that the lock was updated | [optional] +**updated_date_utc** | **Time** | The system date time that the lock was updated | [optional] ## Code Sample diff --git a/docs/finance/ReportHistoryModel.md b/docs/finance/ReportHistoryModel.md index 8ee50af3..82dff149 100644 --- a/docs/finance/ReportHistoryModel.md +++ b/docs/finance/ReportHistoryModel.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **report_name** | **String** | Report code or report title | [optional] **report_date_text** | **String** | The date or date range of the report | [optional] -**published_date_utc** | **DateTime** | The system date time that the report was published | [optional] +**published_date_utc** | **Time** | The system date time that the report was published | [optional] ## Code Sample diff --git a/docs/finance/StatementResponse.md b/docs/finance/StatementResponse.md index b192f4d7..502faf18 100644 --- a/docs/finance/StatementResponse.md +++ b/docs/finance/StatementResponse.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **statement_id** | **String** | Xero Identifier of statement | [optional] **start_date** | **Date** | Start date of statement | [optional] **end_date** | **Date** | End date of statement | [optional] -**imported_date_time_utc** | **DateTime** | Utc date time of when the statement was imported in Xero | [optional] +**imported_date_time_utc** | **Time** | Utc date time of when the statement was imported in Xero | [optional] **import_source** | **String** | Identifies where the statement data in Xero was sourced, 1) direct bank feed, automatically loaded from the bank (eg STMTIMPORTSRC/CBAFEED); 2) indirect bank feed, automatically loaded from a 3rd party provider (eg STMTIMPORTSRC/YODLEE); 3) manually uploaded bank feed (eg STMTIMPORTSRC/CSV) or 4) manually entered statement data (STMTIMPORTSRC/MANUAL). | [optional] **start_balance** | **BigDecimal** | Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0. | [optional] **end_balance** | **BigDecimal** | Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0. | [optional] diff --git a/docs/finance/UserResponse.md b/docs/finance/UserResponse.md index 7cd21947..e464ac2b 100644 --- a/docs/finance/UserResponse.md +++ b/docs/finance/UserResponse.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **user_id** | **String** | The Xero identifier for the user | [optional] -**user_created_date_utc** | **DateTime** | Timestamp of user creation. | [optional] -**last_login_date_utc** | **DateTime** | Timestamp of user last login | [optional] +**user_created_date_utc** | **Time** | Timestamp of user creation. | [optional] +**last_login_date_utc** | **Time** | Timestamp of user last login | [optional] **is_external_partner** | **Boolean** | User is external partner. | [optional] **has_accountant_role** | **Boolean** | User has Accountant role. | [optional] **month_period** | **String** | Month period in format yyyy-MM. | [optional] diff --git a/docs/finance/index.html b/docs/finance/index.html deleted file mode 100644 index 8581cb01..00000000 --- a/docs/finance/index.html +++ /dev/null @@ -1,6230 +0,0 @@ - - - - - Xero Finance API - - - - - - xero-ruby Finance SDK Docs - - - - - - - - - - - - - - - - - - -
- -
- -
-
- - -
-
- -
-
- -
-
-
-
- -
-
-
-

Xero Finance API

-
-
-
- -
-
-

Finance

-
-
-
-

getAccountingActivityAccountUsage

-

Get account usage

-
-
-
-

-

A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments.

-

-
- 
/AccountingActivities/AccountUsage
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-start_month = '2020-09'
-end_month = '2021-09'
-
-begin
-  response = xero_client.accounting_api.get_accounting_activity_account_usage(xero_tenant_id, start_month, end_month)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_accounting_activity_account_usage: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
finance.accountingactivity.readGrant read-only access to Xero usage activity
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
startMonth - - -
-
-
- - String - - -
-

date, yyyy-MM

-

If no parameter is provided, the month 12 months prior to the end month will be used.

-

Account usage for up to 12 months from this date will be returned.

- -
-
-
-
-
endMonth - - -
-
-
- - String - - -
-

date, yyyy-MM

-

If no parameter is provided, the current month will be used.

-

Account usage for up to 12 months prior to this date will be returned.

- -
-
-
-
-
-
-
-
-
-
-
-

getAccountingActivityLockHistory

-

Get lock history

-
-
-
-

-

Provides a history of locking of accounting books. Locking may be an indicator of good accounting practices that could reduce the risk of changes to accounting records in prior periods.

-

-
- 
/AccountingActivities/LockHistory
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-end_date = '2021-09-15'
-
-begin
-  response = xero_client.accounting_api.get_accounting_activity_lock_history(xero_tenant_id, end_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_accounting_activity_lock_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
finance.accountingactivity.readGrant read-only access to Xero usage activity
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
endDate - - -
-
-
- - String - - -
-

date, yyyy-MM-dd

-

If no parameter is provided, the current date will be used.

-

Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned.

-

Please be aware that there may be a delay of up to 3 days before a change is visible from this API.

- -
-
-
-
-
-
-
-
-
-
-
-

getAccountingActivityReportHistory

-

Get report history

-
-
-
-

-

For a specified organisation, provides a summary of all the reports published within a given period, which may be an indicator for good business management and oversight.

-

-
- 
/AccountingActivities/ReportHistory
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-end_date = '2021-09-15'
-
-begin
-  response = xero_client.accounting_api.get_accounting_activity_report_history(xero_tenant_id, end_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_accounting_activity_report_history: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
finance.accountingactivity.readGrant read-only access to Xero usage activity
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
endDate - - -
-
-
- - String - - -
-

date, yyyy-MM-dd

-

If no parameter is provided, the current date will be used.

-

Any reports that were published within the period up to 12 months before this date will be returned.

-

Please be aware that there may be a delay of up to 3 days before a published report is visible from this API.

- -
-
-
-
-
-
-
-
-
-
-
-

getAccountingActivityUserActivities

-

Get user activities

-
-
-
-

-

For a specified organisation, provides a list of all the users registered, and a history of their accounting transactions. Also identifies the existence of an external accounting advisor and the level of interaction.

-

-
- 
/AccountingActivities/UserActivities
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-data_month = '2021-09'
-
-begin
-  response = xero_client.accounting_api.get_accounting_activity_user_activities(xero_tenant_id, data_month)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_accounting_activity_user_activities: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
finance.accountingactivity.readGrant read-only access to Xero usage activity
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
dataMonth - - -
-
-
- - String - - -
-

date, yyyy-MM

-

The specified month must be complete (in the past); The current month cannot be specified since it is not complete.

-

If no parameter is provided, the month immediately previous to the current month will be used.

-

Any user activities occurring within the specified month will be returned.

-

Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API.

- -
-
-
-
-
-
-
-
-
-
-
-

getBankStatementAccounting

-

Get Bank Statement Accounting

-
-
-
-

-

For lenders that prefer using bank statement data as the source of truth. We provide a data point that will allow access to customer bank statements, plus for reconciled bank transactions the matching accounting, invoice and billing data as well. As customers reconcile bank statements to invoices and bills, this transaction detail will provide valuable insight for lender's assessment measures.

-

-
- 
/BankStatementsPlus/statements
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-bank_account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-from_date = '2020-07-01'
-to_date = '2021-06-30'
-summary_only = true
-
-begin
-  response = xero_client.accounting_api.get_bank_statement_accounting(xero_tenant_id, bank_account_id, from_date, to_date, summary_only)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_bank_statement_accounting: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
finance.bankstatementsplus.readGrant read-only access to bank statements accounting data
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
BankAccountID* - - -
-
-
- - UUID - - - (uuid) - - -
-

string, GUID

-

Bank account Id

- -
-
-
- Required -
-
-
-
FromDate* - - -
-
-
- - String - - -
-

date, yyyy-MM-dd

-

Specifies the start date of the query period. -The maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected.

- -
-
-
- Required -
-
-
-
ToDate* - - -
-
-
- - String - - -
-

date, yyyy-MM-dd

-

Specifies the end date of the query period. -If the end date is a future date, the request will be rejected.

- -
-
-
- Required -
-
-
-
SummaryOnly - - -
-
-
- - Boolean - - -
-

boolean, true/false

-

The default value is true if no parameter is provided.

-

In summary mode, the response will exclude the computation-heavy LineItems fields from bank transaction, invoice, credit note, prepayment and overpayment data, making the API calls quicker and more efficient.

- -
-
-
-
-
-
-
-
-
-
-
-

getCashValidation

-

Get cash validation

-
-
-
-

-

Summarizes the total cash position for each account for an org

-

-
- 
/CashValidation
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-balance_date = '2021-09-15'
-as_at_system_date = '2021-09-15'
-begin_date = '2021-09-15'
-
-begin
-  response = xero_client.accounting_api.get_cash_validation(xero_tenant_id, balance_date, as_at_system_date, begin_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_cash_validation: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
finance.cashvalidation.readGrant read-only access to bank statement and reconcilation data
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
balanceDate - - -
-
-
- - String - - -
-

date, yyyy-MM-dd

-

If no parameter is provided, the current date will be used.

-

The ‘balance date’ will return transactions based on the accounting date entered by the user. Transactions before the balanceDate will be included. -The user has discretion as to which accounting period the transaction relates to.

-

The ‘balance date’ will control the latest maximum date of transactions included in the aggregate numbers. Balance date does not affect the CurrentStatement object, as this will always return the most recent statement before asAtSystemDate (if specified)

- -
-
-
-
-
asAtSystemDate - - -
-
-
- - String - - -
-

date, yyyy-MM-dd

-

If no parameter is provided, the current date will be used.

-

The ‘as at’ date will return transactions based on the creation date. It reflects the date the transactions were entered into Xero, not the accounting date. -The ‘as at’ date can not be overridden by the user. This can be used to estimate a ‘historical frequency of reconciliation’.

-

The ‘as at’ date will affect the current statement in the response, as any candidate statements created after this date will be filtered out. Thus the current statement returned will be the most recent statement prior to the specified ‘as at’ date. Be aware that neither the begin date, nor the balance date, will affect the current statement.

-

Note; information is only presented when system architecture allows, meaning historical cash validation information will be an estimate. In addition, delete events are not aware of the ‘as at’ functionality in this endpoint, meaning that transactions deleted at the time the API is accessed will be considered to always have been deleted.

- -
-
-
-
-
beginDate - - -
-
-
- - String - - -
-

date, yyyy-MM-dd

-

If no parameter is provided, the aggregate results will be drawn from the user’s total history.

-

The ‘begin date’ will return transactions based on the accounting date entered by the user. Transactions after the beginDate will be included. -The user has discretion as to which accounting period the transaction relates to.

- -
-
-
-
-
-
-
-
-
-
-
-

getFinancialStatementBalanceSheet

-

Get Balance Sheet report

-
-
-
-

-

The balance sheet report is a standard financial report which describes the financial position of an organisation at a point in time.

-

-
- 
/FinancialStatements/BalanceSheet
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-balance_date = '2020-06-30'
-
-begin
-  response = xero_client.accounting_api.get_financial_statement_balance_sheet(xero_tenant_id, balance_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_financial_statement_balance_sheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
finance.statements.readGrant read-only access to finacial statements
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
balanceDate - - -
-
-
- - String - - -
-

Specifies the date for balance sheet report.

-

Format yyyy-MM-dd. If no parameter is provided, the current date will be used.

- -
-
-
-
-
-
-
-
-
-
-
-

getFinancialStatementCashflow

-

Get Cash flow report

-
-
-
-

-

The statement of cash flows - direct method, provides the year to date changes in operating, financing and investing cash flow activities for an organisation. Cashflow statement is not available in US region at this stage.

-

-
- 
/FinancialStatements/Cashflow
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-start_date = '2020-09-15'
-end_date = '2021-09-15'
-
-begin
-  response = xero_client.accounting_api.get_financial_statement_cashflow(xero_tenant_id, start_date, end_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_financial_statement_cashflow: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
finance.statements.readGrant read-only access to finacial statements
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
startDate - - -
-
-
- - String - - -
-

Date e.g. yyyy-MM-dd

-

Specifies the start date for cash flow report.

-

If no parameter is provided, the date of 12 months before the end date will be used.

- -
-
-
-
-
endDate - - -
-
-
- - String - - -
-

Date e.g. yyyy-MM-dd

-

Specifies the end date for cash flow report.

-

If no parameter is provided, the current date will be used.

- -
-
-
-
-
-
-
-
-
-
-
-

getFinancialStatementContactsExpense

-

Get expense by contacts report

-
-
-
-

-

The expense by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.

-

-
- 
/FinancialStatements/contacts/expense
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_ids = [["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000"]]
-include_manual_journals = true
-start_date = '2020-09-15'
-end_date = '2020-09-15'
-
-begin
-  response = xero_client.accounting_api.get_financial_statement_contacts_expense(xero_tenant_id, contact_ids, include_manual_journals, start_date, end_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_financial_statement_contacts_expense: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
finance.statements.readGrant read-only access to finacial statements
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
contactIds - - -
-
-
- - array[UUID] - - - (uuid) - - -
-

Specifies the customer contacts to be included in the report.

-

If no parameter is provided, all customer contacts will be included

- -
-
-
-
-
includeManualJournals - - -
-
-
- - Boolean - - -
-

Specifies whether to include the manual journals in the report.

-

If no parameter is provided, manual journals will not be included.

- -
-
-
-
-
startDate - - -
-
-
- - String - - -
-

Date yyyy-MM-dd

-

Specifies the start date for the report.

-

If no parameter is provided, the date of 12 months before the end date will be used.

-

It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

- -
-
-
-
-
endDate - - -
-
-
- - String - - -
-

Date yyyy-MM-dd

-

Specifies the end date for the report.

-

If no parameter is provided, the current date will be used.

-

It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

- -
-
-
-
-
-
-
-
-
-
-
-

getFinancialStatementContactsRevenue

-

Get revenue by contacts report

-
-
-
-

-

The revenue by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.

-

-
- 
/FinancialStatements/contacts/revenue
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-contact_ids = [["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000"]]
-include_manual_journals = true
-start_date = '2020-09-15'
-end_date = '2020-09-15'
-
-begin
-  response = xero_client.accounting_api.get_financial_statement_contacts_revenue(xero_tenant_id, contact_ids, include_manual_journals, start_date, end_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_financial_statement_contacts_revenue: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
finance.statements.readGrant read-only access to finacial statements
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
contactIds - - -
-
-
- - array[UUID] - - - (uuid) - - -
-

Specifies the customer contacts to be included in the report.

-

If no parameter is provided, all customer contacts will be included

- -
-
-
-
-
includeManualJournals - - -
-
-
- - Boolean - - -
-

Specifies whether to include the manual journals in the report.

-

If no parameter is provided, manual journals will not be included.

- -
-
-
-
-
startDate - - -
-
-
- - String - - -
-

Date yyyy-MM-dd

-

Specifies the start date for the report.

-

If no parameter is provided, the date of 12 months before the end date will be used.

-

It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

- -
-
-
-
-
endDate - - -
-
-
- - String - - -
-

Date yyyy-MM-dd

-

Specifies the end date for the report.

-

If no parameter is provided, the current date will be used.

-

It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

- -
-
-
-
-
-
-
-
-
-
-
-

getFinancialStatementProfitAndLoss

-

Get Profit & Loss report

-
-
-
-

-

The profit and loss statement is a standard financial report providing detailed year to date income and expense detail for an organisation.

-

-
- 
/FinancialStatements/ProfitAndLoss
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-start_date = '2020-09-15'
-end_date = '2021-09-15'
-
-begin
-  response = xero_client.accounting_api.get_financial_statement_profit_and_loss(xero_tenant_id, start_date, end_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_financial_statement_profit_and_loss: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
finance.statements.readGrant read-only access to finacial statements
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
startDate - - -
-
-
- - String - - -
-

Date e.g. yyyy-MM-dd

-

Specifies the start date for profit and loss report

-

If no parameter is provided, the date of 12 months before the end date will be used.

- -
-
-
-
-
endDate - - -
-
-
- - String - - -
-

Date e.g. yyyy-MM-dd

-

Specifies the end date for profit and loss report

-

If no parameter is provided, the current date will be used.

- -
-
-
-
-
-
-
-
-
-
-
-

getFinancialStatementTrialBalance

-

Get Trial Balance report

-
-
-
-

-

The trial balance provides a detailed list of all accounts of an organisation at a point in time, with revenue and expense items being year to date.

-

-
- 
/FinancialStatements/TrialBalance
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-end_date = '2021-09-15'
-
-begin
-  response = xero_client.accounting_api.get_financial_statement_trial_balance(xero_tenant_id, end_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_financial_statement_trial_balance: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
finance.statements.readGrant read-only access to finacial statements
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
xero-tenant-id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
endDate - - -
-
-
- - String - - -
-

Date e.g. yyyy-MM-dd

-

Specifies the end date for trial balance report

-

If no parameter is provided, the current date will be used.

- -
-
-
-
-
-
-
-
-
-
- -
-
-
- - - - - - - - - - - - - - diff --git a/docs/payroll_au/PayrollAuApi.md b/docs/payroll_au/PayrollAuApi.md index ba2d2ba8..cc9ffb89 100644 --- a/docs/payroll_au/PayrollAuApi.md +++ b/docs/payroll_au/PayrollAuApi.md @@ -41,7 +41,7 @@ Method | HTTP request | Description ## approve_leave_application -> LeaveApplications approve_leave_application(xero_tenant_id, leave_application_id) +> LeaveApplications approve_leave_application(xero_tenant_id, leave_application_id, opts) Approve a requested leave application by a unique leave application id @@ -70,11 +70,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Leave Application id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +leave_application_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Leave Application id for single object +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Approve a requested leave application by a unique leave application id - result = api_instance.approve_leave_application(xero_tenant_id, leave_application_id) + result = api_instance.approve_leave_application(xero_tenant_id, leave_application_id, opts) p result rescue XeroRuby::PayrollAu::ApiError => e puts "Exception when calling PayrollAuApi->approve_leave_application: #{e}" @@ -87,7 +91,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **leave_application_id** | [**String**](.md)| Leave Application id for single object | + **leave_application_id** | **String**| Leave Application id for single object | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -105,7 +110,7 @@ Name | Type | Description | Notes ## create_employee -> Employees create_employee(xero_tenant_id, employee) +> Employees create_employee(xero_tenant_id, employee, opts) Creates a payroll employee @@ -134,11 +139,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant employee = [ { "FirstName": "Albus", "LastName": "Dumbledore", "DateOfBirth": "/Date(321523200000+0000)/", "HomeAddress": { "AddressLine1": "101 Green St", "City": "Island Bay", "Region": "NSW", "PostalCode": "6023", "Country": "AUSTRALIA" }, "StartDate": "/Date(321523200000+0000)/", "MiddleNames": "Percival", "Email": "albus39608@hogwarts.edu", "Gender": "M", "Phone": "444-2323", "Mobile": "555-1212", "IsAuthorisedToApproveLeave": true, "IsAuthorisedToApproveTimesheets": true, "JobTitle": "Regional Manager", "Classification": "corporate", "OrdinaryEarningsRateID": "ab874dfb-ab09-4c91-954e-43acf6fc23b4", "Status": "ACTIVE" } ] # Array | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a payroll employee - result = api_instance.create_employee(xero_tenant_id, employee) + result = api_instance.create_employee(xero_tenant_id, employee, opts) p result rescue XeroRuby::PayrollAu::ApiError => e puts "Exception when calling PayrollAuApi->create_employee: #{e}" @@ -152,6 +161,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **employee** | [**Array<Employee>**](Employee.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -169,7 +179,7 @@ Name | Type | Description | Notes ## create_leave_application -> LeaveApplications create_leave_application(xero_tenant_id, leave_application) +> LeaveApplications create_leave_application(xero_tenant_id, leave_application, opts) Creates a leave application @@ -198,11 +208,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant leave_application = [ { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "LeaveTypeID": "184ea8f7-d143-46dd-bef3-0c60e1aa6fca", "Title": "Hello World", "StartDate": "/Date(1572559200000+0000)/", "EndDate": "/Date(1572645600000+0000)/" } ] # Array | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a leave application - result = api_instance.create_leave_application(xero_tenant_id, leave_application) + result = api_instance.create_leave_application(xero_tenant_id, leave_application, opts) p result rescue XeroRuby::PayrollAu::ApiError => e puts "Exception when calling PayrollAuApi->create_leave_application: #{e}" @@ -216,6 +230,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **leave_application** | [**Array<LeaveApplication>**](LeaveApplication.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -233,7 +248,7 @@ Name | Type | Description | Notes ## create_pay_item -> PayItems create_pay_item(xero_tenant_id, pay_item) +> PayItems create_pay_item(xero_tenant_id, pay_item, opts) Creates a pay item @@ -262,11 +277,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant pay_item = { "EarningsRates": [ { "Name": "MyRate", "AccountCode": "400", "TypeOfUnits": "4.00", "IsExemptFromTax": true, "IsExemptFromSuper": true, "IsReportableAsW1": false, "AllowanceContributesToAnnualLeaveRate": false, "AllowanceContributesToOvertimeRate": false, "EarningsType": "ORDINARYTIMEEARNINGS", "EarningsRateID": "1fa4e226-b711-46ba-a8a7-4344c9c5fb87", "RateType": "MULTIPLE", "RatePerUnit": "10.0", "Multiplier": 1.5, "Amount": 5, "EmploymentTerminationPaymentType": "O" } ] } # PayItem | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a pay item - result = api_instance.create_pay_item(xero_tenant_id, pay_item) + result = api_instance.create_pay_item(xero_tenant_id, pay_item, opts) p result rescue XeroRuby::PayrollAu::ApiError => e puts "Exception when calling PayrollAuApi->create_pay_item: #{e}" @@ -280,6 +299,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **pay_item** | [**PayItem**](PayItem.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -297,7 +317,7 @@ Name | Type | Description | Notes ## create_pay_run -> PayRuns create_pay_run(xero_tenant_id, pay_run) +> PayRuns create_pay_run(xero_tenant_id, pay_run, opts) Creates a pay run @@ -326,11 +346,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant pay_run = [ { "PayrollCalendarID": "78bb86b9-e1ea-47ac-b75d-f087a81931de", "PayRunPeriodStartDate": "/Date(1572566400000+0000)/", "PayRunPeriodEndDate": "/Date(1573084800000+0000)/", "PayRunStatus": "DRAFT", "PaymentDate": "/Date(1573171200000+0000)/" } ] # Array | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a pay run - result = api_instance.create_pay_run(xero_tenant_id, pay_run) + result = api_instance.create_pay_run(xero_tenant_id, pay_run, opts) p result rescue XeroRuby::PayrollAu::ApiError => e puts "Exception when calling PayrollAuApi->create_pay_run: #{e}" @@ -344,6 +368,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **pay_run** | [**Array<PayRun>**](PayRun.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -361,7 +386,7 @@ Name | Type | Description | Notes ## create_payroll_calendar -> PayrollCalendars create_payroll_calendar(xero_tenant_id, payroll_calendar) +> PayrollCalendars create_payroll_calendar(xero_tenant_id, payroll_calendar, opts) Creates a Payroll Calendar @@ -390,11 +415,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant payroll_calendar = [ { "PayrollCalendarID":"78bb86b9-e1ea-47ac-b75d-f087a81931de", "PayRunPeriodStartDate":"/Date(1572566400000+0000)/", "PayRunPeriodEndDate":"/Date(1573084800000+0000)/", "PayRunStatus":"DRAFT", "PaymentDate":"/Date(1573171200000+0000)/" } ] # Array | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a Payroll Calendar - result = api_instance.create_payroll_calendar(xero_tenant_id, payroll_calendar) + result = api_instance.create_payroll_calendar(xero_tenant_id, payroll_calendar, opts) p result rescue XeroRuby::PayrollAu::ApiError => e puts "Exception when calling PayrollAuApi->create_payroll_calendar: #{e}" @@ -408,6 +437,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **payroll_calendar** | [**Array<PayrollCalendar>**](PayrollCalendar.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -425,7 +455,7 @@ Name | Type | Description | Notes ## create_superfund -> SuperFunds create_superfund(xero_tenant_id, super_fund) +> SuperFunds create_superfund(xero_tenant_id, super_fund, opts) Creates a superfund @@ -454,11 +484,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant super_fund = [ { "usi":"PTC0133AU", "Type":"REGULATED", "Name":"Bar99359", "AccountNumber":"FB36350", "AccountName":"Foo38428", "USI":"PTC0133AU" } ] # Array | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a superfund - result = api_instance.create_superfund(xero_tenant_id, super_fund) + result = api_instance.create_superfund(xero_tenant_id, super_fund, opts) p result rescue XeroRuby::PayrollAu::ApiError => e puts "Exception when calling PayrollAuApi->create_superfund: #{e}" @@ -472,6 +506,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **super_fund** | [**Array<SuperFund>**](SuperFund.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -489,7 +524,7 @@ Name | Type | Description | Notes ## create_timesheet -> Timesheets create_timesheet(xero_tenant_id, timesheet) +> Timesheets create_timesheet(xero_tenant_id, timesheet, opts) Creates a timesheet @@ -518,11 +553,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant timesheet = [ { "EmployeeID":"b34e89ff-770d-4099-b7e5-f968767118bc", "StartDate":"/Date(1573171200000+0000)/", "EndDate":"/Date(1573689600000+0000)/", "Status":"DRAFT", "TimesheetLines":[ { "EarningsRateID":"ab874dfb-ab09-4c91-954e-43acf6fc23b4", "TrackingItemID":"af5e9ce2-2349-4136-be99-3561b189f473", "NumberOfUnits":[ 2.0, 10.0, 0.0, 0.0, 5.0, 0.0, 5.0 ] } ] } ] # Array | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a timesheet - result = api_instance.create_timesheet(xero_tenant_id, timesheet) + result = api_instance.create_timesheet(xero_tenant_id, timesheet, opts) p result rescue XeroRuby::PayrollAu::ApiError => e puts "Exception when calling PayrollAuApi->create_timesheet: #{e}" @@ -536,6 +575,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **timesheet** | [**Array<Timesheet>**](Timesheet.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -582,8 +622,8 @@ api_instance = xero_client. -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 +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 detail by unique employee id result = api_instance.get_employee(xero_tenant_id, employee_id) @@ -599,7 +639,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -646,13 +686,13 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"ACTIVE\"', # String | Filter by an any element + where: Status=="ACTIVE", # String | Filter by an any element - order: 'EmailAddress%20DESC', # String | Order by an any element + order: EmailAddress%20DESC, # String | Order by an any element page: 56 # Integer | e.g. page=1 – Up to 100 employees will be returned in a single API call } @@ -672,7 +712,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| e.g. page=1 – Up to 100 employees will be returned in a single API call | [optional] @@ -722,8 +762,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Leave Application id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +leave_application_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Leave Application id for single object begin #Retrieves a leave application by a unique leave application id result = api_instance.get_leave_application(xero_tenant_id, leave_application_id) @@ -739,7 +779,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **leave_application_id** | [**String**](.md)| Leave Application id for single object | + **leave_application_id** | **String**| Leave Application id for single object | ### Return type @@ -786,13 +826,13 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"ACTIVE\"', # String | Filter by an any element + where: Status=="ACTIVE", # String | Filter by an any element - order: 'EmailAddress%20DESC', # String | Order by an any element + order: EmailAddress%20DESC, # String | Order by an any element page: 56 # Integer | e.g. page=1 – Up to 100 objects will be returned in a single API call } @@ -812,7 +852,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| e.g. page=1 – Up to 100 objects will be returned in a single API call | [optional] @@ -862,13 +902,13 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"ACTIVE\"', # String | Filter by an any element + where: Status=="ACTIVE", # String | Filter by an any element - order: 'EmailAddress%20DESC', # String | Order by an any element + order: EmailAddress%20DESC, # String | Order by an any element page: 56 # Integer | e.g. page=1 – Up to 100 objects will be returned in a single API call } @@ -888,7 +928,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| e.g. page=1 – Up to 100 objects will be returned in a single API call | [optional] @@ -938,13 +978,13 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"ACTIVE\"', # String | Filter by an any element + where: Status=="ACTIVE", # String | Filter by an any element - order: 'EmailAddress%20DESC', # String | Order by an any element + order: EmailAddress%20DESC, # String | Order by an any element page: 56 # Integer | e.g. page=1 – Up to 100 objects will be returned in a single API call } @@ -964,7 +1004,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| e.g. page=1 – Up to 100 objects will be returned in a single API call | [optional] @@ -1014,8 +1054,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -pay_run_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | PayRun id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +pay_run_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | PayRun id for single object begin #Retrieves a pay run by using a unique pay run id result = api_instance.get_pay_run(xero_tenant_id, pay_run_id) @@ -1031,7 +1071,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **pay_run_id** | [**String**](.md)| PayRun id for single object | + **pay_run_id** | **String**| PayRun id for single object | ### Return type @@ -1078,13 +1118,13 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"ACTIVE\"', # String | Filter by an any element + where: Status=="ACTIVE", # String | Filter by an any element - order: 'EmailAddress%20DESC', # String | Order by an any element + order: EmailAddress%20DESC, # String | Order by an any element page: 56 # Integer | e.g. page=1 – Up to 100 PayRuns will be returned in a single API call } @@ -1104,7 +1144,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| e.g. page=1 – Up to 100 PayRuns will be returned in a single API call | [optional] @@ -1154,8 +1194,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -payroll_calendar_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Payroll Calendar id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +payroll_calendar_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Payroll Calendar id for single object begin #Retrieves payroll calendar by using a unique payroll calendar ID result = api_instance.get_payroll_calendar(xero_tenant_id, payroll_calendar_id) @@ -1171,7 +1211,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **payroll_calendar_id** | [**String**](.md)| Payroll Calendar id for single object | + **payroll_calendar_id** | **String**| Payroll Calendar id for single object | ### Return type @@ -1218,13 +1258,13 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"ACTIVE\"', # String | Filter by an any element + where: Status=="ACTIVE", # String | Filter by an any element - order: 'EmailAddress%20DESC', # String | Order by an any element + order: EmailAddress%20DESC, # String | Order by an any element page: 56 # Integer | e.g. page=1 – Up to 100 objects will be returned in a single API call } @@ -1244,7 +1284,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| e.g. page=1 – Up to 100 objects will be returned in a single API call | [optional] @@ -1294,8 +1334,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -payslip_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Payslip id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +payslip_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Payslip id for single object begin #Retrieves for a payslip by a unique payslip id result = api_instance.get_payslip(xero_tenant_id, payslip_id) @@ -1311,7 +1351,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **payslip_id** | [**String**](.md)| Payslip id for single object | + **payslip_id** | **String**| Payslip id for single object | ### Return type @@ -1358,7 +1398,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant begin #Retrieves payroll settings result = api_instance.get_settings(xero_tenant_id) @@ -1420,8 +1460,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -super_fund_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Superfund id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +super_fund_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Superfund id for single object begin #Retrieves a superfund by using a unique superfund ID result = api_instance.get_superfund(xero_tenant_id, super_fund_id) @@ -1437,7 +1477,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **super_fund_id** | [**String**](.md)| Superfund id for single object | + **super_fund_id** | **String**| Superfund id for single object | ### Return type @@ -1484,11 +1524,11 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { - abn: '40022701955', # String | The ABN of the Regulated SuperFund + abn: 40022701955, # String | The ABN of the Regulated SuperFund - usi: 'OSF0001AU' # String | The USI of the Regulated SuperFund + usi: OSF0001AU # String | The USI of the Regulated SuperFund } begin @@ -1554,13 +1594,13 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"ACTIVE\"', # String | Filter by an any element + where: Status=="ACTIVE", # String | Filter by an any element - order: 'EmailAddress%20DESC', # String | Order by an any element + order: EmailAddress%20DESC, # String | Order by an any element page: 56 # Integer | e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call } @@ -1580,7 +1620,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call | [optional] @@ -1630,8 +1670,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -timesheet_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Timesheet id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Timesheet id for single object begin #Retrieves a timesheet by using a unique timesheet id result = api_instance.get_timesheet(xero_tenant_id, timesheet_id) @@ -1647,7 +1687,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **timesheet_id** | [**String**](.md)| Timesheet id for single object | + **timesheet_id** | **String**| Timesheet id for single object | ### Return type @@ -1694,13 +1734,13 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { - if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned + if_modified_since: 2020-02-06T12:17:43.202-08:00, # Time | Only records created or modified since this timestamp will be returned - where: 'Status==\"ACTIVE\"', # String | Filter by an any element + where: Status=="ACTIVE", # String | Filter by an any element - order: 'EmailAddress%20DESC', # String | Order by an any element + order: EmailAddress%20DESC, # String | Order by an any element page: 56 # Integer | e.g. page=1 – Up to 100 timesheets will be returned in a single API call } @@ -1720,7 +1760,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] + **if_modified_since** | **Time**| Only records created or modified since this timestamp will be returned | [optional] **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| e.g. page=1 – Up to 100 timesheets will be returned in a single API call | [optional] @@ -1741,7 +1781,7 @@ Name | Type | Description | Notes ## reject_leave_application -> LeaveApplications reject_leave_application(xero_tenant_id, leave_application_id) +> LeaveApplications reject_leave_application(xero_tenant_id, leave_application_id, opts) Reject a leave application by a unique leave application id @@ -1770,11 +1810,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Leave Application id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +leave_application_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Leave Application id for single object +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Reject a leave application by a unique leave application id - result = api_instance.reject_leave_application(xero_tenant_id, leave_application_id) + result = api_instance.reject_leave_application(xero_tenant_id, leave_application_id, opts) p result rescue XeroRuby::PayrollAu::ApiError => e puts "Exception when calling PayrollAuApi->reject_leave_application: #{e}" @@ -1787,7 +1831,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **leave_application_id** | [**String**](.md)| Leave Application id for single object | + **leave_application_id** | **String**| Leave Application id for single object | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1836,9 +1881,11 @@ api_instance = xero_client. -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 +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 = { + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + employee: [ { "MiddleNames": "Frank" } ] # Array | } @@ -1857,7 +1904,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **employee** | [**Array<Employee>**](Employee.md)| | [optional] ### Return type @@ -1876,7 +1924,7 @@ Name | Type | Description | Notes ## update_leave_application -> LeaveApplications update_leave_application(xero_tenant_id, leave_application_id, leave_application) +> LeaveApplications update_leave_application(xero_tenant_id, leave_application_id, leave_application, opts) Updates a specific leave application @@ -1905,12 +1953,16 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Leave Application id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +leave_application_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Leave Application id for single object leave_application = [ { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "LeaveApplicationID": "1d4cd583-0107-4386-936b-672eb3d1f624", "LeaveTypeID": "184ea8f7-d143-46dd-bef3-0c60e1aa6fca", "LeavePeriods": [ { "PayPeriodStartDate": "/Date(1572566400000+0000)/", "PayPeriodEndDate": "/Date(1573084800000+0000)/", "LeavePeriodStatus": "SCHEDULED", "NumberOfUnits": 7.6 } ], "Title": "vacation", "Description": "My updated Description", "StartDate": "/Date(1572559200000+0000)/", "EndDate": "/Date(1572645600000+0000)/", "PayOutType": "DEFAULT" } ] # Array | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific leave application - result = api_instance.update_leave_application(xero_tenant_id, leave_application_id, leave_application) + result = api_instance.update_leave_application(xero_tenant_id, leave_application_id, leave_application, opts) p result rescue XeroRuby::PayrollAu::ApiError => e puts "Exception when calling PayrollAuApi->update_leave_application: #{e}" @@ -1923,8 +1975,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **leave_application_id** | [**String**](.md)| Leave Application id for single object | + **leave_application_id** | **String**| Leave Application id for single object | **leave_application** | [**Array<LeaveApplication>**](LeaveApplication.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1973,10 +2026,12 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -pay_run_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | PayRun id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +pay_run_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | PayRun id for single object opts = { - pay_run: [XeroRuby::PayrollAu::PayRun.new] # Array | + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + pay_run: # Array | } begin @@ -1994,7 +2049,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **pay_run_id** | [**String**](.md)| PayRun id for single object | + **pay_run_id** | **String**| PayRun id for single object | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **pay_run** | [**Array<PayRun>**](PayRun.md)| | [optional] ### Return type @@ -2044,9 +2100,11 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -payslip_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Payslip id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +payslip_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Payslip id for single object opts = { + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + payslip_lines: { "Payslip": { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "DeductionLines": [ { "DeductionTypeID": "727af5e8-b347-4ae7-85fc-9b82266d0aec", "CalculationType": "FIXEDAMOUNT", "NumberOfUnits": 10 } ] } } # Array | } @@ -2065,7 +2123,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **payslip_id** | [**String**](.md)| Payslip id for single object | + **payslip_id** | **String**| Payslip id for single object | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **payslip_lines** | [**Array<PayslipLines>**](PayslipLines.md)| | [optional] ### Return type @@ -2115,9 +2174,11 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -super_fund_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Superfund id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +super_fund_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Superfund id for single object opts = { + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + super_fund: [ { "Type":"REGULATED", "Name":"Nice23534" } ] # Array | } @@ -2136,7 +2197,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **super_fund_id** | [**String**](.md)| Superfund id for single object | + **super_fund_id** | **String**| Superfund id for single object | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **super_fund** | [**Array<SuperFund>**](SuperFund.md)| | [optional] ### Return type @@ -2186,9 +2248,11 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -timesheet_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Timesheet id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Timesheet id for single object opts = { + idempotency_key: KEY_VALUE, # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + timesheet: [ { "EmployeeID":"b34e89ff-770d-4099-b7e5-f968767118bc", "StartDate":"/Date(1573171200000+0000)/", "EndDate":"/Date(1573689600000+0000)/", "Status":"APPROVED", "Hours":22.0, "TimesheetID":"a7eb0a79-8511-4ee7-b473-3a25f28abcb9", "TimesheetLines":[ { "EarningsRateID":"ab874dfb-ab09-4c91-954e-43acf6fc23b4", "TrackingItemID":"af5e9ce2-2349-4136-be99-3561b189f473", "NumberOfUnits":[ 2.0, 10.0, 0.0, 0.0, 5.0, 0.0, 5.0 ], "UpdatedDateUTC":"/Date(1573516185127+0000)/" } ] } ] # Array | } @@ -2207,7 +2271,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **timesheet_id** | [**String**](.md)| Timesheet id for single object | + **timesheet_id** | **String**| Timesheet id for single object | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **timesheet** | [**Array<Timesheet>**](Timesheet.md)| | [optional] ### Return type diff --git a/docs/payroll_au/index.html b/docs/payroll_au/index.html deleted file mode 100644 index 9f93efb1..00000000 --- a/docs/payroll_au/index.html +++ /dev/null @@ -1,9847 +0,0 @@ - - - - - Xero Payroll AU API - - - - - - xero-ruby PayrollAu SDK Docs - - - - - - - - - - - - - - - - - - -
- -
- -
-
- - -
-
- -
-
- -
-
-
-
- -
-
-
-

Xero Payroll AU API

-
-
-
- -
-
-

PayrollAu

-
-
-
-

approveLeaveApplication

-

Approve a requested leave application by a unique leave application id

-
-
-
-

-

-

-
- 
/LeaveApplications/{LeaveApplicationID}/approve
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.approve_leave_application(xero_tenant_id, leave_application_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling approve_leave_application: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
LeaveApplicationID* - - -
-
-
- - UUID - - - (uuid) - - -
-Leave Application id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

createEmployee

-

Creates a payroll employee

-
-
-
-

-

-

-
- 
/Employees
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-date_of_birth = 'YYYY-MM-DD'
-
-home_address = { 
-  address_line_1: "123 Test st",
-  region: "VIC",
-  postal_code: 3000,
-  city: "Melbourne"
-}  
-
-employee = { 
-  first_name: "Adam",
-  last_name: "Adamson",
-  date_of_birth:  date_of_birth,
-  homeAddress:  home_address
-}  
-
-begin
-  response = xero_client.accounting_api.create_employee(xero_tenant_id, employee)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employee * -
-
- - array[Employee] - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createLeaveApplication

-

Creates a leave application

-
-
-
-

-

-

-
- 
/LeaveApplications
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-start_date = 'YYYY-MM-DD'
-end_date = 'YYYY-MM-DD'
-
-leaveApplication = { 
-  employee_id: "00000000-0000-0000-0000-000000000000",
-  leave_type_id: "00000000-0000-0000-0000-000000000000",
-  title: "Annual Leave",
-  start_date:  start_date,
-  end_date:  end_date
-}  
-
-begin
-  response = xero_client.accounting_api.create_leave_application(xero_tenant_id, leaveApplication)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_leave_application: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
leaveApplication * -
-
- - array[LeaveApplication] - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createPayItem

-

Creates a pay item

-
-
-
-

-

-

-
- 
/PayItems
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-earnings_rate = { 
-  name: "Ordinary Hours 123",
-  account_code: "477",
-  type_of_units: "Hours",
-  is_exempt_from_tax: true,
-  is_exempt_from_super: true,
-  earningsType:  XeroRuby::PayrollAu::EarningsType::OVERTIMEEARNINGS
-}  
-
-deduction_type = { 
-  name: "Union Fees",
-  account_code: "826",
-  reduces_tax: true,
-  reduces_super: true
-}  
-
-leave_type = { 
-  name: "Annual Leave",
-  type_of_units: "Hours",
-  is_paid_leave: true,
-  show_on_payslip: true
-}  
-
-reimbursement_type = { 
-  name: "Annual Leave",
-  account_code: "850"
-}    
-earnings_rates = []
-earnings_rates << earnings_rate,  
-deduction_types = []  
-leave_types = []
-leave_types << leave_type  
-reimbursement_types = []
-reimbursement_types << reimbursement_type
-
-pay_item = { 
-  earningsRates:  earnings_rates,
-  deductionTypes:  deduction_types,
-  leaveTypes:  leave_types,
-  reimbursementTypes:  reimbursement_types
-}  
-
-begin
-  response = xero_client.accounting_api.create_pay_item(xero_tenant_id, payItem)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_pay_item: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
payItem * -
-
- - PayItem - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createPayRun

-

Creates a pay run

-
-
-
-

-

-

-
- 
/PayRuns
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-pay_run = { 
-  payroll_calendar_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-begin
-  response = xero_client.accounting_api.create_pay_run(xero_tenant_id, payRun)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_pay_run: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.payrunsGrant read-write access to payroll payruns
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
payRun * -
-
- - array[PayRun] - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createPayrollCalendar

-

Creates a Payroll Calendar

-
-
-
-

-

-

-
- 
/PayrollCalendars
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-start_date = 'YYYY-MM-DD'
-payment_date = 'YYYY-MM-DD'
-
-payroll_calendar = { 
-  name: "Weekly",
-  calendar_type:  XeroRuby::PayrollAu::CalendarType::WEEKLY,
-  start_date:  start_date,
-  payment_date:  payment_date
-}    
-payroll_calendars = []
-payroll_calendars << payroll_calendar
-
-begin
-  response = xero_client.accounting_api.create_payroll_calendar(xero_tenant_id, payrollCalendar)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_payroll_calendar: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
payrollCalendar * -
-
- - array[PayrollCalendar] - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createSuperfund

-

Creates a superfund

-
-
-
-

-

-

-
- 
/Superfunds
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-super_fund = { 
-  type:  XeroRuby::PayrollAu::SuperFundType::REGULATED,
-  USI: "40022701955002"
-}  
-
-begin
-  response = xero_client.accounting_api.create_superfund(xero_tenant_id, superFund)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_superfund: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
superFund * -
-
- - array[SuperFund] - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createTimesheet

-

Creates a timesheet

-
-
-
-

-

-

-
- 
/Timesheets
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-start_date = 'YYYY-MM-DD'
-end_date = 'YYYY-MM-DD'
-
-timesheet = { 
-  employee_id: "00000000-0000-0000-0000-000000000000",
-  start_date:  start_date,
-  end_date:  end_date,
-  status:  XeroRuby::PayrollAu::TimesheetStatus::DRAFT
-}  
-
-begin
-  response = xero_client.accounting_api.create_timesheet(xero_tenant_id, timesheet)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_timesheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
timesheet * -
-
- - array[Timesheet] - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

getEmployee

-

Retrieves an employee's detail by unique employee id

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployees

-

Searches payroll employees

-
-
-
-

-

-

-
- 
/Employees
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status=="ACTIVE"'
-order = 'EmailAddress%20DESC'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_employees(xero_tenant_id, if_modified_since, where, order, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employees: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 employees will be returned in a single API call -
-
-
-
-
-
-
-
-
-
-
-

getLeaveApplication

-

Retrieves a leave application by a unique leave application id

-
-
-
-

-

-

-
- 
/LeaveApplications/{LeaveApplicationID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_leave_application(xero_tenant_id, leave_application_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_leave_application: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
LeaveApplicationID* - - -
-
-
- - UUID - - - (uuid) - - -
-Leave Application id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getLeaveApplications

-

Retrieves leave applications

-
-
-
-

-

-

-
- 
/LeaveApplications
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status=="ACTIVE"'
-order = 'EmailAddress%20DESC'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_leave_applications(xero_tenant_id, if_modified_since, where, order, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_leave_applications: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 objects will be returned in a single API call -
-
-
-
-
-
-
-
-
-
-
-

getLeaveApplicationsV2

-

Retrieves leave applications including leave requests

-
-
-
-

-

-

-
- 
/LeaveApplications/v2
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status=="ACTIVE"'
-order = 'EmailAddress%20DESC'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_leave_applications_v2(xero_tenant_id, if_modified_since, where, order, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_leave_applications_v2: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 objects will be returned in a single API call -
-
-
-
-
-
-
-
-
-
-
-

getPayItems

-

Retrieves pay items

-
-
-
-

-

-

-
- 
/PayItems
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status=="ACTIVE"'
-order = 'EmailAddress%20DESC'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_pay_items(xero_tenant_id, if_modified_since, where, order, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_items: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 objects will be returned in a single API call -
-
-
-
-
-
-
-
-
-
-
-

getPayRun

-

Retrieves a pay run by using a unique pay run id

-
-
-
-

-

-

-
- 
/PayRuns/{PayRunID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-pay_run_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_pay_run(xero_tenant_id, pay_run_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_run: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.payrunsGrant read-write access to payroll payruns
payroll.payruns.readGrant read-only access to payroll payruns
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PayRunID* - - -
-
-
- - UUID - - - (uuid) - - -
-PayRun id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPayRuns

-

Retrieves pay runs

-
-
-
-

-

-

-
- 
/PayRuns
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status=="ACTIVE"'
-order = 'EmailAddress%20DESC'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_pay_runs(xero_tenant_id, if_modified_since, where, order, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_runs: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.payrunsGrant read-write access to payroll payruns
payroll.payruns.readGrant read-only access to payroll payruns
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 PayRuns will be returned in a single API call -
-
-
-
-
-
-
-
-
-
-
-

getPayrollCalendar

-

Retrieves payroll calendar by using a unique payroll calendar ID

-
-
-
-

-

-

-
- 
/PayrollCalendars/{PayrollCalendarID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-payroll_calendar_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_payroll_calendar(xero_tenant_id, payroll_calendar_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_payroll_calendar: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PayrollCalendarID* - - -
-
-
- - UUID - - - (uuid) - - -
-Payroll Calendar id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPayrollCalendars

-

Retrieves payroll calendars

-
-
-
-

-

-

-
- 
/PayrollCalendars
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status=="ACTIVE"'
-order = 'EmailAddress%20DESC'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_payroll_calendars(xero_tenant_id, if_modified_since, where, order, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_payroll_calendars: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 objects will be returned in a single API call -
-
-
-
-
-
-
-
-
-
-
-

getPayslip

-

Retrieves for a payslip by a unique payslip id

-
-
-
-

-

-

-
- 
/Payslip/{PayslipID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-payslip_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_payslip(xero_tenant_id, payslip_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_payslip: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.payslipGrant read-write access to payroll payslips
payroll.payslip.readGrant read-only access to payroll payslips
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PayslipID* - - -
-
-
- - UUID - - - (uuid) - - -
-Payslip id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getSettings

-

Retrieves payroll settings

-
-
-
-

-

-

-
- 
/Settings
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-begin
-  response = xero_client.accounting_api.get_settings(xero_tenant_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_settings: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getSuperfund

-

Retrieves a superfund by using a unique superfund ID

-
-
-
-

-

-

-
- 
/Superfunds/{SuperFundID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-super_fund_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_superfund(xero_tenant_id, super_fund_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_superfund: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
SuperFundID* - - -
-
-
- - UUID - - - (uuid) - - -
-Superfund id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getSuperfundProducts

-

Retrieves superfund products

-
-
-
-

-

-

-
- 
/SuperfundProducts
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-aBN = '40022701955'
-uSI = 'OSF0001AU'
-
-begin
-  response = xero_client.accounting_api.get_superfund_products(xero_tenant_id, aBN, uSI)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_superfund_products: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
ABN - - -
-
-
- - String - - -
-The ABN of the Regulated SuperFund -
-
-
-
-
USI - - -
-
-
- - String - - -
-The USI of the Regulated SuperFund -
-
-
-
-
-
-
-
-
-
-
-

getSuperfunds

-

Retrieves superfunds

-
-
-
-

-

-

-
- 
/Superfunds
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status=="ACTIVE"'
-order = 'EmailAddress%20DESC'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_superfunds(xero_tenant_id, if_modified_since, where, order, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_superfunds: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call -
-
-
-
-
-
-
-
-
-
-
-

getTimesheet

-

Retrieves a timesheet by using a unique timesheet id

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_timesheet(xero_tenant_id, timesheet_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_timesheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
payroll.timesheets.readGrant read-only access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Timesheet id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getTimesheets

-

Retrieves timesheets

-
-
-
-

-

-

-
- 
/Timesheets
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-if_modified_since = "2020-02-06T12:17:43.202-08:00"
-where = 'Status=="ACTIVE"'
-order = 'EmailAddress%20DESC'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_timesheets(xero_tenant_id, if_modified_since, where, order, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_timesheets: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
payroll.timesheets.readGrant read-only access to payroll timesheets
-

Parameters

-
Header parameters
- - - - - - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
If-Modified-Since - - -
-
-
- - Date - - - (date-time) - - -
-Only records created or modified since this timestamp will be returned -
-
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - -
NameDescription
where - - -
-
-
- - String - - -
-Filter by an any element -
-
-
-
-
order - - -
-
-
- - String - - -
-Order by an any element -
-
-
-
-
page - - -
-
-
- - Integer - - -
-e.g. page=1 – Up to 100 timesheets will be returned in a single API call -
-
-
-
-
-
-
-
-
-
-
-

rejectLeaveApplication

-

Reject a leave application by a unique leave application id

-
-
-
-

-

-

-
- 
/LeaveApplications/{LeaveApplicationID}/reject
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.reject_leave_application(xero_tenant_id, leave_application_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling reject_leave_application: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
LeaveApplicationID* - - -
-
-
- - UUID - - - (uuid) - - -
-Leave Application id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

updateEmployee

-

Updates an employee's detail

-
-
-
-

-

Update properties on a single employee

-

-
- 
/Employees/{EmployeeID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-date_of_birth = 'YYYY-MM-DD'
-
-home_address = { 
-  address_line_1: "123 Test st",
-  region: "VIC",
-  postal_code: 3000,
-  city: "Melbourne"
-}  
-
-employee = { 
-  first_name: "Adam",
-  last_name: "Adamson",
-  date_of_birth:  date_of_birth,
-  homeAddress:  home_address
-}  
-
-begin
-  response = xero_client.accounting_api.update_employee(xero_tenant_id, employee_id, employee)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_employee: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employee -
-
- - array[Employee] - -
- -
-
-
- -
-
-
-
-
-
-
-

updateLeaveApplication

-

Updates a specific leave application

-
-
-
-

-

-

-
- 
/LeaveApplications/{LeaveApplicationID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-start_date = 'YYYY-MM-DD'
-end_date = 'YYYY-MM-DD'
-
-leaveApplication = { 
-  employee_id: "00000000-0000-0000-0000-000000000000",
-  leave_type_id: "00000000-0000-0000-0000-000000000000",
-  title: "Annual Leave",
-  start_date:  start_date,
-  end_date:  end_date
-}  
-
-begin
-  response = xero_client.accounting_api.update_leave_application(xero_tenant_id, leave_application_id, leaveApplication)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_leave_application: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
LeaveApplicationID* - - -
-
-
- - UUID - - - (uuid) - - -
-Leave Application id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
leaveApplication * -
-
- - array[LeaveApplication] - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updatePayRun

-

Updates a pay run

-
-
-
-

-

Update properties on a single PayRun

-

-
- 
/PayRuns/{PayRunID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-pay_run_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-pay_run = { 
-  payroll_calendar_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-begin
-  response = xero_client.accounting_api.update_pay_run(xero_tenant_id, pay_run_id, payRun)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_pay_run: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.payrunsGrant read-write access to payroll payruns
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PayRunID* - - -
-
-
- - UUID - - - (uuid) - - -
-PayRun id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
payRun -
-
- - array[PayRun] - -
- -
-
-
- -
-
-
-
-
-
-
-

updatePayslip

-

Updates a payslip

-
-
-
-

-

Update lines on a single payslips

-

-
- 
/Payslip/{PayslipID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-payslip_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-earnings_line = { 
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  rate_per_unit: 20,
-  number_of_units: 1
-}    
-earnings_lines = []
-earnings_lines << earnings_line
-
-payslip_lines = { 
-  earnings_lines: earningsLines
-}    
-payslip_lines = []
-payslip_lines << payslip_line
-
-begin
-  response = xero_client.accounting_api.update_payslip(xero_tenant_id, payslip_id, payslipLines)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_payslip: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.payslipGrant read-write access to payroll payslips
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PayslipID* - - -
-
-
- - UUID - - - (uuid) - - -
-Payslip id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
payslipLines -
-
- - array[PayslipLines] - -
- -
-
-
- -
-
-
-
-
-
-
-

updateSuperfund

-

Updates a superfund

-
-
-
-

-

Update properties on a single Superfund

-

-
- 
/Superfunds/{SuperFundID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-super_fund_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-super_fund = { 
-  type:  XeroRuby::PayrollAu::SuperFundType::REGULATED,
-  USI: "40022701955002"
-}  
-
-begin
-  response = xero_client.accounting_api.update_superfund(xero_tenant_id, super_fund_id, superFund)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_superfund: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
SuperFundID* - - -
-
-
- - UUID - - - (uuid) - - -
-Superfund id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
superFund -
-
- - array[SuperFund] - -
- -
-
-
- -
-
-
-
-
-
-
-

updateTimesheet

-

Updates a timesheet

-
-
-
-

-

Update properties on a single timesheet

-

-
- 
/Timesheets/{TimesheetID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-start_date = 'YYYY-MM-DD'
-end_date = 'YYYY-MM-DD'
-
-timesheet = { 
-  employee_id: "00000000-0000-0000-0000-000000000000",
-  start_date:  start_date,
-  end_date:  end_date,
-  status:  XeroRuby::PayrollAu::TimesheetStatus::DRAFT
-}  
-
-begin
-  response = xero_client.accounting_api.update_timesheet(xero_tenant_id, timesheet_id, timesheet)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_timesheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Timesheet id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
timesheet -
-
- - array[Timesheet] - -
- -
-
-
- -
-
-
-
-
-
- -
-
-
- - - - - - - - - - - - - - diff --git a/docs/payroll_nz/Employee.md b/docs/payroll_nz/Employee.md index c25100ce..570055b8 100644 --- a/docs/payroll_nz/Employee.md +++ b/docs/payroll_nz/Employee.md @@ -16,8 +16,8 @@ Name | Type | Description | Notes **start_date** | **Date** | Employment start date of the employee at the time it was requested | [optional] **end_date** | **Date** | Employment end date of the employee at the time it was requested | [optional] **payroll_calendar_id** | **String** | Xero unique identifier for the payroll calendar of the employee | [optional] -**updated_date_utc** | **DateTime** | UTC timestamp of last update to the employee | [optional] -**created_date_utc** | **DateTime** | UTC timestamp when the employee was created in Xero | [optional] +**updated_date_utc** | **Time** | UTC timestamp of last update to the employee | [optional] +**created_date_utc** | **Time** | UTC timestamp when the employee was created in Xero | [optional] ## Code Sample @@ -28,13 +28,13 @@ instance = XeroRuby::PayrollNz::Employee.new(employee_id: d90457c4-f1be-4f2e-b4e title: Mrs, first_name: Karen, last_name: Jones, - date_of_birth: Wed Jan 02 00:00:00 GMT 2019, + date_of_birth: Wed Jan 02 00:00:00 UTC 2019, address: null, email: developer@me.com, gender: F, phone_number: 415-555-1212, - start_date: Sun Jan 19 00:00:00 GMT 2020, - end_date: Sun Jan 19 00:00:00 GMT 2020, + start_date: Sun Jan 19 00:00:00 UTC 2020, + end_date: Sun Jan 19 00:00:00 UTC 2020, payroll_calendar_id: null, updated_date_utc: null, created_date_utc: null) diff --git a/docs/payroll_nz/EmployeeLeave.md b/docs/payroll_nz/EmployeeLeave.md index 36716646..1309486e 100644 --- a/docs/payroll_nz/EmployeeLeave.md +++ b/docs/payroll_nz/EmployeeLeave.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **start_date** | **Date** | Start date of the leave (YYYY-MM-DD) | **end_date** | **Date** | End date of the leave (YYYY-MM-DD) | **periods** | [**Array<LeavePeriod>**](LeavePeriod.md) | The leave period information. The StartDate, EndDate and NumberOfUnits needs to be specified when you do not want to calculate NumberOfUnits automatically. Using incorrect period StartDate and EndDate will result in automatic computation of the NumberOfUnits. | [optional] -**updated_date_utc** | **DateTime** | UTC timestamp of last update to the leave type note | [optional] +**updated_date_utc** | **Time** | UTC timestamp of last update to the leave type note | [optional] ## Code Sample diff --git a/docs/payroll_nz/LeaveType.md b/docs/payroll_nz/LeaveType.md index 3cf42a0c..650c8ef0 100644 --- a/docs/payroll_nz/LeaveType.md +++ b/docs/payroll_nz/LeaveType.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **name** | **String** | Name of the leave type | **is_paid_leave** | **Boolean** | Indicate that an employee will be paid when taking this type of leave | **show_on_payslip** | **Boolean** | Indicate that a balance for this leave type to be shown on the employee’s payslips | -**updated_date_utc** | **DateTime** | UTC timestamp of last update to the leave type note | [optional] +**updated_date_utc** | **Time** | UTC timestamp of last update to the leave type note | [optional] **is_active** | **Boolean** | Shows whether the leave type is active or not | [optional] ## Code Sample diff --git a/docs/payroll_nz/PayRunCalendar.md b/docs/payroll_nz/PayRunCalendar.md index 61282aee..e9bca1e0 100644 --- a/docs/payroll_nz/PayRunCalendar.md +++ b/docs/payroll_nz/PayRunCalendar.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **period_start_date** | **Date** | Period start date of the calendar | **period_end_date** | **Date** | Period end date of the calendar | [optional] **payment_date** | **Date** | Payment date of the calendar | -**updated_date_utc** | **DateTime** | UTC timestamp of the last update to the pay run calendar | [optional] +**updated_date_utc** | **Time** | UTC timestamp of the last update to the pay run calendar | [optional] ## Code Sample diff --git a/docs/payroll_nz/PayrollNzApi.md b/docs/payroll_nz/PayrollNzApi.md index cf4be8f2..2885c718 100644 --- a/docs/payroll_nz/PayrollNzApi.md +++ b/docs/payroll_nz/PayrollNzApi.md @@ -77,7 +77,7 @@ Method | HTTP request | Description ## approve_timesheet -> TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id) +> TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id, opts) Approves a timesheet @@ -106,11 +106,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Approves a timesheet - result = api_instance.approve_timesheet(xero_tenant_id, timesheet_id) + result = api_instance.approve_timesheet(xero_tenant_id, timesheet_id, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->approve_timesheet: #{e}" @@ -123,7 +127,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **timesheet_id** | [**String**](.md)| Identifier for the timesheet | + **timesheet_id** | **String**| Identifier for the timesheet | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -141,7 +146,7 @@ Name | Type | Description | Notes ## create_deduction -> DeductionObject create_deduction(xero_tenant_id, deduction) +> DeductionObject create_deduction(xero_tenant_id, deduction, opts) Creates a new deduction for a specific employee @@ -170,11 +175,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant deduction = { "deductionName": "My new deduction", "deductionCategory": "NzOther", "liabilityAccountId": "568f2e9a-0870-46cc-8678-f83f132ed4e3" } # Deduction | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new deduction for a specific employee - result = api_instance.create_deduction(xero_tenant_id, deduction) + result = api_instance.create_deduction(xero_tenant_id, deduction, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_deduction: #{e}" @@ -188,6 +197,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **deduction** | [**Deduction**](Deduction.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -205,7 +215,7 @@ Name | Type | Description | Notes ## create_earnings_rate -> EarningsRateObject create_earnings_rate(xero_tenant_id, earnings_rate) +> EarningsRateObject create_earnings_rate(xero_tenant_id, earnings_rate, opts) Creates a new earnings rate @@ -234,11 +244,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new earnings rate - result = api_instance.create_earnings_rate(xero_tenant_id, earnings_rate) + result = api_instance.create_earnings_rate(xero_tenant_id, earnings_rate, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_earnings_rate: #{e}" @@ -252,6 +266,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **earnings_rate** | [**EarningsRate**](EarningsRate.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -269,7 +284,7 @@ Name | Type | Description | Notes ## create_employee -> EmployeeObject create_employee(xero_tenant_id, employee) +> EmployeeObject create_employee(xero_tenant_id, employee, opts) Creates an employees @@ -298,11 +313,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an employees - result = api_instance.create_employee(xero_tenant_id, employee) + result = api_instance.create_employee(xero_tenant_id, employee, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_employee: #{e}" @@ -316,6 +335,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **employee** | [**Employee**](Employee.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -333,7 +353,7 @@ Name | Type | Description | Notes ## create_employee_earnings_template -> EarningsTemplateObject create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) +> EarningsTemplateObject create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts) Creates earnings template records for an employee @@ -362,12 +382,16 @@ api_instance = xero_client. -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 +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates earnings template records for an employee - result = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) + result = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_employee_earnings_template: #{e}" @@ -380,8 +404,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **earnings_template** | [**EarningsTemplate**](EarningsTemplate.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -399,7 +424,7 @@ Name | Type | Description | Notes ## create_employee_leave -> EmployeeLeaveObject create_employee_leave(xero_tenant_id, employee_id, employee_leave) +> EmployeeLeaveObject create_employee_leave(xero_tenant_id, employee_id, employee_leave, opts) Creates leave records for a specific employee @@ -428,12 +453,16 @@ api_instance = xero_client. -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 +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 Description", "startDate": "2020-04-24", "endDate": "2020-04-26" } # EmployeeLeave | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates leave records for a specific employee - result = api_instance.create_employee_leave(xero_tenant_id, employee_id, employee_leave) + result = api_instance.create_employee_leave(xero_tenant_id, employee_id, employee_leave, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_employee_leave: #{e}" @@ -446,8 +475,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **employee_leave** | [**EmployeeLeave**](EmployeeLeave.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -465,7 +495,7 @@ Name | Type | Description | Notes ## create_employee_leave_setup -> EmployeeLeaveSetupObject create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setup) +> EmployeeLeaveSetupObject create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setup, opts) Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee @@ -494,12 +524,16 @@ api_instance = xero_client. -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 +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a leave set-up 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) + result = api_instance.create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setup, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_employee_leave_setup: #{e}" @@ -512,8 +546,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **employee_leave_setup** | [**EmployeeLeaveSetup**](EmployeeLeaveSetup.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -531,7 +566,7 @@ Name | Type | Description | Notes ## create_employee_leave_type -> EmployeeLeaveTypeObject create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type) +> EmployeeLeaveTypeObject create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, opts) Creates leave type records for a specific employee @@ -560,12 +595,16 @@ api_instance = xero_client. -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 +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates leave type records for a specific employee - result = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type) + result = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_employee_leave_type: #{e}" @@ -578,8 +617,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **employee_leave_type** | [**EmployeeLeaveType**](EmployeeLeaveType.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -597,7 +637,7 @@ Name | Type | Description | Notes ## create_employee_opening_balances -> EmployeeOpeningBalancesObject create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance) +> EmployeeOpeningBalancesObject create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance, opts) Creates opening balances for a specific employee @@ -626,12 +666,16 @@ api_instance = xero_client. -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 +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates opening balances for a specific employee - result = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance) + result = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_employee_opening_balances: #{e}" @@ -644,8 +688,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **employee_opening_balance** | [**Array<EmployeeOpeningBalance>**](EmployeeOpeningBalance.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -663,7 +708,7 @@ Name | Type | Description | Notes ## create_employee_payment_method -> PaymentMethodObject create_employee_payment_method(xero_tenant_id, employee_id, payment_method) +> PaymentMethodObject create_employee_payment_method(xero_tenant_id, employee_id, payment_method, opts) Creates a payment method for an employee @@ -692,12 +737,16 @@ api_instance = xero_client. -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 | +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 = # PaymentMethod | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a payment method for an employee - result = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, payment_method) + result = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, payment_method, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_employee_payment_method: #{e}" @@ -710,8 +759,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **payment_method** | [**PaymentMethod**](PaymentMethod.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -729,7 +779,7 @@ Name | Type | Description | Notes ## create_employee_salary_and_wage -> SalaryAndWageObject create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage) +> SalaryAndWageObject create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage, opts) Creates an employee salary and wage record @@ -758,12 +808,16 @@ api_instance = xero_client. -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 +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an employee salary and wage record - result = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage) + result = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_employee_salary_and_wage: #{e}" @@ -776,8 +830,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **salary_and_wage** | [**SalaryAndWage**](SalaryAndWage.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -795,7 +850,7 @@ Name | Type | Description | Notes ## create_employment -> EmploymentObject create_employment(xero_tenant_id, employee_id, employment) +> EmploymentObject create_employment(xero_tenant_id, employee_id, employment, opts) Creates an employment detail for a specific employee @@ -824,12 +879,16 @@ api_instance = xero_client. -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 +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an employment detail for a specific employee - result = api_instance.create_employment(xero_tenant_id, employee_id, employment) + result = api_instance.create_employment(xero_tenant_id, employee_id, employment, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_employment: #{e}" @@ -842,8 +901,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **employment** | [**Employment**](Employment.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -861,7 +921,7 @@ Name | Type | Description | Notes ## create_leave_type -> LeaveTypeObject create_leave_type(xero_tenant_id, leave_type) +> LeaveTypeObject create_leave_type(xero_tenant_id, leave_type, opts) Creates a new leave type @@ -890,11 +950,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant leave_type = { "name": "My wqwhhiktun Leave", "isPaidLeave": false, "showOnPayslip": true } # LeaveType | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new leave type - result = api_instance.create_leave_type(xero_tenant_id, leave_type) + result = api_instance.create_leave_type(xero_tenant_id, leave_type, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_leave_type: #{e}" @@ -908,6 +972,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **leave_type** | [**LeaveType**](LeaveType.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -925,7 +990,7 @@ Name | Type | Description | Notes ## create_multiple_employee_earnings_template -> EmployeeEarningsTemplates create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) +> EmployeeEarningsTemplates create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts) Creates multiple employee earnings template records for a specific employee @@ -954,12 +1019,16 @@ api_instance = xero_client. -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 +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates multiple employee earnings template records for a specific employee - result = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) + result = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_multiple_employee_earnings_template: #{e}" @@ -972,8 +1041,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **earnings_template** | [**Array<EarningsTemplate>**](EarningsTemplate.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -991,7 +1061,7 @@ Name | Type | Description | Notes ## create_pay_run -> PayRunObject create_pay_run(xero_tenant_id, pay_run) +> PayRunObject create_pay_run(xero_tenant_id, pay_run, opts) Creates a pay run @@ -1020,11 +1090,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a pay run - result = api_instance.create_pay_run(xero_tenant_id, pay_run) + result = api_instance.create_pay_run(xero_tenant_id, pay_run, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_pay_run: #{e}" @@ -1038,6 +1112,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **pay_run** | [**PayRun**](PayRun.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1055,7 +1130,7 @@ Name | Type | Description | Notes ## create_pay_run_calendar -> PayRunCalendarObject create_pay_run_calendar(xero_tenant_id, pay_run_calendar) +> PayRunCalendarObject create_pay_run_calendar(xero_tenant_id, pay_run_calendar, opts) Creates a new payrun calendar @@ -1084,11 +1159,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new payrun calendar - result = api_instance.create_pay_run_calendar(xero_tenant_id, pay_run_calendar) + result = api_instance.create_pay_run_calendar(xero_tenant_id, pay_run_calendar, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_pay_run_calendar: #{e}" @@ -1102,6 +1181,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **pay_run_calendar** | [**PayRunCalendar**](PayRunCalendar.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1119,7 +1199,7 @@ Name | Type | Description | Notes ## create_reimbursement -> ReimbursementObject create_reimbursement(xero_tenant_id, reimbursement) +> ReimbursementObject create_reimbursement(xero_tenant_id, reimbursement, opts) Creates a new reimbursement @@ -1148,11 +1228,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new reimbursement - result = api_instance.create_reimbursement(xero_tenant_id, reimbursement) + result = api_instance.create_reimbursement(xero_tenant_id, reimbursement, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_reimbursement: #{e}" @@ -1166,6 +1250,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **reimbursement** | [**Reimbursement**](Reimbursement.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1183,7 +1268,7 @@ Name | Type | Description | Notes ## create_superannuation -> SuperannuationObject create_superannuation(xero_tenant_id, benefit) +> SuperannuationObject create_superannuation(xero_tenant_id, benefit, opts) Creates a new superannuation @@ -1212,11 +1297,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new superannuation - result = api_instance.create_superannuation(xero_tenant_id, benefit) + result = api_instance.create_superannuation(xero_tenant_id, benefit, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_superannuation: #{e}" @@ -1230,6 +1319,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **benefit** | [**Benefit**](Benefit.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1247,7 +1337,7 @@ Name | Type | Description | Notes ## create_timesheet -> TimesheetObject create_timesheet(xero_tenant_id, timesheet) +> TimesheetObject create_timesheet(xero_tenant_id, timesheet, opts) Creates a new timesheet @@ -1276,11 +1366,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new timesheet - result = api_instance.create_timesheet(xero_tenant_id, timesheet) + result = api_instance.create_timesheet(xero_tenant_id, timesheet, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_timesheet: #{e}" @@ -1294,6 +1388,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **timesheet** | [**Timesheet**](Timesheet.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1311,7 +1406,7 @@ Name | Type | Description | Notes ## create_timesheet_line -> TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line) +> TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, opts) Create a new timesheet line for a specific time sheet @@ -1340,12 +1435,16 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet timesheet_line = { "date": "2020-08-03", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 1 } # TimesheetLine | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Create a new timesheet line for a specific time sheet - result = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line) + result = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->create_timesheet_line: #{e}" @@ -1358,8 +1457,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **timesheet_id** | [**String**](.md)| Identifier for the timesheet | + **timesheet_id** | **String**| Identifier for the timesheet | **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1406,9 +1506,9 @@ api_instance = xero_client. -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 +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's earnings template record result = api_instance.delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id) @@ -1424,8 +1524,8 @@ end 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 | + **employee_id** | **String**| Employee id for single object | + **pay_template_earning_id** | **String**| Id for single pay template earnings object | ### Return type @@ -1472,9 +1572,9 @@ api_instance = xero_client. -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 +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 a leave record for a specific employee result = api_instance.delete_employee_leave(xero_tenant_id, employee_id, leave_id) @@ -1490,8 +1590,8 @@ end 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_id** | **String**| Employee id for single object | + **leave_id** | **String**| Leave id for single object | ### Return type @@ -1538,9 +1638,9 @@ api_instance = xero_client. -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 +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's salary and wages record result = api_instance.delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) @@ -1556,8 +1656,8 @@ end 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 | + **employee_id** | **String**| Employee id for single object | + **salary_and_wages_id** | **String**| Id for single salary and wages object | ### Return type @@ -1604,8 +1704,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet begin #Deletes a timesheet result = api_instance.delete_timesheet(xero_tenant_id, timesheet_id) @@ -1621,7 +1721,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **timesheet_id** | [**String**](.md)| Identifier for the timesheet | + **timesheet_id** | **String**| Identifier for the timesheet | ### Return type @@ -1668,9 +1768,9 @@ api_instance = xero_client. -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 +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet +timesheet_line_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet line begin #Deletes a timesheet line for a specific timesheet result = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id) @@ -1686,8 +1786,8 @@ end 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_id** | **String**| Identifier for the timesheet | + **timesheet_line_id** | **String**| Identifier for the timesheet line | ### Return type @@ -1734,8 +1834,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -deduction_id = 'deduction_id_example' # String | Identifier for the deduction +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +deduction_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the deduction begin #Retrieves a single deduction by using a unique deduction ID result = api_instance.get_deduction(xero_tenant_id, deduction_id) @@ -1751,7 +1851,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **deduction_id** | [**String**](.md)| Identifier for the deduction | + **deduction_id** | **String**| Identifier for the deduction | ### Return type @@ -1798,7 +1898,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. } @@ -1865,8 +1965,8 @@ api_instance = xero_client. -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 +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +earnings_rate_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the earnings rate begin #Retrieves a specific earnings rates by using a unique earnings rate id result = api_instance.get_earnings_rate(xero_tenant_id, earnings_rate_id) @@ -1882,7 +1982,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **earnings_rate_id** | [**String**](.md)| Identifier for the earnings rate | + **earnings_rate_id** | **String**| Identifier for the earnings rate | ### Return type @@ -1929,7 +2029,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. } @@ -1996,8 +2096,8 @@ api_instance = xero_client. -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 +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 employees using a unique employee ID result = api_instance.get_employee(xero_tenant_id, employee_id) @@ -2013,7 +2113,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2060,8 +2160,8 @@ api_instance = xero_client. -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 +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 leave balances for a specific employee result = api_instance.get_employee_leave_balances(xero_tenant_id, employee_id) @@ -2077,7 +2177,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2124,12 +2224,12 @@ api_instance = xero_client. -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 +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 + start_date: 2013-10-20, # Date | Filter by start date - end_date: Date.parse('Johnson') # Date | Filter by end date + end_date: Johnson # Date | Filter by end date } begin @@ -2147,7 +2247,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **start_date** | **Date**| Filter by start date | [optional] **end_date** | **Date**| Filter by end date | [optional] @@ -2196,8 +2296,8 @@ api_instance = xero_client. -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 +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 leave types for a specific employee result = api_instance.get_employee_leave_types(xero_tenant_id, employee_id) @@ -2213,7 +2313,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2260,8 +2360,8 @@ api_instance = xero_client. -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 +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 leave records for a specific employee result = api_instance.get_employee_leaves(xero_tenant_id, employee_id) @@ -2277,7 +2377,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2324,8 +2424,8 @@ api_instance = xero_client. -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 +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 the opening balance for a specific employee result = api_instance.get_employee_opening_balances(xero_tenant_id, employee_id) @@ -2341,7 +2441,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2388,8 +2488,8 @@ api_instance = xero_client. -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 +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 pay templates for a specific employee result = api_instance.get_employee_pay_templates(xero_tenant_id, employee_id) @@ -2405,7 +2505,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2452,8 +2552,8 @@ api_instance = xero_client. -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 +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 available payment methods for a specific employee result = api_instance.get_employee_payment_method(xero_tenant_id, employee_id) @@ -2469,7 +2569,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2516,9 +2616,9 @@ api_instance = xero_client. -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 +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 #Retrieves an employee's salary and wages record by using a unique salary and wage ID result = api_instance.get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) @@ -2534,8 +2634,8 @@ end 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 | + **employee_id** | **String**| Employee id for single object | + **salary_and_wages_id** | **String**| Id for single pay template earnings object | ### Return type @@ -2582,8 +2682,8 @@ api_instance = xero_client. -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 +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. } @@ -2603,7 +2703,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| 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 @@ -2651,8 +2751,8 @@ api_instance = xero_client. -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 +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 tax records for a specific employee result = api_instance.get_employee_tax(xero_tenant_id, employee_id) @@ -2668,7 +2768,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2715,9 +2815,9 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { - filter: 'firstName==John,lastName==Smith', # String | Filter by first name and/or lastname + filter: firstName==John,lastName==Smith, # String | Filter by first name and/or lastname page: 5 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. } @@ -2785,8 +2885,8 @@ api_instance = xero_client. -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 +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +leave_type_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the leave type begin #Retrieves a specific leave type by using a unique leave type ID result = api_instance.get_leave_type(xero_tenant_id, leave_type_id) @@ -2802,7 +2902,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **leave_type_id** | [**String**](.md)| Identifier for the leave type | + **leave_type_id** | **String**| Identifier for the leave type | ### Return type @@ -2849,7 +2949,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. @@ -2919,8 +3019,8 @@ api_instance = xero_client. -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 +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +pay_run_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the pay run begin #Retrieves a specific pay run by using a unique pay run ID result = api_instance.get_pay_run(xero_tenant_id, pay_run_id) @@ -2936,7 +3036,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **pay_run_id** | [**String**](.md)| Identifier for the pay run | + **pay_run_id** | **String**| Identifier for the pay run | ### Return type @@ -2983,8 +3083,8 @@ api_instance = xero_client. -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 +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +payroll_calendar_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the payrun calendars begin #Retrieves a specific payrun calendar by using a unique payroll calendar ID result = api_instance.get_pay_run_calendar(xero_tenant_id, payroll_calendar_id) @@ -3000,7 +3100,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **payroll_calendar_id** | [**String**](.md)| Identifier for the payrun calendars | + **payroll_calendar_id** | **String**| Identifier for the payrun calendars | ### Return type @@ -3047,7 +3147,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. } @@ -3114,11 +3214,11 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. + status: Draft # 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 @@ -3184,8 +3284,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -pay_slip_id = 'pay_slip_id_example' # String | Identifier for the payslip +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +pay_slip_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the payslip begin #Retrieves a specific payslip by a unique pay slip ID result = api_instance.get_pay_slip(xero_tenant_id, pay_slip_id) @@ -3201,7 +3301,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **pay_slip_id** | [**String**](.md)| Identifier for the payslip | + **pay_slip_id** | **String**| Identifier for the payslip | ### Return type @@ -3248,8 +3348,8 @@ api_instance = xero_client. -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. +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +pay_run_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # 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. } @@ -3269,7 +3369,7 @@ end 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. | + **pay_run_id** | **String**| 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 @@ -3317,8 +3417,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -reimbursement_id = 'reimbursement_id_example' # String | Identifier for the reimbursement +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +reimbursement_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the reimbursement begin #Retrieves a specific reimbursement by using a unique reimbursement ID result = api_instance.get_reimbursement(xero_tenant_id, reimbursement_id) @@ -3334,7 +3434,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **reimbursement_id** | [**String**](.md)| Identifier for the reimbursement | + **reimbursement_id** | **String**| Identifier for the reimbursement | ### Return type @@ -3381,7 +3481,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. } @@ -3448,7 +3548,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant begin #Retrieves settings result = api_instance.get_settings(xero_tenant_id) @@ -3510,8 +3610,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -id = 'id_example' # String | Identifier for the statutory deduction +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the statutory deduction begin #Retrieves a specific statutory deduction by using a unique statutory deductions id result = api_instance.get_statutory_deduction(xero_tenant_id, id) @@ -3527,7 +3627,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **id** | [**String**](.md)| Identifier for the statutory deduction | + **id** | **String**| Identifier for the statutory deduction | ### Return type @@ -3574,7 +3674,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. } @@ -3641,8 +3741,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -superannuation_id = 'superannuation_id_example' # String | Identifier for the superannuation +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +superannuation_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the superannuation begin #Retrieves a specific superannuation using a unique superannuation ID result = api_instance.get_superannuation(xero_tenant_id, superannuation_id) @@ -3658,7 +3758,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **superannuation_id** | [**String**](.md)| Identifier for the superannuation | + **superannuation_id** | **String**| Identifier for the superannuation | ### Return type @@ -3705,7 +3805,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. } @@ -3772,8 +3872,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet begin #Retrieves a specific timesheet by using a unique timesheet ID result = api_instance.get_timesheet(xero_tenant_id, timesheet_id) @@ -3789,7 +3889,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **timesheet_id** | [**String**](.md)| Identifier for the timesheet | + **timesheet_id** | **String**| Identifier for the timesheet | ### Return type @@ -3836,19 +3936,19 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { page: 5, # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - filter: 'employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000', # String | Filter by employeeId and/or payrollCalendarId + filter: employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000, # String | Filter by employeeId and/or payrollCalendarId - status: 'Draft', # String | filter results by any timesheets with a matching timesheet status + status: Draft, # String | filter results by any timesheets with a matching timesheet status - start_date: '2019-01-02', # String | filter results by any timesheets with a startDate on or after the provided date + start_date: 2019-01-02, # String | filter results by any timesheets with a startDate on or after the provided date - end_date: '2020-01-02', # String | filter results by any timesheets with a endDate on or before the provided date + end_date: 2020-01-02, # String | filter results by any timesheets with a endDate on or before the provided date - sort: 'startDate' # String | sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. + sort: startDate # String | sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. } begin @@ -3918,7 +4018,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant begin #Retrieves tracking categories result = api_instance.get_tracking_categories(xero_tenant_id) @@ -3951,7 +4051,7 @@ Name | Type | Description | Notes ## revert_timesheet -> TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id) +> TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id, opts) Reverts a timesheet to draft @@ -3980,11 +4080,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Reverts a timesheet to draft - result = api_instance.revert_timesheet(xero_tenant_id, timesheet_id) + result = api_instance.revert_timesheet(xero_tenant_id, timesheet_id, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->revert_timesheet: #{e}" @@ -3997,7 +4101,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **timesheet_id** | [**String**](.md)| Identifier for the timesheet | + **timesheet_id** | **String**| Identifier for the timesheet | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4015,7 +4120,7 @@ Name | Type | Description | Notes ## update_employee -> EmployeeObject update_employee(xero_tenant_id, employee_id, employee) +> EmployeeObject update_employee(xero_tenant_id, employee_id, employee, opts) Updates an existing employee @@ -4044,12 +4149,16 @@ api_instance = xero_client. -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 +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates an existing employee - result = api_instance.update_employee(xero_tenant_id, employee_id, employee) + result = api_instance.update_employee(xero_tenant_id, employee_id, employee, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->update_employee: #{e}" @@ -4062,8 +4171,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **employee** | [**Employee**](Employee.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4081,7 +4191,7 @@ Name | Type | Description | Notes ## update_employee_earnings_template -> EarningsTemplateObject update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template) +> EarningsTemplateObject update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts) Updates an earnings template records for an employee @@ -4110,13 +4220,17 @@ api_instance = xero_client. -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 +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates an earnings template records for an employee - result = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template) + result = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->update_employee_earnings_template: #{e}" @@ -4129,9 +4243,10 @@ end 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 | + **employee_id** | **String**| Employee id for single object | + **pay_template_earning_id** | **String**| Id for single pay template earnings object | **earnings_template** | [**EarningsTemplate**](EarningsTemplate.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4149,7 +4264,7 @@ Name | Type | Description | Notes ## update_employee_leave -> EmployeeLeaveObject update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave) +> EmployeeLeaveObject update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, opts) Updates leave records for a specific employee @@ -4178,13 +4293,17 @@ api_instance = xero_client. -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 +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 Description", "startDate": "2020-04-24", "endDate": "2020-04-26", "periods": [ { "periodStartDate": "2020-04-20", "periodEndDate": "2020-04-26", "numberOfUnits": 1, "periodStatus": "Approved" } ] } # EmployeeLeave | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates leave records for a specific employee - result = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave) + result = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->update_employee_leave: #{e}" @@ -4197,9 +4316,10 @@ end 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_id** | **String**| Employee id for single object | + **leave_id** | **String**| Leave id for single object | **employee_leave** | [**EmployeeLeave**](EmployeeLeave.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4217,7 +4337,7 @@ Name | Type | Description | Notes ## update_employee_salary_and_wage -> SalaryAndWageObject update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage) +> SalaryAndWageObject update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts) Updates an employee's salary and wages record @@ -4246,13 +4366,17 @@ api_instance = xero_client. -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 +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates an employee's salary and wages record - result = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage) + result = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->update_employee_salary_and_wage: #{e}" @@ -4265,9 +4389,10 @@ end 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 | + **employee_id** | **String**| Employee id for single object | + **salary_and_wages_id** | **String**| Id for single pay template earnings object | **salary_and_wage** | [**SalaryAndWage**](SalaryAndWage.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4285,7 +4410,7 @@ Name | Type | Description | Notes ## update_employee_tax -> EmployeeTaxObject update_employee_tax(xero_tenant_id, employee_id, employee_tax) +> EmployeeTaxObject update_employee_tax(xero_tenant_id, employee_id, employee_tax, opts) Updates the tax records for a specific employee @@ -4314,12 +4439,16 @@ api_instance = xero_client. -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 | +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 = # EmployeeTax | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates the tax records for a specific employee - result = api_instance.update_employee_tax(xero_tenant_id, employee_id, employee_tax) + result = api_instance.update_employee_tax(xero_tenant_id, employee_id, employee_tax, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->update_employee_tax: #{e}" @@ -4332,8 +4461,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **employee_tax** | [**EmployeeTax**](EmployeeTax.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4351,7 +4481,7 @@ Name | Type | Description | Notes ## update_pay_run -> PayRunObject update_pay_run(xero_tenant_id, pay_run_id, pay_run) +> PayRunObject update_pay_run(xero_tenant_id, pay_run_id, pay_run, opts) Updates a pay run @@ -4380,12 +4510,16 @@ api_instance = xero_client. -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 +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +pay_run_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the pay run pay_run = { "paymentDate": "2019-07-01" } # PayRun | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a pay run - result = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run) + result = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->update_pay_run: #{e}" @@ -4398,8 +4532,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **pay_run_id** | [**String**](.md)| Identifier for the pay run | + **pay_run_id** | **String**| Identifier for the pay run | **pay_run** | [**PayRun**](PayRun.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4417,7 +4552,7 @@ Name | Type | Description | Notes ## update_pay_slip_line_items -> PaySlipObject update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip) +> PaySlipObject update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip, opts) Creates an employee pay slip @@ -4446,12 +4581,16 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -pay_slip_id = 'pay_slip_id_example' # String | Identifier for the payslip +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +pay_slip_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # 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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an employee pay slip - result = api_instance.update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip) + result = api_instance.update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->update_pay_slip_line_items: #{e}" @@ -4464,8 +4603,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **pay_slip_id** | [**String**](.md)| Identifier for the payslip | + **pay_slip_id** | **String**| Identifier for the payslip | **pay_slip** | [**PaySlip**](PaySlip.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4483,7 +4623,7 @@ Name | Type | Description | Notes ## update_timesheet_line -> TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line) +> TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts) Updates a timesheet line for a specific timesheet @@ -4512,13 +4652,17 @@ api_instance = xero_client. -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 +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet +timesheet_line_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet line timesheet_line = { "date": "2020-08-04", "earningsRateID": "f9d8f5b5-9049-47f4-8541-35e200f750a5", "numberOfUnits": 2 } # TimesheetLine | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a timesheet line for a specific timesheet - result = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line) + result = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts) p result rescue XeroRuby::PayrollNz::ApiError => e puts "Exception when calling PayrollNzApi->update_timesheet_line: #{e}" @@ -4531,9 +4675,10 @@ end 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_id** | **String**| Identifier for the timesheet | + **timesheet_line_id** | **String**| Identifier for the timesheet line | **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type diff --git a/docs/payroll_nz/Timesheet.md b/docs/payroll_nz/Timesheet.md index 00a59a6b..4af2d01f 100644 --- a/docs/payroll_nz/Timesheet.md +++ b/docs/payroll_nz/Timesheet.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **end_date** | **Date** | The End Date of the Timesheet period (YYYY-MM-DD) | **status** | **String** | Status of the timesheet | [optional] **total_hours** | **BigDecimal** | The Total Hours of the Timesheet | [optional] -**updated_date_utc** | **DateTime** | The UTC date time that the Timesheet was last updated | [optional] +**updated_date_utc** | **Time** | The UTC date time that the Timesheet was last updated | [optional] **timesheet_lines** | [**Array<TimesheetLine>**](TimesheetLine.md) | | [optional] ## Code Sample diff --git a/docs/payroll_nz/index.html b/docs/payroll_nz/index.html deleted file mode 100644 index 0bde9be5..00000000 --- a/docs/payroll_nz/index.html +++ /dev/null @@ -1,14975 +0,0 @@ - - - - - Xero Payroll NZ - - - - - - xero-ruby PayrollNz SDK Docs - - - - - - - - - - - - - - - - - - -
- -
- -
-
- - -
-
- -
-
- -
-
-
-
-
- -
-
-
-
-

Xero Payroll NZ

-
-
-
- -
-
-

PayrollNz

-
-
-
-

approveTimesheet

-

Approves a timesheet

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}/Approve
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.approve_timesheet(xero_tenant_id, timesheet_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling approve_timesheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

createDeduction

-

Creates a new deduction for a specific employee

-
-
-
-

-

-

-
- 
/Deductions
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-deduction = { 
-  deduction_name: "Deduction test",
-  deduction_category:  XeroRuby::PayrollNz::Deduction::deduction_category::NZ_OTHER,
-  liability_account_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-begin
-  response = xero_client.accounting_api.create_deduction(xero_tenant_id, deduction)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_deduction: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
deduction * -
-
- - Deduction - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEarningsRate

-

Creates a new earnings rate

-
-
-
-

-

-

-
- 
/EarningsRates
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-earnings_rate = { 
-  earnings_type:  XeroRuby::PayrollNz::EarningsRate::EarningsTypeEnum::REGULAREARNINGS,
-  rate_type:  XeroRuby::PayrollNz::EarningsRate::RateTypeEnum::ACCPAYCREDIT,
-  expense_account_ID: "00000000-0000-0000-0000-000000000000"
-}  
-
-begin
-  response = xero_client.accounting_api.create_earnings_rate(xero_tenant_id, earningsRate)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_earnings_rate: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
earningsRate * -
-
- - EarningsRate - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployee

-

Creates an employees

-
-
-
-

-

-

-
- 
/Employees
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-date_of_birth = 'YYYY-MM-DD'
-
-address = { 
-  address_line_1: "123 Test st",
-  city: "Rangiora",
-  post_code: "7400",
-  country_name: "NEW ZEALAND"
-}  
-
-employee = { 
-  first_name: "Adam",
-  last_name: "Adamson",
-  date_of_birth:  date_of_birth,
-  address:  address
-}  
-
-begin
-  response = xero_client.accounting_api.create_employee(xero_tenant_id, employee)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employee * -
-
- - Employee - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployeeEarningsTemplate

-

Creates earnings template records for an employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/PayTemplates/earnings
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-earnings_template = { 
-  pay_template_earning_id: "00000000-0000-0000-0000-000000000000",
-  rate_per_unit: 14.25,
-  number_of_units: 35.5,
-  fixed_amount: 50,
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  name: "Overtime Hours"
-}    
-earnings_templates = []
-earnings_templates << earnings_template
-
-begin
-  response = xero_client.accounting_api.create_employee_earnings_template(xero_tenant_id, employee_id, earningsTemplate)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee_earnings_template: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
earningsTemplate * -
-
- - EarningsTemplate - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployeeLeave

-

Creates leave records for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/Leave
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-start_date = 'YYYY-MM-DD'
-end_date = 'YYYY-MM-DD'
-
-employee_leave = { 
-  leave_type_id: "00000000-0000-0000-0000-000000000000",
-  start_date:  start_date,
-  end_date:  end_date
-}  
-
-begin
-  response = xero_client.accounting_api.create_employee_leave(xero_tenant_id, employee_id, employeeLeave)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee_leave: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employeeLeave * -
-
- - EmployeeLeave - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployeeLeaveSetup

-

Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/leaveSetup
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-employee_leave_setup = { 
-  include_holiday_pay: false,
-  holiday_pay_opening_balance: 10.5,
-  annual_leave_opening_balance: 25.89,
-  sick_leave_hours_to_accrue_annually: 100.0,
-  sick_leave_maximum_hours_to_accrue: 200.0,
-  sick_leave_opening_balance: 10.5
-}  
-
-begin
-  response = xero_client.accounting_api.create_employee_leave_setup(xero_tenant_id, employee_id, employeeLeaveSetup)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee_leave_setup: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employeeLeaveSetup * -
-
- - EmployeeLeaveSetup - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployeeLeaveType

-

Creates leave type records for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/LeaveTypes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-employee_leave_type = { 
-  leave_type_id: "00000000-0000-0000-0000-000000000000",
-  schedule_of_accrual:  XeroRuby::PayrollNz::EmployeeLeaveType::schedule_of_accrual::PERCENTAGEOFGROSSEARNINGS,
-  opening_balance: 5.25
-}  
-
-begin
-  response = xero_client.accounting_api.create_employee_leave_type(xero_tenant_id, employee_id, employeeLeaveType)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee_leave_type: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employeeLeaveType * -
-
- - EmployeeLeaveType - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployeeOpeningBalances

-

Creates opening balances for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/openingBalances
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-period_end_date = 'YYYY-MM-DD'
-
-employee_opening_balance = { 
-  period_end_date:  period_end_date,
-  days_paid: 5,
-  unpaid_weeks: 0,
-  gross_earnings: 1730.77
-}    
-employee_opening_balances = []
-employee_opening_balances << employee_opening_balance
-
-begin
-  response = xero_client.accounting_api.create_employee_opening_balances(xero_tenant_id, employee_id, employeeOpeningBalance)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee_opening_balances: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employeeOpeningBalance * -
-
- - array[EmployeeOpeningBalance] - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployeePaymentMethod

-

Creates a payment method for an employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/PaymentMethods
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-bank_account = { 
-  account_name: "Charlotte Danes",
-  account_number: 123456,
-  sort_code: "123411"
-}    
-bank_accounts = []
-bank_accounts << bank_account
-
-payment_method = { 
-  bankAccounts: bankAccounts
-}  
-
-begin
-  response = xero_client.accounting_api.create_employee_payment_method(xero_tenant_id, employee_id, paymentMethod)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee_payment_method: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
paymentMethod * -
-
- - PaymentMethod - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployeeSalaryAndWage

-

Creates an employee salary and wage record

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/SalaryAndWages
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-salary_and_wage = { 
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  number_of_units_per_day: 0,
-  days_per_week: 0,
-  payment_type:  XeroRuby::PayrollNz::SalaryAndWage::payment_type_enum::HOURLY
-}  
-
-begin
-  response = xero_client.accounting_api.create_employee_salary_and_wage(xero_tenant_id, employee_id, salaryAndWage)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee_salary_and_wage: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
salaryAndWage * -
-
- - SalaryAndWage - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployment

-

Creates an employment detail for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/Employment
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-start_date = 'YYYY-MM-DD'
-
-employment = { 
-  payroll_calendar_id: "00000000-0000-0000-0000-000000000000",
-  start_date:  start_date
-}  
-
-begin
-  response = xero_client.accounting_api.create_employment(xero_tenant_id, employee_id, employment)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employment: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employment * -
-
- - Employment - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createLeaveType

-

Creates a new leave type

-
-
-
-

-

-

-
- 
/LeaveTypes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-leave_type = { 
-  name: "LeaveType",
-  is_paid_leave: true,
-  show_on_payslip: true
-}  
-
-begin
-  response = xero_client.accounting_api.create_leave_type(xero_tenant_id, leaveType)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_leave_type: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
leaveType * -
-
- - LeaveType - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createMultipleEmployeeEarningsTemplate

-

Creates multiple employee earnings template records for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/paytemplateearnings
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-earnings_template = { 
-  pay_template_earning_id: "00000000-0000-0000-0000-000000000000",
-  rate_per_unit: 14.25,
-  number_of_units: 35.5,
-  fixed_amount: 50,
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  name: "Overtime Hours"
-}    
-earnings_templates = []
-earnings_templates << earnings_template
-
-begin
-  response = xero_client.accounting_api.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earningsTemplate)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_multiple_employee_earnings_template: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
earningsTemplate * -
-
- - array[EarningsTemplate] - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createPayRun

-

Creates a pay run

-
-
-
-

-

-

-
- 
/PayRuns
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-pay_run = { 
-  pay_run_type:  XeroRuby::PayrollNz::PayRun::pay_run_type_enum::SCHEDULED,
-  payroll_calendar_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-begin
-  response = xero_client.accounting_api.create_pay_run(xero_tenant_id, payRun)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_pay_run: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.payrunsGrant read-write access to payroll payruns
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
payRun * -
-
- - PayRun - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createPayRunCalendar

-

Creates a new payrun calendar

-
-
-
-

-

-

-
- 
/PayRunCalendars
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-start_date = 'YYYY-MM-DD'
-payment_date = 'YYYY-MM-DD'
-
-pay_run_calendar = { 
-  calendar_type:  XeroRuby::PayrollNz::calendar_type::WEEKLY,
-  period_start_date:  start_date,
-  payment_date:  payment_date
-}  
-
-begin
-  response = xero_client.accounting_api.create_pay_run_calendar(xero_tenant_id, payRunCalendar)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_pay_run_calendar: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
payRunCalendar * -
-
- - PayRunCalendar - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createReimbursement

-

Creates a new reimbursement

-
-
-
-

-

-

-
- 
/Reimbursements
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-reimbursement = { 
-  name: "Test Reimbursement",
-  account_id: "00000000-0000-0000-0000-000000000000"
-}  
-  calculation_type:  XeroRuby::PayrollNz::Reimbursement::calculation_type_enum::FIXEDAMOUNT,
-  reimbursement_category:  XeroRuby::PayrollNz::Reimbursement::reimbursement_category_enum::GST
-}  
-
-begin
-  response = xero_client.accounting_api.create_reimbursement(xero_tenant_id, reimbursement)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_reimbursement: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
reimbursement * -
-
- - Reimbursement - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createSuperannuation

-

Creates a new superannuation

-
-
-
-

-

-

-
- 
/Superannuations
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-benefit = { 
-  category:  XeroRuby::PayrollNz::Benefit::CategoryEnum::COMPLYINGFUND,
-  calculation_type_nz:  XeroRuby::PayrollNz::Benefit::CalculationTypeNZ::PERCENTAGEOFTAXABLEEARNINGS,
-  liability_account_id: "00000000-0000-0000-0000-000000000000",
-  expense_account_id: "00000000-0000-0000-0000-000000000000",
-  percentage: 3,
-  standard_amount: 100
-}  
-
-begin
-  response = xero_client.accounting_api.create_superannuation(xero_tenant_id, benefit)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_superannuation: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
benefit * -
-
- - Benefit - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createTimesheet

-

Creates a new timesheet

-
-
-
-

-

-

-
- 
/Timesheets
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-start_date = 'YYYY-MM-DD'
-end_date = 'YYYY-MM-DD'
-
-timesheet = { 
-  payroll_calendar_id: "00000000-0000-0000-0000-000000000000",
-  employee_id: "00000000-0000-0000-0000-000000000000",
-  start_date:  start_date,
-  end_date:  end_date
-}  
-
-begin
-  response = xero_client.accounting_api.create_timesheet(xero_tenant_id, timesheet)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_timesheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
timesheet * -
-
- - Timesheet - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createTimesheetLine

-

Create a new timesheet line for a specific time sheet

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}/Lines
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-date = 'YYYY-MM-DD'
-
-timesheet_line = { 
-  timesheet_line_id: "00000000-0000-0000-0000-000000000000",
-  date:  date,
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  tracking_item_id: "00000000-0000-0000-0000-000000000000",
-  number_of_units: 6
-}  
-
-begin
-  response = xero_client.accounting_api.create_timesheet_line(xero_tenant_id, timesheet_id, timesheetLine)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_timesheet_line: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
timesheetLine * -
-
- - TimesheetLine - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

deleteEmployeeEarningsTemplate

-

Deletes an employee's earnings template record

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
-
-begin
-  response = xero_client.accounting_api.delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_employee_earnings_template: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
PayTemplateEarningID* - - -
-
-
- - UUID - - - (uuid) - - -
-Id for single pay template earnings object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteEmployeeLeave

-

Deletes a leave record for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/Leave/{LeaveID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314'
-
-begin
-  response = xero_client.accounting_api.delete_employee_leave(xero_tenant_id, employee_id, leave_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_employee_leave: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
LeaveID* - - -
-
-
- - UUID - - - (uuid) - - -
-Leave id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteEmployeeSalaryAndWage

-

Deletes an employee's salary and wages record

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
-
-begin
-  response = xero_client.accounting_api.delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_employee_salary_and_wage: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
SalaryAndWagesID* - - -
-
-
- - UUID - - - (uuid) - - -
-Id for single salary and wages object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteTimesheet

-

Deletes a timesheet

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.delete_timesheet(xero_tenant_id, timesheet_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_timesheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteTimesheetLine

-

Deletes a timesheet line for a specific timesheet

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-timesheet_line_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_timesheet_line: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet -
-
-
- Required -
-
-
-
TimesheetLineID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet line -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getDeduction

-

Retrieves a single deduction by using a unique deduction ID

-
-
-
-

-

-

-
- 
/Deductions/{deductionId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-deduction_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_deduction(xero_tenant_id, deduction_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_deduction: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
deductionId* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the deduction -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getDeductions

-

Retrieves deductions for a specific employee

-
-
-
-

-

-

-
- 
/Deductions
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_deductions(xero_tenant_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_deductions: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getEarningsRate

-

Retrieves a specific earnings rates by using a unique earnings rate id

-
-
-
-

-

-

-
- 
/EarningsRates/{EarningsRateID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-earnings_rate_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_earnings_rate(xero_tenant_id, earnings_rate_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_earnings_rate: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EarningsRateID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the earnings rate -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEarningsRates

-

Retrieves earnings rates

-
-
-
-

-

-

-
- 
/EarningsRates
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_earnings_rates(xero_tenant_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_earnings_rates: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getEmployee

-

Retrieves an employees using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeeLeaveBalances

-

Retrieves leave balances for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/LeaveBalances
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_leave_balances(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_leave_balances: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeeLeavePeriods

-

Retrieves leave periods for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/LeavePeriods
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-start_date = "2013-10-20"
-end_date = "Johnson"
-
-begin
-  response = xero_client.accounting_api.get_employee_leave_periods(xero_tenant_id, employee_id, start_date, end_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_leave_periods: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
startDate - - -
-
-
- - date - - - (date) - - -
-Filter by start date -
-
-
-
-
endDate - - -
-
-
- - date - - - (date) - - -
-Filter by end date -
-
-
-
-
-
-
-
-
-
-
-

getEmployeeLeaveTypes

-

Retrieves leave types for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/LeaveTypes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_leave_types(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_leave_types: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeeLeaves

-

Retrieves leave records for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/Leave
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_leaves(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_leaves: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeeOpeningBalances

-

Retrieves the opening balance for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/openingBalances
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_opening_balances(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_opening_balances: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeePayTemplates

-

Retrieves pay templates for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/PayTemplates
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_pay_templates(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_pay_templates: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeePaymentMethod

-

Retrieves available payment methods for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/PaymentMethods
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_payment_method(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_payment_method: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeeSalaryAndWage

-

Retrieves an employee's salary and wages record by using a unique salary and wage ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
-
-begin
-  response = xero_client.accounting_api.get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_salary_and_wage: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
SalaryAndWagesID* - - -
-
-
- - UUID - - - (uuid) - - -
-Id for single pay template earnings object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeeSalaryAndWages

-

Retrieves an employee's salary and wages

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/SalaryAndWages
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_employee_salary_and_wages(xero_tenant_id, employee_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_salary_and_wages: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getEmployeeTax

-

Retrieves tax records for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/Tax
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_tax(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_tax: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployees

-

Retrieves employees

-
-
-
-

-

-

-
- 
/Employees
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-filter = 'firstName==John,lastName==Smith'
-page = 5
-
-begin
-  response = xero_client.accounting_api.get_employees(xero_tenant_id, filter, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employees: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
filter - - -
-
-
- - String - - -
-Filter by first name and/or lastname -
-
-
-
-
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getLeaveType

-

Retrieves a specific leave type by using a unique leave type ID

-
-
-
-

-

-

-
- 
/LeaveTypes/{LeaveTypeID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-leave_type_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_leave_type(xero_tenant_id, leave_type_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_leave_type: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
LeaveTypeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the leave type -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getLeaveTypes

-

Retrieves leave types

-
-
-
-

-

-

-
- 
/LeaveTypes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-active_only = true
-
-begin
-  response = xero_client.accounting_api.get_leave_types(xero_tenant_id, page, active_only)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_leave_types: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
ActiveOnly - - -
-
-
- - Boolean - - -
-Filters leave types by active status. By default the API returns all leave types. -
-
-
-
-
-
-
-
-
-
-
-

getPayRun

-

Retrieves a specific pay run by using a unique pay run ID

-
-
-
-

-

-

-
- 
/PayRuns/{PayRunID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-pay_run_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_pay_run(xero_tenant_id, pay_run_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_run: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.payrunsGrant read-write access to payroll payruns
payroll.payruns.readGrant read-only access to payroll payruns
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PayRunID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the pay run -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPayRunCalendar

-

Retrieves a specific payrun calendar by using a unique payroll calendar ID

-
-
-
-

-

-

-
- 
/PayRunCalendars/{PayrollCalendarID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-payroll_calendar_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_pay_run_calendar(xero_tenant_id, payroll_calendar_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_run_calendar: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PayrollCalendarID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the payrun calendars -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPayRunCalendars

-

Retrieves payrun calendars

-
-
-
-

-

-

-
- 
/PayRunCalendars
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_pay_run_calendars(xero_tenant_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_run_calendars: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getPayRuns

-

Retrieves pay runs

-
-
-
-

-

-

-
- 
/PayRuns
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-status = 'status_example'
-
-begin
-  response = xero_client.accounting_api.get_pay_runs(xero_tenant_id, page, status)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_runs: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.payrunsGrant read-write access to payroll payruns
payroll.payruns.readGrant read-only access to payroll payruns
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
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={PayRunStatus} to filter the payruns by status. -
-
-
-
-
-
-
-
-
-
-
-

getPaySlip

-

Retrieves a specific payslip by a unique pay slip ID

-
-
-
-

-

-

-
- 
/PaySlips/{PaySlipID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-pay_slip_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_pay_slip(xero_tenant_id, pay_slip_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_slip: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.payslipGrant read-write access to payroll payslips
payroll.payslip.readGrant read-only access to payroll payslips
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PaySlipID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the payslip -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPaySlips

-

Retrieves payslips

-
-
-
-

-

-

-
- 
/PaySlips
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-pay_run_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_pay_slips(xero_tenant_id, pay_run_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_slips: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.payslipGrant read-write access to payroll payslips
payroll.payslip.readGrant read-only access to payroll payslips
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
PayRunID* - - -
-
-
- - UUID - - - (uuid) - - -
-PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun. -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getReimbursement

-

Retrieves a specific reimbursement by using a unique reimbursement ID

-
-
-
-

-

-

-
- 
/Reimbursements/{ReimbursementID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-reimbursement_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_reimbursement(xero_tenant_id, reimbursement_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_reimbursement: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ReimbursementID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the reimbursement -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getReimbursements

-

Retrieves reimbursements

-
-
-
-

-

-

-
- 
/Reimbursements
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_reimbursements(xero_tenant_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_reimbursements: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getSettings

-

Retrieves settings

-
-
-
-

-

-

-
- 
/Settings
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-begin
-  response = xero_client.accounting_api.get_settings(xero_tenant_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_settings: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getStatutoryDeduction

-

Retrieves a specific statutory deduction by using a unique statutory deductions id

-
-
-
-

-

-

-
- 
/StatutoryDeductions/{id}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_statutory_deduction(xero_tenant_id, id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_statutory_deduction: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
id* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the statutory deduction -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getStatutoryDeductions

-

Retrieves statutory deductions

-
-
-
-

-

-

-
- 
/StatutoryDeductions
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_statutory_deductions(xero_tenant_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_statutory_deductions: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getSuperannuation

-

Retrieves a specific superannuation using a unique superannuation ID

-
-
-
-

-

-

-
- 
/Superannuations/{SuperannuationID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-superannuation_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_superannuation(xero_tenant_id, superannuation_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_superannuation: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
SuperannuationID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the superannuation -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getSuperannuations

-

Retrieves superannuations

-
-
-
-

-

-

-
- 
/Superannuations
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_superannuations(xero_tenant_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_superannuations: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getTimesheet

-

Retrieves a specific timesheet by using a unique timesheet ID

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_timesheet(xero_tenant_id, timesheet_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_timesheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
payroll.timesheets.readGrant read-only access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getTimesheets

-

Retrieves timesheets

-
-
-
-

-

-

-
- 
/Timesheets
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 5
-filter = 'employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000'
-status = 'Draft'
-start_date = '2019-01-02'
-end_date = '2020-01-02'
-sort = 'startDate'
-
-begin
-  response = xero_client.accounting_api.get_timesheets(xero_tenant_id, page, filter, status, start_date, end_date, sort)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_timesheets: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
payroll.timesheets.readGrant read-only access to payroll timesheets
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
filter - - -
-
-
- - String - - -
-Filter by employeeId and/or payrollCalendarId -
-
-
-
-
status - - -
-
-
- - String - - -
-filter results by any timesheets with a matching timesheet status -
-
-
-
-
startDate - - -
-
-
- - String - - -
-filter results by any timesheets with a startDate on or after the provided date -
-
-
-
-
endDate - - -
-
-
- - String - - -
-filter results by any timesheets with a endDate on or before the provided date -
-
-
-
-
sort - - -
-
-
- - String - - -
-sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. -
-
-
-
-
-
-
-
-
-
-
-

getTrackingCategories

-

Retrieves tracking categories

-
-
-
-

-

-

-
- 
/Settings/TrackingCategories
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-begin
-  response = xero_client.accounting_api.get_tracking_categories(xero_tenant_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_tracking_categories: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

revertTimesheet

-

Reverts a timesheet to draft

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}/RevertToDraft
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.revert_timesheet(xero_tenant_id, timesheet_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling revert_timesheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

updateEmployee

-

Updates an existing employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-date_of_birth = 'YYYY-MM-DD'
-
-address = { 
-  address_line_1: "123 Test st",
-  city: "Rangiora",
-  post_code: "7400",
-  country_name: "NEW ZEALAND"
-}  
-
-employee = { 
-  first_name: "Adam",
-  last_name: "Adamson",
-  date_of_birth:  date_of_birth,
-  address:  address
-}  
-
-begin
-  response = xero_client.accounting_api.update_employee(xero_tenant_id, employee_id, employee)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_employee: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employee * -
-
- - Employee - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateEmployeeEarningsTemplate

-

Updates an earnings template records for an employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
-
-earnings_template = { 
-  pay_template_earning_id: "00000000-0000-0000-0000-000000000000",
-  rate_per_unit: 14.25,
-  number_of_units: 35.5,
-  fixed_amount: 50,
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  name: "Overtime Hours"
-}    
-earnings_templates = []
-earnings_templates << earnings_template
-
-begin
-  response = xero_client.accounting_api.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earningsTemplate)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_employee_earnings_template: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
PayTemplateEarningID* - - -
-
-
- - UUID - - - (uuid) - - -
-Id for single pay template earnings object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
earningsTemplate * -
-
- - EarningsTemplate - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateEmployeeLeave

-

Updates leave records for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/Leave/{LeaveID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314'
-start_date = 'YYYY-MM-DD'
-end_date = 'YYYY-MM-DD'
-
-employee_leave = { 
-  leave_type_id: "00000000-0000-0000-0000-000000000000",
-  start_date:  start_date,
-  end_date:  end_date
-}  
-
-begin
-  response = xero_client.accounting_api.update_employee_leave(xero_tenant_id, employee_id, leave_id, employeeLeave)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_employee_leave: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
LeaveID* - - -
-
-
- - UUID - - - (uuid) - - -
-Leave id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employeeLeave * -
-
- - EmployeeLeave - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateEmployeeSalaryAndWage

-

Updates an employee's salary and wages record

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
-
-salary_and_wage = { 
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  number_of_units_per_day: 0,
-  days_per_week: 0,
-  payment_type:  XeroRuby::PayrollNz::SalaryAndWage::payment_type_enum::HOURLY
-}  
-
-begin
-  response = xero_client.accounting_api.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salaryAndWage)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_employee_salary_and_wage: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
SalaryAndWagesID* - - -
-
-
- - UUID - - - (uuid) - - -
-Id for single pay template earnings object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
salaryAndWage * -
-
- - SalaryAndWage - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateEmployeeTax

-

Updates the tax records for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/Tax
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-student_loan_as_at = 'YYYY-MM-DD'
-
-employee_tax = { 
-  ird_number: "111111111",
-  has_special_student_loan_rate: true,
-  special_student_loan_rate_percentage: 2,
-  is_eligible_for_kiwi_saver: true,
-  esct_rate_percentage: 17.5,
-  kiwi_saver_contributions:  XeroRuby::PayrollNz::EmployeeTax::kiwi_saver_contributions_enum::MAKECONTRIBUTIONS,
-  kiwi_saver_employee_contribution_rate_percentage: 4,
-  kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage: 2,
-  tax_code:  XeroRuby::PayrollNz::TaxCode::MSL,
-  has_student_loan_balance: true,
-  student_loan_balance: 30.0,
-  student_loan_as_at:  student_loan_as_at
-}  
-
-begin
-  response = xero_client.accounting_api.update_employee_tax(xero_tenant_id, employee_id, employeeTax)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_employee_tax: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employeeTax * -
-
- - EmployeeTax - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updatePayRun

-

Updates a pay run

-
-
-
-

-

-

-
- 
/PayRuns/{PayRunID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-pay_run_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-start_date = 'YYYY-MM-DD'
-payment_date = 'YYYY-MM-DD'
-
-pay_run_calendar = { 
-  calendar_type:  XeroRuby::PayrollNz::calendar_type::WEEKLY,
-  period_start_date:  start_date,
-  payment_date:  payment_date
-}  
-
-begin
-  response = xero_client.accounting_api.update_pay_run(xero_tenant_id, pay_run_id, payRun)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_pay_run: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.payrunsGrant read-write access to payroll payruns
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PayRunID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the pay run -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
payRun * -
-
- - PayRun - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updatePaySlipLineItems

-

Creates an employee pay slip

-
-
-
-

-

-

-
- 
/PaySlips/{PaySlipID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-pay_slip_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-earnings_line = { 
-  earnings_line_id: "00000000-0000-0000-0000-000000000000",
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  rate_per_unit: 14.25,
-  number_of_units: 35.5,
-  is_average_daily_pay_rate: true,
-  is_system_generated: true
-}    
-earnings_lines = []
-earnings_lines << earnings_line
-
-pay_slip = { 
-  earningsLines:  earnings_lines
-}  
-
-begin
-  response = xero_client.accounting_api.update_pay_slip_line_items(xero_tenant_id, pay_slip_id, paySlip)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_pay_slip_line_items: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.payslipGrant read-write access to payroll payslips
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PaySlipID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the payslip -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
paySlip * -
-
- - PaySlip - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateTimesheetLine

-

Updates a timesheet line for a specific timesheet

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-timesheet_line_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-date = 'YYYY-MM-DD'
-
-timesheet_line = { 
-  timesheet_line_id: "00000000-0000-0000-0000-000000000000",
-  date:  date,
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  tracking_item_id: "00000000-0000-0000-0000-000000000000",
-  number_of_units: 6
-}  
-
-begin
-  response = xero_client.accounting_api.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheetLine)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_timesheet_line: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet -
-
-
- Required -
-
-
-
TimesheetLineID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet line -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
timesheetLine * -
-
- - TimesheetLine - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
- -
-
-
- - - - - - - - - - - - - - diff --git a/docs/payroll_uk/Employee.md b/docs/payroll_uk/Employee.md index 26a67074..63e3e856 100644 --- a/docs/payroll_uk/Employee.md +++ b/docs/payroll_uk/Employee.md @@ -16,8 +16,8 @@ Name | Type | Description | Notes **start_date** | **Date** | Employment start date of the employee at the time it was requested | [optional] **end_date** | **Date** | Employment end date of the employee at the time it was requested | [optional] **payroll_calendar_id** | **String** | Xero unique identifier for the payroll calendar of the employee | [optional] -**updated_date_utc** | **DateTime** | UTC timestamp of last update to the employee | [optional] -**created_date_utc** | **DateTime** | UTC timestamp when the employee was created in Xero | [optional] +**updated_date_utc** | **Time** | UTC timestamp of last update to the employee | [optional] +**created_date_utc** | **Time** | UTC timestamp when the employee was created in Xero | [optional] **national_insurance_number** | **String** | National insurance number of the employee | [optional] **is_off_payroll_worker** | **Boolean** | Whether the employee is an off payroll worker | [optional] @@ -30,13 +30,13 @@ instance = XeroRuby::PayrollUk::Employee.new(employee_id: d90457c4-f1be-4f2e-b4e title: Mrs, first_name: Karen, last_name: Jones, - date_of_birth: Wed Jan 02 00:00:00 GMT 2019, + date_of_birth: Wed Jan 02 00:00:00 UTC 2019, address: null, email: developer@me.com, gender: F, phone_number: 415-555-1212, - start_date: Sun Jan 19 00:00:00 GMT 2020, - end_date: Sun Jan 19 00:00:00 GMT 2020, + start_date: Sun Jan 19 00:00:00 UTC 2020, + end_date: Sun Jan 19 00:00:00 UTC 2020, payroll_calendar_id: null, updated_date_utc: null, created_date_utc: null, diff --git a/docs/payroll_uk/EmployeeLeave.md b/docs/payroll_uk/EmployeeLeave.md index 2fe1f8e2..57ca9bb8 100644 --- a/docs/payroll_uk/EmployeeLeave.md +++ b/docs/payroll_uk/EmployeeLeave.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **start_date** | **Date** | Start date of the leave (YYYY-MM-DD) | **end_date** | **Date** | End date of the leave (YYYY-MM-DD) | **periods** | [**Array<LeavePeriod>**](LeavePeriod.md) | The leave period information. The StartDate, EndDate and NumberOfUnits needs to be specified when you do not want to calculate NumberOfUnits automatically. Using incorrect period StartDate and EndDate will result in automatic computation of the NumberOfUnits. | [optional] -**updated_date_utc** | **DateTime** | UTC timestamp of last update to the leave type note | [optional] +**updated_date_utc** | **Time** | UTC timestamp of last update to the leave type note | [optional] ## Code Sample diff --git a/docs/payroll_uk/LeaveType.md b/docs/payroll_uk/LeaveType.md index 4e7c9806..1d5916ac 100644 --- a/docs/payroll_uk/LeaveType.md +++ b/docs/payroll_uk/LeaveType.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **name** | **String** | Name of the leave type | **is_paid_leave** | **Boolean** | Indicate that an employee will be paid when taking this type of leave | **show_on_payslip** | **Boolean** | Indicate that a balance for this leave type to be shown on the employee’s payslips | -**updated_date_utc** | **DateTime** | UTC timestamp of last update to the leave type note | [optional] +**updated_date_utc** | **Time** | UTC timestamp of last update to the leave type note | [optional] **is_active** | **Boolean** | Shows whether the leave type is active or not | [optional] **is_statutory_leave** | **Boolean** | Shows whether the leave type is a statutory leave type or not | [optional] diff --git a/docs/payroll_uk/PayRunCalendar.md b/docs/payroll_uk/PayRunCalendar.md index 31825265..a75a18e5 100644 --- a/docs/payroll_uk/PayRunCalendar.md +++ b/docs/payroll_uk/PayRunCalendar.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **period_start_date** | **Date** | Period start date of the calendar | **period_end_date** | **Date** | Period end date of the calendar | [optional] **payment_date** | **Date** | Payment date of the calendar | -**updated_date_utc** | **DateTime** | UTC timestamp of the last update to the pay run calendar | [optional] +**updated_date_utc** | **Time** | UTC timestamp of the last update to the pay run calendar | [optional] ## Code Sample diff --git a/docs/payroll_uk/PayrollUkApi.md b/docs/payroll_uk/PayrollUkApi.md index 9376b1a7..fcfafd55 100644 --- a/docs/payroll_uk/PayrollUkApi.md +++ b/docs/payroll_uk/PayrollUkApi.md @@ -79,7 +79,7 @@ Method | HTTP request | Description ## approve_timesheet -> TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id) +> TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id, opts) Approves a specific timesheet @@ -108,11 +108,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Approves a specific timesheet - result = api_instance.approve_timesheet(xero_tenant_id, timesheet_id) + result = api_instance.approve_timesheet(xero_tenant_id, timesheet_id, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->approve_timesheet: #{e}" @@ -125,7 +129,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **timesheet_id** | [**String**](.md)| Identifier for the timesheet | + **timesheet_id** | **String**| Identifier for the timesheet | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -143,7 +148,7 @@ Name | Type | Description | Notes ## create_benefit -> BenefitObject create_benefit(xero_tenant_id, benefit) +> BenefitObject create_benefit(xero_tenant_id, benefit, opts) Creates a new employee benefit @@ -172,11 +177,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant benefit = { "name": "My Big Bennie", "category": "StakeholderPension", "liabilityAccountId": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "expenseAccountId": "4b03500d-32fd-4616-8d70-e1e56e0519c6", "standardAmount": 50, "percentage": 25, "calculationType": "PercentageOfGross" } # Benefit | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new employee benefit - result = api_instance.create_benefit(xero_tenant_id, benefit) + result = api_instance.create_benefit(xero_tenant_id, benefit, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_benefit: #{e}" @@ -190,6 +199,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **benefit** | [**Benefit**](Benefit.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -207,7 +217,7 @@ Name | Type | Description | Notes ## create_deduction -> DeductionObject create_deduction(xero_tenant_id, deduction) +> DeductionObject create_deduction(xero_tenant_id, deduction, opts) Creates a new deduction @@ -236,11 +246,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant deduction = { "deductionName": "My new deduction", "deductionCategory": "SalarySacrifice", "liabilityAccountId": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "calculationType": "FixedAmount" } # Deduction | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new deduction - result = api_instance.create_deduction(xero_tenant_id, deduction) + result = api_instance.create_deduction(xero_tenant_id, deduction, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_deduction: #{e}" @@ -254,6 +268,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **deduction** | [**Deduction**](Deduction.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -271,7 +286,7 @@ Name | Type | Description | Notes ## create_earnings_rate -> EarningsRateObject create_earnings_rate(xero_tenant_id, earnings_rate) +> EarningsRateObject create_earnings_rate(xero_tenant_id, earnings_rate, opts) Creates a new earnings rate @@ -300,11 +315,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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": "4b03500d-32fd-4616-8d70-e1e56e0519c6" } # EarningsRate | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new earnings rate - result = api_instance.create_earnings_rate(xero_tenant_id, earnings_rate) + result = api_instance.create_earnings_rate(xero_tenant_id, earnings_rate, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_earnings_rate: #{e}" @@ -318,6 +337,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **earnings_rate** | [**EarningsRate**](EarningsRate.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -335,7 +355,7 @@ Name | Type | Description | Notes ## create_employee -> EmployeeObject create_employee(xero_tenant_id, employee) +> EmployeeObject create_employee(xero_tenant_id, employee, opts) Creates employees @@ -364,11 +384,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant employee = { "title":"Mr", "firstName":"Mike", "lastName":"Fancy", "dateOfBirth":"1999-01-01T00:00:00", "gender":"M", "email":"mike@starkindustries.com", "isOffPayrollWorker": false, "address": { "addressLine1": "171 Midsummer", "city": "Milton Keyness", "postCode": "MK9 1EB" } } # Employee | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates employees - result = api_instance.create_employee(xero_tenant_id, employee) + result = api_instance.create_employee(xero_tenant_id, employee, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_employee: #{e}" @@ -382,6 +406,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **employee** | [**Employee**](Employee.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -399,7 +424,7 @@ Name | Type | Description | Notes ## create_employee_earnings_template -> EarningsTemplateObject create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) +> EarningsTemplateObject create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts) Creates an earnings template records for a specific employee @@ -428,12 +453,16 @@ api_instance = xero_client. -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 = XeroRuby::PayrollUk::EarningsTemplate.new # EarningsTemplate | +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 = # EarningsTemplate | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an earnings template records for a specific employee - result = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) + result = api_instance.create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_employee_earnings_template: #{e}" @@ -446,8 +475,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **earnings_template** | [**EarningsTemplate**](EarningsTemplate.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -465,7 +495,7 @@ Name | Type | Description | Notes ## create_employee_leave -> EmployeeLeaveObject create_employee_leave(xero_tenant_id, employee_id, employee_leave) +> EmployeeLeaveObject create_employee_leave(xero_tenant_id, employee_id, employee_leave, opts) Creates leave records for a specific employee @@ -494,12 +524,16 @@ api_instance = xero_client. -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 +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": "1d2778ee-86ea-45c0-bbf8-1045485f6b3f", "description": "Creating a Description", "startDate": "2020-03-24", "endDate": "2020-03-26" } # EmployeeLeave | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates leave records for a specific employee - result = api_instance.create_employee_leave(xero_tenant_id, employee_id, employee_leave) + result = api_instance.create_employee_leave(xero_tenant_id, employee_id, employee_leave, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_employee_leave: #{e}" @@ -512,8 +546,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **employee_leave** | [**EmployeeLeave**](EmployeeLeave.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -531,7 +566,7 @@ Name | Type | Description | Notes ## create_employee_leave_type -> EmployeeLeaveTypeObject create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type) +> EmployeeLeaveTypeObject create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, opts) Creates employee leave type records @@ -560,12 +595,16 @@ api_instance = xero_client. -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 +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": "4918f233-bd31-43f9-9633-bcc6de1178f2", "scheduleOfAccrual": "BeginningOfCalendarYear", "hoursAccruedAnnually": 10 } # EmployeeLeaveType | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates employee leave type records - result = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type) + result = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_employee_leave_type: #{e}" @@ -578,8 +617,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **employee_leave_type** | [**EmployeeLeaveType**](EmployeeLeaveType.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -597,7 +637,7 @@ Name | Type | Description | Notes ## create_employee_opening_balances -> EmployeeOpeningBalancesObject create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances) +> EmployeeOpeningBalancesObject create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, opts) Creates an opening balance for a specific employee @@ -626,12 +666,16 @@ api_instance = xero_client. -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 +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_balances = { "statutoryAdoptionPay": 10, "statutoryMaternityPay": 10, "statutoryPaternityPay": 10, "statutorySharedParentalPay": 10, "statutorySickPay": 10, "priorEmployeeNumber": 10 } # EmployeeOpeningBalances | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an opening balance for a specific employee - result = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances) + result = api_instance.create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_employee_opening_balances: #{e}" @@ -644,8 +688,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **employee_opening_balances** | [**EmployeeOpeningBalances**](EmployeeOpeningBalances.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -663,7 +708,7 @@ Name | Type | Description | Notes ## create_employee_payment_method -> PaymentMethodObject create_employee_payment_method(xero_tenant_id, employee_id, payment_method) +> PaymentMethodObject create_employee_payment_method(xero_tenant_id, employee_id, payment_method, opts) Creates an employee payment method @@ -692,12 +737,16 @@ api_instance = xero_client. -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 +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 = { "paymentMethod": "Electronically", "bankAccounts": [ { "accountName": "Sid BofA", "accountNumber": "24987654", "sortCode": "287654" } ] } # PaymentMethod | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an employee payment method - result = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, payment_method) + result = api_instance.create_employee_payment_method(xero_tenant_id, employee_id, payment_method, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_employee_payment_method: #{e}" @@ -710,8 +759,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **payment_method** | [**PaymentMethod**](PaymentMethod.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -729,7 +779,7 @@ Name | Type | Description | Notes ## create_employee_salary_and_wage -> SalaryAndWageObject create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage) +> SalaryAndWageObject create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage, opts) Creates a salary and wage record for a specific employee @@ -758,12 +808,16 @@ api_instance = xero_client. -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 +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": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnitsPerWeek": 2, "ratePerUnit": 10, "numberOfUnitsPerDay": 2, "effectiveFrom": "2020-05-01", "annualSalary": 100, "status": "ACTIVE", "paymentType": "Salary" } # SalaryAndWage | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a salary and wage record for a specific employee - result = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage) + result = api_instance.create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_employee_salary_and_wage: #{e}" @@ -776,8 +830,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **salary_and_wage** | [**SalaryAndWage**](SalaryAndWage.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -795,7 +850,7 @@ Name | Type | Description | Notes ## create_employee_statutory_sick_leave -> EmployeeStatutorySickLeaveObject create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave) +> EmployeeStatutorySickLeaveObject create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave, opts) Creates statutory sick leave records @@ -824,11 +879,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant employee_statutory_sick_leave = { "employeeID": "aad6b292-7b94-408b-93f6-e489867e3fb0", "leaveTypeID": "aab78802-e9d3-4bbd-bc87-df858054988f", "startDate": "2020-04-21", "endDate": "2020-04-24", "workPattern": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "isPregnancyRelated": false, "sufficientNotice": true } # EmployeeStatutorySickLeave | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates statutory sick leave records - result = api_instance.create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave) + result = api_instance.create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_employee_statutory_sick_leave: #{e}" @@ -842,6 +901,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **employee_statutory_sick_leave** | [**EmployeeStatutorySickLeave**](EmployeeStatutorySickLeave.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -859,7 +919,7 @@ Name | Type | Description | Notes ## create_employment -> EmploymentObject create_employment(xero_tenant_id, employee_id, employment) +> EmploymentObject create_employment(xero_tenant_id, employee_id, employment, opts) Creates employment detail for a specific employee using a unique employee ID @@ -888,12 +948,16 @@ api_instance = xero_client. -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 +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": "216d80e6-af55-47b1-b718-9457c3f5d2fe", "StartDate": "2020-04-01", "EmployeeNumber": "123ABC", "NICategory": "A" } # Employment | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates employment detail for a specific employee using a unique employee ID - result = api_instance.create_employment(xero_tenant_id, employee_id, employment) + result = api_instance.create_employment(xero_tenant_id, employee_id, employment, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_employment: #{e}" @@ -906,8 +970,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **employment** | [**Employment**](Employment.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -925,7 +990,7 @@ Name | Type | Description | Notes ## create_leave_type -> LeaveTypeObject create_leave_type(xero_tenant_id, leave_type) +> LeaveTypeObject create_leave_type(xero_tenant_id, leave_type, opts) Creates a new leave type @@ -954,11 +1019,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant leave_type = { "name": "My opebvwbfxf Leave", "isPaidLeave": false, "showOnPayslip": true } # LeaveType | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new leave type - result = api_instance.create_leave_type(xero_tenant_id, leave_type) + result = api_instance.create_leave_type(xero_tenant_id, leave_type, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_leave_type: #{e}" @@ -972,6 +1041,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **leave_type** | [**LeaveType**](LeaveType.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -989,7 +1059,7 @@ Name | Type | Description | Notes ## create_multiple_employee_earnings_template -> EmployeePayTemplates create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) +> EmployeePayTemplates create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts) Creates multiple earnings template records for a specific employee using a unique employee ID @@ -1018,12 +1088,16 @@ api_instance = xero_client. -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 +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":"87f5b43a-cf51-4b74-92de-94c819e82d27" }, { "ratePerUnit":20.0, "numberOfUnits":8.0, "earningsRateID":"973365f3-66b2-4c33-8ae6-14b75f78f68b" } ] # Array | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates multiple earnings template records for a specific employee using a unique employee ID - result = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template) + result = api_instance.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_multiple_employee_earnings_template: #{e}" @@ -1036,8 +1110,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **earnings_template** | [**Array<EarningsTemplate>**](EarningsTemplate.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1055,7 +1130,7 @@ Name | Type | Description | Notes ## create_pay_run_calendar -> PayRunCalendarObject create_pay_run_calendar(xero_tenant_id, pay_run_calendar) +> PayRunCalendarObject create_pay_run_calendar(xero_tenant_id, pay_run_calendar, opts) Creates a new payrun calendar @@ -1084,11 +1159,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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 | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new payrun calendar - result = api_instance.create_pay_run_calendar(xero_tenant_id, pay_run_calendar) + result = api_instance.create_pay_run_calendar(xero_tenant_id, pay_run_calendar, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_pay_run_calendar: #{e}" @@ -1102,6 +1181,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **pay_run_calendar** | [**PayRunCalendar**](PayRunCalendar.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1119,7 +1199,7 @@ Name | Type | Description | Notes ## create_reimbursement -> ReimbursementObject create_reimbursement(xero_tenant_id, reimbursement) +> ReimbursementObject create_reimbursement(xero_tenant_id, reimbursement, opts) Creates a new reimbursement @@ -1148,11 +1228,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant reimbursement = { "name": "My new Reimburse", "accountID": "9ee28149-32a9-4661-8eab-a28738696983" } # Reimbursement | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new reimbursement - result = api_instance.create_reimbursement(xero_tenant_id, reimbursement) + result = api_instance.create_reimbursement(xero_tenant_id, reimbursement, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_reimbursement: #{e}" @@ -1166,6 +1250,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **reimbursement** | [**Reimbursement**](Reimbursement.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1183,7 +1268,7 @@ Name | Type | Description | Notes ## create_timesheet -> TimesheetObject create_timesheet(xero_tenant_id, timesheet) +> TimesheetObject create_timesheet(xero_tenant_id, timesheet, opts) Creates a new timesheet @@ -1212,11 +1297,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant timesheet = { "payrollCalendarID": "216d80e6-af55-47b1-b718-9457c3f5d2fe", "employeeID": "aad6b292-7b94-408b-93f6-e489867e3fb0", "startDate": "2020-04-13", "endDate": "2020-04-19", "timesheetLines": [ { "date": "2020-04-13", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 8 }, { "date": "2020-04-15", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 6 } ] } # Timesheet | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new timesheet - result = api_instance.create_timesheet(xero_tenant_id, timesheet) + result = api_instance.create_timesheet(xero_tenant_id, timesheet, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_timesheet: #{e}" @@ -1230,6 +1319,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **timesheet** | [**Timesheet**](Timesheet.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1247,7 +1337,7 @@ Name | Type | Description | Notes ## create_timesheet_line -> TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line) +> TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, opts) Creates a new timesheet line for a specific timesheet using a unique timesheet ID @@ -1276,12 +1366,16 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet timesheet_line = { "date": "2020-04-14", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 1 } # TimesheetLine | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new timesheet line for a specific timesheet using a unique timesheet ID - result = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line) + result = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->create_timesheet_line: #{e}" @@ -1294,8 +1388,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **timesheet_id** | [**String**](.md)| Identifier for the timesheet | + **timesheet_id** | **String**| Identifier for the timesheet | **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1342,9 +1437,9 @@ api_instance = xero_client. -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 +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 a specific employee's earnings template record api_instance.delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id) @@ -1359,8 +1454,8 @@ end 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 | + **employee_id** | **String**| Employee id for single object | + **pay_template_earning_id** | **String**| Id for single pay template earnings object | ### Return type @@ -1407,9 +1502,9 @@ api_instance = xero_client. -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 +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 a specific employee's leave record result = api_instance.delete_employee_leave(xero_tenant_id, employee_id, leave_id) @@ -1425,8 +1520,8 @@ end 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_id** | **String**| Employee id for single object | + **leave_id** | **String**| Leave id for single object | ### Return type @@ -1473,9 +1568,9 @@ api_instance = xero_client. -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 +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 a salary and wages record for a specific employee api_instance.delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) @@ -1490,8 +1585,8 @@ end 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 | + **employee_id** | **String**| Employee id for single object | + **salary_and_wages_id** | **String**| Id for single salary and wages object | ### Return type @@ -1538,8 +1633,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet begin #Deletes a specific timesheet result = api_instance.delete_timesheet(xero_tenant_id, timesheet_id) @@ -1555,7 +1650,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **timesheet_id** | [**String**](.md)| Identifier for the timesheet | + **timesheet_id** | **String**| Identifier for the timesheet | ### Return type @@ -1602,9 +1697,9 @@ api_instance = xero_client. -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 +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet +timesheet_line_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet line begin #Deletes a specific timesheet line result = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id) @@ -1620,8 +1715,8 @@ end 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_id** | **String**| Identifier for the timesheet | + **timesheet_line_id** | **String**| Identifier for the timesheet line | ### Return type @@ -1668,8 +1763,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -id = 'id_example' # String | Identifier for the benefit +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the benefit begin #Retrieves a specific benefit by using a unique benefit ID result = api_instance.get_benefit(xero_tenant_id, id) @@ -1685,7 +1780,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **id** | [**String**](.md)| Identifier for the benefit | + **id** | **String**| Identifier for the benefit | ### Return type @@ -1732,7 +1827,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. } @@ -1799,8 +1894,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -deduction_id = 'deduction_id_example' # String | Identifier for the deduction +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +deduction_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the deduction begin #Retrieves a specific deduction by using a unique deduction ID result = api_instance.get_deduction(xero_tenant_id, deduction_id) @@ -1816,7 +1911,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **deduction_id** | [**String**](.md)| Identifier for the deduction | + **deduction_id** | **String**| Identifier for the deduction | ### Return type @@ -1863,7 +1958,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. } @@ -1930,8 +2025,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -id = 'id_example' # String | Identifier for the deduction +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the deduction begin #Retrieves a specific earnings orders by using a unique earnings orders id result = api_instance.get_earnings_order(xero_tenant_id, id) @@ -1947,7 +2042,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **id** | [**String**](.md)| Identifier for the deduction | + **id** | **String**| Identifier for the deduction | ### Return type @@ -1994,7 +2089,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. } @@ -2061,8 +2156,8 @@ api_instance = xero_client. -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 +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +earnings_rate_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the earnings rate begin #Retrieves a specific earnings rates by using a unique earnings rate id result = api_instance.get_earnings_rate(xero_tenant_id, earnings_rate_id) @@ -2078,7 +2173,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **earnings_rate_id** | [**String**](.md)| Identifier for the earnings rate | + **earnings_rate_id** | **String**| Identifier for the earnings rate | ### Return type @@ -2125,7 +2220,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. } @@ -2192,8 +2287,8 @@ api_instance = xero_client. -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 +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 specific employees by using a unique employee ID result = api_instance.get_employee(xero_tenant_id, employee_id) @@ -2209,7 +2304,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2256,9 +2351,9 @@ api_instance = xero_client. -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 +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 #Retrieves a specific employee's leave record using a unique employee ID result = api_instance.get_employee_leave(xero_tenant_id, employee_id, leave_id) @@ -2274,8 +2369,8 @@ end 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_id** | **String**| Employee id for single object | + **leave_id** | **String**| Leave id for single object | ### Return type @@ -2322,8 +2417,8 @@ api_instance = xero_client. -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 +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 a specific employee's leave balances using a unique employee ID result = api_instance.get_employee_leave_balances(xero_tenant_id, employee_id) @@ -2339,7 +2434,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2386,12 +2481,12 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -employee_id = '00000000-0000-0000-0000-000000000000' # String | Employee id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +employee_id = 00000000-0000-0000-0000-000000000000 # String | Employee id for single object opts = { - start_date: Date.parse('2013-10-20'), # Date | Filter by start date + start_date: 2013-10-20, # Date | Filter by start date - end_date: Date.parse('2013-10-20') # Date | Filter by end date + end_date: 2013-10-20 # Date | Filter by end date } begin @@ -2409,7 +2504,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **start_date** | **Date**| Filter by start date | [optional] **end_date** | **Date**| Filter by end date | [optional] @@ -2458,8 +2553,8 @@ api_instance = xero_client. -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 +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 a specific employee's leave types using a unique employee ID result = api_instance.get_employee_leave_types(xero_tenant_id, employee_id) @@ -2475,7 +2570,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2522,8 +2617,8 @@ api_instance = xero_client. -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 +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 a specific employee's leave records using a unique employee ID result = api_instance.get_employee_leaves(xero_tenant_id, employee_id) @@ -2539,7 +2634,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2586,8 +2681,8 @@ api_instance = xero_client. -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 +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 a specific employee's openingbalances using a unique employee ID result = api_instance.get_employee_opening_balances(xero_tenant_id, employee_id) @@ -2603,7 +2698,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2650,8 +2745,8 @@ api_instance = xero_client. -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 +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 a specific employee pay templates using a unique employee ID result = api_instance.get_employee_pay_template(xero_tenant_id, employee_id) @@ -2667,7 +2762,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2714,8 +2809,8 @@ api_instance = xero_client. -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 +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 a specific employee's payment method using a unique employee ID result = api_instance.get_employee_payment_method(xero_tenant_id, employee_id) @@ -2731,7 +2826,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -2778,9 +2873,9 @@ api_instance = xero_client. -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 +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 #Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id result = api_instance.get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id) @@ -2796,8 +2891,8 @@ end 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 | + **employee_id** | **String**| Employee id for single object | + **salary_and_wages_id** | **String**| Id for single pay template earnings object | ### Return type @@ -2844,8 +2939,8 @@ api_instance = xero_client. -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 +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. } @@ -2865,7 +2960,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| 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 @@ -2913,12 +3008,12 @@ api_instance = xero_client. -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 +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 = { - leave_type: 'sick', # String | Filter by the type of statutory leave + leave_type: sick, # String | Filter by the type of statutory leave - as_of_date: Date.parse('2013-10-20') # Date | The date from which to calculate balance remaining. If not specified, current date UTC is used. + as_of_date: 2013-10-20 # Date | The date from which to calculate balance remaining. If not specified, current date UTC is used. } begin @@ -2936,7 +3031,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **leave_type** | **String**| Filter by the type of statutory leave | [optional] **as_of_date** | **Date**| The date from which to calculate balance remaining. If not specified, current date UTC is used. | [optional] @@ -2985,8 +3080,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -statutory_sick_leave_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Statutory sick leave id for single object +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +statutory_sick_leave_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c # String | Statutory sick leave id for single object begin #Retrieves a statutory sick leave for an employee result = api_instance.get_employee_statutory_sick_leave(xero_tenant_id, statutory_sick_leave_id) @@ -3002,7 +3097,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **statutory_sick_leave_id** | [**String**](.md)| Statutory sick leave id for single object | + **statutory_sick_leave_id** | **String**| Statutory sick leave id for single object | ### Return type @@ -3049,8 +3144,8 @@ api_instance = xero_client. -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 +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 tax records for a specific employee using a unique employee ID result = api_instance.get_employee_tax(xero_tenant_id, employee_id) @@ -3066,7 +3161,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | ### Return type @@ -3113,9 +3208,9 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { - filter: 'firstName==John,lastName==Smith,isOffPayrollWorker==false', # String | Filter by first name, lastname, and/or whether they are an off-payroll worker + filter: firstName==John,lastName==Smith,isOffPayrollWorker==false, # String | Filter by first name, lastname, and/or whether they are an off-payroll worker page: 5 # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. } @@ -3183,8 +3278,8 @@ api_instance = xero_client. -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 +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +leave_type_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the leave type begin #Retrieves a specific leave type by using a unique leave type ID result = api_instance.get_leave_type(xero_tenant_id, leave_type_id) @@ -3200,7 +3295,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **leave_type_id** | [**String**](.md)| Identifier for the leave type | + **leave_type_id** | **String**| Identifier for the leave type | ### Return type @@ -3247,7 +3342,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. @@ -3317,8 +3412,8 @@ api_instance = xero_client. -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 +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +pay_run_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the pay run begin #Retrieves a specific pay run by using a unique pay run ID result = api_instance.get_pay_run(xero_tenant_id, pay_run_id) @@ -3334,7 +3429,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **pay_run_id** | [**String**](.md)| Identifier for the pay run | + **pay_run_id** | **String**| Identifier for the pay run | ### Return type @@ -3381,8 +3476,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -pay_run_calendar_id = 'pay_run_calendar_id_example' # String | Identifier for the payrun calendars +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +pay_run_calendar_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the payrun calendars begin #Retrieves a specific payrun calendar by using a unique payrun calendar ID result = api_instance.get_pay_run_calendar(xero_tenant_id, pay_run_calendar_id) @@ -3398,7 +3493,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **pay_run_calendar_id** | [**String**](.md)| Identifier for the payrun calendars | + **pay_run_calendar_id** | **String**| Identifier for the payrun calendars | ### Return type @@ -3445,7 +3540,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. } @@ -3512,11 +3607,11 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. + status: Draft # 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 @@ -3582,8 +3677,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -payslip_id = 'payslip_id_example' # String | Identifier for the payslip +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +payslip_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the payslip begin #Retrieves a specific payslip by using a unique payslip ID result = api_instance.get_pay_slip(xero_tenant_id, payslip_id) @@ -3599,7 +3694,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **payslip_id** | [**String**](.md)| Identifier for the payslip | + **payslip_id** | **String**| Identifier for the payslip | ### Return type @@ -3646,8 +3741,8 @@ api_instance = xero_client. -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. +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +pay_run_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # 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. } @@ -3667,7 +3762,7 @@ end 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. | + **pay_run_id** | **String**| 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 @@ -3715,8 +3810,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -reimbursement_id = 'reimbursement_id_example' # String | Identifier for the reimbursement +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +reimbursement_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the reimbursement begin #Retrieves a specific reimbursement by using a unique reimbursement id result = api_instance.get_reimbursement(xero_tenant_id, reimbursement_id) @@ -3732,7 +3827,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **reimbursement_id** | [**String**](.md)| Identifier for the reimbursement | + **reimbursement_id** | **String**| Identifier for the reimbursement | ### Return type @@ -3779,7 +3874,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +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. } @@ -3846,7 +3941,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant begin #Retrieves payroll settings result = api_instance.get_settings(xero_tenant_id) @@ -3908,8 +4003,8 @@ api_instance = xero_client. -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 +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 = { active_only: true # Boolean | Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future scheduled) are returned } @@ -3929,7 +4024,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **active_only** | **Boolean**| Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future scheduled) are returned | [optional] ### Return type @@ -3977,8 +4072,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet begin #Retrieve a specific timesheet by using a unique timesheet ID result = api_instance.get_timesheet(xero_tenant_id, timesheet_id) @@ -3994,7 +4089,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **timesheet_id** | [**String**](.md)| Identifier for the timesheet | + **timesheet_id** | **String**| Identifier for the timesheet | ### Return type @@ -4041,19 +4136,19 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { page: 5, # Integer | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - filter: 'employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000', # String | Filter by employeeId and/or payrollCalendarId + filter: employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000, # String | Filter by employeeId and/or payrollCalendarId - status: 'Draft', # String | filter results by any timesheets with a matching timesheet status + status: Draft, # String | filter results by any timesheets with a matching timesheet status - start_date: '2019-01-02', # String | filter results by any timesheets with a startDate on or after the provided date + start_date: 2019-01-02, # String | filter results by any timesheets with a startDate on or after the provided date - end_date: '2020-01-02', # String | filter results by any timesheets with a endDate on or before the provided date + end_date: 2020-01-02, # String | filter results by any timesheets with a endDate on or before the provided date - sort: 'startDate' # String | sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. + sort: startDate # String | sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. } begin @@ -4123,7 +4218,7 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant begin #Retrieves tracking categories result = api_instance.get_tracking_categories(xero_tenant_id) @@ -4156,7 +4251,7 @@ Name | Type | Description | Notes ## revert_timesheet -> TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id) +> TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id, opts) Reverts a specific timesheet to draft @@ -4185,11 +4280,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -timesheet_id = 'timesheet_id_example' # String | Identifier for the timesheet +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Reverts a specific timesheet to draft - result = api_instance.revert_timesheet(xero_tenant_id, timesheet_id) + result = api_instance.revert_timesheet(xero_tenant_id, timesheet_id, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->revert_timesheet: #{e}" @@ -4202,7 +4301,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **timesheet_id** | [**String**](.md)| Identifier for the timesheet | + **timesheet_id** | **String**| Identifier for the timesheet | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4220,7 +4320,7 @@ Name | Type | Description | Notes ## update_employee -> EmployeeObject update_employee(xero_tenant_id, employee_id, employee) +> EmployeeObject update_employee(xero_tenant_id, employee_id, employee, opts) Updates a specific employee's detail @@ -4249,12 +4349,16 @@ api_instance = xero_client. -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 +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": "TestDataUK", "lastName": "Tester", "dateOfBirth": "1992-11-22T00:00:00", "gender": "M", "email": "tester@gmail.com", "phoneNumber": "0400123456", "isOffPayrollWorker": false, "address": { "addressLine1": "171 Midsummer", "city": "Milton Keyness", "postCode": "MK9 1EB" } } # Employee | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific employee's detail - result = api_instance.update_employee(xero_tenant_id, employee_id, employee) + result = api_instance.update_employee(xero_tenant_id, employee_id, employee, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->update_employee: #{e}" @@ -4267,8 +4371,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **employee** | [**Employee**](Employee.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4286,7 +4391,7 @@ Name | Type | Description | Notes ## update_employee_earnings_template -> EarningsTemplateObject update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template) +> EarningsTemplateObject update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts) Updates a specific employee's earnings template records @@ -4315,13 +4420,17 @@ api_instance = xero_client. -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 +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": 30, "numberOfUnits": 4, "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27" } # EarningsTemplate | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific employee's earnings template records - result = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template) + result = api_instance.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->update_employee_earnings_template: #{e}" @@ -4334,9 +4443,10 @@ end 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 | + **employee_id** | **String**| Employee id for single object | + **pay_template_earning_id** | **String**| Id for single pay template earnings object | **earnings_template** | [**EarningsTemplate**](EarningsTemplate.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4354,7 +4464,7 @@ Name | Type | Description | Notes ## update_employee_leave -> EmployeeLeaveObject update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave) +> EmployeeLeaveObject update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, opts) Updates a specific employee's leave records @@ -4383,13 +4493,17 @@ api_instance = xero_client. -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 +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": "ed08dffe-788e-4b24-9630-f0fa2f4d164c", "description": "Creating a Description", "startDate": "2020-04-24", "endDate": "2020-04-26", "periods": [ { "periodStartDate": "2020-04-20", "periodEndDate": "2020-04-26", "numberOfUnits": 1, "periodStatus": "Approved" } ] } # EmployeeLeave | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific employee's leave records - result = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave) + result = api_instance.update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->update_employee_leave: #{e}" @@ -4402,9 +4516,10 @@ end 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_id** | **String**| Employee id for single object | + **leave_id** | **String**| Leave id for single object | **employee_leave** | [**EmployeeLeave**](EmployeeLeave.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4422,7 +4537,7 @@ Name | Type | Description | Notes ## update_employee_opening_balances -> EmployeeOpeningBalancesObject update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances) +> EmployeeOpeningBalancesObject update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, opts) Updates a specific employee's opening balances @@ -4451,12 +4566,16 @@ api_instance = xero_client. -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 +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_balances = { "statutoryAdoptionPay": 20, "statutoryMaternityPay": 20, "statutoryPaternityPay": 20, "statutorySharedParentalPay": 20, "statutorySickPay": 20, "priorEmployeeNumber": 20 } # EmployeeOpeningBalances | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific employee's opening balances - result = api_instance.update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances) + result = api_instance.update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->update_employee_opening_balances: #{e}" @@ -4469,8 +4588,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **employee_id** | [**String**](.md)| Employee id for single object | + **employee_id** | **String**| Employee id for single object | **employee_opening_balances** | [**EmployeeOpeningBalances**](EmployeeOpeningBalances.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4488,7 +4608,7 @@ Name | Type | Description | Notes ## update_employee_salary_and_wage -> SalaryAndWageObject update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage) +> SalaryAndWageObject update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts) Updates salary and wages record for a specific employee @@ -4517,13 +4637,17 @@ api_instance = xero_client. -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 +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": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnitsPerWeek": 3, "ratePerUnit": 11, "effectiveFrom": "2020-05-15", "annualSalary": 101, "status": "ACTIVE", "paymentType": "Salary" } # SalaryAndWage | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates salary and wages record for a specific employee - result = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage) + result = api_instance.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->update_employee_salary_and_wage: #{e}" @@ -4536,9 +4660,10 @@ end 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 | + **employee_id** | **String**| Employee id for single object | + **salary_and_wages_id** | **String**| Id for single pay template earnings object | **salary_and_wage** | [**SalaryAndWage**](SalaryAndWage.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4556,7 +4681,7 @@ Name | Type | Description | Notes ## update_pay_run -> PayRunObject update_pay_run(xero_tenant_id, pay_run_id, pay_run) +> PayRunObject update_pay_run(xero_tenant_id, pay_run_id, pay_run, opts) Updates a specific pay run @@ -4585,12 +4710,16 @@ api_instance = xero_client. -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 +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +pay_run_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the pay run pay_run = { "paymentDate": "2020-05-01" } # PayRun | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific pay run - result = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run) + result = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->update_pay_run: #{e}" @@ -4603,8 +4732,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **pay_run_id** | [**String**](.md)| Identifier for the pay run | + **pay_run_id** | **String**| Identifier for the pay run | **pay_run** | [**PayRun**](PayRun.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4622,7 +4752,7 @@ Name | Type | Description | Notes ## update_timesheet_line -> TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line) +> TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts) Updates a specific timesheet line for a specific timesheet @@ -4651,13 +4781,17 @@ api_instance = xero_client. -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 +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +timesheet_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet +timesheet_line_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier for the timesheet line timesheet_line = { "date": "2020-04-14", "earningsRateID": "87f5b43a-cf51-4b74-92de-94c819e82d27", "numberOfUnits": 2 } # TimesheetLine | +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific timesheet line for a specific timesheet - result = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line) + result = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts) p result rescue XeroRuby::PayrollUk::ApiError => e puts "Exception when calling PayrollUkApi->update_timesheet_line: #{e}" @@ -4670,9 +4804,10 @@ end 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_id** | **String**| Identifier for the timesheet | + **timesheet_line_id** | **String**| Identifier for the timesheet line | **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type diff --git a/docs/payroll_uk/Timesheet.md b/docs/payroll_uk/Timesheet.md index c1e90911..75a73c53 100644 --- a/docs/payroll_uk/Timesheet.md +++ b/docs/payroll_uk/Timesheet.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **end_date** | **Date** | The End Date of the Timesheet period (YYYY-MM-DD) | **status** | **String** | Status of the timesheet | [optional] **total_hours** | **Float** | The Total Hours of the Timesheet | [optional] -**updated_date_utc** | **DateTime** | The UTC date time that the Timesheet was last updated | [optional] +**updated_date_utc** | **Time** | The UTC date time that the Timesheet was last updated | [optional] **timesheet_lines** | [**Array<TimesheetLine>**](TimesheetLine.md) | | [optional] ## Code Sample diff --git a/docs/payroll_uk/index.html b/docs/payroll_uk/index.html deleted file mode 100644 index 6e45eea6..00000000 --- a/docs/payroll_uk/index.html +++ /dev/null @@ -1,14904 +0,0 @@ - - - - - Xero Payroll UK - - - - - - xero-ruby PayrollUk SDK Docs - - - - - - - - - - - - - - - - - - -
- -
- -
-
- - -
-
- -
-
- -
-
-
-
-
- -
-
-
-
-

Xero Payroll UK

-
-
-
- -
-
-

PayrollUk

-
-
-
-

approveTimesheet

-

Approves a specific timesheet

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}/Approve
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.approve_timesheet(xero_tenant_id, timesheet_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling approve_timesheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

createBenefit

-

Creates a new employee benefit

-
-
-
-

-

-

-
- 
/Benefits
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-benefit = { 
-  name: "Benefit Name",
-  expense_account_id: "00000000-0000-0000-0000-000000000000",
-  liability_account_id: "00000000-0000-0000-0000-000000000000",
-  is_calculating_on_qualifying_earnings: true
-}  
-
-begin
-  response = xero_client.accounting_api.create_benefit(xero_tenant_id, benefit)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_benefit: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
benefit * -
-
- - Benefit - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createDeduction

-

Creates a new deduction

-
-
-
-

-

-

-
- 
/Deductions
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-deduction = { 
-  deduction_name: "Test Deduction",
-  deduction_category:  XeroRuby::PayrollUk::Deduction::deduction_category_enum::STAKEHOLDERPENSION,
-  liability_account_id: "00000000-0000-0000-0000-000000000000",
-  calculation_type:  XeroRuby::PayrollUk::Deduction::calculation_type_enum::PERCENTAGEOFGROSS
-}  
-
-begin
-  response = xero_client.accounting_api.create_deduction(xero_tenant_id, deduction)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_deduction: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
deduction * -
-
- - Deduction - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEarningsRate

-

Creates a new earnings rate

-
-
-
-

-

-

-
- 
/EarningsRates
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-earnings_rate = { 
-  earnings_type:  XeroRuby::PayrollUk::EarningsRate::earnings_type_enum::REGULAREARNINGS,
-  rate_type:  XeroRuby::PayrollUk::EarningsRate::RateTypeEnum::ACCPAYCREDIT,
-  expense_account_id: "00000000-0000-0000-0000-000000000000",
-  type_of_units: "Type"
-}  
-
-begin
-  response = xero_client.accounting_api.create_earnings_rate(xero_tenant_id, earningsRate)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_earnings_rate: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
earningsRate * -
-
- - EarningsRate - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployee

-

Creates employees

-
-
-
-

-

-

-
- 
/Employees
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-date_of_birth = 'YYYY-MM-DD'
-
-address = { 
-  address_line_1: "123 Test st",
-  city: "Rangiora",
-  post_code: "7400",
-  country_name: "UNITED KINGDOM"
-}  
-
-employee = { 
-  first_name: "Adam",
-  last_name: "Adamson",
-  date_of_birth:  date_of_birth,
-  address:  address
-}  
-
-begin
-  response = xero_client.accounting_api.create_employee(xero_tenant_id, employee)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employee * -
-
- - Employee - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployeeEarningsTemplate

-

Creates an earnings template records for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/PayTemplates/earnings
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-earnings_template = { 
-  pay_template_earning_id: "00000000-0000-0000-0000-000000000000",
-  rate_per_unit: 14.25,
-  number_of_units: 35.5,
-  fixed_amount: 50,
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  name: "Overtime Hours"
-}    
-earnings_templates = []
-earnings_templates << earnings_template
-
-begin
-  response = xero_client.accounting_api.create_employee_earnings_template(xero_tenant_id, employee_id, earningsTemplate)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee_earnings_template: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
earningsTemplate * -
-
- - EarningsTemplate - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployeeLeave

-

Creates leave records for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/Leave
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-start_date = 'YYYY-MM-DD'
-end_date = 'YYYY-MM-DD'
-
-employee_leave = { 
-  leave_type_id: "00000000-0000-0000-0000-000000000000",
-  start_date:  start_date,
-  end_date:  end_date
-}  
-
-begin
-  response = xero_client.accounting_api.create_employee_leave(xero_tenant_id, employee_id, employeeLeave)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee_leave: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employeeLeave * -
-
- - EmployeeLeave - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployeeLeaveType

-

Creates employee leave type records

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/LeaveTypes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-employee_leave_type = { 
-  leave_type_id: "00000000-0000-0000-0000-000000000000",
-  schedule_of_accrual:  XeroRuby::PayrollUk::EmployeeLeaveType::schedule_of_accrual::BEGINNINGOFCALENDARYEAR,
-  opening_balance: 5.25
-}  
-
-begin
-  response = xero_client.accounting_api.create_employee_leave_type(xero_tenant_id, employee_id, employeeLeaveType)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee_leave_type: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employeeLeaveType * -
-
- - EmployeeLeaveType - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployeeOpeningBalances

-

Creates an opening balance for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/ukopeningbalances
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-employee_opening_balances = { 
-  statutory_maternity_pay: 0.0,
-  statutory_adoption_pay: 100.0,
-  statutory_paternity_pay: 0.0,
-  statutory_shared_parental_pay: 0.0,
-  statutory_sick_pay: 0.0
-}  
-
-begin
-  response = xero_client.accounting_api.create_employee_opening_balances(xero_tenant_id, employee_id, employeeOpeningBalances)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee_opening_balances: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employeeOpeningBalances * -
-
- - EmployeeOpeningBalances - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployeePaymentMethod

-

Creates an employee payment method

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/PaymentMethods
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-bank_account = { 
-  account_name: "Charlotte Danes",
-  account_number: "123456",
-  sort_code: "123411"
-}    
-bank_accounts = []
-bank_accounts << bank_account
-
-payment_method = { 
-  bankAccounts: bankAccounts
-}  
-
-begin
-  response = xero_client.accounting_api.create_employee_payment_method(xero_tenant_id, employee_id, paymentMethod)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee_payment_method: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
paymentMethod * -
-
- - PaymentMethod - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployeeSalaryAndWage

-

Creates a salary and wage record for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/SalaryAndWages
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-salary_and_wage = { 
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  number_of_units_per_day: 0,
-  number_of_units_per_week: 0,
-  payment_type:  XeroRuby::PayrollUk::SalaryAndWage::payment_type_enum::SALARY,
-  status:  XeroRuby::PayrollUk::SalaryAndWage::status_enum::ACTIVE
-}  
-
-begin
-  response = xero_client.accounting_api.create_employee_salary_and_wage(xero_tenant_id, employee_id, salaryAndWage)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee_salary_and_wage: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
salaryAndWage * -
-
- - SalaryAndWage - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployeeStatutorySickLeave

-

Creates statutory sick leave records

-
-
-
-

-

-

-
- 
/StatutoryLeaves/Sick
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-start_date = 'YYYY-MM-DD'
-end_date = 'YYYY-MM-DD'
-
-employee_statutory_sick_leave = { 
-  is_pregnancy_related: true,
-  leave_type_id: "00000000-0000-0000-0000-000000000000",
-  start_date:  start_date,
-  end_date:  end_date
-}  
-
-begin
-  response = xero_client.accounting_api.create_employee_statutory_sick_leave(xero_tenant_id, employeeStatutorySickLeave)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employee_statutory_sick_leave: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employeeStatutorySickLeave * -
-
- - EmployeeStatutorySickLeave - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createEmployment

-

Creates employment detail for a specific employee using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/Employment
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-start_date = 'YYYY-MM-DD'
-
-employment = { 
-  payroll_calendar_id: "00000000-0000-0000-0000-000000000000",
-  start_date:  start_date
-}  
-
-begin
-  response = xero_client.accounting_api.create_employment(xero_tenant_id, employee_id, employment)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_employment: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employment * -
-
- - Employment - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createLeaveType

-

Creates a new leave type

-
-
-
-

-

-

-
- 
/LeaveTypes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-leave_type = { 
-  name: "LeaveType",
-  is_paid_leave: true,
-  show_on_payslip: true
-}  
-
-begin
-  response = xero_client.accounting_api.create_leave_type(xero_tenant_id, leaveType)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_leave_type: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
leaveType * -
-
- - LeaveType - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createMultipleEmployeeEarningsTemplate

-

Creates multiple earnings template records for a specific employee using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/paytemplateearnings
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-earnings_template = { 
-  pay_template_earning_id: "00000000-0000-0000-0000-000000000000",
-  rate_per_unit: 14.25,
-  number_of_units: 35.5,
-  fixed_amount: 50,
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  name: "Overtime Hours"
-}    
-earnings_templates = []
-earnings_templates << earnings_template
-
-begin
-  response = xero_client.accounting_api.create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earningsTemplate)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_multiple_employee_earnings_template: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
earningsTemplate * -
-
- - array[EarningsTemplate] - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createPayRunCalendar

-

Creates a new payrun calendar

-
-
-
-

-

-

-
- 
/PayRunCalendars
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-start_date = 'YYYY-MM-DD'
-payment_date = 'YYYY-MM-DD'
-
-pay_run_calendar = { 
-  calendar_type:  XeroRuby::PayrollUk::PayRunCalendar::calendar_type_enum::WEEKLY,
-  period_start_date:  start_date,
-  payment_date:  payment_date
-}  
-
-begin
-  response = xero_client.accounting_api.create_pay_run_calendar(xero_tenant_id, payRunCalendar)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_pay_run_calendar: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
payRunCalendar * -
-
- - PayRunCalendar - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createReimbursement

-

Creates a new reimbursement

-
-
-
-

-

-

-
- 
/Reimbursements
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-reimbursement = { 
-  name: "Test Reimbursement",
-  account_id: "00000000-0000-0000-0000-000000000000"
-}  
-
-begin
-  response = xero_client.accounting_api.create_reimbursement(xero_tenant_id, reimbursement)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_reimbursement: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.settingsGrant read-write access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
reimbursement * -
-
- - Reimbursement - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createTimesheet

-

Creates a new timesheet

-
-
-
-

-

-

-
- 
/Timesheets
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-start_date = 'YYYY-MM-DD'
-end_date = 'YYYY-MM-DD'
-
-timesheet = { 
-  payroll_calendar_id: "00000000-0000-0000-0000-000000000000",
-  employee_id: "00000000-0000-0000-0000-000000000000",
-  start_date:  start_date,
-  end_date:  end_date
-}  
-
-begin
-  response = xero_client.accounting_api.create_timesheet(xero_tenant_id, timesheet)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_timesheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
timesheet * -
-
- - Timesheet - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createTimesheetLine

-

Creates a new timesheet line for a specific timesheet using a unique timesheet ID

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}/Lines
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-date = 'YYYY-MM-DD'
-
-timesheet_line = { 
-  timesheet_line_id: "00000000-0000-0000-0000-000000000000",
-  date:  date,
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  tracking_item_id: "00000000-0000-0000-0000-000000000000",
-  number_of_units: 6
-}  
-
-begin
-  response = xero_client.accounting_api.create_timesheet_line(xero_tenant_id, timesheet_id, timesheetLine)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_timesheet_line: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
timesheetLine * -
-
- - TimesheetLine - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

deleteEmployeeEarningsTemplate

-

Deletes a specific employee's earnings template record

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
-
-begin
-  response = xero_client.accounting_api.delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_employee_earnings_template: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
PayTemplateEarningID* - - -
-
-
- - UUID - - - (uuid) - - -
-Id for single pay template earnings object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteEmployeeLeave

-

Deletes a specific employee's leave record

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/Leave/{LeaveID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314'
-
-begin
-  response = xero_client.accounting_api.delete_employee_leave(xero_tenant_id, employee_id, leave_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_employee_leave: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
LeaveID* - - -
-
-
- - UUID - - - (uuid) - - -
-Leave id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteEmployeeSalaryAndWage

-

Deletes a salary and wages record for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
-
-begin
-  response = xero_client.accounting_api.delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_employee_salary_and_wage: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
SalaryAndWagesID* - - -
-
-
- - UUID - - - (uuid) - - -
-Id for single salary and wages object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteTimesheet

-

Deletes a specific timesheet

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.delete_timesheet(xero_tenant_id, timesheet_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_timesheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteTimesheetLine

-

Deletes a specific timesheet line

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-timesheet_line_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_timesheet_line: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet -
-
-
- Required -
-
-
-
TimesheetLineID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet line -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBenefit

-

Retrieves a specific benefit by using a unique benefit ID

-
-
-
-

-

-

-
- 
/Benefits/{id}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_benefit(xero_tenant_id, id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_benefit: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
id* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the benefit -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getBenefits

-

Retrieves employee benefits

-
-
-
-

-

-

-
- 
/Benefits
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_benefits(xero_tenant_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_benefits: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getDeduction

-

Retrieves a specific deduction by using a unique deduction ID

-
-
-
-

-

-

-
- 
/Deductions/{deductionId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-deduction_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_deduction(xero_tenant_id, deduction_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_deduction: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
deductionId* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the deduction -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getDeductions

-

Retrieves deductions

-
-
-
-

-

-

-
- 
/Deductions
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_deductions(xero_tenant_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_deductions: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getEarningsOrder

-

Retrieves a specific earnings orders by using a unique earnings orders id

-
-
-
-

-

-

-
- 
/EarningsOrders/{id}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_earnings_order(xero_tenant_id, id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_earnings_order: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
id* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the deduction -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEarningsOrders

-

Retrieves earnings orders

-
-
-
-

-

-

-
- 
/EarningsOrders
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_earnings_orders(xero_tenant_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_earnings_orders: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getEarningsRate

-

Retrieves a specific earnings rates by using a unique earnings rate id

-
-
-
-

-

-

-
- 
/EarningsRates/{EarningsRateID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-earnings_rate_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_earnings_rate(xero_tenant_id, earnings_rate_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_earnings_rate: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EarningsRateID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the earnings rate -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEarningsRates

-

Retrieves earnings rates

-
-
-
-

-

-

-
- 
/EarningsRates
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_earnings_rates(xero_tenant_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_earnings_rates: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getEmployee

-

Retrieves specific employees by using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeeLeave

-

Retrieves a specific employee's leave record using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/Leave/{LeaveID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314'
-
-begin
-  response = xero_client.accounting_api.get_employee_leave(xero_tenant_id, employee_id, leave_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_leave: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
LeaveID* - - -
-
-
- - UUID - - - (uuid) - - -
-Leave id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeeLeaveBalances

-

Retrieves a specific employee's leave balances using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/LeaveBalances
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_leave_balances(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_leave_balances: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeeLeavePeriods

-

Retrieves a specific employee's leave periods using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/LeavePeriods
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '00000000-0000-0000-0000-000000000000'
-start_date = "2013-10-20"
-end_date = "2013-10-20"
-
-begin
-  response = xero_client.accounting_api.get_employee_leave_periods(xero_tenant_id, employee_id, start_date, end_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_leave_periods: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
startDate - - -
-
-
- - date - - - (date) - - -
-Filter by start date -
-
-
-
-
endDate - - -
-
-
- - date - - - (date) - - -
-Filter by end date -
-
-
-
-
-
-
-
-
-
-
-

getEmployeeLeaveTypes

-

Retrieves a specific employee's leave types using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/LeaveTypes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_leave_types(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_leave_types: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeeLeaves

-

Retrieves a specific employee's leave records using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/Leave
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_leaves(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_leaves: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeeOpeningBalances

-

Retrieves a specific employee's openingbalances using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/ukopeningbalances
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_opening_balances(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_opening_balances: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeePayTemplate

-

Retrieves a specific employee pay templates using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/PayTemplates
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_pay_template(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_pay_template: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeePaymentMethod

-

Retrieves a specific employee's payment method using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/PaymentMethods
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_payment_method(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_payment_method: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeeSalaryAndWage

-

Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
-
-begin
-  response = xero_client.accounting_api.get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_salary_and_wage: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
SalaryAndWagesID* - - -
-
-
- - UUID - - - (uuid) - - -
-Id for single pay template earnings object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeeSalaryAndWages

-

Retrieves a specific employee's salary and wages by using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/SalaryAndWages
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_employee_salary_and_wages(xero_tenant_id, employee_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_salary_and_wages: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getEmployeeStatutoryLeaveBalances

-

Retrieves a specific employee's leave balances using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/StatutoryLeaveBalance
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-leave_type = 'sick'
-as_of_date = "2013-10-20"
-
-begin
-  response = xero_client.accounting_api.get_employee_statutory_leave_balances(xero_tenant_id, employee_id, leave_type, as_of_date)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_statutory_leave_balances: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
LeaveType - - -
-
-
- - String - - -
-Filter by the type of statutory leave -
-
-
-
-
AsOfDate - - -
-
-
- - date - - - (date) - - -
-The date from which to calculate balance remaining. If not specified, current date UTC is used. -
-
-
-
-
-
-
-
-
-
-
-

getEmployeeStatutorySickLeave

-

Retrieves a statutory sick leave for an employee

-
-
-
-

-

-

-
- 
/StatutoryLeaves/Sick/{StatutorySickLeaveID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-statutory_sick_leave_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_statutory_sick_leave(xero_tenant_id, statutory_sick_leave_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_statutory_sick_leave: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
StatutorySickLeaveID* - - -
-
-
- - UUID - - - (uuid) - - -
-Statutory sick leave id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployeeTax

-

Retrieves tax records for a specific employee using a unique employee ID

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/Tax
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-begin
-  response = xero_client.accounting_api.get_employee_tax(xero_tenant_id, employee_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employee_tax: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getEmployees

-

Retrieves employees

-
-
-
-

-

-

-
- 
/Employees
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-filter = 'firstName==John,lastName==Smith,isOffPayrollWorker==false'
-page = 5
-
-begin
-  response = xero_client.accounting_api.get_employees(xero_tenant_id, filter, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_employees: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.employeesGrant read-write access to payroll employees
payroll.employees.readGrant read-only access to payroll employees
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
filter - - -
-
-
- - String - - -
-Filter by first name, lastname, and/or whether they are an off-payroll worker -
-
-
-
-
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getLeaveType

-

Retrieves a specific leave type by using a unique leave type ID

-
-
-
-

-

-

-
- 
/LeaveTypes/{LeaveTypeID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-leave_type_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_leave_type(xero_tenant_id, leave_type_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_leave_type: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
LeaveTypeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the leave type -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getLeaveTypes

-

Retrieves leave types

-
-
-
-

-

-

-
- 
/LeaveTypes
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-active_only = true
-
-begin
-  response = xero_client.accounting_api.get_leave_types(xero_tenant_id, page, active_only)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_leave_types: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
ActiveOnly - - -
-
-
- - Boolean - - -
-Filters leave types by active status. By default the API returns all leave types. -
-
-
-
-
-
-
-
-
-
-
-

getPayRun

-

Retrieves a specific pay run by using a unique pay run ID

-
-
-
-

-

-

-
- 
/PayRuns/{PayRunID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-pay_run_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_pay_run(xero_tenant_id, pay_run_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_run: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.payrunsGrant read-write access to payroll payruns
payroll.payruns.readGrant read-only access to payroll payruns
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PayRunID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the pay run -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPayRunCalendar

-

Retrieves a specific payrun calendar by using a unique payrun calendar ID

-
-
-
-

-

-

-
- 
/PayRunCalendars/{PayRunCalendarID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-pay_run_calendar_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_pay_run_calendar(xero_tenant_id, pay_run_calendar_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_run_calendar: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PayRunCalendarID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the payrun calendars -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPayRunCalendars

-

Retrieves payrun calendars

-
-
-
-

-

-

-
- 
/PayRunCalendars
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_pay_run_calendars(xero_tenant_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_run_calendars: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getPayRuns

-

Retrieves pay runs

-
-
-
-

-

-

-
- 
/PayRuns
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-status = 'status_example'
-
-begin
-  response = xero_client.accounting_api.get_pay_runs(xero_tenant_id, page, status)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_runs: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.payrunsGrant read-write access to payroll payruns
payroll.payruns.readGrant read-only access to payroll payruns
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
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={PayRunStatus} to filter the payruns by status. -
-
-
-
-
-
-
-
-
-
-
-

getPaySlip

-

Retrieves a specific payslip by using a unique payslip ID

-
-
-
-

-

-

-
- 
/Payslips/{PayslipID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-payslip_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_pay_slip(xero_tenant_id, payslip_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_slip: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.payslipGrant read-write access to payroll payslips
payroll.payslip.readGrant read-only access to payroll payslips
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PayslipID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the payslip -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getPaySlips

-

Retrieves payslips

-
-
-
-

-

-

-
- 
/Payslips
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-pay_run_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_pay_slips(xero_tenant_id, pay_run_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_pay_slips: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.payslipGrant read-write access to payroll payslips
payroll.payslip.readGrant read-only access to payroll payslips
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
PayRunID* - - -
-
-
- - UUID - - - (uuid) - - -
-PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun. -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getReimbursement

-

Retrieves a specific reimbursement by using a unique reimbursement id

-
-
-
-

-

-

-
- 
/Reimbursements/{ReimbursementID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-reimbursement_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_reimbursement(xero_tenant_id, reimbursement_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_reimbursement: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
ReimbursementID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the reimbursement -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getReimbursements

-

Retrieves reimbursements

-
-
-
-

-

-

-
- 
/Reimbursements
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 56
-
-begin
-  response = xero_client.accounting_api.get_reimbursements(xero_tenant_id, page)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_reimbursements: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
-
-
-
-
-
-
-

getSettings

-

Retrieves payroll settings

-
-
-
-

-

-

-
- 
/Settings
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-begin
-  response = xero_client.accounting_api.get_settings(xero_tenant_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_settings: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getStatutoryLeaveSummary

-

Retrieves a specific employee's summary of statutory leaves using a unique employee ID

-
-
-
-

-

-

-
- 
/StatutoryLeaves/Summary/{EmployeeID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-active_only = true
-
-begin
-  response = xero_client.accounting_api.get_statutory_leave_summary(xero_tenant_id, employee_id, active_only)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_statutory_leave_summary: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - -
NameDescription
activeOnly - - -
-
-
- - Boolean - - -
-Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future scheduled) are returned -
-
-
-
-
-
-
-
-
-
-
-

getTimesheet

-

Retrieve a specific timesheet by using a unique timesheet ID

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_timesheet(xero_tenant_id, timesheet_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_timesheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
payroll.timesheets.readGrant read-only access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getTimesheets

-

Retrieves timesheets

-
-
-
-

-

-

-
- 
/Timesheets
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 5
-filter = 'employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000'
-status = 'Draft'
-start_date = '2019-01-02'
-end_date = '2020-01-02'
-sort = 'startDate'
-
-begin
-  response = xero_client.accounting_api.get_timesheets(xero_tenant_id, page, filter, status, start_date, end_date, sort)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_timesheets: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
payroll.timesheets.readGrant read-only access to payroll timesheets
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. -
-
-
-
-
filter - - -
-
-
- - String - - -
-Filter by employeeId and/or payrollCalendarId -
-
-
-
-
status - - -
-
-
- - String - - -
-filter results by any timesheets with a matching timesheet status -
-
-
-
-
startDate - - -
-
-
- - String - - -
-filter results by any timesheets with a startDate on or after the provided date -
-
-
-
-
endDate - - -
-
-
- - String - - -
-filter results by any timesheets with a endDate on or before the provided date -
-
-
-
-
sort - - -
-
-
- - String - - -
-sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. -
-
-
-
-
-
-
-
-
-
-
-

getTrackingCategories

-

Retrieves tracking categories

-
-
-
-

-

-

-
- 
/Settings/trackingCategories
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-begin
-  response = xero_client.accounting_api.get_tracking_categories(xero_tenant_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_tracking_categories: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
payroll.settingsGrant read-write access to payroll settings
payroll.settings.readGrant read-only access to payroll settings
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

revertTimesheet

-

Reverts a specific timesheet to draft

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}/RevertToDraft
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.revert_timesheet(xero_tenant_id, timesheet_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling revert_timesheet: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

updateEmployee

-

Updates a specific employee's detail

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-date_of_birth = 'YYYY-MM-DD'
-
-address = { 
-  address_line_1: "123 Test st",
-  city: "Rangiora",
-  post_code: "7400",
-  country_name: "NEW ZEALAND"
-}  
-
-employee = { 
-  first_name: "Adam",
-  last_name: "Adamson",
-  date_of_birth:  date_of_birth,
-  address:  address
-}  
-
-begin
-  response = xero_client.accounting_api.update_employee(xero_tenant_id, employee_id, employee)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_employee: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employee * -
-
- - Employee - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateEmployeeEarningsTemplate

-

Updates a specific employee's earnings template records

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-pay_template_earning_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
-
-earnings_template = { 
-  pay_template_earning_id: "00000000-0000-0000-0000-000000000000",
-  rate_per_unit: 14.25,
-  number_of_units: 35.5,
-  fixed_amount: 50,
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  name: "Overtime Hours"
-}    
-earnings_templates = []
-earnings_templates << earnings_template
-
-begin
-  response = xero_client.accounting_api.update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earningsTemplate)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_employee_earnings_template: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
PayTemplateEarningID* - - -
-
-
- - UUID - - - (uuid) - - -
-Id for single pay template earnings object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
earningsTemplate * -
-
- - EarningsTemplate - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateEmployeeLeave

-

Updates a specific employee's leave records

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/Leave/{LeaveID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-leave_id = 'c4be24e5-e840-4c92-9eaa-2d86cd596314'
-start_date = 'YYYY-MM-DD'
-end_date = 'YYYY-MM-DD'
-
-employee_leave = { 
-  leave_type_id: "00000000-0000-0000-0000-000000000000",
-  start_date:  start_date,
-  end_date:  end_date
-}  
-
-begin
-  response = xero_client.accounting_api.update_employee_leave(xero_tenant_id, employee_id, leave_id, employeeLeave)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_employee_leave: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
LeaveID* - - -
-
-
- - UUID - - - (uuid) - - -
-Leave id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employeeLeave * -
-
- - EmployeeLeave - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateEmployeeOpeningBalances

-

Updates a specific employee's opening balances

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/ukopeningbalances
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-
-employee_opening_balances = { 
-  statutory_maternity_pay: 0.0,
-  statutory_adoption_pay: 100.0,
-  statutory_paternity_pay: 0.0,
-  statutory_shared_parental_pay: 0.0,
-  statutory_sick_pay: 0.0
-}  
-
-begin
-  response = xero_client.accounting_api.update_employee_opening_balances(xero_tenant_id, employee_id, employeeOpeningBalances)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_employee_opening_balances: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
employeeOpeningBalances * -
-
- - EmployeeOpeningBalances - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateEmployeeSalaryAndWage

-

Updates salary and wages record for a specific employee

-
-
-
-

-

-

-
- 
/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
-salary_and_wages_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6'
-
-salary_and_wage = { 
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  number_of_units_per_day: 0,
-  number_of_units_per_week: 0,
-  payment_type:  XeroRuby::PayrollUk::SalaryAndWage::payment_type_enum::SALARY,
-  status:  XeroRuby::PayrollUk::SalaryAndWage::status_enum::ACTIVE
-}  
-
-begin
-  response = xero_client.accounting_api.update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salaryAndWage)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_employee_salary_and_wage: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.employeesGrant read-write access to payroll employees
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
EmployeeID* - - -
-
-
- - UUID - - - (uuid) - - -
-Employee id for single object -
-
-
- Required -
-
-
-
SalaryAndWagesID* - - -
-
-
- - UUID - - - (uuid) - - -
-Id for single pay template earnings object -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
salaryAndWage * -
-
- - SalaryAndWage - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updatePayRun

-

Updates a specific pay run

-
-
-
-

-

-

-
- 
/PayRuns/{PayRunID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-pay_run_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-start_date = 'YYYY-MM-DD'
-payment_date = 'YYYY-MM-DD'
-
-pay_run_calendar = { 
-  calendar_type:  XeroRuby::PayrollUk::calendar_type::WEEKLY,
-  period_start_date:  start_date,
-  payment_date:  payment_date
-}  
-
-begin
-  response = xero_client.accounting_api.update_pay_run(xero_tenant_id, pay_run_id, payRun)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_pay_run: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.payrunsGrant read-write access to payroll payruns
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
PayRunID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the pay run -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
payRun * -
-
- - PayRun - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateTimesheetLine

-

Updates a specific timesheet line for a specific timesheet

-
-
-
-

-

-

-
- 
/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-timesheet_line_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-date = 'YYYY-MM-DD'
-
-timesheet_line = { 
-  timesheet_line_id: "00000000-0000-0000-0000-000000000000",
-  date:  date,
-  earnings_rate_id: "00000000-0000-0000-0000-000000000000",
-  tracking_item_id: "00000000-0000-0000-0000-000000000000",
-  number_of_units: 6
-}  
-
-begin
-  response = xero_client.accounting_api.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheetLine)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_timesheet_line: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
payroll.timesheetsGrant read-write access to payroll timesheets
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
TimesheetID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet -
-
-
- Required -
-
-
-
TimesheetLineID* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier for the timesheet line -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
timesheetLine * -
-
- - TimesheetLine - -
- -
-
-
- Required -
-
- -
-
-
-
-
-
- -
-
-
- - - - - - - - - - - - - - diff --git a/docs/projects/Error.md b/docs/projects/Error.md index 2cf3f496..d958a794 100644 --- a/docs/projects/Error.md +++ b/docs/projects/Error.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **message** | **String** | Exception message | [optional] -**model_state** | [**Object**](.md) | Array of Elements of validation Errors | [optional] +**model_state** | **Object** | Array of Elements of validation Errors | [optional] ## Code Sample diff --git a/docs/projects/Project.md b/docs/projects/Project.md index 45fedd2e..2b3a709d 100644 --- a/docs/projects/Project.md +++ b/docs/projects/Project.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **deposit** | [**Amount**](Amount.md) | | [optional] **deposit_applied** | [**Amount**](Amount.md) | | [optional] **credit_note_amount** | [**Amount**](Amount.md) | | [optional] -**deadline_utc** | **DateTime** | Deadline for the project. UTC Date Time in ISO-8601 format. | [optional] +**deadline_utc** | **Time** | Deadline for the project. UTC Date Time in ISO-8601 format. | [optional] **total_invoiced** | [**Amount**](Amount.md) | | [optional] **total_to_be_invoiced** | [**Amount**](Amount.md) | | [optional] **estimate** | [**Amount**](Amount.md) | | [optional] diff --git a/docs/projects/ProjectApi.md b/docs/projects/ProjectApi.md index 78f94ed4..08209b5e 100644 --- a/docs/projects/ProjectApi.md +++ b/docs/projects/ProjectApi.md @@ -25,7 +25,7 @@ Method | HTTP request | Description ## create_project -> Project create_project(xero_tenant_id, project_create_or_update) +> Project create_project(xero_tenant_id, project_create_or_update, opts) Create one or more new projects @@ -54,11 +54,15 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant project_create_or_update = { "contactId": "00000000-0000-0000-000-000000000000", "name": "New Kitchen", "deadlineUtc": "2019-12-10T12:59:59Z", "estimateAmount": "99.99" } # ProjectCreateOrUpdate | Create a new project with ProjectCreateOrUpdate object +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Create one or more new projects - result = api_instance.create_project(xero_tenant_id, project_create_or_update) + result = api_instance.create_project(xero_tenant_id, project_create_or_update, opts) p result rescue XeroRuby::Projects::ApiError => e puts "Exception when calling ProjectApi->create_project: #{e}" @@ -72,6 +76,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **project_create_or_update** | [**ProjectCreateOrUpdate**](ProjectCreateOrUpdate.md)| Create a new project with ProjectCreateOrUpdate object | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -89,7 +94,7 @@ Name | Type | Description | Notes ## create_task -> Task create_task(xero_tenant_id, project_id, task_create_or_update) +> Task create_task(xero_tenant_id, project_id, task_create_or_update, opts) Allows you to create a task @@ -120,12 +125,16 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -project_id = 'project_id_example' # String | You can create a task on a specified projectId +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +project_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can create a task on a specified projectId task_create_or_update = { "status": "INPROGRESS" } # TaskCreateOrUpdate | The task object you are creating +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Allows you to create a task - result = api_instance.create_task(xero_tenant_id, project_id, task_create_or_update) + result = api_instance.create_task(xero_tenant_id, project_id, task_create_or_update, opts) p result rescue XeroRuby::Projects::ApiError => e puts "Exception when calling ProjectApi->create_task: #{e}" @@ -138,8 +147,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **project_id** | [**String**](.md)| You can create a task on a specified projectId | + **project_id** | **String**| You can create a task on a specified projectId | **task_create_or_update** | [**TaskCreateOrUpdate**](TaskCreateOrUpdate.md)| The task object you are creating | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -157,7 +167,7 @@ Name | Type | Description | Notes ## create_time_entry -> TimeEntry create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update) +> TimeEntry create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update, opts) Creates a time entry for a specific project @@ -188,12 +198,16 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +project_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual project by appending the projectId to the endpoint time_entry_create_or_update = { "userId": "00000000-0000-0000-0000-000000000000", "taskId": "00000000-0000-0000-0000-000000000000", "dateUtc": "2020-02-26T15:00:00Z", "duration":30, "description": "My description" } # TimeEntryCreateOrUpdate | The time entry object you are creating +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a time entry for a specific project - result = api_instance.create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update) + result = api_instance.create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update, opts) p result rescue XeroRuby::Projects::ApiError => e puts "Exception when calling ProjectApi->create_time_entry: #{e}" @@ -206,8 +220,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | + **project_id** | **String**| You can specify an individual project by appending the projectId to the endpoint | **time_entry_create_or_update** | [**TimeEntryCreateOrUpdate**](TimeEntryCreateOrUpdate.md)| The time entry object you are creating | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -256,9 +271,9 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint -task_id = 'task_id_example' # String | You can specify an individual task by appending the id to the endpoint +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +project_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual project by appending the projectId to the endpoint +task_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual task by appending the id to the endpoint begin #Allows you to delete a task api_instance.delete_task(xero_tenant_id, project_id, task_id) @@ -273,8 +288,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | - **task_id** | [**String**](.md)| You can specify an individual task by appending the id to the endpoint | + **project_id** | **String**| You can specify an individual project by appending the projectId to the endpoint | + **task_id** | **String**| You can specify an individual task by appending the id to the endpoint | ### Return type @@ -323,9 +338,9 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint -time_entry_id = 'time_entry_id_example' # String | You can specify an individual task by appending the id to the endpoint +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +project_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual project by appending the projectId to the endpoint +time_entry_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual task by appending the id to the endpoint begin #Deletes a time entry for a specific project api_instance.delete_time_entry(xero_tenant_id, project_id, time_entry_id) @@ -340,8 +355,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | - **time_entry_id** | [**String**](.md)| You can specify an individual task by appending the id to the endpoint | + **project_id** | **String**| You can specify an individual project by appending the projectId to the endpoint | + **time_entry_id** | **String**| You can specify an individual task by appending the id to the endpoint | ### Return type @@ -390,8 +405,8 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +project_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual project by appending the projectId to the endpoint begin #Retrieves a single project result = api_instance.get_project(xero_tenant_id, project_id) @@ -407,7 +422,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | + **project_id** | **String**| You can specify an individual project by appending the projectId to the endpoint | ### Return type @@ -456,11 +471,11 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { page: 1, # Integer | set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. - page_size: 50 # Integer | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. + page_size: 100 # Integer | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. } begin @@ -528,17 +543,17 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant opts = { - project_ids: ['project_ids_example'], # Array | Search for all projects that match a comma separated list of projectIds + project_ids: , # Array | Search for all projects that match a comma separated list of projectIds - contact_id: 'contact_id_example', # String | Filter for projects for a specific contact + contact_id: 38400000-8cf0-11bd-b23e-10b96e4ef00d, # String | Filter for projects for a specific contact - states: 'states_example', # String | Filter for projects in a particular state (INPROGRESS or CLOSED) + states: states_example, # String | Filter for projects in a particular state (INPROGRESS or CLOSED) page: 1, # Integer | set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. - page_size: 50 # Integer | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. + page_size: 100 # Integer | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. } begin @@ -557,7 +572,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **project_ids** | [**Array<String>**](String.md)| Search for all projects that match a comma separated list of projectIds | [optional] - **contact_id** | [**String**](.md)| Filter for projects for a specific contact | [optional] + **contact_id** | **String**| Filter for projects for a specific contact | [optional] **states** | **String**| Filter for projects in a particular state (INPROGRESS or CLOSED) | [optional] **page** | **Integer**| set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional] [default to 1] **page_size** | **Integer**| Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. | [optional] [default to 50] @@ -609,9 +624,9 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint -task_id = 'task_id_example' # String | You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskID} +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +project_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual project by appending the projectId to the endpoint +task_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskID} begin #Retrieves a single project task result = api_instance.get_task(xero_tenant_id, project_id, task_id) @@ -627,8 +642,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | - **task_id** | [**String**](.md)| You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskID} | + **project_id** | **String**| You can specify an individual project by appending the projectId to the endpoint | + **task_id** | **String**| You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskID} | ### Return type @@ -677,16 +692,16 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +project_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual project by appending the projectId to the endpoint opts = { page: 1, # Integer | Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. page_size: 10, # Integer | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. - task_ids: 'task_ids_example', # String | Search for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID} + task_ids: task_ids_example, # String | Search for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID} - charge_type: XeroRuby::Projects::ChargeType.new # ChargeType | + charge_type: # ChargeType | } begin @@ -704,7 +719,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | + **project_id** | **String**| You can specify an individual project by appending the projectId to the endpoint | **page** | **Integer**| Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional] **page_size** | **Integer**| Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. | [optional] **task_ids** | **String**| Search for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID} | [optional] @@ -757,28 +772,28 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -project_id = 'project_id_example' # String | Identifier of the project, that the task (which the time entry is logged against) belongs to. +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +project_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | Identifier of the project, that the task (which the time entry is logged against) belongs to. opts = { - user_id: 'user_id_example', # String | The xero user identifier of the person who logged time. + user_id: 38400000-8cf0-11bd-b23e-10b96e4ef00d, # String | The xero user identifier of the person who logged time. - task_id: 'task_id_example', # String | Identifier of the task that time entry is logged against. + task_id: 38400000-8cf0-11bd-b23e-10b96e4ef00d, # String | Identifier of the task that time entry is logged against. - invoice_id: 'invoice_id_example', # String | Finds all time entries for this invoice. + invoice_id: 38400000-8cf0-11bd-b23e-10b96e4ef00d, # String | Finds all time entries for this invoice. - contact_id: 'contact_id_example', # String | Finds all time entries for this contact identifier. + contact_id: 38400000-8cf0-11bd-b23e-10b96e4ef00d, # String | Finds all time entries for this contact identifier. page: 1, # Integer | Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. page_size: 10, # Integer | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. - states: ['states_example'], # Array | Comma-separated list of states to find. Will find all time entries that are in the status of whatever is specified. + states: , # Array | Comma-separated list of states to find. Will find all time entries that are in the status of whatever is specified. is_chargeable: true, # Boolean | Finds all time entries which relate to tasks with the charge type `TIME` or `FIXED`. - date_after_utc: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 UTC date. Finds all time entries on or after this date filtered on the `dateUtc` field. + date_after_utc: 2013-10-20T19:20:30+01:00, # Time | ISO 8601 UTC date. Finds all time entries on or after this date filtered on the `dateUtc` field. - date_before_utc: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | ISO 8601 UTC date. Finds all time entries on or before this date filtered on the `dateUtc` field. + date_before_utc: 2013-10-20T19:20:30+01:00 # Time | ISO 8601 UTC date. Finds all time entries on or before this date filtered on the `dateUtc` field. } begin @@ -796,17 +811,17 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **project_id** | [**String**](.md)| Identifier of the project, that the task (which the time entry is logged against) belongs to. | - **user_id** | [**String**](.md)| The xero user identifier of the person who logged time. | [optional] - **task_id** | [**String**](.md)| Identifier of the task that time entry is logged against. | [optional] - **invoice_id** | [**String**](.md)| Finds all time entries for this invoice. | [optional] - **contact_id** | [**String**](.md)| Finds all time entries for this contact identifier. | [optional] + **project_id** | **String**| Identifier of the project, that the task (which the time entry is logged against) belongs to. | + **user_id** | **String**| The xero user identifier of the person who logged time. | [optional] + **task_id** | **String**| Identifier of the task that time entry is logged against. | [optional] + **invoice_id** | **String**| Finds all time entries for this invoice. | [optional] + **contact_id** | **String**| Finds all time entries for this contact identifier. | [optional] **page** | **Integer**| Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional] **page_size** | **Integer**| Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. | [optional] **states** | [**Array<String>**](String.md)| Comma-separated list of states to find. Will find all time entries that are in the status of whatever is specified. | [optional] **is_chargeable** | **Boolean**| Finds all time entries which relate to tasks with the charge type `TIME` or `FIXED`. | [optional] - **date_after_utc** | **DateTime**| ISO 8601 UTC date. Finds all time entries on or after this date filtered on the `dateUtc` field. | [optional] - **date_before_utc** | **DateTime**| ISO 8601 UTC date. Finds all time entries on or before this date filtered on the `dateUtc` field. | [optional] + **date_after_utc** | **Time**| ISO 8601 UTC date. Finds all time entries on or after this date filtered on the `dateUtc` field. | [optional] + **date_before_utc** | **Time**| ISO 8601 UTC date. Finds all time entries on or before this date filtered on the `dateUtc` field. | [optional] ### Return type @@ -855,9 +870,9 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint -time_entry_id = 'time_entry_id_example' # String | You can specify an individual time entry by appending the id to the endpoint +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +project_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual project by appending the projectId to the endpoint +time_entry_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual time entry by appending the id to the endpoint begin #Retrieves a single time entry for a specific project result = api_instance.get_time_entry(xero_tenant_id, project_id, time_entry_id) @@ -873,8 +888,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | - **time_entry_id** | [**String**](.md)| You can specify an individual time entry by appending the id to the endpoint | + **project_id** | **String**| You can specify an individual project by appending the projectId to the endpoint | + **time_entry_id** | **String**| You can specify an individual time entry by appending the id to the endpoint | ### Return type @@ -892,7 +907,7 @@ Name | Type | Description | Notes ## patch_project -> patch_project(xero_tenant_id, project_id, project_patch) +> patch_project(xero_tenant_id, project_id, project_patch, opts) creates a project for the specified contact @@ -923,12 +938,16 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +project_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual project by appending the projectId to the endpoint project_patch = { "status": "INPROGRESS" } # ProjectPatch | Update the status of an existing Project +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #creates a project for the specified contact - api_instance.patch_project(xero_tenant_id, project_id, project_patch) + api_instance.patch_project(xero_tenant_id, project_id, project_patch, opts) rescue XeroRuby::Projects::ApiError => e puts "Exception when calling ProjectApi->patch_project: #{e}" end @@ -940,8 +959,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | + **project_id** | **String**| You can specify an individual project by appending the projectId to the endpoint | **project_patch** | [**ProjectPatch**](ProjectPatch.md)| Update the status of an existing Project | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -959,7 +979,7 @@ nil (empty response body) ## update_project -> update_project(xero_tenant_id, project_id, project_create_or_update) +> update_project(xero_tenant_id, project_id, project_create_or_update, opts) Updates a specific project @@ -990,12 +1010,16 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +project_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual project by appending the projectId to the endpoint project_create_or_update = { "name": "New Kitchen", "deadlineUtc": "2017-04-23T18:25:43.511Z", "estimateAmount": 99.99 } # ProjectCreateOrUpdate | Request of type ProjectCreateOrUpdate +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific project - api_instance.update_project(xero_tenant_id, project_id, project_create_or_update) + api_instance.update_project(xero_tenant_id, project_id, project_create_or_update, opts) rescue XeroRuby::Projects::ApiError => e puts "Exception when calling ProjectApi->update_project: #{e}" end @@ -1007,8 +1031,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | + **project_id** | **String**| You can specify an individual project by appending the projectId to the endpoint | **project_create_or_update** | [**ProjectCreateOrUpdate**](ProjectCreateOrUpdate.md)| Request of type ProjectCreateOrUpdate | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1026,7 +1051,7 @@ nil (empty response body) ## update_task -> update_task(xero_tenant_id, project_id, task_id, task_create_or_update) +> update_task(xero_tenant_id, project_id, task_id, task_create_or_update, opts) Allows you to update a task @@ -1057,13 +1082,17 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint -task_id = 'task_id_example' # String | You can specify an individual task by appending the id to the endpoint -task_create_or_update = XeroRuby::Projects::TaskCreateOrUpdate.new # TaskCreateOrUpdate | The task object you are updating +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +project_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual project by appending the projectId to the endpoint +task_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual task by appending the id to the endpoint +task_create_or_update = # TaskCreateOrUpdate | The task object you are updating +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Allows you to update a task - api_instance.update_task(xero_tenant_id, project_id, task_id, task_create_or_update) + api_instance.update_task(xero_tenant_id, project_id, task_id, task_create_or_update, opts) rescue XeroRuby::Projects::ApiError => e puts "Exception when calling ProjectApi->update_task: #{e}" end @@ -1075,9 +1104,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | - **task_id** | [**String**](.md)| You can specify an individual task by appending the id to the endpoint | + **project_id** | **String**| You can specify an individual project by appending the projectId to the endpoint | + **task_id** | **String**| You can specify an individual task by appending the id to the endpoint | **task_create_or_update** | [**TaskCreateOrUpdate**](TaskCreateOrUpdate.md)| The task object you are updating | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1095,7 +1125,7 @@ nil (empty response body) ## update_time_entry -> update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update) +> update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, opts) Updates a time entry for a specific project @@ -1126,13 +1156,17 @@ api_instance = xero_client. -xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant -project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint -time_entry_id = 'time_entry_id_example' # String | You can specify an individual time entry by appending the id to the endpoint +xero_tenant_id = xero_tenant_id_example # String | Xero identifier for Tenant +project_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual project by appending the projectId to the endpoint +time_entry_id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # String | You can specify an individual time entry by appending the id to the endpoint time_entry_create_or_update = { "userId": "00000000-0000-0000-0000-000000000000", "taskId": "00000000-0000-0000-0000-000000000000", "dateUtc": "2020-02-27T15:00:00Z", "duration":45, "description": "My UPDATED description" } # TimeEntryCreateOrUpdate | The time entry object you are updating +opts = { + idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a time entry for a specific project - api_instance.update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update) + api_instance.update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, opts) rescue XeroRuby::Projects::ApiError => e puts "Exception when calling ProjectApi->update_time_entry: #{e}" end @@ -1144,9 +1178,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | - **time_entry_id** | [**String**](.md)| You can specify an individual time entry by appending the id to the endpoint | + **project_id** | **String**| You can specify an individual project by appending the projectId to the endpoint | + **time_entry_id** | **String**| You can specify an individual time entry by appending the id to the endpoint | **time_entry_create_or_update** | [**TimeEntryCreateOrUpdate**](TimeEntryCreateOrUpdate.md)| The time entry object you are updating | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type diff --git a/docs/projects/ProjectCreateOrUpdate.md b/docs/projects/ProjectCreateOrUpdate.md index b4c955e1..7a127618 100644 --- a/docs/projects/ProjectCreateOrUpdate.md +++ b/docs/projects/ProjectCreateOrUpdate.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **contact_id** | **String** | Identifier of the contact this project was created for. | [optional] **name** | **String** | Name of the project. | **estimate_amount** | **BigDecimal** | | [optional] -**deadline_utc** | **DateTime** | Deadline for the project. UTC Date Time in ISO-8601 format. | [optional] +**deadline_utc** | **Time** | Deadline for the project. UTC Date Time in ISO-8601 format. | [optional] ## Code Sample diff --git a/docs/projects/TimeEntry.md b/docs/projects/TimeEntry.md index 6f96838d..37f77989 100644 --- a/docs/projects/TimeEntry.md +++ b/docs/projects/TimeEntry.md @@ -8,8 +8,8 @@ Name | Type | Description | Notes **user_id** | **String** | The xero user identifier of the person who logged time. | [optional] **project_id** | **String** | Identifier of the project, that the task (which the time entry is logged against) belongs to. | [optional] **task_id** | **String** | Identifier of the task that time entry is logged against. | [optional] -**date_utc** | **DateTime** | The date time that time entry is logged on. UTC Date Time in ISO-8601 format. | [optional] -**date_entered_utc** | **DateTime** | The date time that time entry is created. UTC Date Time in ISO-8601 format. By default it is set to server time. | [optional] +**date_utc** | **Time** | The date time that time entry is logged on. UTC Date Time in ISO-8601 format. | [optional] +**date_entered_utc** | **Time** | The date time that time entry is created. UTC Date Time in ISO-8601 format. By default it is set to server time. | [optional] **duration** | **Integer** | The duration of logged minutes. | [optional] **description** | **String** | A description of the time entry. | [optional] **status** | **String** | Status of the time entry. By default a time entry is created with status of `ACTIVE`. A `LOCKED` state indicates that the time entry is currently changing state (for example being invoiced). Updates are not allowed when in this state. It will have a status of INVOICED once it is invoiced. | [optional] diff --git a/docs/projects/TimeEntryCreateOrUpdate.md b/docs/projects/TimeEntryCreateOrUpdate.md index 570829ef..eba997ea 100644 --- a/docs/projects/TimeEntryCreateOrUpdate.md +++ b/docs/projects/TimeEntryCreateOrUpdate.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **user_id** | **String** | The xero user identifier of the person logging the time. | **task_id** | **String** | Identifier of the task that time entry is logged against. | -**date_utc** | **DateTime** | Date time entry is logged on. UTC Date Time in ISO-8601 format. | +**date_utc** | **Time** | Date time entry is logged on. UTC Date Time in ISO-8601 format. | **duration** | **Integer** | Number of minutes to be logged. Duration is between 1 and 59940 inclusively. | **description** | **String** | An optional description of the time entry, will be set to null if not provided during update. | [optional] diff --git a/docs/projects/index.html b/docs/projects/index.html deleted file mode 100644 index 83a85ee8..00000000 --- a/docs/projects/index.html +++ /dev/null @@ -1,5942 +0,0 @@ - - - - - Xero Projects API - - - - - - xero-ruby Project SDK Docs - - - - - - - - - - - - - - - - - - -
- -
- -
-
- - -
-
- -
-
- -
-
-
-
-
- -
-
-
-
-

Xero Projects API

-
-
-
- -
-
-

Project

-
-
-
-

createProject

-

Create one or more new projects

-
-
-
-

-

-

-
- 
/Projects
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-
-begin
-  response = xero_client.accounting_api.create_project(xero_tenant_id, projectCreateOrUpdate)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_project: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
projectsGrant read-write access to projects
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
projectCreateOrUpdate * -
-
- - ProjectCreateOrUpdate - -
- Create a new project with ProjectCreateOrUpdate object -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createTask

-

Allows you to create a task

-
-
-
-

-

Allows you to create a specific task

-

-
- 
/Projects/{projectId}/Tasks
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.create_task(xero_tenant_id, project_id, taskCreateOrUpdate)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_task: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
projectsGrant read-write access to projects
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
projectId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can create a task on a specified projectId -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
taskCreateOrUpdate * -
-
- - TaskCreateOrUpdate - -
- The task object you are creating -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

createTimeEntry

-

Creates a time entry for a specific project

-
-
-
-

-

Allows you to create a specific task

-

-
- 
/Projects/{projectId}/Time
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.create_time_entry(xero_tenant_id, project_id, timeEntryCreateOrUpdate)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling create_time_entry: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
projectsGrant read-write access to projects
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
projectId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual project by appending the projectId to the endpoint -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
timeEntryCreateOrUpdate * -
-
- - TimeEntryCreateOrUpdate - -
- The time entry object you are creating -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

deleteTask

-

Allows you to delete a task

-
-
-
-

-

Allows you to delete a specific task

-

-
- 
/Projects/{projectId}/Tasks/{taskId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-task_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.delete_task(xero_tenant_id, project_id, task_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_task: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
projectsGrant read-write access to projects
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
projectId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual project by appending the projectId to the endpoint -
-
-
- Required -
-
-
-
taskId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual task by appending the id to the endpoint -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

deleteTimeEntry

-

Deletes a time entry for a specific project

-
-
-
-

-

Allows you to delete a specific time entry

-

-
- 
/Projects/{projectId}/Time/{timeEntryId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-time_entry_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.delete_time_entry(xero_tenant_id, project_id, time_entry_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling delete_time_entry: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
projectsGrant read-write access to projects
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
projectId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual project by appending the projectId to the endpoint -
-
-
- Required -
-
-
-
timeEntryId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual task by appending the id to the endpoint -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getProject

-

Retrieves a single project

-
-
-
-

-

Allows you to retrieve a specific project using the projectId

-

-
- 
/Projects/{projectId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_project(xero_tenant_id, project_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_project: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
projectsGrant read-write access to projects
projects.readGrant read-only access to projects
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
projectId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual project by appending the projectId to the endpoint -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getProjectUsers

-

Retrieves a list of all project users

-
-
-
-

-

Allows you to retrieve the users on a projects.

-

-
- 
/ProjectsUsers
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-page = 1
-page_size = 100
-
-begin
-  response = xero_client.accounting_api.get_project_users(xero_tenant_id, page, page_size)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_project_users: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
projectsGrant read-write access to projects
projects.readGrant read-only access to projects
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. -
-
-
-
-
pageSize - - -
-
-
- - Integer - - -
-Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. -
-
-
-
-
-
-
-
-
-
-
-

getProjects

-

Retrieves all projects

-
-
-
-

-

Allows you to retrieve, create and update projects.

-

-
- 
/Projects
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-project_ids = []
-contact_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-states = 'states_example'
-page = 1
-page_size = 100
-
-begin
-  response = xero_client.accounting_api.get_projects(xero_tenant_id, project_ids, contact_id, states, page, page_size)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_projects: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
projectsGrant read-write access to projects
projects.readGrant read-only access to projects
-

Parameters

-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
projectIds - - -
-
-
- - array[UUID] - - - (uuid) - - -
-Search for all projects that match a comma separated list of projectIds -
-
-
-
-
contactID - - -
-
-
- - UUID - - - (uuid) - - -
-Filter for projects for a specific contact -
-
-
-
-
states - - -
-
-
- - String - - -
-Filter for projects in a particular state (INPROGRESS or CLOSED) -
-
-
-
-
page - - -
-
-
- - Integer - - -
-set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. -
-
-
-
-
pageSize - - -
-
-
- - Integer - - -
-Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. -
-
-
-
-
-
-
-
-
-
-
-

getTask

-

Retrieves a single project task

-
-
-
-

-

Allows you to retrieve a specific project

-

-
- 
/Projects/{projectId}/Tasks/{taskId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-task_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_task(xero_tenant_id, project_id, task_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_task: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
projectsGrant read-write access to projects
projects.readGrant read-only access to projects
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
projectId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual project by appending the projectId to the endpoint -
-
-
- Required -
-
-
-
taskId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskID} -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

getTasks

-

Retrieves all project tasks

-
-
-
-

-

Allows you to retrieve a specific project

-

-
- 
/Projects/{projectId}/Tasks
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-page = 1
-page_size = 10
-task_ids = 'taskIds_example'
-charge_type = 
-
-begin
-  response = xero_client.accounting_api.get_tasks(xero_tenant_id, project_id, page, page_size, task_ids, charge_type)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_tasks: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
projectsGrant read-write access to projects
projects.readGrant read-only access to projects
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
projectId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual project by appending the projectId to the endpoint -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
page - - -
-
-
- - Integer - - -
-Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. -
-
-
-
-
pageSize - - -
-
-
- - Integer - - -
-Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. -
-
-
-
-
taskIds - - -
-
-
- - String - - -
-Search for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskID},{taskID} -
-
-
-
-
chargeType - - -
-
-
- - ChargeType - - -
- -
-
-
-
-
-
-
-
-
-
-
-

getTimeEntries

-

Retrieves all time entries associated with a specific project

-
-
-
-

-

Allows you to retrieve the time entries associated with a specific project

-

-
- 
/Projects/{projectId}/Time
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-task_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-invoice_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-contact_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-page = 1
-page_size = 10
-states = []
-is_chargeable = true
-date_after_utc = "2013-10-20T19:20:30+01:00"
-date_before_utc = "2013-10-20T19:20:30+01:00"
-
-begin
-  response = xero_client.accounting_api.get_time_entries(xero_tenant_id, project_id, user_id, task_id, invoice_id, contact_id, page, page_size, states, is_chargeable, date_after_utc, date_before_utc)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_time_entries: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
projectsGrant read-write access to projects
projects.readGrant read-only access to projects
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
projectId* - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier of the project, that the task (which the time entry is logged against) belongs to. -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Query parameters
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
userId - - -
-
-
- - UUID - - - (uuid) - - -
-The xero user identifier of the person who logged time. -
-
-
-
-
taskId - - -
-
-
- - UUID - - - (uuid) - - -
-Identifier of the task that time entry is logged against. -
-
-
-
-
invoiceId - - -
-
-
- - UUID - - - (uuid) - - -
-Finds all time entries for this invoice. -
-
-
-
-
contactId - - -
-
-
- - UUID - - - (uuid) - - -
-Finds all time entries for this contact identifier. -
-
-
-
-
page - - -
-
-
- - Integer - - -
-Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. -
-
-
-
-
pageSize - - -
-
-
- - Integer - - -
-Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. -
-
-
-
-
states - - -
-
-
- - array[String] - - -
-Comma-separated list of states to find. Will find all time entries that are in the status of whatever is specified. -
-
-
-
-
isChargeable - - -
-
-
- - Boolean - - -
-Finds all time entries which relate to tasks with the charge type TIME or FIXED. -
-
-
-
-
dateAfterUtc - - -
-
-
- - Date - - - (date-time) - - -
-ISO 8601 UTC date. Finds all time entries on or after this date filtered on the dateUtc field. -
-
-
-
-
dateBeforeUtc - - -
-
-
- - Date - - - (date-time) - - -
-ISO 8601 UTC date. Finds all time entries on or before this date filtered on the dateUtc field. -
-
-
-
-
-
-
-
-
-
-
-

getTimeEntry

-

Retrieves a single time entry for a specific project

-
-
-
-

-

Allows you to get a single time entry in a project

-

-
- 
/Projects/{projectId}/Time/{timeEntryId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-time_entry_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.get_time_entry(xero_tenant_id, project_id, time_entry_id)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling get_time_entry: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - - - - - - -
projectsGrant read-write access to projects
projects.readGrant read-only access to projects
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
projectId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual project by appending the projectId to the endpoint -
-
-
- Required -
-
-
-
timeEntryId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual time entry by appending the id to the endpoint -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
-
-
-
-
-
-

patchProject

-

creates a project for the specified contact

-
-
-
-

-

Allows you to update a specific projects.

-

-
- 
/Projects/{projectId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.patch_project(xero_tenant_id, project_id, projectPatch)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling patch_project: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
projectsGrant read-write access to projects
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
projectId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual project by appending the projectId to the endpoint -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
projectPatch * -
-
- - ProjectPatch - -
- Update the status of an existing Project -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateProject

-

Updates a specific project

-
-
-
-

-

Allows you to update a specific projects.

-

-
- 
/Projects/{projectId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.update_project(xero_tenant_id, project_id, projectCreateOrUpdate)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_project: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
projectsGrant read-write access to projects
-

Parameters

-
Path parameters
- - - - - - - - - -
NameDescription
projectId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual project by appending the projectId to the endpoint -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
projectCreateOrUpdate * -
-
- - ProjectCreateOrUpdate - -
- Request of type ProjectCreateOrUpdate -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateTask

-

Allows you to update a task

-
-
-
-

-

Allows you to update a specific task

-

-
- 
/Projects/{projectId}/Tasks/{taskId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-task_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.update_task(xero_tenant_id, project_id, task_id, taskCreateOrUpdate)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_task: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
projectsGrant read-write access to projects
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
projectId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual project by appending the projectId to the endpoint -
-
-
- Required -
-
-
-
taskId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual task by appending the id to the endpoint -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
taskCreateOrUpdate * -
-
- - TaskCreateOrUpdate - -
- The task object you are updating -
-
-
- Required -
-
- -
-
-
-
-
-
-
-

updateTimeEntry

-

Updates a time entry for a specific project

-
-
-
-

-

Allows you to update time entry in a project

-

-
- 
/Projects/{projectId}/Time/{timeEntryId}
-

-

Usage and SDK Samples

-

- -
- -
- 
xero_client.set_token_set(user.token_set)
-
-xero_tenant_id = 'xeroTenantId_example'
-project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-time_entry_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-
-begin
-  response = xero_client.accounting_api.update_time_entry(xero_tenant_id, project_id, time_entry_id, timeEntryCreateOrUpdate)
-  return response
-rescue XeroRuby::ApiError => e
-  puts "Exception when calling update_time_entry: #{e}"
-end
-
-
-
-

Scopes

- - - - - - - -
projectsGrant read-write access to projects
-

Parameters

-
Path parameters
- - - - - - - - - - - - - -
NameDescription
projectId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual project by appending the projectId to the endpoint -
-
-
- Required -
-
-
-
timeEntryId* - - -
-
-
- - UUID - - - (uuid) - - -
-You can specify an individual time entry by appending the id to the endpoint -
-
-
- Required -
-
-
-
-
Header parameters
- - - - - - - - - -
NameDescription
Xero-Tenant-Id* - - -
-
-
- - String - - -
-Xero identifier for Tenant -
-
-
- Required -
-
-
-
-
Body parameters
- - - - - - - -
NameDescription
timeEntryCreateOrUpdate * -
-
- - TimeEntryCreateOrUpdate - -
- The time entry object you are updating -
-
-
- Required -
-
- -
-
-
-
-
-
- -
-
-
- - - - - - - - - - - - - - diff --git a/lib/xero-ruby.rb b/lib/xero-ruby.rb index 1139d08a..31d4a85e 100644 --- a/lib/xero-ruby.rb +++ b/lib/xero-ruby.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -366,7 +366,6 @@ require 'xero-ruby/models/files/folders' require 'xero-ruby/models/files/object_group' require 'xero-ruby/models/files/object_type' -require 'xero-ruby/models/files/upload_object' require 'xero-ruby/models/files/user' require 'xero-ruby/models/projects/amount' require 'xero-ruby/models/projects/charge_type' diff --git a/lib/xero-ruby/api/accounting_api.rb b/lib/xero-ruby/api/accounting_api.rb index 8efce419..e796b9ba 100644 --- a/lib/xero-ruby/api/accounting_api.rb +++ b/lib/xero-ruby/api/accounting_api.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -20,6 +20,7 @@ def initialize(api_client = ApiClient.new) # @param xero_tenant_id [String] Xero identifier for Tenant # @param account [Account] Account object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Accounts] def create_account(xero_tenant_id, account, opts = {}) data, _status_code, _headers = create_account_with_http_info(xero_tenant_id, account, opts) @@ -30,6 +31,7 @@ def create_account(xero_tenant_id, account, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param account [Account] Account object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Accounts, Integer, Hash)>] Accounts data, response status code and response headers def create_account_with_http_info(xero_tenant_id, account, options = {}) opts = options.dup @@ -64,6 +66,7 @@ def create_account_with_http_info(xero_tenant_id, account, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -99,6 +102,7 @@ def create_account_with_http_info(xero_tenant_id, account, options = {}) # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, opts = {}) data, _status_code, _headers = create_account_attachment_by_file_name_with_http_info(xero_tenant_id, account_id, file_name, body, opts) @@ -111,6 +115,7 @@ def create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def create_account_attachment_by_file_name_with_http_info(xero_tenant_id, account_id, file_name, body, options = {}) opts = options.dup @@ -153,6 +158,7 @@ def create_account_attachment_by_file_name_with_http_info(xero_tenant_id, accoun # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -188,6 +194,7 @@ def create_account_attachment_by_file_name_with_http_info(xero_tenant_id, accoun # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, opts = {}) data, _status_code, _headers = create_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transaction_id, file_name, body, opts) @@ -200,6 +207,7 @@ def create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transac # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def create_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transaction_id, file_name, body, options = {}) opts = options.dup @@ -242,6 +250,7 @@ def create_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_i # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -276,6 +285,7 @@ def create_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_i # @param bank_transaction_id [String] Xero generated unique identifier for a bank transaction # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records, opts = {}) data, _status_code, _headers = create_bank_transaction_history_record_with_http_info(xero_tenant_id, bank_transaction_id, history_records, opts) @@ -287,6 +297,7 @@ def create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, # @param bank_transaction_id [String] Xero generated unique identifier for a bank transaction # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_bank_transaction_history_record_with_http_info(xero_tenant_id, bank_transaction_id, history_records, options = {}) opts = options.dup @@ -325,6 +336,7 @@ def create_bank_transaction_history_record_with_http_info(xero_tenant_id, bank_t # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -358,6 +370,7 @@ def create_bank_transaction_history_record_with_http_info(xero_tenant_id, bank_t # @param xero_tenant_id [String] Xero identifier for Tenant # @param bank_transactions [BankTransactions] BankTransactions with an array of BankTransaction objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [BankTransactions] @@ -370,6 +383,7 @@ def create_bank_transactions(xero_tenant_id, bank_transactions, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param bank_transactions [BankTransactions] BankTransactions with an array of BankTransaction objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Array<(BankTransactions, Integer, Hash)>] BankTransactions data, response status code and response headers @@ -408,6 +422,7 @@ def create_bank_transactions_with_http_info(xero_tenant_id, bank_transactions, o # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -441,6 +456,7 @@ def create_bank_transactions_with_http_info(xero_tenant_id, bank_transactions, o # @param xero_tenant_id [String] Xero identifier for Tenant # @param bank_transfers [BankTransfers] BankTransfers with array of BankTransfer objects in request body # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [BankTransfers] def create_bank_transfer(xero_tenant_id, bank_transfers, opts = {}) data, _status_code, _headers = create_bank_transfer_with_http_info(xero_tenant_id, bank_transfers, opts) @@ -451,6 +467,7 @@ def create_bank_transfer(xero_tenant_id, bank_transfers, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param bank_transfers [BankTransfers] BankTransfers with array of BankTransfer objects in request body # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(BankTransfers, Integer, Hash)>] BankTransfers data, response status code and response headers def create_bank_transfer_with_http_info(xero_tenant_id, bank_transfers, options = {}) opts = options.dup @@ -485,6 +502,7 @@ def create_bank_transfer_with_http_info(xero_tenant_id, bank_transfers, options # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -519,6 +537,7 @@ def create_bank_transfer_with_http_info(xero_tenant_id, bank_transfers, options # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, opts = {}) data, _status_code, _headers = create_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transfer_id, file_name, body, opts) @@ -530,6 +549,7 @@ def create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_i # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def create_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transfer_id, file_name, body, options = {}) opts = options.dup @@ -572,6 +592,7 @@ def create_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -606,6 +627,7 @@ def create_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, # @param bank_transfer_id [String] Xero generated unique identifier for a bank transfer # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records, opts = {}) data, _status_code, _headers = create_bank_transfer_history_record_with_http_info(xero_tenant_id, bank_transfer_id, history_records, opts) @@ -617,6 +639,7 @@ def create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, histor # @param bank_transfer_id [String] Xero generated unique identifier for a bank transfer # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_bank_transfer_history_record_with_http_info(xero_tenant_id, bank_transfer_id, history_records, options = {}) opts = options.dup @@ -655,6 +678,7 @@ def create_bank_transfer_history_record_with_http_info(xero_tenant_id, bank_tran # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -689,6 +713,7 @@ def create_bank_transfer_history_record_with_http_info(xero_tenant_id, bank_tran # @param batch_payments [BatchPayments] BatchPayments with an array of Payments in body of request # @param [Hash] opts the optional parameters # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [BatchPayments] def create_batch_payment(xero_tenant_id, batch_payments, opts = {}) data, _status_code, _headers = create_batch_payment_with_http_info(xero_tenant_id, batch_payments, opts) @@ -700,6 +725,7 @@ def create_batch_payment(xero_tenant_id, batch_payments, opts = {}) # @param batch_payments [BatchPayments] BatchPayments with an array of Payments in body of request # @param [Hash] opts the optional parameters # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(BatchPayments, Integer, Hash)>] BatchPayments data, response status code and response headers def create_batch_payment_with_http_info(xero_tenant_id, batch_payments, options = {}) opts = options.dup @@ -735,6 +761,7 @@ def create_batch_payment_with_http_info(xero_tenant_id, batch_payments, options # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -769,6 +796,7 @@ def create_batch_payment_with_http_info(xero_tenant_id, batch_payments, options # @param batch_payment_id [String] Unique identifier for BatchPayment # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records, opts = {}) data, _status_code, _headers = create_batch_payment_history_record_with_http_info(xero_tenant_id, batch_payment_id, history_records, opts) @@ -780,6 +808,7 @@ def create_batch_payment_history_record(xero_tenant_id, batch_payment_id, histor # @param batch_payment_id [String] Unique identifier for BatchPayment # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_batch_payment_history_record_with_http_info(xero_tenant_id, batch_payment_id, history_records, options = {}) opts = options.dup @@ -818,6 +847,7 @@ def create_batch_payment_history_record_with_http_info(xero_tenant_id, batch_pay # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -852,6 +882,7 @@ def create_batch_payment_history_record_with_http_info(xero_tenant_id, batch_pay # @param branding_theme_id [String] Unique identifier for a Branding Theme # @param payment_services [PaymentServices] PaymentServices array with PaymentService object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [PaymentServices] def create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_services, opts = {}) data, _status_code, _headers = create_branding_theme_payment_services_with_http_info(xero_tenant_id, branding_theme_id, payment_services, opts) @@ -863,6 +894,7 @@ def create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, pa # @param branding_theme_id [String] Unique identifier for a Branding Theme # @param payment_services [PaymentServices] PaymentServices array with PaymentService object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(PaymentServices, Integer, Hash)>] PaymentServices data, response status code and response headers def create_branding_theme_payment_services_with_http_info(xero_tenant_id, branding_theme_id, payment_services, options = {}) opts = options.dup @@ -901,6 +933,7 @@ def create_branding_theme_payment_services_with_http_info(xero_tenant_id, brandi # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -935,6 +968,7 @@ def create_branding_theme_payment_services_with_http_info(xero_tenant_id, brandi # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, opts = {}) data, _status_code, _headers = create_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contact_id, file_name, body, opts) @@ -946,6 +980,7 @@ def create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def create_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contact_id, file_name, body, options = {}) opts = options.dup @@ -988,6 +1023,7 @@ def create_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contac # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1021,6 +1057,7 @@ def create_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contac # @param xero_tenant_id [String] Xero identifier for Tenant # @param contact_groups [ContactGroups] ContactGroups with an array of names in request body # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [ContactGroups] def create_contact_group(xero_tenant_id, contact_groups, opts = {}) data, _status_code, _headers = create_contact_group_with_http_info(xero_tenant_id, contact_groups, opts) @@ -1031,6 +1068,7 @@ def create_contact_group(xero_tenant_id, contact_groups, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param contact_groups [ContactGroups] ContactGroups with an array of names in request body # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(ContactGroups, Integer, Hash)>] ContactGroups data, response status code and response headers def create_contact_group_with_http_info(xero_tenant_id, contact_groups, options = {}) opts = options.dup @@ -1065,6 +1103,7 @@ def create_contact_group_with_http_info(xero_tenant_id, contact_groups, options # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1099,6 +1138,7 @@ def create_contact_group_with_http_info(xero_tenant_id, contact_groups, options # @param contact_group_id [String] Unique identifier for a Contact Group # @param contacts [Contacts] Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Contacts] def create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts, opts = {}) data, _status_code, _headers = create_contact_group_contacts_with_http_info(xero_tenant_id, contact_group_id, contacts, opts) @@ -1110,6 +1150,7 @@ def create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts, op # @param contact_group_id [String] Unique identifier for a Contact Group # @param contacts [Contacts] Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Contacts, Integer, Hash)>] Contacts data, response status code and response headers def create_contact_group_contacts_with_http_info(xero_tenant_id, contact_group_id, contacts, options = {}) opts = options.dup @@ -1148,6 +1189,7 @@ def create_contact_group_contacts_with_http_info(xero_tenant_id, contact_group_i # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1182,6 +1224,7 @@ def create_contact_group_contacts_with_http_info(xero_tenant_id, contact_group_i # @param contact_id [String] Unique identifier for a Contact # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_contact_history(xero_tenant_id, contact_id, history_records, opts = {}) data, _status_code, _headers = create_contact_history_with_http_info(xero_tenant_id, contact_id, history_records, opts) @@ -1193,6 +1236,7 @@ def create_contact_history(xero_tenant_id, contact_id, history_records, opts = { # @param contact_id [String] Unique identifier for a Contact # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_contact_history_with_http_info(xero_tenant_id, contact_id, history_records, options = {}) opts = options.dup @@ -1231,6 +1275,7 @@ def create_contact_history_with_http_info(xero_tenant_id, contact_id, history_re # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1264,6 +1309,7 @@ def create_contact_history_with_http_info(xero_tenant_id, contact_id, history_re # @param xero_tenant_id [String] Xero identifier for Tenant # @param contacts [Contacts] Contacts with an array of Contact objects to create in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [Contacts] def create_contacts(xero_tenant_id, contacts, opts = {}) @@ -1275,6 +1321,7 @@ def create_contacts(xero_tenant_id, contacts, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param contacts [Contacts] Contacts with an array of Contact objects to create in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(Contacts, Integer, Hash)>] Contacts data, response status code and response headers def create_contacts_with_http_info(xero_tenant_id, contacts, options = {}) @@ -1311,6 +1358,7 @@ def create_contacts_with_http_info(xero_tenant_id, contacts, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1345,6 +1393,7 @@ def create_contacts_with_http_info(xero_tenant_id, contacts, options = {}) # @param credit_note_id [String] Unique identifier for a Credit Note # @param allocations [Allocations] Allocations with array of Allocation object in body of request. # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [Allocations] def create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, opts = {}) @@ -1357,6 +1406,7 @@ def create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, o # @param credit_note_id [String] Unique identifier for a Credit Note # @param allocations [Allocations] Allocations with array of Allocation object in body of request. # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(Allocations, Integer, Hash)>] Allocations data, response status code and response headers def create_credit_note_allocation_with_http_info(xero_tenant_id, credit_note_id, allocations, options = {}) @@ -1397,6 +1447,7 @@ def create_credit_note_allocation_with_http_info(xero_tenant_id, credit_note_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1432,6 +1483,7 @@ def create_credit_note_allocation_with_http_info(xero_tenant_id, credit_note_id, # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :include_online Allows an attachment to be seen by the end customer within their online invoice (default to false) # @return [Attachments] def create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, opts = {}) @@ -1445,6 +1497,7 @@ def create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, f # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :include_online Allows an attachment to be seen by the end customer within their online invoice # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def create_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, credit_note_id, file_name, body, options = {}) @@ -1489,6 +1542,7 @@ def create_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, cr # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1523,6 +1577,7 @@ def create_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, cr # @param credit_note_id [String] Unique identifier for a Credit Note # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_credit_note_history(xero_tenant_id, credit_note_id, history_records, opts = {}) data, _status_code, _headers = create_credit_note_history_with_http_info(xero_tenant_id, credit_note_id, history_records, opts) @@ -1534,6 +1589,7 @@ def create_credit_note_history(xero_tenant_id, credit_note_id, history_records, # @param credit_note_id [String] Unique identifier for a Credit Note # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_credit_note_history_with_http_info(xero_tenant_id, credit_note_id, history_records, options = {}) opts = options.dup @@ -1572,6 +1628,7 @@ def create_credit_note_history_with_http_info(xero_tenant_id, credit_note_id, hi # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1605,6 +1662,7 @@ def create_credit_note_history_with_http_info(xero_tenant_id, credit_note_id, hi # @param xero_tenant_id [String] Xero identifier for Tenant # @param credit_notes [CreditNotes] Credit Notes with array of CreditNote object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [CreditNotes] @@ -1617,6 +1675,7 @@ def create_credit_notes(xero_tenant_id, credit_notes, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param credit_notes [CreditNotes] Credit Notes with array of CreditNote object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Array<(CreditNotes, Integer, Hash)>] CreditNotes data, response status code and response headers @@ -1655,6 +1714,7 @@ def create_credit_notes_with_http_info(xero_tenant_id, credit_notes, options = { # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1688,6 +1748,7 @@ def create_credit_notes_with_http_info(xero_tenant_id, credit_notes, options = { # @param xero_tenant_id [String] Xero identifier for Tenant # @param currency [Currency] Currency object in the body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Currencies] def create_currency(xero_tenant_id, currency, opts = {}) data, _status_code, _headers = create_currency_with_http_info(xero_tenant_id, currency, opts) @@ -1698,6 +1759,7 @@ def create_currency(xero_tenant_id, currency, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param currency [Currency] Currency object in the body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Currencies, Integer, Hash)>] Currencies data, response status code and response headers def create_currency_with_http_info(xero_tenant_id, currency, options = {}) opts = options.dup @@ -1732,6 +1794,7 @@ def create_currency_with_http_info(xero_tenant_id, currency, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1765,6 +1828,7 @@ def create_currency_with_http_info(xero_tenant_id, currency, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param employees [Employees] Employees with array of Employee object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [Employees] def create_employees(xero_tenant_id, employees, opts = {}) @@ -1776,6 +1840,7 @@ def create_employees(xero_tenant_id, employees, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param employees [Employees] Employees with array of Employee object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(Employees, Integer, Hash)>] Employees data, response status code and response headers def create_employees_with_http_info(xero_tenant_id, employees, options = {}) @@ -1812,6 +1877,7 @@ def create_employees_with_http_info(xero_tenant_id, employees, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1846,6 +1912,7 @@ def create_employees_with_http_info(xero_tenant_id, employees, options = {}) # @param expense_claim_id [String] Unique identifier for a ExpenseClaim # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records, opts = {}) data, _status_code, _headers = create_expense_claim_history_with_http_info(xero_tenant_id, expense_claim_id, history_records, opts) @@ -1857,6 +1924,7 @@ def create_expense_claim_history(xero_tenant_id, expense_claim_id, history_recor # @param expense_claim_id [String] Unique identifier for a ExpenseClaim # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_expense_claim_history_with_http_info(xero_tenant_id, expense_claim_id, history_records, options = {}) opts = options.dup @@ -1895,6 +1963,7 @@ def create_expense_claim_history_with_http_info(xero_tenant_id, expense_claim_id # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1928,6 +1997,7 @@ def create_expense_claim_history_with_http_info(xero_tenant_id, expense_claim_id # @param xero_tenant_id [String] Xero identifier for Tenant # @param expense_claims [ExpenseClaims] ExpenseClaims with array of ExpenseClaim object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [ExpenseClaims] def create_expense_claims(xero_tenant_id, expense_claims, opts = {}) data, _status_code, _headers = create_expense_claims_with_http_info(xero_tenant_id, expense_claims, opts) @@ -1938,6 +2008,7 @@ def create_expense_claims(xero_tenant_id, expense_claims, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param expense_claims [ExpenseClaims] ExpenseClaims with array of ExpenseClaim object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(ExpenseClaims, Integer, Hash)>] ExpenseClaims data, response status code and response headers def create_expense_claims_with_http_info(xero_tenant_id, expense_claims, options = {}) opts = options.dup @@ -1972,6 +2043,7 @@ def create_expense_claims_with_http_info(xero_tenant_id, expense_claims, options # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2007,6 +2079,7 @@ def create_expense_claims_with_http_info(xero_tenant_id, expense_claims, options # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :include_online Allows an attachment to be seen by the end customer within their online invoice (default to false) # @return [Attachments] def create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, opts = {}) @@ -2020,6 +2093,7 @@ def create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :include_online Allows an attachment to be seen by the end customer within their online invoice # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def create_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoice_id, file_name, body, options = {}) @@ -2064,6 +2138,7 @@ def create_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoic # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2098,6 +2173,7 @@ def create_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoic # @param invoice_id [String] Unique identifier for an Invoice # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_invoice_history(xero_tenant_id, invoice_id, history_records, opts = {}) data, _status_code, _headers = create_invoice_history_with_http_info(xero_tenant_id, invoice_id, history_records, opts) @@ -2109,6 +2185,7 @@ def create_invoice_history(xero_tenant_id, invoice_id, history_records, opts = { # @param invoice_id [String] Unique identifier for an Invoice # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_invoice_history_with_http_info(xero_tenant_id, invoice_id, history_records, options = {}) opts = options.dup @@ -2147,6 +2224,7 @@ def create_invoice_history_with_http_info(xero_tenant_id, invoice_id, history_re # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2180,6 +2258,7 @@ def create_invoice_history_with_http_info(xero_tenant_id, invoice_id, history_re # @param xero_tenant_id [String] Xero identifier for Tenant # @param invoices [Invoices] Invoices with an array of invoice objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Invoices] @@ -2192,6 +2271,7 @@ def create_invoices(xero_tenant_id, invoices, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param invoices [Invoices] Invoices with an array of invoice objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Array<(Invoices, Integer, Hash)>] Invoices data, response status code and response headers @@ -2230,6 +2310,7 @@ def create_invoices_with_http_info(xero_tenant_id, invoices, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2264,6 +2345,7 @@ def create_invoices_with_http_info(xero_tenant_id, invoices, options = {}) # @param item_id [String] Unique identifier for an Item # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_item_history(xero_tenant_id, item_id, history_records, opts = {}) data, _status_code, _headers = create_item_history_with_http_info(xero_tenant_id, item_id, history_records, opts) @@ -2275,6 +2357,7 @@ def create_item_history(xero_tenant_id, item_id, history_records, opts = {}) # @param item_id [String] Unique identifier for an Item # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_item_history_with_http_info(xero_tenant_id, item_id, history_records, options = {}) opts = options.dup @@ -2313,6 +2396,7 @@ def create_item_history_with_http_info(xero_tenant_id, item_id, history_records, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2346,6 +2430,7 @@ def create_item_history_with_http_info(xero_tenant_id, item_id, history_records, # @param xero_tenant_id [String] Xero identifier for Tenant # @param items [Items] Items with an array of Item objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Items] @@ -2358,6 +2443,7 @@ def create_items(xero_tenant_id, items, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param items [Items] Items with an array of Item objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Array<(Items, Integer, Hash)>] Items data, response status code and response headers @@ -2396,6 +2482,7 @@ def create_items_with_http_info(xero_tenant_id, items, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2429,6 +2516,7 @@ def create_items_with_http_info(xero_tenant_id, items, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param linked_transaction [LinkedTransaction] LinkedTransaction object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [LinkedTransactions] def create_linked_transaction(xero_tenant_id, linked_transaction, opts = {}) data, _status_code, _headers = create_linked_transaction_with_http_info(xero_tenant_id, linked_transaction, opts) @@ -2439,6 +2527,7 @@ def create_linked_transaction(xero_tenant_id, linked_transaction, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param linked_transaction [LinkedTransaction] LinkedTransaction object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(LinkedTransactions, Integer, Hash)>] LinkedTransactions data, response status code and response headers def create_linked_transaction_with_http_info(xero_tenant_id, linked_transaction, options = {}) opts = options.dup @@ -2473,6 +2562,7 @@ def create_linked_transaction_with_http_info(xero_tenant_id, linked_transaction, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2508,6 +2598,7 @@ def create_linked_transaction_with_http_info(xero_tenant_id, linked_transaction, # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, opts = {}) data, _status_code, _headers = create_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, manual_journal_id, file_name, body, opts) @@ -2520,6 +2611,7 @@ def create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def create_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, manual_journal_id, file_name, body, options = {}) opts = options.dup @@ -2562,6 +2654,7 @@ def create_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2596,6 +2689,7 @@ def create_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, # @param manual_journal_id [String] Unique identifier for a ManualJournal # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records, opts = {}) data, _status_code, _headers = create_manual_journal_history_record_with_http_info(xero_tenant_id, manual_journal_id, history_records, opts) @@ -2607,6 +2701,7 @@ def create_manual_journal_history_record(xero_tenant_id, manual_journal_id, hist # @param manual_journal_id [String] Unique identifier for a ManualJournal # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_manual_journal_history_record_with_http_info(xero_tenant_id, manual_journal_id, history_records, options = {}) opts = options.dup @@ -2645,6 +2740,7 @@ def create_manual_journal_history_record_with_http_info(xero_tenant_id, manual_j # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2678,6 +2774,7 @@ def create_manual_journal_history_record_with_http_info(xero_tenant_id, manual_j # @param xero_tenant_id [String] Xero identifier for Tenant # @param manual_journals [ManualJournals] ManualJournals array with ManualJournal object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [ManualJournals] def create_manual_journals(xero_tenant_id, manual_journals, opts = {}) @@ -2689,6 +2786,7 @@ def create_manual_journals(xero_tenant_id, manual_journals, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param manual_journals [ManualJournals] ManualJournals array with ManualJournal object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(ManualJournals, Integer, Hash)>] ManualJournals data, response status code and response headers def create_manual_journals_with_http_info(xero_tenant_id, manual_journals, options = {}) @@ -2725,6 +2823,7 @@ def create_manual_journals_with_http_info(xero_tenant_id, manual_journals, optio # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2759,6 +2858,7 @@ def create_manual_journals_with_http_info(xero_tenant_id, manual_journals, optio # @param overpayment_id [String] Unique identifier for a Overpayment # @param allocations [Allocations] Allocations array with Allocation object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [Allocations] def create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, opts = {}) @@ -2771,6 +2871,7 @@ def create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, # @param overpayment_id [String] Unique identifier for a Overpayment # @param allocations [Allocations] Allocations array with Allocation object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(Allocations, Integer, Hash)>] Allocations data, response status code and response headers def create_overpayment_allocations_with_http_info(xero_tenant_id, overpayment_id, allocations, options = {}) @@ -2811,6 +2912,7 @@ def create_overpayment_allocations_with_http_info(xero_tenant_id, overpayment_id # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2845,6 +2947,7 @@ def create_overpayment_allocations_with_http_info(xero_tenant_id, overpayment_id # @param overpayment_id [String] Unique identifier for a Overpayment # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_overpayment_history(xero_tenant_id, overpayment_id, history_records, opts = {}) data, _status_code, _headers = create_overpayment_history_with_http_info(xero_tenant_id, overpayment_id, history_records, opts) @@ -2856,6 +2959,7 @@ def create_overpayment_history(xero_tenant_id, overpayment_id, history_records, # @param overpayment_id [String] Unique identifier for a Overpayment # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_overpayment_history_with_http_info(xero_tenant_id, overpayment_id, history_records, options = {}) opts = options.dup @@ -2894,6 +2998,7 @@ def create_overpayment_history_with_http_info(xero_tenant_id, overpayment_id, hi # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2927,6 +3032,7 @@ def create_overpayment_history_with_http_info(xero_tenant_id, overpayment_id, hi # @param xero_tenant_id [String] Xero identifier for Tenant # @param payment [Payment] Request body with a single Payment object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Payments] def create_payment(xero_tenant_id, payment, opts = {}) data, _status_code, _headers = create_payment_with_http_info(xero_tenant_id, payment, opts) @@ -2937,6 +3043,7 @@ def create_payment(xero_tenant_id, payment, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param payment [Payment] Request body with a single Payment object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Payments, Integer, Hash)>] Payments data, response status code and response headers def create_payment_with_http_info(xero_tenant_id, payment, options = {}) opts = options.dup @@ -2971,6 +3078,7 @@ def create_payment_with_http_info(xero_tenant_id, payment, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -3005,6 +3113,7 @@ def create_payment_with_http_info(xero_tenant_id, payment, options = {}) # @param payment_id [String] Unique identifier for a Payment # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_payment_history(xero_tenant_id, payment_id, history_records, opts = {}) data, _status_code, _headers = create_payment_history_with_http_info(xero_tenant_id, payment_id, history_records, opts) @@ -3016,6 +3125,7 @@ def create_payment_history(xero_tenant_id, payment_id, history_records, opts = { # @param payment_id [String] Unique identifier for a Payment # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_payment_history_with_http_info(xero_tenant_id, payment_id, history_records, options = {}) opts = options.dup @@ -3054,6 +3164,7 @@ def create_payment_history_with_http_info(xero_tenant_id, payment_id, history_re # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -3087,6 +3198,7 @@ def create_payment_history_with_http_info(xero_tenant_id, payment_id, history_re # @param xero_tenant_id [String] Xero identifier for Tenant # @param payment_services [PaymentServices] PaymentServices array with PaymentService object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [PaymentServices] def create_payment_service(xero_tenant_id, payment_services, opts = {}) data, _status_code, _headers = create_payment_service_with_http_info(xero_tenant_id, payment_services, opts) @@ -3097,6 +3209,7 @@ def create_payment_service(xero_tenant_id, payment_services, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param payment_services [PaymentServices] PaymentServices array with PaymentService object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(PaymentServices, Integer, Hash)>] PaymentServices data, response status code and response headers def create_payment_service_with_http_info(xero_tenant_id, payment_services, options = {}) opts = options.dup @@ -3131,6 +3244,7 @@ def create_payment_service_with_http_info(xero_tenant_id, payment_services, opti # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -3164,6 +3278,7 @@ def create_payment_service_with_http_info(xero_tenant_id, payment_services, opti # @param xero_tenant_id [String] Xero identifier for Tenant # @param payments [Payments] Payments array with Payment object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [Payments] def create_payments(xero_tenant_id, payments, opts = {}) @@ -3175,6 +3290,7 @@ def create_payments(xero_tenant_id, payments, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param payments [Payments] Payments array with Payment object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(Payments, Integer, Hash)>] Payments data, response status code and response headers def create_payments_with_http_info(xero_tenant_id, payments, options = {}) @@ -3211,6 +3327,7 @@ def create_payments_with_http_info(xero_tenant_id, payments, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -3245,6 +3362,7 @@ def create_payments_with_http_info(xero_tenant_id, payments, options = {}) # @param prepayment_id [String] Unique identifier for a PrePayment # @param allocations [Allocations] Allocations with an array of Allocation object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [Allocations] def create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, opts = {}) @@ -3257,6 +3375,7 @@ def create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, op # @param prepayment_id [String] Unique identifier for a PrePayment # @param allocations [Allocations] Allocations with an array of Allocation object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(Allocations, Integer, Hash)>] Allocations data, response status code and response headers def create_prepayment_allocations_with_http_info(xero_tenant_id, prepayment_id, allocations, options = {}) @@ -3297,6 +3416,7 @@ def create_prepayment_allocations_with_http_info(xero_tenant_id, prepayment_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -3331,6 +3451,7 @@ def create_prepayment_allocations_with_http_info(xero_tenant_id, prepayment_id, # @param prepayment_id [String] Unique identifier for a PrePayment # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_prepayment_history(xero_tenant_id, prepayment_id, history_records, opts = {}) data, _status_code, _headers = create_prepayment_history_with_http_info(xero_tenant_id, prepayment_id, history_records, opts) @@ -3342,6 +3463,7 @@ def create_prepayment_history(xero_tenant_id, prepayment_id, history_records, op # @param prepayment_id [String] Unique identifier for a PrePayment # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_prepayment_history_with_http_info(xero_tenant_id, prepayment_id, history_records, options = {}) opts = options.dup @@ -3380,6 +3502,7 @@ def create_prepayment_history_with_http_info(xero_tenant_id, prepayment_id, hist # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -3415,6 +3538,7 @@ def create_prepayment_history_with_http_info(xero_tenant_id, prepayment_id, hist # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, opts = {}) data, _status_code, _headers = create_purchase_order_attachment_by_file_name_with_http_info(xero_tenant_id, purchase_order_id, file_name, body, opts) @@ -3427,6 +3551,7 @@ def create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def create_purchase_order_attachment_by_file_name_with_http_info(xero_tenant_id, purchase_order_id, file_name, body, options = {}) opts = options.dup @@ -3469,6 +3594,7 @@ def create_purchase_order_attachment_by_file_name_with_http_info(xero_tenant_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -3503,6 +3629,7 @@ def create_purchase_order_attachment_by_file_name_with_http_info(xero_tenant_id, # @param purchase_order_id [String] Unique identifier for an Purchase Order # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records, opts = {}) data, _status_code, _headers = create_purchase_order_history_with_http_info(xero_tenant_id, purchase_order_id, history_records, opts) @@ -3514,6 +3641,7 @@ def create_purchase_order_history(xero_tenant_id, purchase_order_id, history_rec # @param purchase_order_id [String] Unique identifier for an Purchase Order # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_purchase_order_history_with_http_info(xero_tenant_id, purchase_order_id, history_records, options = {}) opts = options.dup @@ -3552,6 +3680,7 @@ def create_purchase_order_history_with_http_info(xero_tenant_id, purchase_order_ # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -3585,6 +3714,7 @@ def create_purchase_order_history_with_http_info(xero_tenant_id, purchase_order_ # @param xero_tenant_id [String] Xero identifier for Tenant # @param purchase_orders [PurchaseOrders] PurchaseOrders with an array of PurchaseOrder object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [PurchaseOrders] def create_purchase_orders(xero_tenant_id, purchase_orders, opts = {}) @@ -3596,6 +3726,7 @@ def create_purchase_orders(xero_tenant_id, purchase_orders, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param purchase_orders [PurchaseOrders] PurchaseOrders with an array of PurchaseOrder object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(PurchaseOrders, Integer, Hash)>] PurchaseOrders data, response status code and response headers def create_purchase_orders_with_http_info(xero_tenant_id, purchase_orders, options = {}) @@ -3632,6 +3763,7 @@ def create_purchase_orders_with_http_info(xero_tenant_id, purchase_orders, optio # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -3667,6 +3799,7 @@ def create_purchase_orders_with_http_info(xero_tenant_id, purchase_orders, optio # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, opts = {}) data, _status_code, _headers = create_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id, file_name, body, opts) @@ -3679,6 +3812,7 @@ def create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, bo # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def create_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id, file_name, body, options = {}) opts = options.dup @@ -3721,6 +3855,7 @@ def create_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -3755,6 +3890,7 @@ def create_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id # @param quote_id [String] Unique identifier for an Quote # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_quote_history(xero_tenant_id, quote_id, history_records, opts = {}) data, _status_code, _headers = create_quote_history_with_http_info(xero_tenant_id, quote_id, history_records, opts) @@ -3766,6 +3902,7 @@ def create_quote_history(xero_tenant_id, quote_id, history_records, opts = {}) # @param quote_id [String] Unique identifier for an Quote # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_quote_history_with_http_info(xero_tenant_id, quote_id, history_records, options = {}) opts = options.dup @@ -3804,6 +3941,7 @@ def create_quote_history_with_http_info(xero_tenant_id, quote_id, history_record # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -3837,6 +3975,7 @@ def create_quote_history_with_http_info(xero_tenant_id, quote_id, history_record # @param xero_tenant_id [String] Xero identifier for Tenant # @param quotes [Quotes] Quotes with an array of Quote object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [Quotes] def create_quotes(xero_tenant_id, quotes, opts = {}) @@ -3848,6 +3987,7 @@ def create_quotes(xero_tenant_id, quotes, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param quotes [Quotes] Quotes with an array of Quote object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(Quotes, Integer, Hash)>] Quotes data, response status code and response headers def create_quotes_with_http_info(xero_tenant_id, quotes, options = {}) @@ -3884,6 +4024,7 @@ def create_quotes_with_http_info(xero_tenant_id, quotes, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -3917,6 +4058,7 @@ def create_quotes_with_http_info(xero_tenant_id, quotes, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param receipts [Receipts] Receipts with an array of Receipt object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Receipts] def create_receipt(xero_tenant_id, receipts, opts = {}) @@ -3928,6 +4070,7 @@ def create_receipt(xero_tenant_id, receipts, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param receipts [Receipts] Receipts with an array of Receipt object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Array<(Receipts, Integer, Hash)>] Receipts data, response status code and response headers def create_receipt_with_http_info(xero_tenant_id, receipts, options = {}) @@ -3964,6 +4107,7 @@ def create_receipt_with_http_info(xero_tenant_id, receipts, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -3999,6 +4143,7 @@ def create_receipt_with_http_info(xero_tenant_id, receipts, options = {}) # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, opts = {}) data, _status_code, _headers = create_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receipt_id, file_name, body, opts) @@ -4011,6 +4156,7 @@ def create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def create_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receipt_id, file_name, body, options = {}) opts = options.dup @@ -4053,6 +4199,7 @@ def create_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receip # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4087,6 +4234,7 @@ def create_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receip # @param receipt_id [String] Unique identifier for a Receipt # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_receipt_history(xero_tenant_id, receipt_id, history_records, opts = {}) data, _status_code, _headers = create_receipt_history_with_http_info(xero_tenant_id, receipt_id, history_records, opts) @@ -4098,6 +4246,7 @@ def create_receipt_history(xero_tenant_id, receipt_id, history_records, opts = { # @param receipt_id [String] Unique identifier for a Receipt # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_receipt_history_with_http_info(xero_tenant_id, receipt_id, history_records, options = {}) opts = options.dup @@ -4136,6 +4285,7 @@ def create_receipt_history_with_http_info(xero_tenant_id, receipt_id, history_re # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4171,6 +4321,7 @@ def create_receipt_history_with_http_info(xero_tenant_id, receipt_id, history_re # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, opts = {}) data, _status_code, _headers = create_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, repeating_invoice_id, file_name, body, opts) @@ -4183,6 +4334,7 @@ def create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_i # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def create_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, repeating_invoice_id, file_name, body, options = {}) opts = options.dup @@ -4225,6 +4377,7 @@ def create_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_ # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4259,6 +4412,7 @@ def create_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_ # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [HistoryRecords] def create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records, opts = {}) data, _status_code, _headers = create_repeating_invoice_history_with_http_info(xero_tenant_id, repeating_invoice_id, history_records, opts) @@ -4270,6 +4424,7 @@ def create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, histo # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(HistoryRecords, Integer, Hash)>] HistoryRecords data, response status code and response headers def create_repeating_invoice_history_with_http_info(xero_tenant_id, repeating_invoice_id, history_records, options = {}) opts = options.dup @@ -4308,6 +4463,7 @@ def create_repeating_invoice_history_with_http_info(xero_tenant_id, repeating_in # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4341,6 +4497,7 @@ def create_repeating_invoice_history_with_http_info(xero_tenant_id, repeating_in # @param xero_tenant_id [String] Xero identifier for Tenant # @param repeating_invoices [RepeatingInvoices] RepeatingInvoices with an array of repeating invoice objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [RepeatingInvoices] def create_repeating_invoices(xero_tenant_id, repeating_invoices, opts = {}) @@ -4352,6 +4509,7 @@ def create_repeating_invoices(xero_tenant_id, repeating_invoices, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param repeating_invoices [RepeatingInvoices] RepeatingInvoices with an array of repeating invoice objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(RepeatingInvoices, Integer, Hash)>] RepeatingInvoices data, response status code and response headers def create_repeating_invoices_with_http_info(xero_tenant_id, repeating_invoices, options = {}) @@ -4388,6 +4546,7 @@ def create_repeating_invoices_with_http_info(xero_tenant_id, repeating_invoices, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4421,6 +4580,7 @@ def create_repeating_invoices_with_http_info(xero_tenant_id, repeating_invoices, # @param xero_tenant_id [String] Xero identifier for Tenant # @param tax_rates [TaxRates] TaxRates array with TaxRate object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TaxRates] def create_tax_rates(xero_tenant_id, tax_rates, opts = {}) data, _status_code, _headers = create_tax_rates_with_http_info(xero_tenant_id, tax_rates, opts) @@ -4431,6 +4591,7 @@ def create_tax_rates(xero_tenant_id, tax_rates, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param tax_rates [TaxRates] TaxRates array with TaxRate object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TaxRates, Integer, Hash)>] TaxRates data, response status code and response headers def create_tax_rates_with_http_info(xero_tenant_id, tax_rates, options = {}) opts = options.dup @@ -4465,6 +4626,7 @@ def create_tax_rates_with_http_info(xero_tenant_id, tax_rates, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4498,6 +4660,7 @@ def create_tax_rates_with_http_info(xero_tenant_id, tax_rates, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param tracking_category [TrackingCategory] TrackingCategory object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TrackingCategories] def create_tracking_category(xero_tenant_id, tracking_category, opts = {}) data, _status_code, _headers = create_tracking_category_with_http_info(xero_tenant_id, tracking_category, opts) @@ -4508,6 +4671,7 @@ def create_tracking_category(xero_tenant_id, tracking_category, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param tracking_category [TrackingCategory] TrackingCategory object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TrackingCategories, Integer, Hash)>] TrackingCategories data, response status code and response headers def create_tracking_category_with_http_info(xero_tenant_id, tracking_category, options = {}) opts = options.dup @@ -4542,6 +4706,7 @@ def create_tracking_category_with_http_info(xero_tenant_id, tracking_category, o # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4576,6 +4741,7 @@ def create_tracking_category_with_http_info(xero_tenant_id, tracking_category, o # @param tracking_category_id [String] Unique identifier for a TrackingCategory # @param tracking_option [TrackingOption] TrackingOption object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TrackingOptions] def create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option, opts = {}) data, _status_code, _headers = create_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, tracking_option, opts) @@ -4587,6 +4753,7 @@ def create_tracking_options(xero_tenant_id, tracking_category_id, tracking_optio # @param tracking_category_id [String] Unique identifier for a TrackingCategory # @param tracking_option [TrackingOption] TrackingOption object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TrackingOptions, Integer, Hash)>] TrackingOptions data, response status code and response headers def create_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, tracking_option, options = {}) opts = options.dup @@ -4625,6 +4792,7 @@ def create_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4733,6 +4901,7 @@ def delete_account_with_http_info(xero_tenant_id, account_id, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param batch_payment_delete [BatchPaymentDelete] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [BatchPayments] def delete_batch_payment(xero_tenant_id, batch_payment_delete, opts = {}) data, _status_code, _headers = delete_batch_payment_with_http_info(xero_tenant_id, batch_payment_delete, opts) @@ -4743,6 +4912,7 @@ def delete_batch_payment(xero_tenant_id, batch_payment_delete, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param batch_payment_delete [BatchPaymentDelete] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(BatchPayments, Integer, Hash)>] BatchPayments data, response status code and response headers def delete_batch_payment_with_http_info(xero_tenant_id, batch_payment_delete, options = {}) opts = options.dup @@ -4777,6 +4947,7 @@ def delete_batch_payment_with_http_info(xero_tenant_id, batch_payment_delete, op # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4811,6 +4982,7 @@ def delete_batch_payment_with_http_info(xero_tenant_id, batch_payment_delete, op # @param batch_payment_id [String] Unique identifier for BatchPayment # @param batch_payment_delete_by_url_param [BatchPaymentDeleteByUrlParam] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [BatchPayments] def delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param, opts = {}) data, _status_code, _headers = delete_batch_payment_by_url_param_with_http_info(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param, opts) @@ -4822,6 +4994,7 @@ def delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batch_pa # @param batch_payment_id [String] Unique identifier for BatchPayment # @param batch_payment_delete_by_url_param [BatchPaymentDeleteByUrlParam] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(BatchPayments, Integer, Hash)>] BatchPayments data, response status code and response headers def delete_batch_payment_by_url_param_with_http_info(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param, options = {}) opts = options.dup @@ -4860,6 +5033,7 @@ def delete_batch_payment_by_url_param_with_http_info(xero_tenant_id, batch_payme # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -5043,6 +5217,87 @@ def delete_contact_group_contacts_with_http_info(xero_tenant_id, contact_group_i return data, status_code, headers end + # Deletes an Allocation from a Credit Note + # @param xero_tenant_id [String] Xero identifier for Tenant + # @param credit_note_id [String] Unique identifier for a Credit Note + # @param allocation_id [String] Unique identifier for Allocation object + # @param [Hash] opts the optional parameters + # @return [Allocation] + def delete_credit_note_allocations(xero_tenant_id, credit_note_id, allocation_id, opts = {}) + data, _status_code, _headers = delete_credit_note_allocations_with_http_info(xero_tenant_id, credit_note_id, allocation_id, opts) + data + end + + # Deletes an Allocation from a Credit Note + # @param xero_tenant_id [String] Xero identifier for Tenant + # @param credit_note_id [String] Unique identifier for a Credit Note + # @param allocation_id [String] Unique identifier for Allocation object + # @param [Hash] opts the optional parameters + # @return [Array<(Allocation, Integer, Hash)>] Allocation data, response status code and response headers + def delete_credit_note_allocations_with_http_info(xero_tenant_id, credit_note_id, allocation_id, options = {}) + opts = options.dup + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: AccountingApi.delete_credit_note_allocations ...' + end + # verify the required parameter 'xero_tenant_id' is set + if @api_client.config.client_side_validation && xero_tenant_id.nil? + fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.delete_credit_note_allocations" + end + # verify the required parameter 'credit_note_id' is set + if @api_client.config.client_side_validation && credit_note_id.nil? + fail ArgumentError, "Missing the required parameter 'credit_note_id' when calling AccountingApi.delete_credit_note_allocations" + end + # verify the required parameter 'allocation_id' is set + if @api_client.config.client_side_validation && allocation_id.nil? + fail ArgumentError, "Missing the required parameter 'allocation_id' when calling AccountingApi.delete_credit_note_allocations" + end + # resource path + local_var_path = '/CreditNotes/{CreditNoteID}/Allocations/{AllocationID}'.sub('{' + 'CreditNoteID' + '}', credit_note_id.to_s).sub('{' + 'AllocationID' + '}', allocation_id.to_s) + + # camelize keys of incoming `where` opts + opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil? + + # query parameters + query_params = opts[:query_params] || {} + + # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations: + query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil? + query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + header_params[:'xero-tenant-id'] = xero_tenant_id + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Allocation' + + # auth_names + auth_names = opts[:auth_names] || ['OAuth2'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, "AccountingApi", new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: AccountingApi#delete_credit_note_allocations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + # Deletes a specific item # @param xero_tenant_id [String] Xero identifier for Tenant # @param item_id [String] Unique identifier for an Item @@ -5193,11 +5448,93 @@ def delete_linked_transaction_with_http_info(xero_tenant_id, linked_transaction_ return data, status_code, headers end + # Deletes an Allocation from an overpayment + # @param xero_tenant_id [String] Xero identifier for Tenant + # @param overpayment_id [String] Unique identifier for a Overpayment + # @param allocation_id [String] Unique identifier for Allocation object + # @param [Hash] opts the optional parameters + # @return [Allocation] + def delete_overpayment_allocations(xero_tenant_id, overpayment_id, allocation_id, opts = {}) + data, _status_code, _headers = delete_overpayment_allocations_with_http_info(xero_tenant_id, overpayment_id, allocation_id, opts) + data + end + + # Deletes an Allocation from an overpayment + # @param xero_tenant_id [String] Xero identifier for Tenant + # @param overpayment_id [String] Unique identifier for a Overpayment + # @param allocation_id [String] Unique identifier for Allocation object + # @param [Hash] opts the optional parameters + # @return [Array<(Allocation, Integer, Hash)>] Allocation data, response status code and response headers + def delete_overpayment_allocations_with_http_info(xero_tenant_id, overpayment_id, allocation_id, options = {}) + opts = options.dup + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: AccountingApi.delete_overpayment_allocations ...' + end + # verify the required parameter 'xero_tenant_id' is set + if @api_client.config.client_side_validation && xero_tenant_id.nil? + fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.delete_overpayment_allocations" + end + # verify the required parameter 'overpayment_id' is set + if @api_client.config.client_side_validation && overpayment_id.nil? + fail ArgumentError, "Missing the required parameter 'overpayment_id' when calling AccountingApi.delete_overpayment_allocations" + end + # verify the required parameter 'allocation_id' is set + if @api_client.config.client_side_validation && allocation_id.nil? + fail ArgumentError, "Missing the required parameter 'allocation_id' when calling AccountingApi.delete_overpayment_allocations" + end + # resource path + local_var_path = '/Overpayments/{OverpaymentID}/Allocations/{AllocationID}'.sub('{' + 'OverpaymentID' + '}', overpayment_id.to_s).sub('{' + 'AllocationID' + '}', allocation_id.to_s) + + # camelize keys of incoming `where` opts + opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil? + + # query parameters + query_params = opts[:query_params] || {} + + # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations: + query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil? + query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + header_params[:'xero-tenant-id'] = xero_tenant_id + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Allocation' + + # auth_names + auth_names = opts[:auth_names] || ['OAuth2'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, "AccountingApi", new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: AccountingApi#delete_overpayment_allocations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + # Updates a specific payment for invoices and credit notes # @param xero_tenant_id [String] Xero identifier for Tenant # @param payment_id [String] Unique identifier for a Payment # @param payment_delete [PaymentDelete] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Payments] def delete_payment(xero_tenant_id, payment_id, payment_delete, opts = {}) data, _status_code, _headers = delete_payment_with_http_info(xero_tenant_id, payment_id, payment_delete, opts) @@ -5209,6 +5546,7 @@ def delete_payment(xero_tenant_id, payment_id, payment_delete, opts = {}) # @param payment_id [String] Unique identifier for a Payment # @param payment_delete [PaymentDelete] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Payments, Integer, Hash)>] Payments data, response status code and response headers def delete_payment_with_http_info(xero_tenant_id, payment_id, payment_delete, options = {}) opts = options.dup @@ -5247,6 +5585,7 @@ def delete_payment_with_http_info(xero_tenant_id, payment_id, payment_delete, op # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -5276,6 +5615,87 @@ def delete_payment_with_http_info(xero_tenant_id, payment_id, payment_delete, op return data, status_code, headers end + # Deletes an Allocation from a Prepayment + # @param xero_tenant_id [String] Xero identifier for Tenant + # @param prepayment_id [String] Unique identifier for a PrePayment + # @param allocation_id [String] Unique identifier for Allocation object + # @param [Hash] opts the optional parameters + # @return [Allocation] + def delete_prepayment_allocations(xero_tenant_id, prepayment_id, allocation_id, opts = {}) + data, _status_code, _headers = delete_prepayment_allocations_with_http_info(xero_tenant_id, prepayment_id, allocation_id, opts) + data + end + + # Deletes an Allocation from a Prepayment + # @param xero_tenant_id [String] Xero identifier for Tenant + # @param prepayment_id [String] Unique identifier for a PrePayment + # @param allocation_id [String] Unique identifier for Allocation object + # @param [Hash] opts the optional parameters + # @return [Array<(Allocation, Integer, Hash)>] Allocation data, response status code and response headers + def delete_prepayment_allocations_with_http_info(xero_tenant_id, prepayment_id, allocation_id, options = {}) + opts = options.dup + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: AccountingApi.delete_prepayment_allocations ...' + end + # verify the required parameter 'xero_tenant_id' is set + if @api_client.config.client_side_validation && xero_tenant_id.nil? + fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.delete_prepayment_allocations" + end + # verify the required parameter 'prepayment_id' is set + if @api_client.config.client_side_validation && prepayment_id.nil? + fail ArgumentError, "Missing the required parameter 'prepayment_id' when calling AccountingApi.delete_prepayment_allocations" + end + # verify the required parameter 'allocation_id' is set + if @api_client.config.client_side_validation && allocation_id.nil? + fail ArgumentError, "Missing the required parameter 'allocation_id' when calling AccountingApi.delete_prepayment_allocations" + end + # resource path + local_var_path = '/Prepayments/{PrepaymentID}/Allocations/{AllocationID}'.sub('{' + 'PrepaymentID' + '}', prepayment_id.to_s).sub('{' + 'AllocationID' + '}', allocation_id.to_s) + + # camelize keys of incoming `where` opts + opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil? + + # query parameters + query_params = opts[:query_params] || {} + + # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations: + query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil? + query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + header_params[:'xero-tenant-id'] = xero_tenant_id + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Allocation' + + # auth_names + auth_names = opts[:auth_names] || ['OAuth2'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, "AccountingApi", new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: AccountingApi#delete_prepayment_allocations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + # Deletes a specific tracking category # @param xero_tenant_id [String] Xero identifier for Tenant # @param tracking_category_id [String] Unique identifier for a TrackingCategory @@ -5437,6 +5857,7 @@ def delete_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, # @param invoice_id [String] Unique identifier for an Invoice # @param request_empty [RequestEmpty] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [nil] def email_invoice(xero_tenant_id, invoice_id, request_empty, opts = {}) email_invoice_with_http_info(xero_tenant_id, invoice_id, request_empty, opts) @@ -5448,6 +5869,7 @@ def email_invoice(xero_tenant_id, invoice_id, request_empty, opts = {}) # @param invoice_id [String] Unique identifier for an Invoice # @param request_empty [RequestEmpty] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def email_invoice_with_http_info(xero_tenant_id, invoice_id, request_empty, options = {}) opts = options.dup @@ -5486,6 +5908,7 @@ def email_invoice_with_http_info(xero_tenant_id, invoice_id, request_empty, opti # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -5844,7 +6267,7 @@ def get_account_attachments_with_http_info(xero_tenant_id, account_id, options = # Retrieves the full chart of accounts # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @return [Accounts] @@ -5856,7 +6279,7 @@ def get_accounts(xero_tenant_id, opts = {}) # Retrieves the full chart of accounts # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @return [Array<(Accounts, Integer, Hash)>] Accounts data, response status code and response headers @@ -6251,7 +6674,7 @@ def get_bank_transaction_attachments_with_http_info(xero_tenant_id, bank_transac # Retrieves any spent or received money transactions # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page Up to 100 bank transactions will be returned in a single API call with line items details @@ -6265,7 +6688,7 @@ def get_bank_transactions(xero_tenant_id, opts = {}) # Retrieves any spent or received money transactions # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page Up to 100 bank transactions will be returned in a single API call with line items details @@ -6811,7 +7234,7 @@ def get_bank_transfer_history_with_http_info(xero_tenant_id, bank_transfer_id, o # Retrieves all bank transfers # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @return [BankTransfers] @@ -6823,7 +7246,7 @@ def get_bank_transfers(xero_tenant_id, opts = {}) # Retrieves all bank transfers # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @return [Array<(BankTransfers, Integer, Hash)>] BankTransfers data, response status code and response headers @@ -7039,7 +7462,7 @@ def get_batch_payment_history_with_http_info(xero_tenant_id, batch_payment_id, o # Retrieves either one or many batch payments for invoices # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @return [BatchPayments] @@ -7051,7 +7474,7 @@ def get_batch_payments(xero_tenant_id, opts = {}) # Retrieves either one or many batch payments for invoices # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @return [Array<(BatchPayments, Integer, Hash)>] BatchPayments data, response status code and response headers @@ -7417,7 +7840,7 @@ def get_budget_with_http_info(xero_tenant_id, budget_id, options = {}) # Retrieve a list of budgets # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [Array] :i_ds Filter by BudgetID. Allows you to retrieve a specific individual budget. + # @option opts [Array] :ids Filter by BudgetID. Allows you to retrieve a specific individual budget. # @option opts [Date] :date_to Filter by start date # @option opts [Date] :date_from Filter by end date # @return [Budgets] @@ -7429,7 +7852,7 @@ def get_budgets(xero_tenant_id, opts = {}) # Retrieve a list of budgets # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [Array] :i_ds Filter by BudgetID. Allows you to retrieve a specific individual budget. + # @option opts [Array] :ids Filter by BudgetID. Allows you to retrieve a specific individual budget. # @option opts [Date] :date_to Filter by start date # @option opts [Date] :date_from Filter by end date # @return [Array<(Budgets, Integer, Hash)>] Budgets data, response status code and response headers @@ -7450,7 +7873,7 @@ def get_budgets_with_http_info(xero_tenant_id, options = {}) # query parameters query_params = opts[:query_params] || {} - query_params[:'IDs'] = @api_client.build_collection_param(opts[:'i_ds'], :csv) if !opts[:'i_ds'].nil? + query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil? query_params[:'DateTo'] = opts[:'date_to'] if !opts[:'date_to'].nil? query_params[:'DateFrom'] = opts[:'date_from'] if !opts[:'date_from'].nil? @@ -8196,10 +8619,10 @@ def get_contact_history_with_http_info(xero_tenant_id, contact_id, options = {}) # Retrieves all contacts in a Xero organisation # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element - # @option opts [Array] :i_ds Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. + # @option opts [Array] :ids Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. # @option opts [Integer] :page e.g. page=1 - Up to 100 contacts will be returned in a single API call. # @option opts [Boolean] :include_archived e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response # @option opts [Boolean] :summary_only Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (default to false) @@ -8213,10 +8636,10 @@ def get_contacts(xero_tenant_id, opts = {}) # Retrieves all contacts in a Xero organisation # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element - # @option opts [Array] :i_ds Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. + # @option opts [Array] :ids Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. # @option opts [Integer] :page e.g. page=1 - Up to 100 contacts will be returned in a single API call. # @option opts [Boolean] :include_archived e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response # @option opts [Boolean] :summary_only Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. @@ -8241,7 +8664,7 @@ def get_contacts_with_http_info(xero_tenant_id, options = {}) query_params = opts[:query_params] || {} query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil? query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil? - query_params[:'IDs'] = @api_client.build_collection_param(opts[:'i_ds'], :csv) if !opts[:'i_ds'].nil? + query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil? query_params[:'summaryOnly'] = opts[:'summary_only'] if !opts[:'summary_only'].nil? @@ -8768,7 +9191,7 @@ def get_credit_note_history_with_http_info(xero_tenant_id, credit_note_id, optio # Retrieves any credit notes # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note @@ -8782,7 +9205,7 @@ def get_credit_notes(xero_tenant_id, opts = {}) # Retrieves any credit notes # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note @@ -9002,7 +9425,7 @@ def get_employee_with_http_info(xero_tenant_id, employee_id, options = {}) # Retrieves employees used in Xero payrun # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @return [Employees] @@ -9014,7 +9437,7 @@ def get_employees(xero_tenant_id, opts = {}) # Retrieves employees used in Xero payrun # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @return [Array<(Employees, Integer, Hash)>] Employees data, response status code and response headers @@ -9230,7 +9653,7 @@ def get_expense_claim_history_with_http_info(xero_tenant_id, expense_claim_id, o # Retrieves expense claims # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @return [ExpenseClaims] @@ -9242,7 +9665,7 @@ def get_expense_claims(xero_tenant_id, opts = {}) # Retrieves expense claims # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @return [Array<(ExpenseClaims, Integer, Hash)>] ExpenseClaims data, response status code and response headers @@ -9856,12 +10279,12 @@ def get_invoice_reminders_with_http_info(xero_tenant_id, options = {}) # Retrieves sales invoices or purchase bills # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element - # @option opts [Array] :i_ds Filter by a comma-separated list of InvoicesIDs. + # @option opts [Array] :ids Filter by a comma-separated list of InvoicesIDs. # @option opts [Array] :invoice_numbers Filter by a comma-separated list of InvoiceNumbers. - # @option opts [Array] :contact_i_ds Filter by a comma-separated list of ContactIDs. + # @option opts [Array] :contact_ids Filter by a comma-separated list of ContactIDs. # @option opts [Array] :statuses Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter. # @option opts [Integer] :page e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice # @option opts [Boolean] :include_archived e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response @@ -9877,12 +10300,12 @@ def get_invoices(xero_tenant_id, opts = {}) # Retrieves sales invoices or purchase bills # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element - # @option opts [Array] :i_ds Filter by a comma-separated list of InvoicesIDs. + # @option opts [Array] :ids Filter by a comma-separated list of InvoicesIDs. # @option opts [Array] :invoice_numbers Filter by a comma-separated list of InvoiceNumbers. - # @option opts [Array] :contact_i_ds Filter by a comma-separated list of ContactIDs. + # @option opts [Array] :contact_ids Filter by a comma-separated list of ContactIDs. # @option opts [Array] :statuses Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter. # @option opts [Integer] :page e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice # @option opts [Boolean] :include_archived e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response @@ -9909,9 +10332,9 @@ def get_invoices_with_http_info(xero_tenant_id, options = {}) query_params = opts[:query_params] || {} query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil? query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil? - query_params[:'IDs'] = @api_client.build_collection_param(opts[:'i_ds'], :csv) if !opts[:'i_ds'].nil? + query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil? query_params[:'InvoiceNumbers'] = @api_client.build_collection_param(opts[:'invoice_numbers'], :csv) if !opts[:'invoice_numbers'].nil? - query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_i_ds'], :csv) if !opts[:'contact_i_ds'].nil? + query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil? query_params[:'Statuses'] = @api_client.build_collection_param(opts[:'statuses'], :csv) if !opts[:'statuses'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil? @@ -10114,7 +10537,7 @@ def get_item_history_with_http_info(xero_tenant_id, item_id, options = {}) # Retrieves items # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts @@ -10127,7 +10550,7 @@ def get_items(xero_tenant_id, opts = {}) # Retrieves items # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts @@ -10345,7 +10768,7 @@ def get_journal_by_number_with_http_info(xero_tenant_id, journal_number, options # Retrieves journals # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [Integer] :offset Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned # @option opts [Boolean] :payments_only Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default. # @return [Journals] @@ -10357,7 +10780,7 @@ def get_journals(xero_tenant_id, opts = {}) # Retrieves journals # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [Integer] :offset Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned # @option opts [Boolean] :payments_only Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default. # @return [Array<(Journals, Integer, Hash)>] Journals data, response status code and response headers @@ -10911,7 +11334,7 @@ def get_manual_journal_attachments_with_http_info(xero_tenant_id, manual_journal # Retrieves manual journals # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment @@ -10924,7 +11347,7 @@ def get_manual_journals(xero_tenant_id, opts = {}) # Retrieves manual journals # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment @@ -11505,7 +11928,7 @@ def get_overpayment_history_with_http_info(xero_tenant_id, overpayment_id, optio # Retrieves overpayments # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment @@ -11519,7 +11942,7 @@ def get_overpayments(xero_tenant_id, opts = {}) # Retrieves overpayments # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment @@ -11808,7 +12231,7 @@ def get_payment_services_with_http_info(xero_tenant_id, options = {}) # Retrieves payments for invoices and credit notes # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page Up to 100 payments will be returned in a single API call @@ -11821,7 +12244,7 @@ def get_payments(xero_tenant_id, opts = {}) # Retrieves payments for invoices and credit notes # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page Up to 100 payments will be returned in a single API call @@ -12039,7 +12462,7 @@ def get_prepayment_history_with_http_info(xero_tenant_id, prepayment_id, options # Retrieves prepayments # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment @@ -12053,7 +12476,7 @@ def get_prepayments(xero_tenant_id, opts = {}) # Retrieves prepayments # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment @@ -12674,7 +13097,7 @@ def get_purchase_order_history_with_http_info(xero_tenant_id, purchase_order_id, # Retrieves purchase orders # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :status Filter by purchase order status # @option opts [String] :date_from Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 # @option opts [String] :date_to Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 @@ -12689,7 +13112,7 @@ def get_purchase_orders(xero_tenant_id, opts = {}) # Retrieves purchase orders # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :status Filter by purchase order status # @option opts [String] :date_from Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 # @option opts [String] :date_to Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 @@ -13241,7 +13664,7 @@ def get_quote_history_with_http_info(xero_tenant_id, quote_id, options = {}) # Retrieves sales quotes # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [Date] :date_from Filter for quotes after a particular date # @option opts [Date] :date_to Filter for quotes before a particular date # @option opts [Date] :expiry_date_from Filter for quotes expiring after a particular date @@ -13260,7 +13683,7 @@ def get_quotes(xero_tenant_id, opts = {}) # Retrieves sales quotes # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [Date] :date_from Filter for quotes after a particular date # @option opts [Date] :date_to Filter for quotes before a particular date # @option opts [Date] :expiry_date_from Filter for quotes expiring after a particular date @@ -13744,7 +14167,7 @@ def get_receipt_history_with_http_info(xero_tenant_id, receipt_id, options = {}) # Retrieves draft expense claim receipts for any user # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts @@ -13757,7 +14180,7 @@ def get_receipts(xero_tenant_id, opts = {}) # Retrieves draft expense claim receipts for any user # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts @@ -15490,7 +15913,7 @@ def get_user_with_http_info(xero_tenant_id, user_id, options = {}) # Retrieves users # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @return [Users] @@ -15502,7 +15925,7 @@ def get_users(xero_tenant_id, opts = {}) # Retrieves users # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @return [Array<(Users, Integer, Hash)>] Users data, response status code and response headers @@ -15569,6 +15992,7 @@ def get_users_with_http_info(xero_tenant_id, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param setup [Setup] Object including an accounts array, a conversion balances array and a conversion date object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [ImportSummaryObject] def post_setup(xero_tenant_id, setup, opts = {}) data, _status_code, _headers = post_setup_with_http_info(xero_tenant_id, setup, opts) @@ -15579,6 +16003,7 @@ def post_setup(xero_tenant_id, setup, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param setup [Setup] Object including an accounts array, a conversion balances array and a conversion date object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(ImportSummaryObject, Integer, Hash)>] ImportSummaryObject data, response status code and response headers def post_setup_with_http_info(xero_tenant_id, setup, options = {}) opts = options.dup @@ -15613,6 +16038,7 @@ def post_setup_with_http_info(xero_tenant_id, setup, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -15647,6 +16073,7 @@ def post_setup_with_http_info(xero_tenant_id, setup, options = {}) # @param account_id [String] Unique identifier for Account object # @param accounts [Accounts] Request of type Accounts array with one Account # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Accounts] def update_account(xero_tenant_id, account_id, accounts, opts = {}) data, _status_code, _headers = update_account_with_http_info(xero_tenant_id, account_id, accounts, opts) @@ -15658,6 +16085,7 @@ def update_account(xero_tenant_id, account_id, accounts, opts = {}) # @param account_id [String] Unique identifier for Account object # @param accounts [Accounts] Request of type Accounts array with one Account # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Accounts, Integer, Hash)>] Accounts data, response status code and response headers def update_account_with_http_info(xero_tenant_id, account_id, accounts, options = {}) opts = options.dup @@ -15696,6 +16124,7 @@ def update_account_with_http_info(xero_tenant_id, account_id, accounts, options # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -15731,6 +16160,7 @@ def update_account_with_http_info(xero_tenant_id, account_id, accounts, options # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, opts = {}) data, _status_code, _headers = update_account_attachment_by_file_name_with_http_info(xero_tenant_id, account_id, file_name, body, opts) @@ -15743,6 +16173,7 @@ def update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def update_account_attachment_by_file_name_with_http_info(xero_tenant_id, account_id, file_name, body, options = {}) opts = options.dup @@ -15785,6 +16216,7 @@ def update_account_attachment_by_file_name_with_http_info(xero_tenant_id, accoun # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -15819,6 +16251,7 @@ def update_account_attachment_by_file_name_with_http_info(xero_tenant_id, accoun # @param bank_transaction_id [String] Xero generated unique identifier for a bank transaction # @param bank_transactions [BankTransactions] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [BankTransactions] def update_bank_transaction(xero_tenant_id, bank_transaction_id, bank_transactions, opts = {}) @@ -15831,6 +16264,7 @@ def update_bank_transaction(xero_tenant_id, bank_transaction_id, bank_transactio # @param bank_transaction_id [String] Xero generated unique identifier for a bank transaction # @param bank_transactions [BankTransactions] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Array<(BankTransactions, Integer, Hash)>] BankTransactions data, response status code and response headers def update_bank_transaction_with_http_info(xero_tenant_id, bank_transaction_id, bank_transactions, options = {}) @@ -15871,6 +16305,7 @@ def update_bank_transaction_with_http_info(xero_tenant_id, bank_transaction_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -15906,6 +16341,7 @@ def update_bank_transaction_with_http_info(xero_tenant_id, bank_transaction_id, # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, opts = {}) data, _status_code, _headers = update_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transaction_id, file_name, body, opts) @@ -15918,6 +16354,7 @@ def update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transac # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def update_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transaction_id, file_name, body, options = {}) opts = options.dup @@ -15960,6 +16397,7 @@ def update_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_i # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -15994,6 +16432,7 @@ def update_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_i # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, opts = {}) data, _status_code, _headers = update_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transfer_id, file_name, body, opts) @@ -16005,6 +16444,7 @@ def update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_i # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def update_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transfer_id, file_name, body, options = {}) opts = options.dup @@ -16047,6 +16487,7 @@ def update_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -16081,6 +16522,7 @@ def update_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, # @param contact_id [String] Unique identifier for a Contact # @param contacts [Contacts] an array of Contacts containing single Contact object with properties to update # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Contacts] def update_contact(xero_tenant_id, contact_id, contacts, opts = {}) data, _status_code, _headers = update_contact_with_http_info(xero_tenant_id, contact_id, contacts, opts) @@ -16092,6 +16534,7 @@ def update_contact(xero_tenant_id, contact_id, contacts, opts = {}) # @param contact_id [String] Unique identifier for a Contact # @param contacts [Contacts] an array of Contacts containing single Contact object with properties to update # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Contacts, Integer, Hash)>] Contacts data, response status code and response headers def update_contact_with_http_info(xero_tenant_id, contact_id, contacts, options = {}) opts = options.dup @@ -16130,6 +16573,7 @@ def update_contact_with_http_info(xero_tenant_id, contact_id, contacts, options # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -16164,6 +16608,7 @@ def update_contact_with_http_info(xero_tenant_id, contact_id, contacts, options # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, opts = {}) data, _status_code, _headers = update_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contact_id, file_name, body, opts) @@ -16175,6 +16620,7 @@ def update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def update_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contact_id, file_name, body, options = {}) opts = options.dup @@ -16217,6 +16663,7 @@ def update_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contac # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -16251,6 +16698,7 @@ def update_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contac # @param contact_group_id [String] Unique identifier for a Contact Group # @param contact_groups [ContactGroups] an array of Contact groups with Name of specific group to update # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [ContactGroups] def update_contact_group(xero_tenant_id, contact_group_id, contact_groups, opts = {}) data, _status_code, _headers = update_contact_group_with_http_info(xero_tenant_id, contact_group_id, contact_groups, opts) @@ -16262,6 +16710,7 @@ def update_contact_group(xero_tenant_id, contact_group_id, contact_groups, opts # @param contact_group_id [String] Unique identifier for a Contact Group # @param contact_groups [ContactGroups] an array of Contact groups with Name of specific group to update # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(ContactGroups, Integer, Hash)>] ContactGroups data, response status code and response headers def update_contact_group_with_http_info(xero_tenant_id, contact_group_id, contact_groups, options = {}) opts = options.dup @@ -16300,6 +16749,7 @@ def update_contact_group_with_http_info(xero_tenant_id, contact_group_id, contac # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -16334,6 +16784,7 @@ def update_contact_group_with_http_info(xero_tenant_id, contact_group_id, contac # @param credit_note_id [String] Unique identifier for a Credit Note # @param credit_notes [CreditNotes] an array of Credit Notes containing credit note details to update # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [CreditNotes] def update_credit_note(xero_tenant_id, credit_note_id, credit_notes, opts = {}) @@ -16346,6 +16797,7 @@ def update_credit_note(xero_tenant_id, credit_note_id, credit_notes, opts = {}) # @param credit_note_id [String] Unique identifier for a Credit Note # @param credit_notes [CreditNotes] an array of Credit Notes containing credit note details to update # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Array<(CreditNotes, Integer, Hash)>] CreditNotes data, response status code and response headers def update_credit_note_with_http_info(xero_tenant_id, credit_note_id, credit_notes, options = {}) @@ -16386,6 +16838,7 @@ def update_credit_note_with_http_info(xero_tenant_id, credit_note_id, credit_not # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -16421,6 +16874,7 @@ def update_credit_note_with_http_info(xero_tenant_id, credit_note_id, credit_not # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, opts = {}) data, _status_code, _headers = update_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, credit_note_id, file_name, body, opts) @@ -16433,6 +16887,7 @@ def update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, f # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def update_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, credit_note_id, file_name, body, options = {}) opts = options.dup @@ -16475,6 +16930,7 @@ def update_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, cr # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -16509,6 +16965,7 @@ def update_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, cr # @param expense_claim_id [String] Unique identifier for a ExpenseClaim # @param expense_claims [ExpenseClaims] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [ExpenseClaims] def update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims, opts = {}) data, _status_code, _headers = update_expense_claim_with_http_info(xero_tenant_id, expense_claim_id, expense_claims, opts) @@ -16520,6 +16977,7 @@ def update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims, opts # @param expense_claim_id [String] Unique identifier for a ExpenseClaim # @param expense_claims [ExpenseClaims] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(ExpenseClaims, Integer, Hash)>] ExpenseClaims data, response status code and response headers def update_expense_claim_with_http_info(xero_tenant_id, expense_claim_id, expense_claims, options = {}) opts = options.dup @@ -16558,6 +17016,7 @@ def update_expense_claim_with_http_info(xero_tenant_id, expense_claim_id, expens # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -16592,6 +17051,7 @@ def update_expense_claim_with_http_info(xero_tenant_id, expense_claim_id, expens # @param invoice_id [String] Unique identifier for an Invoice # @param invoices [Invoices] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Invoices] def update_invoice(xero_tenant_id, invoice_id, invoices, opts = {}) @@ -16604,6 +17064,7 @@ def update_invoice(xero_tenant_id, invoice_id, invoices, opts = {}) # @param invoice_id [String] Unique identifier for an Invoice # @param invoices [Invoices] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Array<(Invoices, Integer, Hash)>] Invoices data, response status code and response headers def update_invoice_with_http_info(xero_tenant_id, invoice_id, invoices, options = {}) @@ -16644,6 +17105,7 @@ def update_invoice_with_http_info(xero_tenant_id, invoice_id, invoices, options # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -16679,6 +17141,7 @@ def update_invoice_with_http_info(xero_tenant_id, invoice_id, invoices, options # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, opts = {}) data, _status_code, _headers = update_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoice_id, file_name, body, opts) @@ -16691,6 +17154,7 @@ def update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def update_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoice_id, file_name, body, options = {}) opts = options.dup @@ -16733,6 +17197,7 @@ def update_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoic # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -16767,6 +17232,7 @@ def update_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoic # @param item_id [String] Unique identifier for an Item # @param items [Items] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Items] def update_item(xero_tenant_id, item_id, items, opts = {}) @@ -16779,6 +17245,7 @@ def update_item(xero_tenant_id, item_id, items, opts = {}) # @param item_id [String] Unique identifier for an Item # @param items [Items] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Array<(Items, Integer, Hash)>] Items data, response status code and response headers def update_item_with_http_info(xero_tenant_id, item_id, items, options = {}) @@ -16819,6 +17286,7 @@ def update_item_with_http_info(xero_tenant_id, item_id, items, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -16853,6 +17321,7 @@ def update_item_with_http_info(xero_tenant_id, item_id, items, options = {}) # @param linked_transaction_id [String] Unique identifier for a LinkedTransaction # @param linked_transactions [LinkedTransactions] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [LinkedTransactions] def update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions, opts = {}) data, _status_code, _headers = update_linked_transaction_with_http_info(xero_tenant_id, linked_transaction_id, linked_transactions, opts) @@ -16864,6 +17333,7 @@ def update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_tran # @param linked_transaction_id [String] Unique identifier for a LinkedTransaction # @param linked_transactions [LinkedTransactions] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(LinkedTransactions, Integer, Hash)>] LinkedTransactions data, response status code and response headers def update_linked_transaction_with_http_info(xero_tenant_id, linked_transaction_id, linked_transactions, options = {}) opts = options.dup @@ -16902,6 +17372,7 @@ def update_linked_transaction_with_http_info(xero_tenant_id, linked_transaction_ # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -16936,6 +17407,7 @@ def update_linked_transaction_with_http_info(xero_tenant_id, linked_transaction_ # @param manual_journal_id [String] Unique identifier for a ManualJournal # @param manual_journals [ManualJournals] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [ManualJournals] def update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals, opts = {}) data, _status_code, _headers = update_manual_journal_with_http_info(xero_tenant_id, manual_journal_id, manual_journals, opts) @@ -16947,6 +17419,7 @@ def update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals, op # @param manual_journal_id [String] Unique identifier for a ManualJournal # @param manual_journals [ManualJournals] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(ManualJournals, Integer, Hash)>] ManualJournals data, response status code and response headers def update_manual_journal_with_http_info(xero_tenant_id, manual_journal_id, manual_journals, options = {}) opts = options.dup @@ -16985,6 +17458,7 @@ def update_manual_journal_with_http_info(xero_tenant_id, manual_journal_id, manu # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -17020,6 +17494,7 @@ def update_manual_journal_with_http_info(xero_tenant_id, manual_journal_id, manu # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, opts = {}) data, _status_code, _headers = update_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, manual_journal_id, file_name, body, opts) @@ -17032,6 +17507,7 @@ def update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def update_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, manual_journal_id, file_name, body, options = {}) opts = options.dup @@ -17074,6 +17550,7 @@ def update_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -17107,6 +17584,7 @@ def update_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, # @param xero_tenant_id [String] Xero identifier for Tenant # @param bank_transactions [BankTransactions] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [BankTransactions] @@ -17119,6 +17597,7 @@ def update_or_create_bank_transactions(xero_tenant_id, bank_transactions, opts = # @param xero_tenant_id [String] Xero identifier for Tenant # @param bank_transactions [BankTransactions] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Array<(BankTransactions, Integer, Hash)>] BankTransactions data, response status code and response headers @@ -17157,6 +17636,7 @@ def update_or_create_bank_transactions_with_http_info(xero_tenant_id, bank_trans # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -17190,6 +17670,7 @@ def update_or_create_bank_transactions_with_http_info(xero_tenant_id, bank_trans # @param xero_tenant_id [String] Xero identifier for Tenant # @param contacts [Contacts] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [Contacts] def update_or_create_contacts(xero_tenant_id, contacts, opts = {}) @@ -17201,6 +17682,7 @@ def update_or_create_contacts(xero_tenant_id, contacts, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param contacts [Contacts] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(Contacts, Integer, Hash)>] Contacts data, response status code and response headers def update_or_create_contacts_with_http_info(xero_tenant_id, contacts, options = {}) @@ -17237,6 +17719,7 @@ def update_or_create_contacts_with_http_info(xero_tenant_id, contacts, options = # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -17270,6 +17753,7 @@ def update_or_create_contacts_with_http_info(xero_tenant_id, contacts, options = # @param xero_tenant_id [String] Xero identifier for Tenant # @param credit_notes [CreditNotes] an array of Credit Notes with a single CreditNote object. # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [CreditNotes] @@ -17282,6 +17766,7 @@ def update_or_create_credit_notes(xero_tenant_id, credit_notes, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param credit_notes [CreditNotes] an array of Credit Notes with a single CreditNote object. # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Array<(CreditNotes, Integer, Hash)>] CreditNotes data, response status code and response headers @@ -17320,6 +17805,7 @@ def update_or_create_credit_notes_with_http_info(xero_tenant_id, credit_notes, o # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -17353,6 +17839,7 @@ def update_or_create_credit_notes_with_http_info(xero_tenant_id, credit_notes, o # @param xero_tenant_id [String] Xero identifier for Tenant # @param employees [Employees] Employees with array of Employee object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [Employees] def update_or_create_employees(xero_tenant_id, employees, opts = {}) @@ -17364,6 +17851,7 @@ def update_or_create_employees(xero_tenant_id, employees, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param employees [Employees] Employees with array of Employee object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(Employees, Integer, Hash)>] Employees data, response status code and response headers def update_or_create_employees_with_http_info(xero_tenant_id, employees, options = {}) @@ -17400,6 +17888,7 @@ def update_or_create_employees_with_http_info(xero_tenant_id, employees, options # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -17433,6 +17922,7 @@ def update_or_create_employees_with_http_info(xero_tenant_id, employees, options # @param xero_tenant_id [String] Xero identifier for Tenant # @param invoices [Invoices] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Invoices] @@ -17445,6 +17935,7 @@ def update_or_create_invoices(xero_tenant_id, invoices, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param invoices [Invoices] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Array<(Invoices, Integer, Hash)>] Invoices data, response status code and response headers @@ -17483,6 +17974,7 @@ def update_or_create_invoices_with_http_info(xero_tenant_id, invoices, options = # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -17516,6 +18008,7 @@ def update_or_create_invoices_with_http_info(xero_tenant_id, invoices, options = # @param xero_tenant_id [String] Xero identifier for Tenant # @param items [Items] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Items] @@ -17528,6 +18021,7 @@ def update_or_create_items(xero_tenant_id, items, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param items [Items] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Array<(Items, Integer, Hash)>] Items data, response status code and response headers @@ -17566,6 +18060,7 @@ def update_or_create_items_with_http_info(xero_tenant_id, items, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -17599,6 +18094,7 @@ def update_or_create_items_with_http_info(xero_tenant_id, items, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param manual_journals [ManualJournals] ManualJournals array with ManualJournal object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [ManualJournals] def update_or_create_manual_journals(xero_tenant_id, manual_journals, opts = {}) @@ -17610,6 +18106,7 @@ def update_or_create_manual_journals(xero_tenant_id, manual_journals, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param manual_journals [ManualJournals] ManualJournals array with ManualJournal object in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(ManualJournals, Integer, Hash)>] ManualJournals data, response status code and response headers def update_or_create_manual_journals_with_http_info(xero_tenant_id, manual_journals, options = {}) @@ -17646,6 +18143,7 @@ def update_or_create_manual_journals_with_http_info(xero_tenant_id, manual_journ # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -17679,6 +18177,7 @@ def update_or_create_manual_journals_with_http_info(xero_tenant_id, manual_journ # @param xero_tenant_id [String] Xero identifier for Tenant # @param purchase_orders [PurchaseOrders] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [PurchaseOrders] def update_or_create_purchase_orders(xero_tenant_id, purchase_orders, opts = {}) @@ -17690,6 +18189,7 @@ def update_or_create_purchase_orders(xero_tenant_id, purchase_orders, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param purchase_orders [PurchaseOrders] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(PurchaseOrders, Integer, Hash)>] PurchaseOrders data, response status code and response headers def update_or_create_purchase_orders_with_http_info(xero_tenant_id, purchase_orders, options = {}) @@ -17726,6 +18226,7 @@ def update_or_create_purchase_orders_with_http_info(xero_tenant_id, purchase_ord # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -17759,6 +18260,7 @@ def update_or_create_purchase_orders_with_http_info(xero_tenant_id, purchase_ord # @param xero_tenant_id [String] Xero identifier for Tenant # @param quotes [Quotes] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [Quotes] def update_or_create_quotes(xero_tenant_id, quotes, opts = {}) @@ -17770,6 +18272,7 @@ def update_or_create_quotes(xero_tenant_id, quotes, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param quotes [Quotes] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(Quotes, Integer, Hash)>] Quotes data, response status code and response headers def update_or_create_quotes_with_http_info(xero_tenant_id, quotes, options = {}) @@ -17806,6 +18309,7 @@ def update_or_create_quotes_with_http_info(xero_tenant_id, quotes, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -17839,6 +18343,7 @@ def update_or_create_quotes_with_http_info(xero_tenant_id, quotes, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param repeating_invoices [RepeatingInvoices] RepeatingInvoices with an array of repeating invoice objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false) # @return [RepeatingInvoices] def update_or_create_repeating_invoices(xero_tenant_id, repeating_invoices, opts = {}) @@ -17850,6 +18355,7 @@ def update_or_create_repeating_invoices(xero_tenant_id, repeating_invoices, opts # @param xero_tenant_id [String] Xero identifier for Tenant # @param repeating_invoices [RepeatingInvoices] RepeatingInvoices with an array of repeating invoice objects in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors # @return [Array<(RepeatingInvoices, Integer, Hash)>] RepeatingInvoices data, response status code and response headers def update_or_create_repeating_invoices_with_http_info(xero_tenant_id, repeating_invoices, options = {}) @@ -17886,6 +18392,7 @@ def update_or_create_repeating_invoices_with_http_info(xero_tenant_id, repeating # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -17920,6 +18427,7 @@ def update_or_create_repeating_invoices_with_http_info(xero_tenant_id, repeating # @param purchase_order_id [String] Unique identifier for an Purchase Order # @param purchase_orders [PurchaseOrders] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [PurchaseOrders] def update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders, opts = {}) data, _status_code, _headers = update_purchase_order_with_http_info(xero_tenant_id, purchase_order_id, purchase_orders, opts) @@ -17931,6 +18439,7 @@ def update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders, op # @param purchase_order_id [String] Unique identifier for an Purchase Order # @param purchase_orders [PurchaseOrders] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(PurchaseOrders, Integer, Hash)>] PurchaseOrders data, response status code and response headers def update_purchase_order_with_http_info(xero_tenant_id, purchase_order_id, purchase_orders, options = {}) opts = options.dup @@ -17969,6 +18478,7 @@ def update_purchase_order_with_http_info(xero_tenant_id, purchase_order_id, purc # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -18004,6 +18514,7 @@ def update_purchase_order_with_http_info(xero_tenant_id, purchase_order_id, purc # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, opts = {}) data, _status_code, _headers = update_purchase_order_attachment_by_file_name_with_http_info(xero_tenant_id, purchase_order_id, file_name, body, opts) @@ -18016,6 +18527,7 @@ def update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def update_purchase_order_attachment_by_file_name_with_http_info(xero_tenant_id, purchase_order_id, file_name, body, options = {}) opts = options.dup @@ -18058,6 +18570,7 @@ def update_purchase_order_attachment_by_file_name_with_http_info(xero_tenant_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -18092,6 +18605,7 @@ def update_purchase_order_attachment_by_file_name_with_http_info(xero_tenant_id, # @param quote_id [String] Unique identifier for an Quote # @param quotes [Quotes] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Quotes] def update_quote(xero_tenant_id, quote_id, quotes, opts = {}) data, _status_code, _headers = update_quote_with_http_info(xero_tenant_id, quote_id, quotes, opts) @@ -18103,6 +18617,7 @@ def update_quote(xero_tenant_id, quote_id, quotes, opts = {}) # @param quote_id [String] Unique identifier for an Quote # @param quotes [Quotes] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Quotes, Integer, Hash)>] Quotes data, response status code and response headers def update_quote_with_http_info(xero_tenant_id, quote_id, quotes, options = {}) opts = options.dup @@ -18141,6 +18656,7 @@ def update_quote_with_http_info(xero_tenant_id, quote_id, quotes, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -18176,6 +18692,7 @@ def update_quote_with_http_info(xero_tenant_id, quote_id, quotes, options = {}) # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, opts = {}) data, _status_code, _headers = update_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id, file_name, body, opts) @@ -18188,6 +18705,7 @@ def update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, bo # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def update_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id, file_name, body, options = {}) opts = options.dup @@ -18230,6 +18748,7 @@ def update_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -18264,6 +18783,7 @@ def update_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id # @param receipt_id [String] Unique identifier for a Receipt # @param receipts [Receipts] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Receipts] def update_receipt(xero_tenant_id, receipt_id, receipts, opts = {}) @@ -18276,6 +18796,7 @@ def update_receipt(xero_tenant_id, receipt_id, receipts, opts = {}) # @param receipt_id [String] Unique identifier for a Receipt # @param receipts [Receipts] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts # @return [Array<(Receipts, Integer, Hash)>] Receipts data, response status code and response headers def update_receipt_with_http_info(xero_tenant_id, receipt_id, receipts, options = {}) @@ -18316,6 +18837,7 @@ def update_receipt_with_http_info(xero_tenant_id, receipt_id, receipts, options # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -18351,6 +18873,7 @@ def update_receipt_with_http_info(xero_tenant_id, receipt_id, receipts, options # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, opts = {}) data, _status_code, _headers = update_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receipt_id, file_name, body, opts) @@ -18363,6 +18886,7 @@ def update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def update_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receipt_id, file_name, body, options = {}) opts = options.dup @@ -18405,6 +18929,7 @@ def update_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receip # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -18439,6 +18964,7 @@ def update_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receip # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice # @param repeating_invoices [RepeatingInvoices] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [RepeatingInvoices] def update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_invoices, opts = {}) data, _status_code, _headers = update_repeating_invoice_with_http_info(xero_tenant_id, repeating_invoice_id, repeating_invoices, opts) @@ -18450,6 +18976,7 @@ def update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_inv # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice # @param repeating_invoices [RepeatingInvoices] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(RepeatingInvoices, Integer, Hash)>] RepeatingInvoices data, response status code and response headers def update_repeating_invoice_with_http_info(xero_tenant_id, repeating_invoice_id, repeating_invoices, options = {}) opts = options.dup @@ -18488,6 +19015,7 @@ def update_repeating_invoice_with_http_info(xero_tenant_id, repeating_invoice_id # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -18523,6 +19051,7 @@ def update_repeating_invoice_with_http_info(xero_tenant_id, repeating_invoice_id # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Attachments] def update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, opts = {}) data, _status_code, _headers = update_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, repeating_invoice_id, file_name, body, opts) @@ -18535,6 +19064,7 @@ def update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_i # @param file_name [String] Name of the attachment # @param body [String] Byte array of file in body of request # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Attachments, Integer, Hash)>] Attachments data, response status code and response headers def update_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, repeating_invoice_id, file_name, body, options = {}) opts = options.dup @@ -18577,6 +19107,7 @@ def update_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_ # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -18610,6 +19141,7 @@ def update_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_ # @param xero_tenant_id [String] Xero identifier for Tenant # @param tax_rates [TaxRates] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TaxRates] def update_tax_rate(xero_tenant_id, tax_rates, opts = {}) data, _status_code, _headers = update_tax_rate_with_http_info(xero_tenant_id, tax_rates, opts) @@ -18620,6 +19152,7 @@ def update_tax_rate(xero_tenant_id, tax_rates, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param tax_rates [TaxRates] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TaxRates, Integer, Hash)>] TaxRates data, response status code and response headers def update_tax_rate_with_http_info(xero_tenant_id, tax_rates, options = {}) opts = options.dup @@ -18654,6 +19187,7 @@ def update_tax_rate_with_http_info(xero_tenant_id, tax_rates, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -18688,6 +19222,7 @@ def update_tax_rate_with_http_info(xero_tenant_id, tax_rates, options = {}) # @param tracking_category_id [String] Unique identifier for a TrackingCategory # @param tracking_category [TrackingCategory] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TrackingCategories] def update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category, opts = {}) data, _status_code, _headers = update_tracking_category_with_http_info(xero_tenant_id, tracking_category_id, tracking_category, opts) @@ -18699,6 +19234,7 @@ def update_tracking_category(xero_tenant_id, tracking_category_id, tracking_cate # @param tracking_category_id [String] Unique identifier for a TrackingCategory # @param tracking_category [TrackingCategory] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TrackingCategories, Integer, Hash)>] TrackingCategories data, response status code and response headers def update_tracking_category_with_http_info(xero_tenant_id, tracking_category_id, tracking_category, options = {}) opts = options.dup @@ -18737,6 +19273,7 @@ def update_tracking_category_with_http_info(xero_tenant_id, tracking_category_id # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -18772,6 +19309,7 @@ def update_tracking_category_with_http_info(xero_tenant_id, tracking_category_id # @param tracking_option_id [String] Unique identifier for a Tracking Option # @param tracking_option [TrackingOption] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TrackingOptions] def update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option, opts = {}) data, _status_code, _headers = update_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option, opts) @@ -18784,6 +19322,7 @@ def update_tracking_options(xero_tenant_id, tracking_category_id, tracking_optio # @param tracking_option_id [String] Unique identifier for a Tracking Option # @param tracking_option [TrackingOption] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TrackingOptions, Integer, Hash)>] TrackingOptions data, response status code and response headers def update_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option, options = {}) opts = options.dup @@ -18826,6 +19365,7 @@ def update_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} diff --git a/lib/xero-ruby/api/app_store_api.rb b/lib/xero-ruby/api/app_store_api.rb index 37588ea8..3e08c103 100644 --- a/lib/xero-ruby/api/app_store_api.rb +++ b/lib/xero-ruby/api/app_store_api.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -157,6 +157,7 @@ def get_usage_records_with_http_info(subscription_id, options = {}) # @param subscription_item_id [String] The unique identifier of the subscriptionItem # @param create_usage_record [CreateUsageRecord] Contains the quantity for the usage record to create # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [UsageRecord] def post_usage_records(subscription_id, subscription_item_id, create_usage_record, opts = {}) data, _status_code, _headers = post_usage_records_with_http_info(subscription_id, subscription_item_id, create_usage_record, opts) @@ -168,6 +169,7 @@ def post_usage_records(subscription_id, subscription_item_id, create_usage_recor # @param subscription_item_id [String] The unique identifier of the subscriptionItem # @param create_usage_record [CreateUsageRecord] Contains the quantity for the usage record to create # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(UsageRecord, Integer, Hash)>] UsageRecord data, response status code and response headers def post_usage_records_with_http_info(subscription_id, subscription_item_id, create_usage_record, options = {}) opts = options.dup @@ -205,6 +207,7 @@ def post_usage_records_with_http_info(subscription_id, subscription_item_id, cre header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -240,6 +243,7 @@ def post_usage_records_with_http_info(subscription_id, subscription_item_id, cre # @param usage_record_id [String] The unique identifier of the usage record # @param update_usage_record [UpdateUsageRecord] Contains the quantity for the usage record to update # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [UsageRecord] def put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record, opts = {}) data, _status_code, _headers = put_usage_records_with_http_info(subscription_id, subscription_item_id, usage_record_id, update_usage_record, opts) @@ -252,6 +256,7 @@ def put_usage_records(subscription_id, subscription_item_id, usage_record_id, up # @param usage_record_id [String] The unique identifier of the usage record # @param update_usage_record [UpdateUsageRecord] Contains the quantity for the usage record to update # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(UsageRecord, Integer, Hash)>] UsageRecord data, response status code and response headers def put_usage_records_with_http_info(subscription_id, subscription_item_id, usage_record_id, update_usage_record, options = {}) opts = options.dup @@ -293,6 +298,7 @@ def put_usage_records_with_http_info(subscription_id, subscription_item_id, usag header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} diff --git a/lib/xero-ruby/api/asset_api.rb b/lib/xero-ruby/api/asset_api.rb index 51d8ac95..9f2bdee0 100644 --- a/lib/xero-ruby/api/asset_api.rb +++ b/lib/xero-ruby/api/asset_api.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -21,6 +21,7 @@ def initialize(api_client = ApiClient.new) # @param xero_tenant_id [String] Xero identifier for Tenant # @param asset [Asset] Fixed asset you are creating # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Asset] def create_asset(xero_tenant_id, asset, opts = {}) data, _status_code, _headers = create_asset_with_http_info(xero_tenant_id, asset, opts) @@ -32,6 +33,7 @@ def create_asset(xero_tenant_id, asset, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param asset [Asset] Fixed asset you are creating # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Asset, Integer, Hash)>] Asset data, response status code and response headers def create_asset_with_http_info(xero_tenant_id, asset, options = {}) opts = options.dup @@ -66,6 +68,7 @@ def create_asset_with_http_info(xero_tenant_id, asset, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -99,6 +102,7 @@ def create_asset_with_http_info(xero_tenant_id, asset, options = {}) # Adds an fixed asset type to the system # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [AssetType] :asset_type Asset type to add # @return [AssetType] def create_asset_type(xero_tenant_id, opts = {}) @@ -110,6 +114,7 @@ def create_asset_type(xero_tenant_id, opts = {}) # Adds an fixed asset type to the system # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [AssetType] :asset_type Asset type to add # @return [Array<(AssetType, Integer, Hash)>] AssetType data, response status code and response headers def create_asset_type_with_http_info(xero_tenant_id, options = {}) @@ -141,6 +146,7 @@ def create_asset_type_with_http_info(xero_tenant_id, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} diff --git a/lib/xero-ruby/api/files_api.rb b/lib/xero-ruby/api/files_api.rb index 79661a61..8f7a45cb 100644 --- a/lib/xero-ruby/api/files_api.rb +++ b/lib/xero-ruby/api/files_api.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -21,6 +21,7 @@ def initialize(api_client = ApiClient.new) # @param xero_tenant_id [String] Xero identifier for Tenant # @param file_id [String] File id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Association] :association # @return [Association] def create_file_association(xero_tenant_id, file_id, opts = {}) @@ -33,6 +34,7 @@ def create_file_association(xero_tenant_id, file_id, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param file_id [String] File id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Association] :association # @return [Array<(Association, Integer, Hash)>] Association data, response status code and response headers def create_file_association_with_http_info(xero_tenant_id, file_id, options = {}) @@ -68,6 +70,7 @@ def create_file_association_with_http_info(xero_tenant_id, file_id, options = {} # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -101,6 +104,7 @@ def create_file_association_with_http_info(xero_tenant_id, file_id, options = {} # By passing in the appropriate properties, you can create a new folder # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Folder] :folder # @return [Folder] def create_folder(xero_tenant_id, opts = {}) @@ -112,6 +116,7 @@ def create_folder(xero_tenant_id, opts = {}) # By passing in the appropriate properties, you can create a new folder # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Folder] :folder # @return [Array<(Folder, Integer, Hash)>] Folder data, response status code and response headers def create_folder_with_http_info(xero_tenant_id, options = {}) @@ -143,6 +148,7 @@ def create_folder_with_http_info(xero_tenant_id, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -408,6 +414,10 @@ def delete_folder_with_http_info(xero_tenant_id, folder_id, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param object_id [String] Object id for single object # @param [Hash] opts the optional parameters + # @option opts [Integer] :pagesize pass an optional page size value + # @option opts [Integer] :page number of records to skip for pagination + # @option opts [String] :sort values to sort by + # @option opts [String] :direction direction to sort by # @return [Array] def get_associations_by_object(xero_tenant_id, object_id, opts = {}) data, _status_code, _headers = get_associations_by_object_with_http_info(xero_tenant_id, object_id, opts) @@ -419,6 +429,10 @@ def get_associations_by_object(xero_tenant_id, object_id, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param object_id [String] Object id for single object # @param [Hash] opts the optional parameters + # @option opts [Integer] :pagesize pass an optional page size value + # @option opts [Integer] :page number of records to skip for pagination + # @option opts [String] :sort values to sort by + # @option opts [String] :direction direction to sort by # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers def get_associations_by_object_with_http_info(xero_tenant_id, object_id, options = {}) opts = options.dup @@ -433,6 +447,22 @@ def get_associations_by_object_with_http_info(xero_tenant_id, object_id, options if @api_client.config.client_side_validation && object_id.nil? fail ArgumentError, "Missing the required parameter 'object_id' when calling FilesApi.get_associations_by_object" end + if @api_client.config.client_side_validation && !opts[:'pagesize'].nil? && opts[:'pagesize'] > 100 + fail ArgumentError, 'invalid value for "opts[:"pagesize"]" when calling FilesApi.get_associations_by_object, must be smaller than or equal to 100.' + end + + if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1 + fail ArgumentError, 'invalid value for "opts[:"page"]" when calling FilesApi.get_associations_by_object, must be greater than or equal to 1.' + end + + allowable_values = ["Name", "CreatedDateUTC"] + if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) + fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" + end + allowable_values = ["ASC", "DESC"] + if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction']) + fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}" + end # resource path local_var_path = '/Associations/{ObjectId}'.sub('{' + 'ObjectId' + '}', object_id.to_s) @@ -441,6 +471,10 @@ def get_associations_by_object_with_http_info(xero_tenant_id, object_id, options # query parameters query_params = opts[:query_params] || {} + query_params[:'pagesize'] = opts[:'pagesize'] if !opts[:'pagesize'].nil? + query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? + query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? + query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil? # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations: query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil? @@ -1108,6 +1142,7 @@ def get_inbox_with_http_info(xero_tenant_id, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param file_id [String] File id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [FileObject] :file_object # @return [FileObject] def update_file(xero_tenant_id, file_id, opts = {}) @@ -1120,6 +1155,7 @@ def update_file(xero_tenant_id, file_id, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param file_id [String] File id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [FileObject] :file_object # @return [Array<(FileObject, Integer, Hash)>] FileObject data, response status code and response headers def update_file_with_http_info(xero_tenant_id, file_id, options = {}) @@ -1155,6 +1191,7 @@ def update_file_with_http_info(xero_tenant_id, file_id, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1190,6 +1227,7 @@ def update_file_with_http_info(xero_tenant_id, file_id, options = {}) # @param folder_id [String] Folder id for single object # @param folder [Folder] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Folder] def update_folder(xero_tenant_id, folder_id, folder, opts = {}) data, _status_code, _headers = update_folder_with_http_info(xero_tenant_id, folder_id, folder, opts) @@ -1202,6 +1240,7 @@ def update_folder(xero_tenant_id, folder_id, folder, opts = {}) # @param folder_id [String] Folder id for single object # @param folder [Folder] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Folder, Integer, Hash)>] Folder data, response status code and response headers def update_folder_with_http_info(xero_tenant_id, folder_id, folder, options = {}) opts = options.dup @@ -1240,6 +1279,7 @@ def update_folder_with_http_info(xero_tenant_id, folder_id, folder, options = {} # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1275,6 +1315,7 @@ def update_folder_with_http_info(xero_tenant_id, folder_id, folder, options = {} # @param name [String] exact name of the file you are uploading # @param filename [String] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [String] :mime_type # @return [FileObject] def upload_file(xero_tenant_id, body, name, filename, opts = {}) @@ -1288,6 +1329,7 @@ def upload_file(xero_tenant_id, body, name, filename, opts = {}) # @param name [String] exact name of the file you are uploading # @param filename [String] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [String] :mime_type # @return [Array<(FileObject, Integer, Hash)>] FileObject data, response status code and response headers def upload_file_with_http_info(xero_tenant_id, body, name, filename, options = {}) @@ -1331,6 +1373,7 @@ def upload_file_with_http_info(xero_tenant_id, body, name, filename, options = { # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1371,6 +1414,7 @@ def upload_file_with_http_info(xero_tenant_id, body, name, filename, options = { # @param name [String] exact name of the file you are uploading # @param filename [String] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [String] :mime_type # @return [FileObject] def upload_file_to_folder(xero_tenant_id, folder_id, body, name, filename, opts = {}) @@ -1385,6 +1429,7 @@ def upload_file_to_folder(xero_tenant_id, folder_id, body, name, filename, opts # @param name [String] exact name of the file you are uploading # @param filename [String] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [String] :mime_type # @return [Array<(FileObject, Integer, Hash)>] FileObject data, response status code and response headers def upload_file_to_folder_with_http_info(xero_tenant_id, folder_id, body, name, filename, options = {}) @@ -1432,6 +1477,7 @@ def upload_file_to_folder_with_http_info(xero_tenant_id, folder_id, body, name, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data']) header_params[:'xero-tenant-id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} diff --git a/lib/xero-ruby/api/finance_api.rb b/lib/xero-ruby/api/finance_api.rb index db694e8b..e97f9f7c 100644 --- a/lib/xero-ruby/api/finance_api.rb +++ b/lib/xero-ruby/api/finance_api.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/api/payroll_au_api.rb b/lib/xero-ruby/api/payroll_au_api.rb index 79a824cd..5554c4bc 100644 --- a/lib/xero-ruby/api/payroll_au_api.rb +++ b/lib/xero-ruby/api/payroll_au_api.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -20,6 +20,7 @@ def initialize(api_client = ApiClient.new) # @param xero_tenant_id [String] Xero identifier for Tenant # @param leave_application_id [String] Leave Application id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [LeaveApplications] def approve_leave_application(xero_tenant_id, leave_application_id, opts = {}) data, _status_code, _headers = approve_leave_application_with_http_info(xero_tenant_id, leave_application_id, opts) @@ -30,6 +31,7 @@ def approve_leave_application(xero_tenant_id, leave_application_id, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param leave_application_id [String] Leave Application id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(LeaveApplications, Integer, Hash)>] LeaveApplications data, response status code and response headers def approve_leave_application_with_http_info(xero_tenant_id, leave_application_id, options = {}) opts = options.dup @@ -62,6 +64,7 @@ def approve_leave_application_with_http_info(xero_tenant_id, leave_application_i # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -95,6 +98,7 @@ def approve_leave_application_with_http_info(xero_tenant_id, leave_application_i # @param xero_tenant_id [String] Xero identifier for Tenant # @param employee [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Employees] def create_employee(xero_tenant_id, employee, opts = {}) data, _status_code, _headers = create_employee_with_http_info(xero_tenant_id, employee, opts) @@ -105,6 +109,7 @@ def create_employee(xero_tenant_id, employee, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param employee [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Employees, Integer, Hash)>] Employees data, response status code and response headers def create_employee_with_http_info(xero_tenant_id, employee, options = {}) opts = options.dup @@ -139,6 +144,7 @@ def create_employee_with_http_info(xero_tenant_id, employee, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -172,6 +178,7 @@ def create_employee_with_http_info(xero_tenant_id, employee, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param leave_application [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [LeaveApplications] def create_leave_application(xero_tenant_id, leave_application, opts = {}) data, _status_code, _headers = create_leave_application_with_http_info(xero_tenant_id, leave_application, opts) @@ -182,6 +189,7 @@ def create_leave_application(xero_tenant_id, leave_application, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param leave_application [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(LeaveApplications, Integer, Hash)>] LeaveApplications data, response status code and response headers def create_leave_application_with_http_info(xero_tenant_id, leave_application, options = {}) opts = options.dup @@ -216,6 +224,7 @@ def create_leave_application_with_http_info(xero_tenant_id, leave_application, o # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -249,6 +258,7 @@ def create_leave_application_with_http_info(xero_tenant_id, leave_application, o # @param xero_tenant_id [String] Xero identifier for Tenant # @param pay_item [PayItem] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [PayItems] def create_pay_item(xero_tenant_id, pay_item, opts = {}) data, _status_code, _headers = create_pay_item_with_http_info(xero_tenant_id, pay_item, opts) @@ -259,6 +269,7 @@ def create_pay_item(xero_tenant_id, pay_item, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param pay_item [PayItem] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(PayItems, Integer, Hash)>] PayItems data, response status code and response headers def create_pay_item_with_http_info(xero_tenant_id, pay_item, options = {}) opts = options.dup @@ -293,6 +304,7 @@ def create_pay_item_with_http_info(xero_tenant_id, pay_item, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -326,6 +338,7 @@ def create_pay_item_with_http_info(xero_tenant_id, pay_item, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param pay_run [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [PayRuns] def create_pay_run(xero_tenant_id, pay_run, opts = {}) data, _status_code, _headers = create_pay_run_with_http_info(xero_tenant_id, pay_run, opts) @@ -336,6 +349,7 @@ def create_pay_run(xero_tenant_id, pay_run, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param pay_run [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(PayRuns, Integer, Hash)>] PayRuns data, response status code and response headers def create_pay_run_with_http_info(xero_tenant_id, pay_run, options = {}) opts = options.dup @@ -370,6 +384,7 @@ def create_pay_run_with_http_info(xero_tenant_id, pay_run, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -403,6 +418,7 @@ def create_pay_run_with_http_info(xero_tenant_id, pay_run, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param payroll_calendar [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [PayrollCalendars] def create_payroll_calendar(xero_tenant_id, payroll_calendar, opts = {}) data, _status_code, _headers = create_payroll_calendar_with_http_info(xero_tenant_id, payroll_calendar, opts) @@ -413,6 +429,7 @@ def create_payroll_calendar(xero_tenant_id, payroll_calendar, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param payroll_calendar [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(PayrollCalendars, Integer, Hash)>] PayrollCalendars data, response status code and response headers def create_payroll_calendar_with_http_info(xero_tenant_id, payroll_calendar, options = {}) opts = options.dup @@ -447,6 +464,7 @@ def create_payroll_calendar_with_http_info(xero_tenant_id, payroll_calendar, opt # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -480,6 +498,7 @@ def create_payroll_calendar_with_http_info(xero_tenant_id, payroll_calendar, opt # @param xero_tenant_id [String] Xero identifier for Tenant # @param super_fund [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [SuperFunds] def create_superfund(xero_tenant_id, super_fund, opts = {}) data, _status_code, _headers = create_superfund_with_http_info(xero_tenant_id, super_fund, opts) @@ -490,6 +509,7 @@ def create_superfund(xero_tenant_id, super_fund, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param super_fund [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(SuperFunds, Integer, Hash)>] SuperFunds data, response status code and response headers def create_superfund_with_http_info(xero_tenant_id, super_fund, options = {}) opts = options.dup @@ -524,6 +544,7 @@ def create_superfund_with_http_info(xero_tenant_id, super_fund, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -557,6 +578,7 @@ def create_superfund_with_http_info(xero_tenant_id, super_fund, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Timesheets] def create_timesheet(xero_tenant_id, timesheet, opts = {}) data, _status_code, _headers = create_timesheet_with_http_info(xero_tenant_id, timesheet, opts) @@ -567,6 +589,7 @@ def create_timesheet(xero_tenant_id, timesheet, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Timesheets, Integer, Hash)>] Timesheets data, response status code and response headers def create_timesheet_with_http_info(xero_tenant_id, timesheet, options = {}) opts = options.dup @@ -601,6 +624,7 @@ def create_timesheet_with_http_info(xero_tenant_id, timesheet, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -708,7 +732,7 @@ def get_employee_with_http_info(xero_tenant_id, employee_id, options = {}) # Searches payroll employees # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 employees will be returned in a single API call @@ -721,7 +745,7 @@ def get_employees(xero_tenant_id, opts = {}) # Searches payroll employees # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 employees will be returned in a single API call @@ -864,7 +888,7 @@ def get_leave_application_with_http_info(xero_tenant_id, leave_application_id, o # Retrieves leave applications # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 objects will be returned in a single API call @@ -877,7 +901,7 @@ def get_leave_applications(xero_tenant_id, opts = {}) # Retrieves leave applications # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 objects will be returned in a single API call @@ -945,7 +969,7 @@ def get_leave_applications_with_http_info(xero_tenant_id, options = {}) # Retrieves leave applications including leave requests # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 objects will be returned in a single API call @@ -958,7 +982,7 @@ def get_leave_applications_v2(xero_tenant_id, opts = {}) # Retrieves leave applications including leave requests # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 objects will be returned in a single API call @@ -1026,7 +1050,7 @@ def get_leave_applications_v2_with_http_info(xero_tenant_id, options = {}) # Retrieves pay items # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 objects will be returned in a single API call @@ -1039,7 +1063,7 @@ def get_pay_items(xero_tenant_id, opts = {}) # Retrieves pay items # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 objects will be returned in a single API call @@ -1182,7 +1206,7 @@ def get_pay_run_with_http_info(xero_tenant_id, pay_run_id, options = {}) # Retrieves pay runs # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 PayRuns will be returned in a single API call @@ -1195,7 +1219,7 @@ def get_pay_runs(xero_tenant_id, opts = {}) # Retrieves pay runs # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 PayRuns will be returned in a single API call @@ -1338,7 +1362,7 @@ def get_payroll_calendar_with_http_info(xero_tenant_id, payroll_calendar_id, opt # Retrieves payroll calendars # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 objects will be returned in a single API call @@ -1351,7 +1375,7 @@ def get_payroll_calendars(xero_tenant_id, opts = {}) # Retrieves payroll calendars # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 objects will be returned in a single API call @@ -1713,7 +1737,7 @@ def get_superfund_products_with_http_info(xero_tenant_id, options = {}) # Retrieves superfunds # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call @@ -1726,7 +1750,7 @@ def get_superfunds(xero_tenant_id, opts = {}) # Retrieves superfunds # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 SuperFunds will be returned in a single API call @@ -1869,7 +1893,7 @@ def get_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) # Retrieves timesheets # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 timesheets will be returned in a single API call @@ -1882,7 +1906,7 @@ def get_timesheets(xero_tenant_id, opts = {}) # Retrieves timesheets # @param xero_tenant_id [String] Xero identifier for Tenant # @param [Hash] opts the optional parameters - # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned + # @option opts [Time] :if_modified_since Only records created or modified since this timestamp will be returned # @option opts [String] :where Filter by an any element # @option opts [String] :order Order by an any element # @option opts [Integer] :page e.g. page=1 – Up to 100 timesheets will be returned in a single API call @@ -1951,6 +1975,7 @@ def get_timesheets_with_http_info(xero_tenant_id, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param leave_application_id [String] Leave Application id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [LeaveApplications] def reject_leave_application(xero_tenant_id, leave_application_id, opts = {}) data, _status_code, _headers = reject_leave_application_with_http_info(xero_tenant_id, leave_application_id, opts) @@ -1961,6 +1986,7 @@ def reject_leave_application(xero_tenant_id, leave_application_id, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param leave_application_id [String] Leave Application id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(LeaveApplications, Integer, Hash)>] LeaveApplications data, response status code and response headers def reject_leave_application_with_http_info(xero_tenant_id, leave_application_id, options = {}) opts = options.dup @@ -1993,6 +2019,7 @@ def reject_leave_application_with_http_info(xero_tenant_id, leave_application_id # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2027,6 +2054,7 @@ def reject_leave_application_with_http_info(xero_tenant_id, leave_application_id # @param xero_tenant_id [String] Xero identifier for Tenant # @param employee_id [String] Employee id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Array] :employee # @return [Employees] def update_employee(xero_tenant_id, employee_id, opts = {}) @@ -2039,6 +2067,7 @@ def update_employee(xero_tenant_id, employee_id, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param employee_id [String] Employee id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Array] :employee # @return [Array<(Employees, Integer, Hash)>] Employees data, response status code and response headers def update_employee_with_http_info(xero_tenant_id, employee_id, options = {}) @@ -2074,6 +2103,7 @@ def update_employee_with_http_info(xero_tenant_id, employee_id, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2108,6 +2138,7 @@ def update_employee_with_http_info(xero_tenant_id, employee_id, options = {}) # @param leave_application_id [String] Leave Application id for single object # @param leave_application [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [LeaveApplications] def update_leave_application(xero_tenant_id, leave_application_id, leave_application, opts = {}) data, _status_code, _headers = update_leave_application_with_http_info(xero_tenant_id, leave_application_id, leave_application, opts) @@ -2119,6 +2150,7 @@ def update_leave_application(xero_tenant_id, leave_application_id, leave_applica # @param leave_application_id [String] Leave Application id for single object # @param leave_application [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(LeaveApplications, Integer, Hash)>] LeaveApplications data, response status code and response headers def update_leave_application_with_http_info(xero_tenant_id, leave_application_id, leave_application, options = {}) opts = options.dup @@ -2157,6 +2189,7 @@ def update_leave_application_with_http_info(xero_tenant_id, leave_application_id # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2191,6 +2224,7 @@ def update_leave_application_with_http_info(xero_tenant_id, leave_application_id # @param xero_tenant_id [String] Xero identifier for Tenant # @param pay_run_id [String] PayRun id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Array] :pay_run # @return [PayRuns] def update_pay_run(xero_tenant_id, pay_run_id, opts = {}) @@ -2203,6 +2237,7 @@ def update_pay_run(xero_tenant_id, pay_run_id, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param pay_run_id [String] PayRun id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Array] :pay_run # @return [Array<(PayRuns, Integer, Hash)>] PayRuns data, response status code and response headers def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, options = {}) @@ -2238,6 +2273,7 @@ def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2272,6 +2308,7 @@ def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param payslip_id [String] Payslip id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Array] :payslip_lines # @return [Payslips] def update_payslip(xero_tenant_id, payslip_id, opts = {}) @@ -2284,6 +2321,7 @@ def update_payslip(xero_tenant_id, payslip_id, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param payslip_id [String] Payslip id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Array] :payslip_lines # @return [Array<(Payslips, Integer, Hash)>] Payslips data, response status code and response headers def update_payslip_with_http_info(xero_tenant_id, payslip_id, options = {}) @@ -2319,6 +2357,7 @@ def update_payslip_with_http_info(xero_tenant_id, payslip_id, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2353,6 +2392,7 @@ def update_payslip_with_http_info(xero_tenant_id, payslip_id, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param super_fund_id [String] Superfund id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Array] :super_fund # @return [SuperFunds] def update_superfund(xero_tenant_id, super_fund_id, opts = {}) @@ -2365,6 +2405,7 @@ def update_superfund(xero_tenant_id, super_fund_id, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param super_fund_id [String] Superfund id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Array] :super_fund # @return [Array<(SuperFunds, Integer, Hash)>] SuperFunds data, response status code and response headers def update_superfund_with_http_info(xero_tenant_id, super_fund_id, options = {}) @@ -2400,6 +2441,7 @@ def update_superfund_with_http_info(xero_tenant_id, super_fund_id, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -2434,6 +2476,7 @@ def update_superfund_with_http_info(xero_tenant_id, super_fund_id, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet_id [String] Timesheet id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Array] :timesheet # @return [Timesheets] def update_timesheet(xero_tenant_id, timesheet_id, opts = {}) @@ -2446,6 +2489,7 @@ def update_timesheet(xero_tenant_id, timesheet_id, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet_id [String] Timesheet id for single object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @option opts [Array] :timesheet # @return [Array<(Timesheets, Integer, Hash)>] Timesheets data, response status code and response headers def update_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) @@ -2481,6 +2525,7 @@ def update_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} diff --git a/lib/xero-ruby/api/payroll_nz_api.rb b/lib/xero-ruby/api/payroll_nz_api.rb index ce9427c7..ee8eb295 100644 --- a/lib/xero-ruby/api/payroll_nz_api.rb +++ b/lib/xero-ruby/api/payroll_nz_api.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -20,6 +20,7 @@ def initialize(api_client = ApiClient.new) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet_id [String] Identifier for the timesheet # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TimesheetObject] def approve_timesheet(xero_tenant_id, timesheet_id, opts = {}) data, _status_code, _headers = approve_timesheet_with_http_info(xero_tenant_id, timesheet_id, opts) @@ -30,6 +31,7 @@ def approve_timesheet(xero_tenant_id, timesheet_id, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet_id [String] Identifier for the timesheet # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers def approve_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) opts = options.dup @@ -62,6 +64,7 @@ def approve_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -95,6 +98,7 @@ def approve_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param deduction [Deduction] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [DeductionObject] def create_deduction(xero_tenant_id, deduction, opts = {}) data, _status_code, _headers = create_deduction_with_http_info(xero_tenant_id, deduction, opts) @@ -105,6 +109,7 @@ def create_deduction(xero_tenant_id, deduction, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param deduction [Deduction] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(DeductionObject, Integer, Hash)>] DeductionObject data, response status code and response headers def create_deduction_with_http_info(xero_tenant_id, deduction, options = {}) opts = options.dup @@ -139,6 +144,7 @@ def create_deduction_with_http_info(xero_tenant_id, deduction, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -172,6 +178,7 @@ def create_deduction_with_http_info(xero_tenant_id, deduction, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param earnings_rate [EarningsRate] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EarningsRateObject] def create_earnings_rate(xero_tenant_id, earnings_rate, opts = {}) data, _status_code, _headers = create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, opts) @@ -182,6 +189,7 @@ def create_earnings_rate(xero_tenant_id, earnings_rate, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param earnings_rate [EarningsRate] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EarningsRateObject, Integer, Hash)>] EarningsRateObject data, response status code and response headers def create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, options = {}) opts = options.dup @@ -216,6 +224,7 @@ def create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, options = # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -249,6 +258,7 @@ def create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, options = # @param xero_tenant_id [String] Xero identifier for Tenant # @param employee [Employee] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeObject] def create_employee(xero_tenant_id, employee, opts = {}) data, _status_code, _headers = create_employee_with_http_info(xero_tenant_id, employee, opts) @@ -259,6 +269,7 @@ def create_employee(xero_tenant_id, employee, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param employee [Employee] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeObject, Integer, Hash)>] EmployeeObject data, response status code and response headers def create_employee_with_http_info(xero_tenant_id, employee, options = {}) opts = options.dup @@ -293,6 +304,7 @@ def create_employee_with_http_info(xero_tenant_id, employee, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -327,6 +339,7 @@ def create_employee_with_http_info(xero_tenant_id, employee, options = {}) # @param employee_id [String] Employee id for single object # @param earnings_template [EarningsTemplate] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EarningsTemplateObject] def create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts = {}) data, _status_code, _headers = create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, opts) @@ -338,6 +351,7 @@ def create_employee_earnings_template(xero_tenant_id, employee_id, earnings_temp # @param employee_id [String] Employee id for single object # @param earnings_template [EarningsTemplate] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EarningsTemplateObject, Integer, Hash)>] EarningsTemplateObject data, response status code and response headers def create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, options = {}) opts = options.dup @@ -376,6 +390,7 @@ def create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -410,6 +425,7 @@ def create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id # @param employee_id [String] Employee id for single object # @param employee_leave [EmployeeLeave] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeLeaveObject] def create_employee_leave(xero_tenant_id, employee_id, employee_leave, opts = {}) data, _status_code, _headers = create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_leave, opts) @@ -421,6 +437,7 @@ def create_employee_leave(xero_tenant_id, employee_id, employee_leave, opts = {} # @param employee_id [String] Employee id for single object # @param employee_leave [EmployeeLeave] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeLeaveObject, Integer, Hash)>] EmployeeLeaveObject data, response status code and response headers def create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_leave, options = {}) opts = options.dup @@ -459,6 +476,7 @@ def create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_l # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -493,6 +511,7 @@ def create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_l # @param employee_id [String] Employee id for single object # @param employee_leave_setup [EmployeeLeaveSetup] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeLeaveSetupObject] def create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setup, opts = {}) data, _status_code, _headers = create_employee_leave_setup_with_http_info(xero_tenant_id, employee_id, employee_leave_setup, opts) @@ -504,6 +523,7 @@ def create_employee_leave_setup(xero_tenant_id, employee_id, employee_leave_setu # @param employee_id [String] Employee id for single object # @param employee_leave_setup [EmployeeLeaveSetup] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeLeaveSetupObject, Integer, Hash)>] EmployeeLeaveSetupObject data, response status code and response headers def create_employee_leave_setup_with_http_info(xero_tenant_id, employee_id, employee_leave_setup, options = {}) opts = options.dup @@ -542,6 +562,7 @@ def create_employee_leave_setup_with_http_info(xero_tenant_id, employee_id, empl # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -576,6 +597,7 @@ def create_employee_leave_setup_with_http_info(xero_tenant_id, employee_id, empl # @param employee_id [String] Employee id for single object # @param employee_leave_type [EmployeeLeaveType] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeLeaveTypeObject] def create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, opts = {}) data, _status_code, _headers = create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, employee_leave_type, opts) @@ -587,6 +609,7 @@ def create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, # @param employee_id [String] Employee id for single object # @param employee_leave_type [EmployeeLeaveType] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeLeaveTypeObject, Integer, Hash)>] EmployeeLeaveTypeObject data, response status code and response headers def create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, employee_leave_type, options = {}) opts = options.dup @@ -625,6 +648,7 @@ def create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, emplo # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -659,6 +683,7 @@ def create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, emplo # @param employee_id [String] Employee id for single object # @param employee_opening_balance [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeOpeningBalancesObject] def create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balance, opts = {}) data, _status_code, _headers = create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balance, opts) @@ -670,6 +695,7 @@ def create_employee_opening_balances(xero_tenant_id, employee_id, employee_openi # @param employee_id [String] Employee id for single object # @param employee_opening_balance [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeOpeningBalancesObject, Integer, Hash)>] EmployeeOpeningBalancesObject data, response status code and response headers def create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balance, options = {}) opts = options.dup @@ -708,6 +734,7 @@ def create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -742,6 +769,7 @@ def create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, # @param employee_id [String] Employee id for single object # @param payment_method [PaymentMethod] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [PaymentMethodObject] def create_employee_payment_method(xero_tenant_id, employee_id, payment_method, opts = {}) data, _status_code, _headers = create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, payment_method, opts) @@ -753,6 +781,7 @@ def create_employee_payment_method(xero_tenant_id, employee_id, payment_method, # @param employee_id [String] Employee id for single object # @param payment_method [PaymentMethod] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(PaymentMethodObject, Integer, Hash)>] PaymentMethodObject data, response status code and response headers def create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, payment_method, options = {}) opts = options.dup @@ -791,6 +820,7 @@ def create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, p # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -825,6 +855,7 @@ def create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, p # @param employee_id [String] Employee id for single object # @param salary_and_wage [SalaryAndWage] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [SalaryAndWageObject] def create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage, opts = {}) data, _status_code, _headers = create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wage, opts) @@ -836,6 +867,7 @@ def create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage # @param employee_id [String] Employee id for single object # @param salary_and_wage [SalaryAndWage] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(SalaryAndWageObject, Integer, Hash)>] SalaryAndWageObject data, response status code and response headers def create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wage, options = {}) opts = options.dup @@ -874,6 +906,7 @@ def create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -908,6 +941,7 @@ def create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, # @param employee_id [String] Employee id for single object # @param employment [Employment] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmploymentObject] def create_employment(xero_tenant_id, employee_id, employment, opts = {}) data, _status_code, _headers = create_employment_with_http_info(xero_tenant_id, employee_id, employment, opts) @@ -919,6 +953,7 @@ def create_employment(xero_tenant_id, employee_id, employment, opts = {}) # @param employee_id [String] Employee id for single object # @param employment [Employment] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmploymentObject, Integer, Hash)>] EmploymentObject data, response status code and response headers def create_employment_with_http_info(xero_tenant_id, employee_id, employment, options = {}) opts = options.dup @@ -957,6 +992,7 @@ def create_employment_with_http_info(xero_tenant_id, employee_id, employment, op # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -990,6 +1026,7 @@ def create_employment_with_http_info(xero_tenant_id, employee_id, employment, op # @param xero_tenant_id [String] Xero identifier for Tenant # @param leave_type [LeaveType] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [LeaveTypeObject] def create_leave_type(xero_tenant_id, leave_type, opts = {}) data, _status_code, _headers = create_leave_type_with_http_info(xero_tenant_id, leave_type, opts) @@ -1000,6 +1037,7 @@ def create_leave_type(xero_tenant_id, leave_type, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param leave_type [LeaveType] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(LeaveTypeObject, Integer, Hash)>] LeaveTypeObject data, response status code and response headers def create_leave_type_with_http_info(xero_tenant_id, leave_type, options = {}) opts = options.dup @@ -1034,6 +1072,7 @@ def create_leave_type_with_http_info(xero_tenant_id, leave_type, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1068,6 +1107,7 @@ def create_leave_type_with_http_info(xero_tenant_id, leave_type, options = {}) # @param employee_id [String] Employee id for single object # @param earnings_template [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeEarningsTemplates] def create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts = {}) data, _status_code, _headers = create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, opts) @@ -1079,6 +1119,7 @@ def create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earn # @param employee_id [String] Employee id for single object # @param earnings_template [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeEarningsTemplates, Integer, Hash)>] EmployeeEarningsTemplates data, response status code and response headers def create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, options = {}) opts = options.dup @@ -1117,6 +1158,7 @@ def create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, em # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1150,6 +1192,7 @@ def create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, em # @param xero_tenant_id [String] Xero identifier for Tenant # @param pay_run [PayRun] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [PayRunObject] def create_pay_run(xero_tenant_id, pay_run, opts = {}) data, _status_code, _headers = create_pay_run_with_http_info(xero_tenant_id, pay_run, opts) @@ -1160,6 +1203,7 @@ def create_pay_run(xero_tenant_id, pay_run, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param pay_run [PayRun] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(PayRunObject, Integer, Hash)>] PayRunObject data, response status code and response headers def create_pay_run_with_http_info(xero_tenant_id, pay_run, options = {}) opts = options.dup @@ -1194,6 +1238,7 @@ def create_pay_run_with_http_info(xero_tenant_id, pay_run, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1227,6 +1272,7 @@ def create_pay_run_with_http_info(xero_tenant_id, pay_run, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param pay_run_calendar [PayRunCalendar] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [PayRunCalendarObject] def create_pay_run_calendar(xero_tenant_id, pay_run_calendar, opts = {}) data, _status_code, _headers = create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, opts) @@ -1237,6 +1283,7 @@ def create_pay_run_calendar(xero_tenant_id, pay_run_calendar, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param pay_run_calendar [PayRunCalendar] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(PayRunCalendarObject, Integer, Hash)>] PayRunCalendarObject data, response status code and response headers def create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, options = {}) opts = options.dup @@ -1271,6 +1318,7 @@ def create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, opt # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1304,6 +1352,7 @@ def create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, opt # @param xero_tenant_id [String] Xero identifier for Tenant # @param reimbursement [Reimbursement] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [ReimbursementObject] def create_reimbursement(xero_tenant_id, reimbursement, opts = {}) data, _status_code, _headers = create_reimbursement_with_http_info(xero_tenant_id, reimbursement, opts) @@ -1314,6 +1363,7 @@ def create_reimbursement(xero_tenant_id, reimbursement, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param reimbursement [Reimbursement] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(ReimbursementObject, Integer, Hash)>] ReimbursementObject data, response status code and response headers def create_reimbursement_with_http_info(xero_tenant_id, reimbursement, options = {}) opts = options.dup @@ -1348,6 +1398,7 @@ def create_reimbursement_with_http_info(xero_tenant_id, reimbursement, options = # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1381,6 +1432,7 @@ def create_reimbursement_with_http_info(xero_tenant_id, reimbursement, options = # @param xero_tenant_id [String] Xero identifier for Tenant # @param benefit [Benefit] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [SuperannuationObject] def create_superannuation(xero_tenant_id, benefit, opts = {}) data, _status_code, _headers = create_superannuation_with_http_info(xero_tenant_id, benefit, opts) @@ -1391,6 +1443,7 @@ def create_superannuation(xero_tenant_id, benefit, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param benefit [Benefit] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(SuperannuationObject, Integer, Hash)>] SuperannuationObject data, response status code and response headers def create_superannuation_with_http_info(xero_tenant_id, benefit, options = {}) opts = options.dup @@ -1425,6 +1478,7 @@ def create_superannuation_with_http_info(xero_tenant_id, benefit, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1458,6 +1512,7 @@ def create_superannuation_with_http_info(xero_tenant_id, benefit, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet [Timesheet] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TimesheetObject] def create_timesheet(xero_tenant_id, timesheet, opts = {}) data, _status_code, _headers = create_timesheet_with_http_info(xero_tenant_id, timesheet, opts) @@ -1468,6 +1523,7 @@ def create_timesheet(xero_tenant_id, timesheet, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet [Timesheet] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers def create_timesheet_with_http_info(xero_tenant_id, timesheet, options = {}) opts = options.dup @@ -1502,6 +1558,7 @@ def create_timesheet_with_http_info(xero_tenant_id, timesheet, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1536,6 +1593,7 @@ def create_timesheet_with_http_info(xero_tenant_id, timesheet, options = {}) # @param timesheet_id [String] Identifier for the timesheet # @param timesheet_line [TimesheetLine] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TimesheetLineObject] def create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, opts = {}) data, _status_code, _headers = create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line, opts) @@ -1547,6 +1605,7 @@ def create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, opts = { # @param timesheet_id [String] Identifier for the timesheet # @param timesheet_line [TimesheetLine] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TimesheetLineObject, Integer, Hash)>] TimesheetLineObject data, response status code and response headers def create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line, options = {}) opts = options.dup @@ -1585,6 +1644,7 @@ def create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4572,6 +4632,7 @@ def get_tracking_categories_with_http_info(xero_tenant_id, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet_id [String] Identifier for the timesheet # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TimesheetObject] def revert_timesheet(xero_tenant_id, timesheet_id, opts = {}) data, _status_code, _headers = revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, opts) @@ -4582,6 +4643,7 @@ def revert_timesheet(xero_tenant_id, timesheet_id, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet_id [String] Identifier for the timesheet # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers def revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) opts = options.dup @@ -4614,6 +4676,7 @@ def revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4648,6 +4711,7 @@ def revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) # @param employee_id [String] Employee id for single object # @param employee [Employee] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeObject] def update_employee(xero_tenant_id, employee_id, employee, opts = {}) data, _status_code, _headers = update_employee_with_http_info(xero_tenant_id, employee_id, employee, opts) @@ -4659,6 +4723,7 @@ def update_employee(xero_tenant_id, employee_id, employee, opts = {}) # @param employee_id [String] Employee id for single object # @param employee [Employee] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeObject, Integer, Hash)>] EmployeeObject data, response status code and response headers def update_employee_with_http_info(xero_tenant_id, employee_id, employee, options = {}) opts = options.dup @@ -4697,6 +4762,7 @@ def update_employee_with_http_info(xero_tenant_id, employee_id, employee, option # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4732,6 +4798,7 @@ def update_employee_with_http_info(xero_tenant_id, employee_id, employee, option # @param pay_template_earning_id [String] Id for single pay template earnings object # @param earnings_template [EarningsTemplate] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EarningsTemplateObject] def update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts = {}) data, _status_code, _headers = update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts) @@ -4744,6 +4811,7 @@ def update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_ # @param pay_template_earning_id [String] Id for single pay template earnings object # @param earnings_template [EarningsTemplate] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EarningsTemplateObject, Integer, Hash)>] EarningsTemplateObject data, response status code and response headers def update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, options = {}) opts = options.dup @@ -4786,6 +4854,7 @@ def update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4821,6 +4890,7 @@ def update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id # @param leave_id [String] Leave id for single object # @param employee_leave [EmployeeLeave] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeLeaveObject] def update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, opts = {}) data, _status_code, _headers = update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, employee_leave, opts) @@ -4833,6 +4903,7 @@ def update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, # @param leave_id [String] Leave id for single object # @param employee_leave [EmployeeLeave] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeLeaveObject, Integer, Hash)>] EmployeeLeaveObject data, response status code and response headers def update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, employee_leave, options = {}) opts = options.dup @@ -4875,6 +4946,7 @@ def update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4910,6 +4982,7 @@ def update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, # @param salary_and_wages_id [String] Id for single pay template earnings object # @param salary_and_wage [SalaryAndWage] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [SalaryAndWageObject] def update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts = {}) data, _status_code, _headers = update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts) @@ -4922,6 +4995,7 @@ def update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage # @param salary_and_wages_id [String] Id for single pay template earnings object # @param salary_and_wage [SalaryAndWage] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(SalaryAndWageObject, Integer, Hash)>] SalaryAndWageObject data, response status code and response headers def update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, options = {}) opts = options.dup @@ -4964,6 +5038,7 @@ def update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4998,6 +5073,7 @@ def update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, # @param employee_id [String] Employee id for single object # @param employee_tax [EmployeeTax] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeTaxObject] def update_employee_tax(xero_tenant_id, employee_id, employee_tax, opts = {}) data, _status_code, _headers = update_employee_tax_with_http_info(xero_tenant_id, employee_id, employee_tax, opts) @@ -5009,6 +5085,7 @@ def update_employee_tax(xero_tenant_id, employee_id, employee_tax, opts = {}) # @param employee_id [String] Employee id for single object # @param employee_tax [EmployeeTax] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeTaxObject, Integer, Hash)>] EmployeeTaxObject data, response status code and response headers def update_employee_tax_with_http_info(xero_tenant_id, employee_id, employee_tax, options = {}) opts = options.dup @@ -5047,6 +5124,7 @@ def update_employee_tax_with_http_info(xero_tenant_id, employee_id, employee_tax # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -5081,6 +5159,7 @@ def update_employee_tax_with_http_info(xero_tenant_id, employee_id, employee_tax # @param pay_run_id [String] Identifier for the pay run # @param pay_run [PayRun] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [PayRunObject] def update_pay_run(xero_tenant_id, pay_run_id, pay_run, opts = {}) data, _status_code, _headers = update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, opts) @@ -5092,6 +5171,7 @@ def update_pay_run(xero_tenant_id, pay_run_id, pay_run, opts = {}) # @param pay_run_id [String] Identifier for the pay run # @param pay_run [PayRun] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(PayRunObject, Integer, Hash)>] PayRunObject data, response status code and response headers def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, options = {}) opts = options.dup @@ -5130,6 +5210,7 @@ def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, options = # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -5164,6 +5245,7 @@ def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, options = # @param pay_slip_id [String] Identifier for the payslip # @param pay_slip [PaySlip] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [PaySlipObject] def update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip, opts = {}) data, _status_code, _headers = update_pay_slip_line_items_with_http_info(xero_tenant_id, pay_slip_id, pay_slip, opts) @@ -5175,6 +5257,7 @@ def update_pay_slip_line_items(xero_tenant_id, pay_slip_id, pay_slip, opts = {}) # @param pay_slip_id [String] Identifier for the payslip # @param pay_slip [PaySlip] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(PaySlipObject, Integer, Hash)>] PaySlipObject data, response status code and response headers def update_pay_slip_line_items_with_http_info(xero_tenant_id, pay_slip_id, pay_slip, options = {}) opts = options.dup @@ -5213,6 +5296,7 @@ def update_pay_slip_line_items_with_http_info(xero_tenant_id, pay_slip_id, pay_s # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -5248,6 +5332,7 @@ def update_pay_slip_line_items_with_http_info(xero_tenant_id, pay_slip_id, pay_s # @param timesheet_line_id [String] Identifier for the timesheet line # @param timesheet_line [TimesheetLine] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TimesheetLineObject] def update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts = {}) data, _status_code, _headers = update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts) @@ -5260,6 +5345,7 @@ def update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, times # @param timesheet_line_id [String] Identifier for the timesheet line # @param timesheet_line [TimesheetLine] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TimesheetLineObject, Integer, Hash)>] TimesheetLineObject data, response status code and response headers def update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, options = {}) opts = options.dup @@ -5302,6 +5388,7 @@ def update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} diff --git a/lib/xero-ruby/api/payroll_uk_api.rb b/lib/xero-ruby/api/payroll_uk_api.rb index ad2599b9..91d0eece 100644 --- a/lib/xero-ruby/api/payroll_uk_api.rb +++ b/lib/xero-ruby/api/payroll_uk_api.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -20,6 +20,7 @@ def initialize(api_client = ApiClient.new) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet_id [String] Identifier for the timesheet # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TimesheetObject] def approve_timesheet(xero_tenant_id, timesheet_id, opts = {}) data, _status_code, _headers = approve_timesheet_with_http_info(xero_tenant_id, timesheet_id, opts) @@ -30,6 +31,7 @@ def approve_timesheet(xero_tenant_id, timesheet_id, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet_id [String] Identifier for the timesheet # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers def approve_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) opts = options.dup @@ -62,6 +64,7 @@ def approve_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -95,6 +98,7 @@ def approve_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param benefit [Benefit] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [BenefitObject] def create_benefit(xero_tenant_id, benefit, opts = {}) data, _status_code, _headers = create_benefit_with_http_info(xero_tenant_id, benefit, opts) @@ -105,6 +109,7 @@ def create_benefit(xero_tenant_id, benefit, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param benefit [Benefit] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(BenefitObject, Integer, Hash)>] BenefitObject data, response status code and response headers def create_benefit_with_http_info(xero_tenant_id, benefit, options = {}) opts = options.dup @@ -139,6 +144,7 @@ def create_benefit_with_http_info(xero_tenant_id, benefit, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -172,6 +178,7 @@ def create_benefit_with_http_info(xero_tenant_id, benefit, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param deduction [Deduction] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [DeductionObject] def create_deduction(xero_tenant_id, deduction, opts = {}) data, _status_code, _headers = create_deduction_with_http_info(xero_tenant_id, deduction, opts) @@ -182,6 +189,7 @@ def create_deduction(xero_tenant_id, deduction, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param deduction [Deduction] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(DeductionObject, Integer, Hash)>] DeductionObject data, response status code and response headers def create_deduction_with_http_info(xero_tenant_id, deduction, options = {}) opts = options.dup @@ -216,6 +224,7 @@ def create_deduction_with_http_info(xero_tenant_id, deduction, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -249,6 +258,7 @@ def create_deduction_with_http_info(xero_tenant_id, deduction, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param earnings_rate [EarningsRate] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EarningsRateObject] def create_earnings_rate(xero_tenant_id, earnings_rate, opts = {}) data, _status_code, _headers = create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, opts) @@ -259,6 +269,7 @@ def create_earnings_rate(xero_tenant_id, earnings_rate, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param earnings_rate [EarningsRate] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EarningsRateObject, Integer, Hash)>] EarningsRateObject data, response status code and response headers def create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, options = {}) opts = options.dup @@ -293,6 +304,7 @@ def create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, options = # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -326,6 +338,7 @@ def create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, options = # @param xero_tenant_id [String] Xero identifier for Tenant # @param employee [Employee] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeObject] def create_employee(xero_tenant_id, employee, opts = {}) data, _status_code, _headers = create_employee_with_http_info(xero_tenant_id, employee, opts) @@ -336,6 +349,7 @@ def create_employee(xero_tenant_id, employee, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param employee [Employee] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeObject, Integer, Hash)>] EmployeeObject data, response status code and response headers def create_employee_with_http_info(xero_tenant_id, employee, options = {}) opts = options.dup @@ -370,6 +384,7 @@ def create_employee_with_http_info(xero_tenant_id, employee, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -404,6 +419,7 @@ def create_employee_with_http_info(xero_tenant_id, employee, options = {}) # @param employee_id [String] Employee id for single object # @param earnings_template [EarningsTemplate] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EarningsTemplateObject] def create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts = {}) data, _status_code, _headers = create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, opts) @@ -415,6 +431,7 @@ def create_employee_earnings_template(xero_tenant_id, employee_id, earnings_temp # @param employee_id [String] Employee id for single object # @param earnings_template [EarningsTemplate] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EarningsTemplateObject, Integer, Hash)>] EarningsTemplateObject data, response status code and response headers def create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, options = {}) opts = options.dup @@ -453,6 +470,7 @@ def create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -487,6 +505,7 @@ def create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id # @param employee_id [String] Employee id for single object # @param employee_leave [EmployeeLeave] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeLeaveObject] def create_employee_leave(xero_tenant_id, employee_id, employee_leave, opts = {}) data, _status_code, _headers = create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_leave, opts) @@ -498,6 +517,7 @@ def create_employee_leave(xero_tenant_id, employee_id, employee_leave, opts = {} # @param employee_id [String] Employee id for single object # @param employee_leave [EmployeeLeave] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeLeaveObject, Integer, Hash)>] EmployeeLeaveObject data, response status code and response headers def create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_leave, options = {}) opts = options.dup @@ -536,6 +556,7 @@ def create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_l # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -570,6 +591,7 @@ def create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_l # @param employee_id [String] Employee id for single object # @param employee_leave_type [EmployeeLeaveType] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeLeaveTypeObject] def create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, opts = {}) data, _status_code, _headers = create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, employee_leave_type, opts) @@ -581,6 +603,7 @@ def create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, # @param employee_id [String] Employee id for single object # @param employee_leave_type [EmployeeLeaveType] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeLeaveTypeObject, Integer, Hash)>] EmployeeLeaveTypeObject data, response status code and response headers def create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, employee_leave_type, options = {}) opts = options.dup @@ -619,6 +642,7 @@ def create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, emplo # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -653,6 +677,7 @@ def create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, emplo # @param employee_id [String] Employee id for single object # @param employee_opening_balances [EmployeeOpeningBalances] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeOpeningBalancesObject] def create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, opts = {}) data, _status_code, _headers = create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, opts) @@ -664,6 +689,7 @@ def create_employee_opening_balances(xero_tenant_id, employee_id, employee_openi # @param employee_id [String] Employee id for single object # @param employee_opening_balances [EmployeeOpeningBalances] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeOpeningBalancesObject, Integer, Hash)>] EmployeeOpeningBalancesObject data, response status code and response headers def create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, options = {}) opts = options.dup @@ -702,6 +728,7 @@ def create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -736,6 +763,7 @@ def create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, # @param employee_id [String] Employee id for single object # @param payment_method [PaymentMethod] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [PaymentMethodObject] def create_employee_payment_method(xero_tenant_id, employee_id, payment_method, opts = {}) data, _status_code, _headers = create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, payment_method, opts) @@ -747,6 +775,7 @@ def create_employee_payment_method(xero_tenant_id, employee_id, payment_method, # @param employee_id [String] Employee id for single object # @param payment_method [PaymentMethod] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(PaymentMethodObject, Integer, Hash)>] PaymentMethodObject data, response status code and response headers def create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, payment_method, options = {}) opts = options.dup @@ -785,6 +814,7 @@ def create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, p # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -819,6 +849,7 @@ def create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, p # @param employee_id [String] Employee id for single object # @param salary_and_wage [SalaryAndWage] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [SalaryAndWageObject] def create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage, opts = {}) data, _status_code, _headers = create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wage, opts) @@ -830,6 +861,7 @@ def create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage # @param employee_id [String] Employee id for single object # @param salary_and_wage [SalaryAndWage] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(SalaryAndWageObject, Integer, Hash)>] SalaryAndWageObject data, response status code and response headers def create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wage, options = {}) opts = options.dup @@ -868,6 +900,7 @@ def create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -901,6 +934,7 @@ def create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, # @param xero_tenant_id [String] Xero identifier for Tenant # @param employee_statutory_sick_leave [EmployeeStatutorySickLeave] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeStatutorySickLeaveObject] def create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave, opts = {}) data, _status_code, _headers = create_employee_statutory_sick_leave_with_http_info(xero_tenant_id, employee_statutory_sick_leave, opts) @@ -911,6 +945,7 @@ def create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick # @param xero_tenant_id [String] Xero identifier for Tenant # @param employee_statutory_sick_leave [EmployeeStatutorySickLeave] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeStatutorySickLeaveObject, Integer, Hash)>] EmployeeStatutorySickLeaveObject data, response status code and response headers def create_employee_statutory_sick_leave_with_http_info(xero_tenant_id, employee_statutory_sick_leave, options = {}) opts = options.dup @@ -945,6 +980,7 @@ def create_employee_statutory_sick_leave_with_http_info(xero_tenant_id, employee # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -979,6 +1015,7 @@ def create_employee_statutory_sick_leave_with_http_info(xero_tenant_id, employee # @param employee_id [String] Employee id for single object # @param employment [Employment] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmploymentObject] def create_employment(xero_tenant_id, employee_id, employment, opts = {}) data, _status_code, _headers = create_employment_with_http_info(xero_tenant_id, employee_id, employment, opts) @@ -990,6 +1027,7 @@ def create_employment(xero_tenant_id, employee_id, employment, opts = {}) # @param employee_id [String] Employee id for single object # @param employment [Employment] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmploymentObject, Integer, Hash)>] EmploymentObject data, response status code and response headers def create_employment_with_http_info(xero_tenant_id, employee_id, employment, options = {}) opts = options.dup @@ -1028,6 +1066,7 @@ def create_employment_with_http_info(xero_tenant_id, employee_id, employment, op # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1061,6 +1100,7 @@ def create_employment_with_http_info(xero_tenant_id, employee_id, employment, op # @param xero_tenant_id [String] Xero identifier for Tenant # @param leave_type [LeaveType] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [LeaveTypeObject] def create_leave_type(xero_tenant_id, leave_type, opts = {}) data, _status_code, _headers = create_leave_type_with_http_info(xero_tenant_id, leave_type, opts) @@ -1071,6 +1111,7 @@ def create_leave_type(xero_tenant_id, leave_type, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param leave_type [LeaveType] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(LeaveTypeObject, Integer, Hash)>] LeaveTypeObject data, response status code and response headers def create_leave_type_with_http_info(xero_tenant_id, leave_type, options = {}) opts = options.dup @@ -1105,6 +1146,7 @@ def create_leave_type_with_http_info(xero_tenant_id, leave_type, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1139,6 +1181,7 @@ def create_leave_type_with_http_info(xero_tenant_id, leave_type, options = {}) # @param employee_id [String] Employee id for single object # @param earnings_template [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeePayTemplates] def create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts = {}) data, _status_code, _headers = create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, opts) @@ -1150,6 +1193,7 @@ def create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earn # @param employee_id [String] Employee id for single object # @param earnings_template [Array] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeePayTemplates, Integer, Hash)>] EmployeePayTemplates data, response status code and response headers def create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, options = {}) opts = options.dup @@ -1188,6 +1232,7 @@ def create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, em # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1221,6 +1266,7 @@ def create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, em # @param xero_tenant_id [String] Xero identifier for Tenant # @param pay_run_calendar [PayRunCalendar] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [PayRunCalendarObject] def create_pay_run_calendar(xero_tenant_id, pay_run_calendar, opts = {}) data, _status_code, _headers = create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, opts) @@ -1231,6 +1277,7 @@ def create_pay_run_calendar(xero_tenant_id, pay_run_calendar, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param pay_run_calendar [PayRunCalendar] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(PayRunCalendarObject, Integer, Hash)>] PayRunCalendarObject data, response status code and response headers def create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, options = {}) opts = options.dup @@ -1265,6 +1312,7 @@ def create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, opt # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1298,6 +1346,7 @@ def create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, opt # @param xero_tenant_id [String] Xero identifier for Tenant # @param reimbursement [Reimbursement] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [ReimbursementObject] def create_reimbursement(xero_tenant_id, reimbursement, opts = {}) data, _status_code, _headers = create_reimbursement_with_http_info(xero_tenant_id, reimbursement, opts) @@ -1308,6 +1357,7 @@ def create_reimbursement(xero_tenant_id, reimbursement, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param reimbursement [Reimbursement] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(ReimbursementObject, Integer, Hash)>] ReimbursementObject data, response status code and response headers def create_reimbursement_with_http_info(xero_tenant_id, reimbursement, options = {}) opts = options.dup @@ -1342,6 +1392,7 @@ def create_reimbursement_with_http_info(xero_tenant_id, reimbursement, options = # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1375,6 +1426,7 @@ def create_reimbursement_with_http_info(xero_tenant_id, reimbursement, options = # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet [Timesheet] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TimesheetObject] def create_timesheet(xero_tenant_id, timesheet, opts = {}) data, _status_code, _headers = create_timesheet_with_http_info(xero_tenant_id, timesheet, opts) @@ -1385,6 +1437,7 @@ def create_timesheet(xero_tenant_id, timesheet, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet [Timesheet] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers def create_timesheet_with_http_info(xero_tenant_id, timesheet, options = {}) opts = options.dup @@ -1419,6 +1472,7 @@ def create_timesheet_with_http_info(xero_tenant_id, timesheet, options = {}) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1453,6 +1507,7 @@ def create_timesheet_with_http_info(xero_tenant_id, timesheet, options = {}) # @param timesheet_id [String] Identifier for the timesheet # @param timesheet_line [TimesheetLine] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TimesheetLineObject] def create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, opts = {}) data, _status_code, _headers = create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line, opts) @@ -1464,6 +1519,7 @@ def create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, opts = { # @param timesheet_id [String] Identifier for the timesheet # @param timesheet_line [TimesheetLine] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TimesheetLineObject, Integer, Hash)>] TimesheetLineObject data, response status code and response headers def create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line, options = {}) opts = options.dup @@ -1502,6 +1558,7 @@ def create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4800,6 +4857,7 @@ def get_tracking_categories_with_http_info(xero_tenant_id, options = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet_id [String] Identifier for the timesheet # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TimesheetObject] def revert_timesheet(xero_tenant_id, timesheet_id, opts = {}) data, _status_code, _headers = revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, opts) @@ -4810,6 +4868,7 @@ def revert_timesheet(xero_tenant_id, timesheet_id, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param timesheet_id [String] Identifier for the timesheet # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers def revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) opts = options.dup @@ -4842,6 +4901,7 @@ def revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4876,6 +4936,7 @@ def revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) # @param employee_id [String] Employee id for single object # @param employee [Employee] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeObject] def update_employee(xero_tenant_id, employee_id, employee, opts = {}) data, _status_code, _headers = update_employee_with_http_info(xero_tenant_id, employee_id, employee, opts) @@ -4887,6 +4948,7 @@ def update_employee(xero_tenant_id, employee_id, employee, opts = {}) # @param employee_id [String] Employee id for single object # @param employee [Employee] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeObject, Integer, Hash)>] EmployeeObject data, response status code and response headers def update_employee_with_http_info(xero_tenant_id, employee_id, employee, options = {}) opts = options.dup @@ -4925,6 +4987,7 @@ def update_employee_with_http_info(xero_tenant_id, employee_id, employee, option # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -4960,6 +5023,7 @@ def update_employee_with_http_info(xero_tenant_id, employee_id, employee, option # @param pay_template_earning_id [String] Id for single pay template earnings object # @param earnings_template [EarningsTemplate] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EarningsTemplateObject] def update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts = {}) data, _status_code, _headers = update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts) @@ -4972,6 +5036,7 @@ def update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_ # @param pay_template_earning_id [String] Id for single pay template earnings object # @param earnings_template [EarningsTemplate] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EarningsTemplateObject, Integer, Hash)>] EarningsTemplateObject data, response status code and response headers def update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, options = {}) opts = options.dup @@ -5014,6 +5079,7 @@ def update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -5049,6 +5115,7 @@ def update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id # @param leave_id [String] Leave id for single object # @param employee_leave [EmployeeLeave] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeLeaveObject] def update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, opts = {}) data, _status_code, _headers = update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, employee_leave, opts) @@ -5061,6 +5128,7 @@ def update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, # @param leave_id [String] Leave id for single object # @param employee_leave [EmployeeLeave] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeLeaveObject, Integer, Hash)>] EmployeeLeaveObject data, response status code and response headers def update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, employee_leave, options = {}) opts = options.dup @@ -5103,6 +5171,7 @@ def update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -5137,6 +5206,7 @@ def update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, # @param employee_id [String] Employee id for single object # @param employee_opening_balances [EmployeeOpeningBalances] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [EmployeeOpeningBalancesObject] def update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, opts = {}) data, _status_code, _headers = update_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, opts) @@ -5148,6 +5218,7 @@ def update_employee_opening_balances(xero_tenant_id, employee_id, employee_openi # @param employee_id [String] Employee id for single object # @param employee_opening_balances [EmployeeOpeningBalances] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(EmployeeOpeningBalancesObject, Integer, Hash)>] EmployeeOpeningBalancesObject data, response status code and response headers def update_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, options = {}) opts = options.dup @@ -5186,6 +5257,7 @@ def update_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -5221,6 +5293,7 @@ def update_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, # @param salary_and_wages_id [String] Id for single pay template earnings object # @param salary_and_wage [SalaryAndWage] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [SalaryAndWageObject] def update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts = {}) data, _status_code, _headers = update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts) @@ -5233,6 +5306,7 @@ def update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage # @param salary_and_wages_id [String] Id for single pay template earnings object # @param salary_and_wage [SalaryAndWage] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(SalaryAndWageObject, Integer, Hash)>] SalaryAndWageObject data, response status code and response headers def update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, options = {}) opts = options.dup @@ -5275,6 +5349,7 @@ def update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -5309,6 +5384,7 @@ def update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, # @param pay_run_id [String] Identifier for the pay run # @param pay_run [PayRun] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [PayRunObject] def update_pay_run(xero_tenant_id, pay_run_id, pay_run, opts = {}) data, _status_code, _headers = update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, opts) @@ -5320,6 +5396,7 @@ def update_pay_run(xero_tenant_id, pay_run_id, pay_run, opts = {}) # @param pay_run_id [String] Identifier for the pay run # @param pay_run [PayRun] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(PayRunObject, Integer, Hash)>] PayRunObject data, response status code and response headers def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, options = {}) opts = options.dup @@ -5358,6 +5435,7 @@ def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, options = # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -5393,6 +5471,7 @@ def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, options = # @param timesheet_line_id [String] Identifier for the timesheet line # @param timesheet_line [TimesheetLine] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TimesheetLineObject] def update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts = {}) data, _status_code, _headers = update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts) @@ -5405,6 +5484,7 @@ def update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, times # @param timesheet_line_id [String] Identifier for the timesheet line # @param timesheet_line [TimesheetLine] # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TimesheetLineObject, Integer, Hash)>] TimesheetLineObject data, response status code and response headers def update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, options = {}) opts = options.dup @@ -5447,6 +5527,7 @@ def update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} diff --git a/lib/xero-ruby/api/project_api.rb b/lib/xero-ruby/api/project_api.rb index 998a5ca2..49cbc544 100644 --- a/lib/xero-ruby/api/project_api.rb +++ b/lib/xero-ruby/api/project_api.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -20,6 +20,7 @@ def initialize(api_client = ApiClient.new) # @param xero_tenant_id [String] Xero identifier for Tenant # @param project_create_or_update [ProjectCreateOrUpdate] Create a new project with ProjectCreateOrUpdate object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Project] def create_project(xero_tenant_id, project_create_or_update, opts = {}) data, _status_code, _headers = create_project_with_http_info(xero_tenant_id, project_create_or_update, opts) @@ -30,6 +31,7 @@ def create_project(xero_tenant_id, project_create_or_update, opts = {}) # @param xero_tenant_id [String] Xero identifier for Tenant # @param project_create_or_update [ProjectCreateOrUpdate] Create a new project with ProjectCreateOrUpdate object # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Project, Integer, Hash)>] Project data, response status code and response headers def create_project_with_http_info(xero_tenant_id, project_create_or_update, options = {}) opts = options.dup @@ -64,6 +66,7 @@ def create_project_with_http_info(xero_tenant_id, project_create_or_update, opti # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -99,6 +102,7 @@ def create_project_with_http_info(xero_tenant_id, project_create_or_update, opti # @param project_id [String] You can create a task on a specified projectId # @param task_create_or_update [TaskCreateOrUpdate] The task object you are creating # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Task] def create_task(xero_tenant_id, project_id, task_create_or_update, opts = {}) data, _status_code, _headers = create_task_with_http_info(xero_tenant_id, project_id, task_create_or_update, opts) @@ -111,6 +115,7 @@ def create_task(xero_tenant_id, project_id, task_create_or_update, opts = {}) # @param project_id [String] You can create a task on a specified projectId # @param task_create_or_update [TaskCreateOrUpdate] The task object you are creating # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(Task, Integer, Hash)>] Task data, response status code and response headers def create_task_with_http_info(xero_tenant_id, project_id, task_create_or_update, options = {}) opts = options.dup @@ -149,6 +154,7 @@ def create_task_with_http_info(xero_tenant_id, project_id, task_create_or_update # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -184,6 +190,7 @@ def create_task_with_http_info(xero_tenant_id, project_id, task_create_or_update # @param project_id [String] You can specify an individual project by appending the projectId to the endpoint # @param time_entry_create_or_update [TimeEntryCreateOrUpdate] The time entry object you are creating # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [TimeEntry] def create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update, opts = {}) data, _status_code, _headers = create_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_create_or_update, opts) @@ -196,6 +203,7 @@ def create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update, o # @param project_id [String] You can specify an individual project by appending the projectId to the endpoint # @param time_entry_create_or_update [TimeEntryCreateOrUpdate] The time entry object you are creating # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(TimeEntry, Integer, Hash)>] TimeEntry data, response status code and response headers def create_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_create_or_update, options = {}) opts = options.dup @@ -234,6 +242,7 @@ def create_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_crea # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -870,8 +879,8 @@ def get_tasks_with_http_info(xero_tenant_id, project_id, options = {}) # @option opts [Integer] :page_size Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. # @option opts [Array] :states Comma-separated list of states to find. Will find all time entries that are in the status of whatever is specified. # @option opts [Boolean] :is_chargeable Finds all time entries which relate to tasks with the charge type `TIME` or `FIXED`. - # @option opts [DateTime] :date_after_utc ISO 8601 UTC date. Finds all time entries on or after this date filtered on the `dateUtc` field. - # @option opts [DateTime] :date_before_utc ISO 8601 UTC date. Finds all time entries on or before this date filtered on the `dateUtc` field. + # @option opts [Time] :date_after_utc ISO 8601 UTC date. Finds all time entries on or after this date filtered on the `dateUtc` field. + # @option opts [Time] :date_before_utc ISO 8601 UTC date. Finds all time entries on or before this date filtered on the `dateUtc` field. # @return [TimeEntries] def get_time_entries(xero_tenant_id, project_id, opts = {}) data, _status_code, _headers = get_time_entries_with_http_info(xero_tenant_id, project_id, opts) @@ -891,8 +900,8 @@ def get_time_entries(xero_tenant_id, project_id, opts = {}) # @option opts [Integer] :page_size Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. # @option opts [Array] :states Comma-separated list of states to find. Will find all time entries that are in the status of whatever is specified. # @option opts [Boolean] :is_chargeable Finds all time entries which relate to tasks with the charge type `TIME` or `FIXED`. - # @option opts [DateTime] :date_after_utc ISO 8601 UTC date. Finds all time entries on or after this date filtered on the `dateUtc` field. - # @option opts [DateTime] :date_before_utc ISO 8601 UTC date. Finds all time entries on or before this date filtered on the `dateUtc` field. + # @option opts [Time] :date_after_utc ISO 8601 UTC date. Finds all time entries on or after this date filtered on the `dateUtc` field. + # @option opts [Time] :date_before_utc ISO 8601 UTC date. Finds all time entries on or before this date filtered on the `dateUtc` field. # @return [Array<(TimeEntries, Integer, Hash)>] TimeEntries data, response status code and response headers def get_time_entries_with_http_info(xero_tenant_id, project_id, options = {}) opts = options.dup @@ -1053,6 +1062,7 @@ def get_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, opt # @param project_id [String] You can specify an individual project by appending the projectId to the endpoint # @param project_patch [ProjectPatch] Update the status of an existing Project # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [nil] def patch_project(xero_tenant_id, project_id, project_patch, opts = {}) patch_project_with_http_info(xero_tenant_id, project_id, project_patch, opts) @@ -1065,6 +1075,7 @@ def patch_project(xero_tenant_id, project_id, project_patch, opts = {}) # @param project_id [String] You can specify an individual project by appending the projectId to the endpoint # @param project_patch [ProjectPatch] Update the status of an existing Project # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def patch_project_with_http_info(xero_tenant_id, project_id, project_patch, options = {}) opts = options.dup @@ -1103,6 +1114,7 @@ def patch_project_with_http_info(xero_tenant_id, project_id, project_patch, opti # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1138,6 +1150,7 @@ def patch_project_with_http_info(xero_tenant_id, project_id, project_patch, opti # @param project_id [String] You can specify an individual project by appending the projectId to the endpoint # @param project_create_or_update [ProjectCreateOrUpdate] Request of type ProjectCreateOrUpdate # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [nil] def update_project(xero_tenant_id, project_id, project_create_or_update, opts = {}) update_project_with_http_info(xero_tenant_id, project_id, project_create_or_update, opts) @@ -1150,6 +1163,7 @@ def update_project(xero_tenant_id, project_id, project_create_or_update, opts = # @param project_id [String] You can specify an individual project by appending the projectId to the endpoint # @param project_create_or_update [ProjectCreateOrUpdate] Request of type ProjectCreateOrUpdate # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def update_project_with_http_info(xero_tenant_id, project_id, project_create_or_update, options = {}) opts = options.dup @@ -1188,6 +1202,7 @@ def update_project_with_http_info(xero_tenant_id, project_id, project_create_or_ # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1224,6 +1239,7 @@ def update_project_with_http_info(xero_tenant_id, project_id, project_create_or_ # @param task_id [String] You can specify an individual task by appending the id to the endpoint # @param task_create_or_update [TaskCreateOrUpdate] The task object you are updating # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [nil] def update_task(xero_tenant_id, project_id, task_id, task_create_or_update, opts = {}) update_task_with_http_info(xero_tenant_id, project_id, task_id, task_create_or_update, opts) @@ -1237,6 +1253,7 @@ def update_task(xero_tenant_id, project_id, task_id, task_create_or_update, opts # @param task_id [String] You can specify an individual task by appending the id to the endpoint # @param task_create_or_update [TaskCreateOrUpdate] The task object you are updating # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def update_task_with_http_info(xero_tenant_id, project_id, task_id, task_create_or_update, options = {}) opts = options.dup @@ -1279,6 +1296,7 @@ def update_task_with_http_info(xero_tenant_id, project_id, task_id, task_create_ # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} @@ -1315,6 +1333,7 @@ def update_task_with_http_info(xero_tenant_id, project_id, task_id, task_create_ # @param time_entry_id [String] You can specify an individual time entry by appending the id to the endpoint # @param time_entry_create_or_update [TimeEntryCreateOrUpdate] The time entry object you are updating # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [nil] def update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, opts = {}) update_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, opts) @@ -1328,6 +1347,7 @@ def update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_crea # @param time_entry_id [String] You can specify an individual time entry by appending the id to the endpoint # @param time_entry_create_or_update [TimeEntryCreateOrUpdate] The time entry object you are updating # @param [Hash] opts the optional parameters + # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max. # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def update_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, options = {}) opts = options.dup @@ -1370,6 +1390,7 @@ def update_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Xero-Tenant-Id'] = xero_tenant_id + header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} diff --git a/lib/xero-ruby/api_client.rb b/lib/xero-ruby/api_client.rb index 8dc16d4b..c7fcfd5b 100644 --- a/lib/xero-ruby/api_client.rb +++ b/lib/xero-ruby/api_client.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/api_error.rb b/lib/xero-ruby/api_error.rb index 74cd4a72..91e1ec38 100644 --- a/lib/xero-ruby/api_error.rb +++ b/lib/xero-ruby/api_error.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/configuration.rb b/lib/xero-ruby/configuration.rb index 7710f557..a4f5d366 100644 --- a/lib/xero-ruby/configuration.rb +++ b/lib/xero-ruby/configuration.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/account.rb b/lib/xero-ruby/models/accounting/account.rb index ebbac176..cbc9fba7 100644 --- a/lib/xero-ruby/models/accounting/account.rb +++ b/lib/xero-ruby/models/accounting/account.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/account_type.rb b/lib/xero-ruby/models/accounting/account_type.rb index ca1473a4..960d36b5 100644 --- a/lib/xero-ruby/models/accounting/account_type.rb +++ b/lib/xero-ruby/models/accounting/account_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -31,11 +31,7 @@ class AccountType REVENUE ||= "REVENUE".freeze SALES ||= "SALES".freeze TERMLIAB ||= "TERMLIAB".freeze - PAYGLIABILITY ||= "PAYGLIABILITY".freeze PAYG ||= "PAYG".freeze - SUPERANNUATIONEXPENSE ||= "SUPERANNUATIONEXPENSE".freeze - SUPERANNUATIONLIABILITY ||= "SUPERANNUATIONLIABILITY".freeze - WAGESEXPENSE ||= "WAGESEXPENSE".freeze # Builds the enum from string # @param [String] The enum value in the form of the string diff --git a/lib/xero-ruby/models/accounting/accounts.rb b/lib/xero-ruby/models/accounting/accounts.rb index 23f94324..82a0466a 100644 --- a/lib/xero-ruby/models/accounting/accounts.rb +++ b/lib/xero-ruby/models/accounting/accounts.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/accounts_payable.rb b/lib/xero-ruby/models/accounting/accounts_payable.rb index 5fec3ade..520e8881 100644 --- a/lib/xero-ruby/models/accounting/accounts_payable.rb +++ b/lib/xero-ruby/models/accounting/accounts_payable.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/accounts_receivable.rb b/lib/xero-ruby/models/accounting/accounts_receivable.rb index bcac47fd..8f4c1f52 100644 --- a/lib/xero-ruby/models/accounting/accounts_receivable.rb +++ b/lib/xero-ruby/models/accounting/accounts_receivable.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/action.rb b/lib/xero-ruby/models/accounting/action.rb index 60f84824..d818612b 100644 --- a/lib/xero-ruby/models/accounting/action.rb +++ b/lib/xero-ruby/models/accounting/action.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/actions.rb b/lib/xero-ruby/models/accounting/actions.rb index 4d58db73..1f07319c 100644 --- a/lib/xero-ruby/models/accounting/actions.rb +++ b/lib/xero-ruby/models/accounting/actions.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/address.rb b/lib/xero-ruby/models/accounting/address.rb index 2461943c..6c8738c5 100644 --- a/lib/xero-ruby/models/accounting/address.rb +++ b/lib/xero-ruby/models/accounting/address.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/address_for_organisation.rb b/lib/xero-ruby/models/accounting/address_for_organisation.rb index 88267601..29c26ba4 100644 --- a/lib/xero-ruby/models/accounting/address_for_organisation.rb +++ b/lib/xero-ruby/models/accounting/address_for_organisation.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/allocation.rb b/lib/xero-ruby/models/accounting/allocation.rb index 53c348af..1ca17c0f 100644 --- a/lib/xero-ruby/models/accounting/allocation.rb +++ b/lib/xero-ruby/models/accounting/allocation.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -16,6 +16,9 @@ module XeroRuby::Accounting require 'bigdecimal' class Allocation + # Xero generated unique identifier + attr_accessor :allocation_id + attr_accessor :invoice @@ -34,6 +37,9 @@ class Allocation # the date the allocation is applied YYYY-MM-DD. attr_accessor :date + # A flag that returns true when the allocation is succesfully deleted + attr_accessor :is_deleted + # A string to indicate if a invoice status attr_accessor :status_attribute_string @@ -43,12 +49,14 @@ class Allocation # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { + :'allocation_id' => :'AllocationID', :'invoice' => :'Invoice', :'overpayment' => :'Overpayment', :'prepayment' => :'Prepayment', :'credit_note' => :'CreditNote', :'amount' => :'Amount', :'date' => :'Date', + :'is_deleted' => :'IsDeleted', :'status_attribute_string' => :'StatusAttributeString', :'validation_errors' => :'ValidationErrors' } @@ -57,12 +65,14 @@ def self.attribute_map # Attribute type mapping. def self.openapi_types { + :'allocation_id' => :'String', :'invoice' => :'Invoice', :'overpayment' => :'Overpayment', :'prepayment' => :'Prepayment', :'credit_note' => :'CreditNote', :'amount' => :'BigDecimal', :'date' => :'Date', + :'is_deleted' => :'Boolean', :'status_attribute_string' => :'String', :'validation_errors' => :'Array' } @@ -83,6 +93,10 @@ def initialize(attributes = {}) h[k.to_sym] = v } + if attributes.key?(:'allocation_id') + self.allocation_id = attributes[:'allocation_id'] + end + if attributes.key?(:'invoice') self.invoice = attributes[:'invoice'] end @@ -107,6 +121,10 @@ def initialize(attributes = {}) self.date = attributes[:'date'] end + if attributes.key?(:'is_deleted') + self.is_deleted = attributes[:'is_deleted'] + end + if attributes.key?(:'status_attribute_string') self.status_attribute_string = attributes[:'status_attribute_string'] end @@ -151,12 +169,14 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && + allocation_id == o.allocation_id && invoice == o.invoice && overpayment == o.overpayment && prepayment == o.prepayment && credit_note == o.credit_note && amount == o.amount && date == o.date && + is_deleted == o.is_deleted && status_attribute_string == o.status_attribute_string && validation_errors == o.validation_errors end @@ -170,7 +190,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [invoice, overpayment, prepayment, credit_note, amount, date, status_attribute_string, validation_errors].hash + [allocation_id, invoice, overpayment, prepayment, credit_note, amount, date, is_deleted, status_attribute_string, validation_errors].hash end # Builds the object from hash diff --git a/lib/xero-ruby/models/accounting/allocations.rb b/lib/xero-ruby/models/accounting/allocations.rb index f9c0bc30..b13f0945 100644 --- a/lib/xero-ruby/models/accounting/allocations.rb +++ b/lib/xero-ruby/models/accounting/allocations.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/attachment.rb b/lib/xero-ruby/models/accounting/attachment.rb index 5cb13d0d..abd74ab9 100644 --- a/lib/xero-ruby/models/accounting/attachment.rb +++ b/lib/xero-ruby/models/accounting/attachment.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/attachments.rb b/lib/xero-ruby/models/accounting/attachments.rb index 448b044a..f81689e4 100644 --- a/lib/xero-ruby/models/accounting/attachments.rb +++ b/lib/xero-ruby/models/accounting/attachments.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/balance_details.rb b/lib/xero-ruby/models/accounting/balance_details.rb index ebf3947a..e60c2da9 100644 --- a/lib/xero-ruby/models/accounting/balance_details.rb +++ b/lib/xero-ruby/models/accounting/balance_details.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/balances.rb b/lib/xero-ruby/models/accounting/balances.rb index 4010ba24..c5529906 100644 --- a/lib/xero-ruby/models/accounting/balances.rb +++ b/lib/xero-ruby/models/accounting/balances.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/bank_transaction.rb b/lib/xero-ruby/models/accounting/bank_transaction.rb index cd8dd61c..e76d4290 100644 --- a/lib/xero-ruby/models/accounting/bank_transaction.rb +++ b/lib/xero-ruby/models/accounting/bank_transaction.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/bank_transactions.rb b/lib/xero-ruby/models/accounting/bank_transactions.rb index 56f9feb4..8af17f0e 100644 --- a/lib/xero-ruby/models/accounting/bank_transactions.rb +++ b/lib/xero-ruby/models/accounting/bank_transactions.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/bank_transfer.rb b/lib/xero-ruby/models/accounting/bank_transfer.rb index 6d2b47aa..3d3f8902 100644 --- a/lib/xero-ruby/models/accounting/bank_transfer.rb +++ b/lib/xero-ruby/models/accounting/bank_transfer.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/bank_transfers.rb b/lib/xero-ruby/models/accounting/bank_transfers.rb index c8495b8e..c8af39bf 100644 --- a/lib/xero-ruby/models/accounting/bank_transfers.rb +++ b/lib/xero-ruby/models/accounting/bank_transfers.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/batch_payment.rb b/lib/xero-ruby/models/accounting/batch_payment.rb index e0630d21..bf578a3a 100644 --- a/lib/xero-ruby/models/accounting/batch_payment.rb +++ b/lib/xero-ruby/models/accounting/batch_payment.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/batch_payment_delete.rb b/lib/xero-ruby/models/accounting/batch_payment_delete.rb index 48c215c9..1685f86d 100644 --- a/lib/xero-ruby/models/accounting/batch_payment_delete.rb +++ b/lib/xero-ruby/models/accounting/batch_payment_delete.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/batch_payment_delete_by_url_param.rb b/lib/xero-ruby/models/accounting/batch_payment_delete_by_url_param.rb index d4190871..d1da1eb9 100644 --- a/lib/xero-ruby/models/accounting/batch_payment_delete_by_url_param.rb +++ b/lib/xero-ruby/models/accounting/batch_payment_delete_by_url_param.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/batch_payment_details.rb b/lib/xero-ruby/models/accounting/batch_payment_details.rb index 2a126f4d..97602db9 100644 --- a/lib/xero-ruby/models/accounting/batch_payment_details.rb +++ b/lib/xero-ruby/models/accounting/batch_payment_details.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/batch_payments.rb b/lib/xero-ruby/models/accounting/batch_payments.rb index 616b0a4a..4a91fda4 100644 --- a/lib/xero-ruby/models/accounting/batch_payments.rb +++ b/lib/xero-ruby/models/accounting/batch_payments.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/bill.rb b/lib/xero-ruby/models/accounting/bill.rb index 31a00cef..bc345858 100644 --- a/lib/xero-ruby/models/accounting/bill.rb +++ b/lib/xero-ruby/models/accounting/bill.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/branding_theme.rb b/lib/xero-ruby/models/accounting/branding_theme.rb index 7104e8af..ed41a85e 100644 --- a/lib/xero-ruby/models/accounting/branding_theme.rb +++ b/lib/xero-ruby/models/accounting/branding_theme.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/branding_themes.rb b/lib/xero-ruby/models/accounting/branding_themes.rb index 44da3381..9d715bfd 100644 --- a/lib/xero-ruby/models/accounting/branding_themes.rb +++ b/lib/xero-ruby/models/accounting/branding_themes.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/budget.rb b/lib/xero-ruby/models/accounting/budget.rb index f8923a1e..f3a1f00a 100644 --- a/lib/xero-ruby/models/accounting/budget.rb +++ b/lib/xero-ruby/models/accounting/budget.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/budget_balance.rb b/lib/xero-ruby/models/accounting/budget_balance.rb index 6702daad..773200cf 100644 --- a/lib/xero-ruby/models/accounting/budget_balance.rb +++ b/lib/xero-ruby/models/accounting/budget_balance.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/budget_line.rb b/lib/xero-ruby/models/accounting/budget_line.rb index 20beb5ee..b6dad484 100644 --- a/lib/xero-ruby/models/accounting/budget_line.rb +++ b/lib/xero-ruby/models/accounting/budget_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/budgets.rb b/lib/xero-ruby/models/accounting/budgets.rb index 79ff99b1..e1b70800 100644 --- a/lib/xero-ruby/models/accounting/budgets.rb +++ b/lib/xero-ruby/models/accounting/budgets.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/cis_org_setting.rb b/lib/xero-ruby/models/accounting/cis_org_setting.rb index cbc75da2..22bc5c16 100644 --- a/lib/xero-ruby/models/accounting/cis_org_setting.rb +++ b/lib/xero-ruby/models/accounting/cis_org_setting.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/cis_org_settings.rb b/lib/xero-ruby/models/accounting/cis_org_settings.rb index 4018f636..a3f5183d 100644 --- a/lib/xero-ruby/models/accounting/cis_org_settings.rb +++ b/lib/xero-ruby/models/accounting/cis_org_settings.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/cis_setting.rb b/lib/xero-ruby/models/accounting/cis_setting.rb index 777f140a..bf80d11b 100644 --- a/lib/xero-ruby/models/accounting/cis_setting.rb +++ b/lib/xero-ruby/models/accounting/cis_setting.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/cis_settings.rb b/lib/xero-ruby/models/accounting/cis_settings.rb index f88812da..b97a1c1f 100644 --- a/lib/xero-ruby/models/accounting/cis_settings.rb +++ b/lib/xero-ruby/models/accounting/cis_settings.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/contact.rb b/lib/xero-ruby/models/accounting/contact.rb index cc4ebe93..b5121117 100644 --- a/lib/xero-ruby/models/accounting/contact.rb +++ b/lib/xero-ruby/models/accounting/contact.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -49,9 +49,6 @@ class Contact # Email address of contact person (umlauts not supported) (max length = 255) attr_accessor :email_address - # Skype user name of contact - attr_accessor :skype_user_name - # See contact persons attr_accessor :contact_persons @@ -189,7 +186,6 @@ def self.attribute_map :'last_name' => :'LastName', :'company_number' => :'CompanyNumber', :'email_address' => :'EmailAddress', - :'skype_user_name' => :'SkypeUserName', :'contact_persons' => :'ContactPersons', :'bank_account_details' => :'BankAccountDetails', :'tax_number' => :'TaxNumber', @@ -238,7 +234,6 @@ def self.openapi_types :'last_name' => :'String', :'company_number' => :'String', :'email_address' => :'String', - :'skype_user_name' => :'String', :'contact_persons' => :'Array', :'bank_account_details' => :'String', :'tax_number' => :'String', @@ -329,10 +324,6 @@ def initialize(attributes = {}) self.email_address = attributes[:'email_address'] end - if attributes.key?(:'skype_user_name') - self.skype_user_name = attributes[:'skype_user_name'] - end - if attributes.key?(:'contact_persons') if (value = attributes[:'contact_persons']).is_a?(Array) self.contact_persons = value @@ -666,7 +657,6 @@ def ==(o) last_name == o.last_name && company_number == o.company_number && email_address == o.email_address && - skype_user_name == o.skype_user_name && contact_persons == o.contact_persons && bank_account_details == o.bank_account_details && tax_number == o.tax_number && @@ -710,7 +700,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [contact_id, merged_to_contact_id, contact_number, account_number, contact_status, name, first_name, last_name, company_number, email_address, skype_user_name, contact_persons, bank_account_details, tax_number, accounts_receivable_tax_type, accounts_payable_tax_type, addresses, phones, is_supplier, is_customer, sales_default_line_amount_type, purchases_default_line_amount_type, default_currency, xero_network_key, sales_default_account_code, purchases_default_account_code, sales_tracking_categories, purchases_tracking_categories, tracking_category_name, tracking_category_option, payment_terms, updated_date_utc, contact_groups, website, branding_theme, batch_payments, discount, balances, attachments, has_attachments, validation_errors, has_validation_errors, status_attribute_string].hash + [contact_id, merged_to_contact_id, contact_number, account_number, contact_status, name, first_name, last_name, company_number, email_address, contact_persons, bank_account_details, tax_number, accounts_receivable_tax_type, accounts_payable_tax_type, addresses, phones, is_supplier, is_customer, sales_default_line_amount_type, purchases_default_line_amount_type, default_currency, xero_network_key, sales_default_account_code, purchases_default_account_code, sales_tracking_categories, purchases_tracking_categories, tracking_category_name, tracking_category_option, payment_terms, updated_date_utc, contact_groups, website, branding_theme, batch_payments, discount, balances, attachments, has_attachments, validation_errors, has_validation_errors, status_attribute_string].hash end # Builds the object from hash diff --git a/lib/xero-ruby/models/accounting/contact_group.rb b/lib/xero-ruby/models/accounting/contact_group.rb index 7008352d..b08a6ab7 100644 --- a/lib/xero-ruby/models/accounting/contact_group.rb +++ b/lib/xero-ruby/models/accounting/contact_group.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/contact_groups.rb b/lib/xero-ruby/models/accounting/contact_groups.rb index 5d1d9fc7..b0a3823f 100644 --- a/lib/xero-ruby/models/accounting/contact_groups.rb +++ b/lib/xero-ruby/models/accounting/contact_groups.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/contact_person.rb b/lib/xero-ruby/models/accounting/contact_person.rb index f0e6742d..f621a08b 100644 --- a/lib/xero-ruby/models/accounting/contact_person.rb +++ b/lib/xero-ruby/models/accounting/contact_person.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/contacts.rb b/lib/xero-ruby/models/accounting/contacts.rb index 4f89ab8d..87bf591d 100644 --- a/lib/xero-ruby/models/accounting/contacts.rb +++ b/lib/xero-ruby/models/accounting/contacts.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/conversion_balances.rb b/lib/xero-ruby/models/accounting/conversion_balances.rb index 91555e78..adcea1fe 100644 --- a/lib/xero-ruby/models/accounting/conversion_balances.rb +++ b/lib/xero-ruby/models/accounting/conversion_balances.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/conversion_date.rb b/lib/xero-ruby/models/accounting/conversion_date.rb index e558ff2f..a4c1d095 100644 --- a/lib/xero-ruby/models/accounting/conversion_date.rb +++ b/lib/xero-ruby/models/accounting/conversion_date.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/country_code.rb b/lib/xero-ruby/models/accounting/country_code.rb index 6f6fb186..dc450270 100644 --- a/lib/xero-ruby/models/accounting/country_code.rb +++ b/lib/xero-ruby/models/accounting/country_code.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/credit_note.rb b/lib/xero-ruby/models/accounting/credit_note.rb index 69e865e5..05a9683a 100644 --- a/lib/xero-ruby/models/accounting/credit_note.rb +++ b/lib/xero-ruby/models/accounting/credit_note.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/credit_notes.rb b/lib/xero-ruby/models/accounting/credit_notes.rb index 0e69cb8f..d9d2067e 100644 --- a/lib/xero-ruby/models/accounting/credit_notes.rb +++ b/lib/xero-ruby/models/accounting/credit_notes.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/currencies.rb b/lib/xero-ruby/models/accounting/currencies.rb index 84df70d6..434bebef 100644 --- a/lib/xero-ruby/models/accounting/currencies.rb +++ b/lib/xero-ruby/models/accounting/currencies.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/currency.rb b/lib/xero-ruby/models/accounting/currency.rb index 49aaab6f..c79e8c54 100644 --- a/lib/xero-ruby/models/accounting/currency.rb +++ b/lib/xero-ruby/models/accounting/currency.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/currency_code.rb b/lib/xero-ruby/models/accounting/currency_code.rb index e832ad23..4716c035 100644 --- a/lib/xero-ruby/models/accounting/currency_code.rb +++ b/lib/xero-ruby/models/accounting/currency_code.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/element.rb b/lib/xero-ruby/models/accounting/element.rb index e2973a85..d392ba9e 100644 --- a/lib/xero-ruby/models/accounting/element.rb +++ b/lib/xero-ruby/models/accounting/element.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/employee.rb b/lib/xero-ruby/models/accounting/employee.rb index a7cd9cfb..a8a993c1 100644 --- a/lib/xero-ruby/models/accounting/employee.rb +++ b/lib/xero-ruby/models/accounting/employee.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/employees.rb b/lib/xero-ruby/models/accounting/employees.rb index 3b8391ff..2b27defb 100644 --- a/lib/xero-ruby/models/accounting/employees.rb +++ b/lib/xero-ruby/models/accounting/employees.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/error.rb b/lib/xero-ruby/models/accounting/error.rb index 62e7a84c..ecb9180b 100644 --- a/lib/xero-ruby/models/accounting/error.rb +++ b/lib/xero-ruby/models/accounting/error.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/expense_claim.rb b/lib/xero-ruby/models/accounting/expense_claim.rb index 4fa9b262..59ce21f2 100644 --- a/lib/xero-ruby/models/accounting/expense_claim.rb +++ b/lib/xero-ruby/models/accounting/expense_claim.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/expense_claims.rb b/lib/xero-ruby/models/accounting/expense_claims.rb index 43a20bc4..b7f6e6a7 100644 --- a/lib/xero-ruby/models/accounting/expense_claims.rb +++ b/lib/xero-ruby/models/accounting/expense_claims.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/external_link.rb b/lib/xero-ruby/models/accounting/external_link.rb index 0ebe3911..ea9f52da 100644 --- a/lib/xero-ruby/models/accounting/external_link.rb +++ b/lib/xero-ruby/models/accounting/external_link.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/history_record.rb b/lib/xero-ruby/models/accounting/history_record.rb index 949c3ab2..b5921219 100644 --- a/lib/xero-ruby/models/accounting/history_record.rb +++ b/lib/xero-ruby/models/accounting/history_record.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/history_records.rb b/lib/xero-ruby/models/accounting/history_records.rb index 58f9ab12..33c0548c 100644 --- a/lib/xero-ruby/models/accounting/history_records.rb +++ b/lib/xero-ruby/models/accounting/history_records.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/import_summary.rb b/lib/xero-ruby/models/accounting/import_summary.rb index 061ad95f..96e3f5d5 100644 --- a/lib/xero-ruby/models/accounting/import_summary.rb +++ b/lib/xero-ruby/models/accounting/import_summary.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/import_summary_accounts.rb b/lib/xero-ruby/models/accounting/import_summary_accounts.rb index aa6e17be..171bf299 100644 --- a/lib/xero-ruby/models/accounting/import_summary_accounts.rb +++ b/lib/xero-ruby/models/accounting/import_summary_accounts.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/import_summary_object.rb b/lib/xero-ruby/models/accounting/import_summary_object.rb index 3f38dc82..daf6f7e4 100644 --- a/lib/xero-ruby/models/accounting/import_summary_object.rb +++ b/lib/xero-ruby/models/accounting/import_summary_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/import_summary_organisation.rb b/lib/xero-ruby/models/accounting/import_summary_organisation.rb index de9ad97b..755c3f7a 100644 --- a/lib/xero-ruby/models/accounting/import_summary_organisation.rb +++ b/lib/xero-ruby/models/accounting/import_summary_organisation.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/invoice.rb b/lib/xero-ruby/models/accounting/invoice.rb index 0c46aa69..7a4faf32 100644 --- a/lib/xero-ruby/models/accounting/invoice.rb +++ b/lib/xero-ruby/models/accounting/invoice.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/invoice_reminder.rb b/lib/xero-ruby/models/accounting/invoice_reminder.rb index 59764ede..6bd37e07 100644 --- a/lib/xero-ruby/models/accounting/invoice_reminder.rb +++ b/lib/xero-ruby/models/accounting/invoice_reminder.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/invoice_reminders.rb b/lib/xero-ruby/models/accounting/invoice_reminders.rb index 579d2c37..4fa5ef92 100644 --- a/lib/xero-ruby/models/accounting/invoice_reminders.rb +++ b/lib/xero-ruby/models/accounting/invoice_reminders.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/invoices.rb b/lib/xero-ruby/models/accounting/invoices.rb index f6fe97e1..e9aaa4c6 100644 --- a/lib/xero-ruby/models/accounting/invoices.rb +++ b/lib/xero-ruby/models/accounting/invoices.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/item.rb b/lib/xero-ruby/models/accounting/item.rb index 2e796893..c4462c83 100644 --- a/lib/xero-ruby/models/accounting/item.rb +++ b/lib/xero-ruby/models/accounting/item.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/items.rb b/lib/xero-ruby/models/accounting/items.rb index 1ad45703..0c26b608 100644 --- a/lib/xero-ruby/models/accounting/items.rb +++ b/lib/xero-ruby/models/accounting/items.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/journal.rb b/lib/xero-ruby/models/accounting/journal.rb index c426c441..25e683c9 100644 --- a/lib/xero-ruby/models/accounting/journal.rb +++ b/lib/xero-ruby/models/accounting/journal.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/journal_line.rb b/lib/xero-ruby/models/accounting/journal_line.rb index ec8f4f34..8910d98b 100644 --- a/lib/xero-ruby/models/accounting/journal_line.rb +++ b/lib/xero-ruby/models/accounting/journal_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/journals.rb b/lib/xero-ruby/models/accounting/journals.rb index 93796fa3..c41f421f 100644 --- a/lib/xero-ruby/models/accounting/journals.rb +++ b/lib/xero-ruby/models/accounting/journals.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/line_amount_types.rb b/lib/xero-ruby/models/accounting/line_amount_types.rb index 0a85bc72..05d66b23 100644 --- a/lib/xero-ruby/models/accounting/line_amount_types.rb +++ b/lib/xero-ruby/models/accounting/line_amount_types.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/line_item.rb b/lib/xero-ruby/models/accounting/line_item.rb index e86407cf..40ebfe0d 100644 --- a/lib/xero-ruby/models/accounting/line_item.rb +++ b/lib/xero-ruby/models/accounting/line_item.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/line_item_item.rb b/lib/xero-ruby/models/accounting/line_item_item.rb index 5b495424..5cc90c60 100644 --- a/lib/xero-ruby/models/accounting/line_item_item.rb +++ b/lib/xero-ruby/models/accounting/line_item_item.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/line_item_tracking.rb b/lib/xero-ruby/models/accounting/line_item_tracking.rb index f1117e30..7e87174f 100644 --- a/lib/xero-ruby/models/accounting/line_item_tracking.rb +++ b/lib/xero-ruby/models/accounting/line_item_tracking.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/linked_transaction.rb b/lib/xero-ruby/models/accounting/linked_transaction.rb index 890d465f..8ce691ce 100644 --- a/lib/xero-ruby/models/accounting/linked_transaction.rb +++ b/lib/xero-ruby/models/accounting/linked_transaction.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/linked_transactions.rb b/lib/xero-ruby/models/accounting/linked_transactions.rb index 6e4b99e8..1424de3a 100644 --- a/lib/xero-ruby/models/accounting/linked_transactions.rb +++ b/lib/xero-ruby/models/accounting/linked_transactions.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/manual_journal.rb b/lib/xero-ruby/models/accounting/manual_journal.rb index 2becb10d..f59014f4 100644 --- a/lib/xero-ruby/models/accounting/manual_journal.rb +++ b/lib/xero-ruby/models/accounting/manual_journal.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/manual_journal_line.rb b/lib/xero-ruby/models/accounting/manual_journal_line.rb index 07b66034..e6e4acac 100644 --- a/lib/xero-ruby/models/accounting/manual_journal_line.rb +++ b/lib/xero-ruby/models/accounting/manual_journal_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/manual_journals.rb b/lib/xero-ruby/models/accounting/manual_journals.rb index 5c90a305..26999577 100644 --- a/lib/xero-ruby/models/accounting/manual_journals.rb +++ b/lib/xero-ruby/models/accounting/manual_journals.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/online_invoice.rb b/lib/xero-ruby/models/accounting/online_invoice.rb index 500660a0..713f83c9 100644 --- a/lib/xero-ruby/models/accounting/online_invoice.rb +++ b/lib/xero-ruby/models/accounting/online_invoice.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/online_invoices.rb b/lib/xero-ruby/models/accounting/online_invoices.rb index ccfc3315..5a22faa8 100644 --- a/lib/xero-ruby/models/accounting/online_invoices.rb +++ b/lib/xero-ruby/models/accounting/online_invoices.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/organisation.rb b/lib/xero-ruby/models/accounting/organisation.rb index 6903ee85..2037ef1c 100644 --- a/lib/xero-ruby/models/accounting/organisation.rb +++ b/lib/xero-ruby/models/accounting/organisation.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/organisations.rb b/lib/xero-ruby/models/accounting/organisations.rb index 7375938c..3383b8e1 100644 --- a/lib/xero-ruby/models/accounting/organisations.rb +++ b/lib/xero-ruby/models/accounting/organisations.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/overpayment.rb b/lib/xero-ruby/models/accounting/overpayment.rb index 378b7abd..2b090808 100644 --- a/lib/xero-ruby/models/accounting/overpayment.rb +++ b/lib/xero-ruby/models/accounting/overpayment.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/overpayments.rb b/lib/xero-ruby/models/accounting/overpayments.rb index 42c86f57..6c757ae6 100644 --- a/lib/xero-ruby/models/accounting/overpayments.rb +++ b/lib/xero-ruby/models/accounting/overpayments.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/payment.rb b/lib/xero-ruby/models/accounting/payment.rb index 58d28135..d2fa08d4 100644 --- a/lib/xero-ruby/models/accounting/payment.rb +++ b/lib/xero-ruby/models/accounting/payment.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/payment_delete.rb b/lib/xero-ruby/models/accounting/payment_delete.rb index 7b9a3af0..6a86b014 100644 --- a/lib/xero-ruby/models/accounting/payment_delete.rb +++ b/lib/xero-ruby/models/accounting/payment_delete.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/payment_service.rb b/lib/xero-ruby/models/accounting/payment_service.rb index 12d6a983..c3d8cda8 100644 --- a/lib/xero-ruby/models/accounting/payment_service.rb +++ b/lib/xero-ruby/models/accounting/payment_service.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/payment_services.rb b/lib/xero-ruby/models/accounting/payment_services.rb index 6ddf39d5..758bd633 100644 --- a/lib/xero-ruby/models/accounting/payment_services.rb +++ b/lib/xero-ruby/models/accounting/payment_services.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/payment_term.rb b/lib/xero-ruby/models/accounting/payment_term.rb index c70b9634..caa50084 100644 --- a/lib/xero-ruby/models/accounting/payment_term.rb +++ b/lib/xero-ruby/models/accounting/payment_term.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/payment_term_type.rb b/lib/xero-ruby/models/accounting/payment_term_type.rb index a2606af5..6243c0d9 100644 --- a/lib/xero-ruby/models/accounting/payment_term_type.rb +++ b/lib/xero-ruby/models/accounting/payment_term_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/payments.rb b/lib/xero-ruby/models/accounting/payments.rb index 4d0df9c9..a09b3491 100644 --- a/lib/xero-ruby/models/accounting/payments.rb +++ b/lib/xero-ruby/models/accounting/payments.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/phone.rb b/lib/xero-ruby/models/accounting/phone.rb index 45557efd..9acee3ef 100644 --- a/lib/xero-ruby/models/accounting/phone.rb +++ b/lib/xero-ruby/models/accounting/phone.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/prepayment.rb b/lib/xero-ruby/models/accounting/prepayment.rb index f8e3c30a..a84961fe 100644 --- a/lib/xero-ruby/models/accounting/prepayment.rb +++ b/lib/xero-ruby/models/accounting/prepayment.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/prepayments.rb b/lib/xero-ruby/models/accounting/prepayments.rb index 7dc0aded..51eb06e6 100644 --- a/lib/xero-ruby/models/accounting/prepayments.rb +++ b/lib/xero-ruby/models/accounting/prepayments.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/purchase.rb b/lib/xero-ruby/models/accounting/purchase.rb index 06360e16..5b182d60 100644 --- a/lib/xero-ruby/models/accounting/purchase.rb +++ b/lib/xero-ruby/models/accounting/purchase.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/purchase_order.rb b/lib/xero-ruby/models/accounting/purchase_order.rb index 404654b7..3f5da9cf 100644 --- a/lib/xero-ruby/models/accounting/purchase_order.rb +++ b/lib/xero-ruby/models/accounting/purchase_order.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/purchase_orders.rb b/lib/xero-ruby/models/accounting/purchase_orders.rb index a5707e83..a8cd539e 100644 --- a/lib/xero-ruby/models/accounting/purchase_orders.rb +++ b/lib/xero-ruby/models/accounting/purchase_orders.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/quote.rb b/lib/xero-ruby/models/accounting/quote.rb index 4be0eae0..c2324c23 100644 --- a/lib/xero-ruby/models/accounting/quote.rb +++ b/lib/xero-ruby/models/accounting/quote.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/quote_line_amount_types.rb b/lib/xero-ruby/models/accounting/quote_line_amount_types.rb index 9d56e9c8..8d0aac83 100644 --- a/lib/xero-ruby/models/accounting/quote_line_amount_types.rb +++ b/lib/xero-ruby/models/accounting/quote_line_amount_types.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/quote_status_codes.rb b/lib/xero-ruby/models/accounting/quote_status_codes.rb index 0cee3956..ef5bcaaa 100644 --- a/lib/xero-ruby/models/accounting/quote_status_codes.rb +++ b/lib/xero-ruby/models/accounting/quote_status_codes.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/quotes.rb b/lib/xero-ruby/models/accounting/quotes.rb index 707a5793..fcf6e241 100644 --- a/lib/xero-ruby/models/accounting/quotes.rb +++ b/lib/xero-ruby/models/accounting/quotes.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/receipt.rb b/lib/xero-ruby/models/accounting/receipt.rb index 4a6c19e4..a8e6ec10 100644 --- a/lib/xero-ruby/models/accounting/receipt.rb +++ b/lib/xero-ruby/models/accounting/receipt.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/receipts.rb b/lib/xero-ruby/models/accounting/receipts.rb index 9a29e210..1f44fde3 100644 --- a/lib/xero-ruby/models/accounting/receipts.rb +++ b/lib/xero-ruby/models/accounting/receipts.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/repeating_invoice.rb b/lib/xero-ruby/models/accounting/repeating_invoice.rb index 0a298924..e2c56409 100644 --- a/lib/xero-ruby/models/accounting/repeating_invoice.rb +++ b/lib/xero-ruby/models/accounting/repeating_invoice.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/repeating_invoices.rb b/lib/xero-ruby/models/accounting/repeating_invoices.rb index a7fd6f9e..7243ad6a 100644 --- a/lib/xero-ruby/models/accounting/repeating_invoices.rb +++ b/lib/xero-ruby/models/accounting/repeating_invoices.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/report.rb b/lib/xero-ruby/models/accounting/report.rb index f202fa6a..9586fc55 100644 --- a/lib/xero-ruby/models/accounting/report.rb +++ b/lib/xero-ruby/models/accounting/report.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/report_attribute.rb b/lib/xero-ruby/models/accounting/report_attribute.rb index 6f9ff896..e1660340 100644 --- a/lib/xero-ruby/models/accounting/report_attribute.rb +++ b/lib/xero-ruby/models/accounting/report_attribute.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/report_cell.rb b/lib/xero-ruby/models/accounting/report_cell.rb index 48fcf739..12886f1e 100644 --- a/lib/xero-ruby/models/accounting/report_cell.rb +++ b/lib/xero-ruby/models/accounting/report_cell.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/report_fields.rb b/lib/xero-ruby/models/accounting/report_fields.rb index dfe6c6c9..d133d3a7 100644 --- a/lib/xero-ruby/models/accounting/report_fields.rb +++ b/lib/xero-ruby/models/accounting/report_fields.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/report_row.rb b/lib/xero-ruby/models/accounting/report_row.rb index 00355d1b..68f8d3a9 100644 --- a/lib/xero-ruby/models/accounting/report_row.rb +++ b/lib/xero-ruby/models/accounting/report_row.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/report_rows.rb b/lib/xero-ruby/models/accounting/report_rows.rb index 7298b334..96aa623a 100644 --- a/lib/xero-ruby/models/accounting/report_rows.rb +++ b/lib/xero-ruby/models/accounting/report_rows.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/report_with_row.rb b/lib/xero-ruby/models/accounting/report_with_row.rb index 57b3f8fe..b6bf1c4a 100644 --- a/lib/xero-ruby/models/accounting/report_with_row.rb +++ b/lib/xero-ruby/models/accounting/report_with_row.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/report_with_rows.rb b/lib/xero-ruby/models/accounting/report_with_rows.rb index bd554062..3c15c5e7 100644 --- a/lib/xero-ruby/models/accounting/report_with_rows.rb +++ b/lib/xero-ruby/models/accounting/report_with_rows.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/reports.rb b/lib/xero-ruby/models/accounting/reports.rb index 402015ad..65ce5787 100644 --- a/lib/xero-ruby/models/accounting/reports.rb +++ b/lib/xero-ruby/models/accounting/reports.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/request_empty.rb b/lib/xero-ruby/models/accounting/request_empty.rb index c2df72b8..be2c842b 100644 --- a/lib/xero-ruby/models/accounting/request_empty.rb +++ b/lib/xero-ruby/models/accounting/request_empty.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/row_type.rb b/lib/xero-ruby/models/accounting/row_type.rb index be6966ba..b6f8773d 100644 --- a/lib/xero-ruby/models/accounting/row_type.rb +++ b/lib/xero-ruby/models/accounting/row_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/sales_tracking_category.rb b/lib/xero-ruby/models/accounting/sales_tracking_category.rb index 4ed2276f..f29d93b5 100644 --- a/lib/xero-ruby/models/accounting/sales_tracking_category.rb +++ b/lib/xero-ruby/models/accounting/sales_tracking_category.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/schedule.rb b/lib/xero-ruby/models/accounting/schedule.rb index e3ae3b76..c88859fe 100644 --- a/lib/xero-ruby/models/accounting/schedule.rb +++ b/lib/xero-ruby/models/accounting/schedule.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/setup.rb b/lib/xero-ruby/models/accounting/setup.rb index 1b19350c..a0c2ae86 100644 --- a/lib/xero-ruby/models/accounting/setup.rb +++ b/lib/xero-ruby/models/accounting/setup.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/tax_component.rb b/lib/xero-ruby/models/accounting/tax_component.rb index cde6f301..953e67e6 100644 --- a/lib/xero-ruby/models/accounting/tax_component.rb +++ b/lib/xero-ruby/models/accounting/tax_component.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/tax_rate.rb b/lib/xero-ruby/models/accounting/tax_rate.rb index d39a6771..bd750ab2 100644 --- a/lib/xero-ruby/models/accounting/tax_rate.rb +++ b/lib/xero-ruby/models/accounting/tax_rate.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/tax_rates.rb b/lib/xero-ruby/models/accounting/tax_rates.rb index cf1ae05e..d39bca4e 100644 --- a/lib/xero-ruby/models/accounting/tax_rates.rb +++ b/lib/xero-ruby/models/accounting/tax_rates.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/tax_type.rb b/lib/xero-ruby/models/accounting/tax_type.rb index d41c519b..50127398 100644 --- a/lib/xero-ruby/models/accounting/tax_type.rb +++ b/lib/xero-ruby/models/accounting/tax_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -110,6 +110,30 @@ class TaxType IMREY23 ||= "IMREY23".freeze BADDEBTRECOVERY ||= "BADDEBTRECOVERY".freeze BADDEBTRECOVERYY23 ||= "BADDEBTRECOVERYY23".freeze + OUTPUTY24 ||= "OUTPUTY24".freeze + DSOUTPUTY24 ||= "DSOUTPUTY24".freeze + INPUTY24 ||= "INPUTY24".freeze + IGDSINPUT2_Y24 ||= "IGDSINPUT2Y24".freeze + TXPETINPUTY24 ||= "TXPETINPUTY24".freeze + TXESSINPUTY24 ||= "TXESSINPUTY24".freeze + TXN33_INPUTY24 ||= "TXN33INPUTY24".freeze + TXREINPUTY24 ||= "TXREINPUTY24".freeze + TXCAY24 ||= "TXCAY24".freeze + BADDEBTRELIEFY24 ||= "BADDEBTRELIEFY24".freeze + IGDSINPUT3_Y24 ||= "IGDSINPUT3Y24".freeze + SROVRRSY24 ||= "SROVRRSY24".freeze + SROVRLVGY24 ||= "SROVRLVGY24".freeze + SRLVGY24 ||= "SRLVGY24".freeze + TXRCTSY24 ||= "TXRCTSY24".freeze + TXRCESSY24 ||= "TXRCESSY24".freeze + TXRCN33_Y24 ||= "TXRCN33Y24".freeze + TXRCREY24 ||= "TXRCREY24".freeze + IMY24 ||= "IMY24".freeze + IMESSY24 ||= "IMESSY24".freeze + IMN33_Y24 ||= "IMN33Y24".freeze + IMREY24 ||= "IMREY24".freeze + BADDEBTRECOVERYY24 ||= "BADDEBTRECOVERYY24".freeze + OSOUTPUT2 ||= "OSOUTPUT2".freeze # Builds the enum from string # @param [String] The enum value in the form of the string diff --git a/lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb b/lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb index 33ce6591..71114f9e 100644 --- a/lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb +++ b/lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -82,6 +82,44 @@ class TenNinetyNineContact # Contact contact id attr_accessor :contact_id + # Contact legal name + attr_accessor :legal_name + + # Contact business name + attr_accessor :business_name + + # Contact federal tax classification + attr_accessor :federal_tax_classification + SOLE_PROPRIETOR ||= "SOLE_PROPRIETOR".freeze + PARTNERSHIP ||= "PARTNERSHIP".freeze + TRUST_OR_ESTATE ||= "TRUST_OR_ESTATE".freeze + NONPROFIT ||= "NONPROFIT".freeze + C_CORP ||= "C_CORP".freeze + S_CORP ||= "S_CORP".freeze + OTHER ||= "OTHER".freeze + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -106,7 +144,10 @@ def self.attribute_map :'email' => :'Email', :'street_address' => :'StreetAddress', :'tax_id' => :'TaxID', - :'contact_id' => :'ContactId' + :'contact_id' => :'ContactId', + :'legal_name' => :'LegalName', + :'business_name' => :'BusinessName', + :'federal_tax_classification' => :'FederalTaxClassification' } end @@ -134,7 +175,10 @@ def self.openapi_types :'email' => :'String', :'street_address' => :'String', :'tax_id' => :'String', - :'contact_id' => :'String' + :'contact_id' => :'String', + :'legal_name' => :'String', + :'business_name' => :'String', + :'federal_tax_classification' => :'String' } end @@ -240,6 +284,18 @@ def initialize(attributes = {}) if attributes.key?(:'contact_id') self.contact_id = attributes[:'contact_id'] end + + if attributes.key?(:'legal_name') + self.legal_name = attributes[:'legal_name'] + end + + if attributes.key?(:'business_name') + self.business_name = attributes[:'business_name'] + end + + if attributes.key?(:'federal_tax_classification') + self.federal_tax_classification = attributes[:'federal_tax_classification'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -252,9 +308,21 @@ def list_invalid_properties # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + federal_tax_classification_validator = EnumAttributeValidator.new('String', ["SOLE_PROPRIETOR", "PARTNERSHIP", "TRUST_OR_ESTATE", "NONPROFIT", "C_CORP", "S_CORP", "OTHER"]) + return false unless federal_tax_classification_validator.valid?(@federal_tax_classification) true end + # Custom attribute writer method checking allowed values (enum). + # @param [Object] federal_tax_classification Object to be assigned + def federal_tax_classification=(federal_tax_classification) + validator = EnumAttributeValidator.new('String', ["SOLE_PROPRIETOR", "PARTNERSHIP", "TRUST_OR_ESTATE", "NONPROFIT", "C_CORP", "S_CORP", "OTHER"]) + unless validator.valid?(federal_tax_classification) + fail ArgumentError, "invalid value for \"federal_tax_classification\", must be one of #{validator.allowable_values}." + end + @federal_tax_classification = federal_tax_classification + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) @@ -281,7 +349,10 @@ def ==(o) email == o.email && street_address == o.street_address && tax_id == o.tax_id && - contact_id == o.contact_id + contact_id == o.contact_id && + legal_name == o.legal_name && + business_name == o.business_name && + federal_tax_classification == o.federal_tax_classification end # @see the `==` method @@ -293,7 +364,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [box1, box2, box3, box4, box5, box6, box7, box8, box9, box10, box11, box13, box14, name, federal_tax_id_type, city, zip, state, email, street_address, tax_id, contact_id].hash + [box1, box2, box3, box4, box5, box6, box7, box8, box9, box10, box11, box13, box14, name, federal_tax_id_type, city, zip, state, email, street_address, tax_id, contact_id, legal_name, business_name, federal_tax_classification].hash end # Builds the object from hash diff --git a/lib/xero-ruby/models/accounting/time_zone.rb b/lib/xero-ruby/models/accounting/time_zone.rb index ac32826f..4f3cf1da 100644 --- a/lib/xero-ruby/models/accounting/time_zone.rb +++ b/lib/xero-ruby/models/accounting/time_zone.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/tracking_categories.rb b/lib/xero-ruby/models/accounting/tracking_categories.rb index 15c30a37..1bb09828 100644 --- a/lib/xero-ruby/models/accounting/tracking_categories.rb +++ b/lib/xero-ruby/models/accounting/tracking_categories.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/tracking_category.rb b/lib/xero-ruby/models/accounting/tracking_category.rb index b6dcbc7d..b684ef38 100644 --- a/lib/xero-ruby/models/accounting/tracking_category.rb +++ b/lib/xero-ruby/models/accounting/tracking_category.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/tracking_option.rb b/lib/xero-ruby/models/accounting/tracking_option.rb index 41546b94..3b86bdde 100644 --- a/lib/xero-ruby/models/accounting/tracking_option.rb +++ b/lib/xero-ruby/models/accounting/tracking_option.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/tracking_options.rb b/lib/xero-ruby/models/accounting/tracking_options.rb index 94ccbfd4..7527af76 100644 --- a/lib/xero-ruby/models/accounting/tracking_options.rb +++ b/lib/xero-ruby/models/accounting/tracking_options.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/user.rb b/lib/xero-ruby/models/accounting/user.rb index ba5b5aba..999f8ecd 100644 --- a/lib/xero-ruby/models/accounting/user.rb +++ b/lib/xero-ruby/models/accounting/user.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/users.rb b/lib/xero-ruby/models/accounting/users.rb index cf81f223..11d7bce2 100644 --- a/lib/xero-ruby/models/accounting/users.rb +++ b/lib/xero-ruby/models/accounting/users.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/accounting/validation_error.rb b/lib/xero-ruby/models/accounting/validation_error.rb index 1e9d0fa7..65c281a7 100644 --- a/lib/xero-ruby/models/accounting/validation_error.rb +++ b/lib/xero-ruby/models/accounting/validation_error.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/app_store/create_usage_record.rb b/lib/xero-ruby/models/app_store/create_usage_record.rb index c30c9348..899578ec 100644 --- a/lib/xero-ruby/models/app_store/create_usage_record.rb +++ b/lib/xero-ruby/models/app_store/create_usage_record.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -35,7 +35,7 @@ def self.attribute_map def self.openapi_types { :'quantity' => :'Integer', - :'timestamp' => :'DateTime' + :'timestamp' => :'Time' } end diff --git a/lib/xero-ruby/models/app_store/plan.rb b/lib/xero-ruby/models/app_store/plan.rb index b0f06f02..872238c8 100644 --- a/lib/xero-ruby/models/app_store/plan.rb +++ b/lib/xero-ruby/models/app_store/plan.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/app_store/price.rb b/lib/xero-ruby/models/app_store/price.rb index 40128e43..70cbdb88 100644 --- a/lib/xero-ruby/models/app_store/price.rb +++ b/lib/xero-ruby/models/app_store/price.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/app_store/problem_details.rb b/lib/xero-ruby/models/app_store/problem_details.rb index 6d17e8ad..41cb9fe3 100644 --- a/lib/xero-ruby/models/app_store/problem_details.rb +++ b/lib/xero-ruby/models/app_store/problem_details.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/app_store/product.rb b/lib/xero-ruby/models/app_store/product.rb index 66738f63..ab746834 100644 --- a/lib/xero-ruby/models/app_store/product.rb +++ b/lib/xero-ruby/models/app_store/product.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/app_store/subscription.rb b/lib/xero-ruby/models/app_store/subscription.rb index d0467be9..2242284a 100644 --- a/lib/xero-ruby/models/app_store/subscription.rb +++ b/lib/xero-ruby/models/app_store/subscription.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -82,12 +82,12 @@ def self.attribute_map # Attribute type mapping. def self.openapi_types { - :'current_period_end' => :'DateTime', - :'end_date' => :'DateTime', + :'current_period_end' => :'Time', + :'end_date' => :'Time', :'id' => :'String', :'organisation_id' => :'String', :'plans' => :'Array', - :'start_date' => :'DateTime', + :'start_date' => :'Time', :'status' => :'String', :'test_mode' => :'Boolean' } diff --git a/lib/xero-ruby/models/app_store/subscription_item.rb b/lib/xero-ruby/models/app_store/subscription_item.rb index b3d20d25..156e51fc 100644 --- a/lib/xero-ruby/models/app_store/subscription_item.rb +++ b/lib/xero-ruby/models/app_store/subscription_item.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -82,12 +82,12 @@ def self.attribute_map # Attribute type mapping. def self.openapi_types { - :'end_date' => :'DateTime', + :'end_date' => :'Time', :'id' => :'String', :'price' => :'Price', :'product' => :'Product', :'quantity' => :'Integer', - :'start_date' => :'DateTime', + :'start_date' => :'Time', :'status' => :'String', :'test_mode' => :'Boolean' } diff --git a/lib/xero-ruby/models/app_store/update_usage_record.rb b/lib/xero-ruby/models/app_store/update_usage_record.rb index 8bf410ea..f87c4c06 100644 --- a/lib/xero-ruby/models/app_store/update_usage_record.rb +++ b/lib/xero-ruby/models/app_store/update_usage_record.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/app_store/usage_record.rb b/lib/xero-ruby/models/app_store/usage_record.rb index 8b5e1303..0f535e33 100644 --- a/lib/xero-ruby/models/app_store/usage_record.rb +++ b/lib/xero-ruby/models/app_store/usage_record.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -61,7 +61,7 @@ def self.openapi_types :'subscription_id' => :'String', :'subscription_item_id' => :'String', :'test_mode' => :'Boolean', - :'recorded_at' => :'DateTime', + :'recorded_at' => :'Time', :'usage_record_id' => :'String', :'price_per_unit' => :'Float', :'product_id' => :'String' diff --git a/lib/xero-ruby/models/app_store/usage_records_list.rb b/lib/xero-ruby/models/app_store/usage_records_list.rb index fd07150b..5250a2cf 100644 --- a/lib/xero-ruby/models/app_store/usage_records_list.rb +++ b/lib/xero-ruby/models/app_store/usage_records_list.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/assets/asset.rb b/lib/xero-ruby/models/assets/asset.rb index c5da7e25..a524c296 100644 --- a/lib/xero-ruby/models/assets/asset.rb +++ b/lib/xero-ruby/models/assets/asset.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/assets/asset_status.rb b/lib/xero-ruby/models/assets/asset_status.rb index 002c4bc2..15628175 100644 --- a/lib/xero-ruby/models/assets/asset_status.rb +++ b/lib/xero-ruby/models/assets/asset_status.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/assets/asset_status_query_param.rb b/lib/xero-ruby/models/assets/asset_status_query_param.rb index c751d12f..bc352068 100644 --- a/lib/xero-ruby/models/assets/asset_status_query_param.rb +++ b/lib/xero-ruby/models/assets/asset_status_query_param.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/assets/asset_type.rb b/lib/xero-ruby/models/assets/asset_type.rb index 70537638..e7be1401 100644 --- a/lib/xero-ruby/models/assets/asset_type.rb +++ b/lib/xero-ruby/models/assets/asset_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/assets/assets.rb b/lib/xero-ruby/models/assets/assets.rb index 3a57b19f..cf83f6d5 100644 --- a/lib/xero-ruby/models/assets/assets.rb +++ b/lib/xero-ruby/models/assets/assets.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/assets/book_depreciation_detail.rb b/lib/xero-ruby/models/assets/book_depreciation_detail.rb index a96c0892..d61f55b8 100644 --- a/lib/xero-ruby/models/assets/book_depreciation_detail.rb +++ b/lib/xero-ruby/models/assets/book_depreciation_detail.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/assets/book_depreciation_setting.rb b/lib/xero-ruby/models/assets/book_depreciation_setting.rb index 9bd12f4f..f43e5a76 100644 --- a/lib/xero-ruby/models/assets/book_depreciation_setting.rb +++ b/lib/xero-ruby/models/assets/book_depreciation_setting.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/assets/error.rb b/lib/xero-ruby/models/assets/error.rb index bf5fba80..ce147f0f 100644 --- a/lib/xero-ruby/models/assets/error.rb +++ b/lib/xero-ruby/models/assets/error.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/assets/field_validation_errors_element.rb b/lib/xero-ruby/models/assets/field_validation_errors_element.rb index 03ffb35a..35b5bcaa 100644 --- a/lib/xero-ruby/models/assets/field_validation_errors_element.rb +++ b/lib/xero-ruby/models/assets/field_validation_errors_element.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/assets/pagination.rb b/lib/xero-ruby/models/assets/pagination.rb index 87286dd7..40599122 100644 --- a/lib/xero-ruby/models/assets/pagination.rb +++ b/lib/xero-ruby/models/assets/pagination.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/assets/resource_validation_errors_element.rb b/lib/xero-ruby/models/assets/resource_validation_errors_element.rb index 04f9ddc3..83c3ca50 100644 --- a/lib/xero-ruby/models/assets/resource_validation_errors_element.rb +++ b/lib/xero-ruby/models/assets/resource_validation_errors_element.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/assets/setting.rb b/lib/xero-ruby/models/assets/setting.rb index ca489503..63744f1f 100644 --- a/lib/xero-ruby/models/assets/setting.rb +++ b/lib/xero-ruby/models/assets/setting.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/files/association.rb b/lib/xero-ruby/models/files/association.rb index ac43f100..8b337030 100644 --- a/lib/xero-ruby/models/files/association.rb +++ b/lib/xero-ruby/models/files/association.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/files/file_object.rb b/lib/xero-ruby/models/files/file_object.rb index 278b4dbe..2e875395 100644 --- a/lib/xero-ruby/models/files/file_object.rb +++ b/lib/xero-ruby/models/files/file_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/files/files.rb b/lib/xero-ruby/models/files/files.rb index adb79c44..31c81bd1 100644 --- a/lib/xero-ruby/models/files/files.rb +++ b/lib/xero-ruby/models/files/files.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/files/folder.rb b/lib/xero-ruby/models/files/folder.rb index 0e410cbb..c1146ab5 100644 --- a/lib/xero-ruby/models/files/folder.rb +++ b/lib/xero-ruby/models/files/folder.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/files/folders.rb b/lib/xero-ruby/models/files/folders.rb index 628cc476..970a8b41 100644 --- a/lib/xero-ruby/models/files/folders.rb +++ b/lib/xero-ruby/models/files/folders.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/files/object_group.rb b/lib/xero-ruby/models/files/object_group.rb index 5df114da..c8141c04 100644 --- a/lib/xero-ruby/models/files/object_group.rb +++ b/lib/xero-ruby/models/files/object_group.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/files/object_type.rb b/lib/xero-ruby/models/files/object_type.rb index f8d62cfc..18bf90b1 100644 --- a/lib/xero-ruby/models/files/object_type.rb +++ b/lib/xero-ruby/models/files/object_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/files/upload_object.rb b/lib/xero-ruby/models/files/upload_object.rb deleted file mode 100644 index 7a812839..00000000 --- a/lib/xero-ruby/models/files/upload_object.rb +++ /dev/null @@ -1,267 +0,0 @@ -=begin -#Xero Files API - -#These endpoints are specific to Xero Files API - -Contact: api@xero.com -Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 - -=end - -require 'time' -require 'date' - -module XeroRuby::Files - require 'bigdecimal' - - class UploadObject - - attr_accessor :body - - # exact name of the file you are uploading - attr_accessor :name - - - attr_accessor :filename - - - attr_accessor :mime_type - - # Attribute mapping from ruby-style variable name to JSON key. - def self.attribute_map - { - :'body' => :'body', - :'name' => :'name', - :'filename' => :'filename', - :'mime_type' => :'mimeType' - } - end - - # Attribute type mapping. - def self.openapi_types - { - :'body' => :'String', - :'name' => :'String', - :'filename' => :'String', - :'mime_type' => :'String' - } - end - - # Initializes the object - # @param [Hash] attributes Model attributes in the form of hash - def initialize(attributes = {}) - if (!attributes.is_a?(Hash)) - fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Files::UploadObject` initialize method" - end - - # check to see if the attribute exists and convert string to symbol for hash key - attributes = attributes.each_with_object({}) { |(k, v), h| - if (!self.class.attribute_map.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Files::UploadObject`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect - end - h[k.to_sym] = v - } - - if attributes.key?(:'body') - self.body = attributes[:'body'] - end - - if attributes.key?(:'name') - self.name = attributes[:'name'] - end - - if attributes.key?(:'filename') - self.filename = attributes[:'filename'] - end - - if attributes.key?(:'mime_type') - self.mime_type = attributes[:'mime_type'] - end - end - - # Show invalid properties with the reasons. Usually used together with valid? - # @return Array for valid properties with the reasons - def list_invalid_properties - invalid_properties = Array.new - if @body.nil? - invalid_properties.push('invalid value for "body", body cannot be nil.') - end - - if @name.nil? - invalid_properties.push('invalid value for "name", name cannot be nil.') - end - - if @filename.nil? - invalid_properties.push('invalid value for "filename", filename cannot be nil.') - end - - invalid_properties - end - - # Check to see if the all the properties in the model are valid - # @return true if the model is valid - def valid? - return false if @body.nil? - return false if @name.nil? - return false if @filename.nil? - true - end - - # Checks equality by comparing each attribute. - # @param [Object] Object to be compared - def ==(o) - return true if self.equal?(o) - self.class == o.class && - body == o.body && - name == o.name && - filename == o.filename && - mime_type == o.mime_type - end - - # @see the `==` method - # @param [Object] Object to be compared - def eql?(o) - self == o - end - - # Calculates hash code according to all attributes. - # @return [Integer] Hash code - def hash - [body, name, filename, mime_type].hash - end - - # Builds the object from hash - # @param [Hash] attributes Model attributes in the form of hash - # @return [Object] Returns the model itself - def self.build_from_hash(attributes) - new.build_from_hash(attributes) - end - - # Builds the object from hash - # @param [Hash] attributes Model attributes in the form of hash - # @return [Object] Returns the model itself - def build_from_hash(attributes) - return nil unless attributes.is_a?(Hash) - self.class.openapi_types.each_pair do |key, type| - if type =~ /\AArray<(.*)>/i - # check to ensure the input is an array given that the attribute - # is documented as an array but the input is not - if attributes[self.class.attribute_map[key]].is_a?(Array) - self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) - end - elsif !attributes[self.class.attribute_map[key]].nil? - self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) - end # or else data not found in attributes(hash), not an issue as the data can be optional - end - - self - end - - # Deserializes the data based on type - # @param string type Data type - # @param string value Value to be deserialized - # @return [Object] Deserialized data - def _deserialize(type, value) - case type.to_sym - when :DateTime - DateTime.parse(parse_date(value)) - when :Date - Date.parse(parse_date(value)) - when :String - value.to_s - when :Integer - value.to_i - when :Float - value.to_f - when :BigDecimal - BigDecimal(value.to_s) - when :Boolean - if value.to_s =~ /\A(true|t|yes|y|1)\z/i - true - else - false - end - when :Object - # generic object (usually a Hash), return directly - value - when /\AArray<(?.+)>\z/ - inner_type = Regexp.last_match[:inner_type] - value.map { |v| _deserialize(inner_type, v) } - when /\AHash<(?.+?), (?.+)>\z/ - k_type = Regexp.last_match[:k_type] - v_type = Regexp.last_match[:v_type] - {}.tap do |hash| - value.each do |k, v| - hash[_deserialize(k_type, k)] = _deserialize(v_type, v) - end - end - else # model - XeroRuby::Files.const_get(type).build_from_hash(value) - end - end - - # Returns the string representation of the object - # @return [String] String presentation of the object - def to_s - to_hash.to_s - end - - # to_body is an alias to to_hash (backward compatibility) - # @return [Hash] Returns the object in the form of hash - def to_body - to_hash - end - - # Returns the object in the form of hash - # @return [Hash] Returns the object in the form of hash - def to_hash(downcase: false) - hash = {} - self.class.attribute_map.each_pair do |attr, param| - value = self.send(attr) - next if value.nil? - key = downcase ? attr : param - hash[key] = _to_hash(value, downcase: downcase) - end - hash - end - - # Returns the object in the form of hash with snake_case - def to_attributes - to_hash(downcase: true) - end - - # Outputs non-array value in the form of hash - # For object, use to_hash. Otherwise, just return the value - # @param [Object] value Any valid value - # @return [Hash] Returns the value in the form of hash - def _to_hash(value, downcase: false) - if value.is_a?(Array) - value.map do |v| - v.to_hash(downcase: downcase) - end - elsif value.is_a?(Hash) - {}.tap do |hash| - value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) } - end - elsif value.respond_to? :to_hash - value.to_hash(downcase: downcase) - else - value - end - end - - def parse_date(datestring) - if datestring.include?('Date') - date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\// - original, date, timezone = *date_pattern.match(datestring) - date = (date.to_i / 1000) - Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s - elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD - Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s - else # handle date 'types' for small subset of payroll API's - Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s - end - end - end -end diff --git a/lib/xero-ruby/models/files/user.rb b/lib/xero-ruby/models/files/user.rb index d6b96d5c..f409524e 100644 --- a/lib/xero-ruby/models/files/user.rb +++ b/lib/xero-ruby/models/files/user.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/account_usage.rb b/lib/xero-ruby/models/finance/account_usage.rb index a41d1bfd..8d49cc55 100644 --- a/lib/xero-ruby/models/finance/account_usage.rb +++ b/lib/xero-ruby/models/finance/account_usage.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -89,7 +89,7 @@ def self.openapi_types :'account_name' => :'String', :'reporting_code' => :'String', :'reporting_code_name' => :'String', - :'report_code_updated_date_utc' => :'DateTime' + :'report_code_updated_date_utc' => :'Time' } end diff --git a/lib/xero-ruby/models/finance/account_usage_response.rb b/lib/xero-ruby/models/finance/account_usage_response.rb index d7326a0b..bdb39f4b 100644 --- a/lib/xero-ruby/models/finance/account_usage_response.rb +++ b/lib/xero-ruby/models/finance/account_usage_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/balance_sheet_account_detail.rb b/lib/xero-ruby/models/finance/balance_sheet_account_detail.rb index 4ef3a6d0..c7092090 100644 --- a/lib/xero-ruby/models/finance/balance_sheet_account_detail.rb +++ b/lib/xero-ruby/models/finance/balance_sheet_account_detail.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/balance_sheet_account_group.rb b/lib/xero-ruby/models/finance/balance_sheet_account_group.rb index bc0b1432..35eac73a 100644 --- a/lib/xero-ruby/models/finance/balance_sheet_account_group.rb +++ b/lib/xero-ruby/models/finance/balance_sheet_account_group.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/balance_sheet_account_type.rb b/lib/xero-ruby/models/finance/balance_sheet_account_type.rb index 69441180..38172785 100644 --- a/lib/xero-ruby/models/finance/balance_sheet_account_type.rb +++ b/lib/xero-ruby/models/finance/balance_sheet_account_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/balance_sheet_response.rb b/lib/xero-ruby/models/finance/balance_sheet_response.rb index d6daef73..182a6800 100644 --- a/lib/xero-ruby/models/finance/balance_sheet_response.rb +++ b/lib/xero-ruby/models/finance/balance_sheet_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/bank_statement_accounting_response.rb b/lib/xero-ruby/models/finance/bank_statement_accounting_response.rb index a926fec1..570433dc 100644 --- a/lib/xero-ruby/models/finance/bank_statement_accounting_response.rb +++ b/lib/xero-ruby/models/finance/bank_statement_accounting_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/bank_statement_response.rb b/lib/xero-ruby/models/finance/bank_statement_response.rb index 2d663aac..937b49f3 100644 --- a/lib/xero-ruby/models/finance/bank_statement_response.rb +++ b/lib/xero-ruby/models/finance/bank_statement_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/bank_transaction_response.rb b/lib/xero-ruby/models/finance/bank_transaction_response.rb index 1fe21ade..4a6d2256 100644 --- a/lib/xero-ruby/models/finance/bank_transaction_response.rb +++ b/lib/xero-ruby/models/finance/bank_transaction_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/cash_account_response.rb b/lib/xero-ruby/models/finance/cash_account_response.rb index 13b92e90..5047ebbb 100644 --- a/lib/xero-ruby/models/finance/cash_account_response.rb +++ b/lib/xero-ruby/models/finance/cash_account_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/cash_balance.rb b/lib/xero-ruby/models/finance/cash_balance.rb index 25812241..42563413 100644 --- a/lib/xero-ruby/models/finance/cash_balance.rb +++ b/lib/xero-ruby/models/finance/cash_balance.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/cash_validation_response.rb b/lib/xero-ruby/models/finance/cash_validation_response.rb index 312b17de..df403a04 100644 --- a/lib/xero-ruby/models/finance/cash_validation_response.rb +++ b/lib/xero-ruby/models/finance/cash_validation_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/cashflow_account.rb b/lib/xero-ruby/models/finance/cashflow_account.rb index 4d9fc27a..0c230e18 100644 --- a/lib/xero-ruby/models/finance/cashflow_account.rb +++ b/lib/xero-ruby/models/finance/cashflow_account.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/cashflow_activity.rb b/lib/xero-ruby/models/finance/cashflow_activity.rb index 6e397cf7..77b87595 100644 --- a/lib/xero-ruby/models/finance/cashflow_activity.rb +++ b/lib/xero-ruby/models/finance/cashflow_activity.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/cashflow_response.rb b/lib/xero-ruby/models/finance/cashflow_response.rb index 4d9fbe31..176f40ad 100644 --- a/lib/xero-ruby/models/finance/cashflow_response.rb +++ b/lib/xero-ruby/models/finance/cashflow_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/cashflow_type.rb b/lib/xero-ruby/models/finance/cashflow_type.rb index 8782a5a7..3d279c52 100644 --- a/lib/xero-ruby/models/finance/cashflow_type.rb +++ b/lib/xero-ruby/models/finance/cashflow_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/contact_detail.rb b/lib/xero-ruby/models/finance/contact_detail.rb index 16c150d9..f62c8b88 100644 --- a/lib/xero-ruby/models/finance/contact_detail.rb +++ b/lib/xero-ruby/models/finance/contact_detail.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/contact_response.rb b/lib/xero-ruby/models/finance/contact_response.rb index 6cda373d..cdafa4e6 100644 --- a/lib/xero-ruby/models/finance/contact_response.rb +++ b/lib/xero-ruby/models/finance/contact_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/contact_total_detail.rb b/lib/xero-ruby/models/finance/contact_total_detail.rb index b4f00b96..4645f97c 100644 --- a/lib/xero-ruby/models/finance/contact_total_detail.rb +++ b/lib/xero-ruby/models/finance/contact_total_detail.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/contact_total_other.rb b/lib/xero-ruby/models/finance/contact_total_other.rb index 7a2ecf47..6a6b352c 100644 --- a/lib/xero-ruby/models/finance/contact_total_other.rb +++ b/lib/xero-ruby/models/finance/contact_total_other.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/credit_note_response.rb b/lib/xero-ruby/models/finance/credit_note_response.rb index 8883ae79..c632cf10 100644 --- a/lib/xero-ruby/models/finance/credit_note_response.rb +++ b/lib/xero-ruby/models/finance/credit_note_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/current_statement_response.rb b/lib/xero-ruby/models/finance/current_statement_response.rb index 846f6a7e..9d943223 100644 --- a/lib/xero-ruby/models/finance/current_statement_response.rb +++ b/lib/xero-ruby/models/finance/current_statement_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -53,7 +53,7 @@ def self.openapi_types :'end_date' => :'Date', :'start_balance' => :'BigDecimal', :'end_balance' => :'BigDecimal', - :'imported_date_time_utc' => :'DateTime', + :'imported_date_time_utc' => :'Time', :'import_source_type' => :'String' } end diff --git a/lib/xero-ruby/models/finance/data_source_response.rb b/lib/xero-ruby/models/finance/data_source_response.rb index 1dadc392..546e9fea 100644 --- a/lib/xero-ruby/models/finance/data_source_response.rb +++ b/lib/xero-ruby/models/finance/data_source_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/history_record_response.rb b/lib/xero-ruby/models/finance/history_record_response.rb index 8847b3b1..2c79ae39 100644 --- a/lib/xero-ruby/models/finance/history_record_response.rb +++ b/lib/xero-ruby/models/finance/history_record_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -47,7 +47,7 @@ def self.openapi_types { :'changes' => :'String', :'date_utc_string' => :'String', - :'date_utc' => :'DateTime', + :'date_utc' => :'Time', :'user' => :'String', :'details' => :'String' } diff --git a/lib/xero-ruby/models/finance/income_by_contact_response.rb b/lib/xero-ruby/models/finance/income_by_contact_response.rb index 607093d3..8b5bb977 100644 --- a/lib/xero-ruby/models/finance/income_by_contact_response.rb +++ b/lib/xero-ruby/models/finance/income_by_contact_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/invoice_response.rb b/lib/xero-ruby/models/finance/invoice_response.rb index 763084db..35681e17 100644 --- a/lib/xero-ruby/models/finance/invoice_response.rb +++ b/lib/xero-ruby/models/finance/invoice_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/line_item_response.rb b/lib/xero-ruby/models/finance/line_item_response.rb index 0b2a8287..c27a3a8d 100644 --- a/lib/xero-ruby/models/finance/line_item_response.rb +++ b/lib/xero-ruby/models/finance/line_item_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/lock_history_model.rb b/lib/xero-ruby/models/finance/lock_history_model.rb index 17e21ff0..ee95b040 100644 --- a/lib/xero-ruby/models/finance/lock_history_model.rb +++ b/lib/xero-ruby/models/finance/lock_history_model.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -39,7 +39,7 @@ def self.openapi_types { :'hard_lock_date' => :'Date', :'soft_lock_date' => :'Date', - :'updated_date_utc' => :'DateTime' + :'updated_date_utc' => :'Time' } end diff --git a/lib/xero-ruby/models/finance/lock_history_response.rb b/lib/xero-ruby/models/finance/lock_history_response.rb index 343daec2..bd62934a 100644 --- a/lib/xero-ruby/models/finance/lock_history_response.rb +++ b/lib/xero-ruby/models/finance/lock_history_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/manual_journal_total.rb b/lib/xero-ruby/models/finance/manual_journal_total.rb index bc1de25a..75b68697 100644 --- a/lib/xero-ruby/models/finance/manual_journal_total.rb +++ b/lib/xero-ruby/models/finance/manual_journal_total.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/overpayment_response.rb b/lib/xero-ruby/models/finance/overpayment_response.rb index 31c3c419..6b471fed 100644 --- a/lib/xero-ruby/models/finance/overpayment_response.rb +++ b/lib/xero-ruby/models/finance/overpayment_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/payment_response.rb b/lib/xero-ruby/models/finance/payment_response.rb index 52682f3c..4381e19b 100644 --- a/lib/xero-ruby/models/finance/payment_response.rb +++ b/lib/xero-ruby/models/finance/payment_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/pnl_account.rb b/lib/xero-ruby/models/finance/pnl_account.rb index 978839c0..4415d4ed 100644 --- a/lib/xero-ruby/models/finance/pnl_account.rb +++ b/lib/xero-ruby/models/finance/pnl_account.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/pnl_account_class.rb b/lib/xero-ruby/models/finance/pnl_account_class.rb index 66668e49..f86c37ed 100644 --- a/lib/xero-ruby/models/finance/pnl_account_class.rb +++ b/lib/xero-ruby/models/finance/pnl_account_class.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/pnl_account_type.rb b/lib/xero-ruby/models/finance/pnl_account_type.rb index fd852f55..f01523b2 100644 --- a/lib/xero-ruby/models/finance/pnl_account_type.rb +++ b/lib/xero-ruby/models/finance/pnl_account_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/practice_response.rb b/lib/xero-ruby/models/finance/practice_response.rb index 33bb7eaf..49213cd5 100644 --- a/lib/xero-ruby/models/finance/practice_response.rb +++ b/lib/xero-ruby/models/finance/practice_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/prepayment_response.rb b/lib/xero-ruby/models/finance/prepayment_response.rb index f1020d5e..56a2f054 100644 --- a/lib/xero-ruby/models/finance/prepayment_response.rb +++ b/lib/xero-ruby/models/finance/prepayment_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/problem.rb b/lib/xero-ruby/models/finance/problem.rb index 5be95192..e77fc828 100644 --- a/lib/xero-ruby/models/finance/problem.rb +++ b/lib/xero-ruby/models/finance/problem.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/problem_type.rb b/lib/xero-ruby/models/finance/problem_type.rb index 561934b6..24fa1335 100644 --- a/lib/xero-ruby/models/finance/problem_type.rb +++ b/lib/xero-ruby/models/finance/problem_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -24,6 +24,7 @@ class ProblemType REQUEST_TIMEOUT ||= "request-timeout".freeze SERVICE_UNAVAILABLE ||= "service-unavailable".freeze UNAUTHORIZED ||= "unauthorized".freeze + RATE_LIMIT_ERROR ||= "rate-limit-error".freeze # Builds the enum from string # @param [String] The enum value in the form of the string diff --git a/lib/xero-ruby/models/finance/profit_and_loss_response.rb b/lib/xero-ruby/models/finance/profit_and_loss_response.rb index 0925c0ac..7ae2c5e6 100644 --- a/lib/xero-ruby/models/finance/profit_and_loss_response.rb +++ b/lib/xero-ruby/models/finance/profit_and_loss_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/report_history_model.rb b/lib/xero-ruby/models/finance/report_history_model.rb index 452ce2e7..93700d9b 100644 --- a/lib/xero-ruby/models/finance/report_history_model.rb +++ b/lib/xero-ruby/models/finance/report_history_model.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -39,7 +39,7 @@ def self.openapi_types { :'report_name' => :'String', :'report_date_text' => :'String', - :'published_date_utc' => :'DateTime' + :'published_date_utc' => :'Time' } end diff --git a/lib/xero-ruby/models/finance/report_history_response.rb b/lib/xero-ruby/models/finance/report_history_response.rb index 2c583f58..a0ac9637 100644 --- a/lib/xero-ruby/models/finance/report_history_response.rb +++ b/lib/xero-ruby/models/finance/report_history_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/statement_balance_response.rb b/lib/xero-ruby/models/finance/statement_balance_response.rb index 1cc393c7..e624c0ed 100644 --- a/lib/xero-ruby/models/finance/statement_balance_response.rb +++ b/lib/xero-ruby/models/finance/statement_balance_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/statement_line_response.rb b/lib/xero-ruby/models/finance/statement_line_response.rb index 39502a07..070fd4f0 100644 --- a/lib/xero-ruby/models/finance/statement_line_response.rb +++ b/lib/xero-ruby/models/finance/statement_line_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/statement_lines_response.rb b/lib/xero-ruby/models/finance/statement_lines_response.rb index 71d651a1..ee7387f3 100644 --- a/lib/xero-ruby/models/finance/statement_lines_response.rb +++ b/lib/xero-ruby/models/finance/statement_lines_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/statement_response.rb b/lib/xero-ruby/models/finance/statement_response.rb index 08e7f2b2..897e720b 100644 --- a/lib/xero-ruby/models/finance/statement_response.rb +++ b/lib/xero-ruby/models/finance/statement_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -68,7 +68,7 @@ def self.openapi_types :'statement_id' => :'String', :'start_date' => :'Date', :'end_date' => :'Date', - :'imported_date_time_utc' => :'DateTime', + :'imported_date_time_utc' => :'Time', :'import_source' => :'String', :'start_balance' => :'BigDecimal', :'end_balance' => :'BigDecimal', diff --git a/lib/xero-ruby/models/finance/total_detail.rb b/lib/xero-ruby/models/finance/total_detail.rb index 7f6edd65..ab99d94a 100644 --- a/lib/xero-ruby/models/finance/total_detail.rb +++ b/lib/xero-ruby/models/finance/total_detail.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/total_other.rb b/lib/xero-ruby/models/finance/total_other.rb index 61d39e09..dadbbe8a 100644 --- a/lib/xero-ruby/models/finance/total_other.rb +++ b/lib/xero-ruby/models/finance/total_other.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/trial_balance_account.rb b/lib/xero-ruby/models/finance/trial_balance_account.rb index c0dbc577..5bc39cf8 100644 --- a/lib/xero-ruby/models/finance/trial_balance_account.rb +++ b/lib/xero-ruby/models/finance/trial_balance_account.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/trial_balance_entry.rb b/lib/xero-ruby/models/finance/trial_balance_entry.rb index 4e620ac8..4c2594fa 100644 --- a/lib/xero-ruby/models/finance/trial_balance_entry.rb +++ b/lib/xero-ruby/models/finance/trial_balance_entry.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/trial_balance_movement.rb b/lib/xero-ruby/models/finance/trial_balance_movement.rb index c15b8152..d140e5f3 100644 --- a/lib/xero-ruby/models/finance/trial_balance_movement.rb +++ b/lib/xero-ruby/models/finance/trial_balance_movement.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/trial_balance_response.rb b/lib/xero-ruby/models/finance/trial_balance_response.rb index 12e3df25..90a7c6d4 100644 --- a/lib/xero-ruby/models/finance/trial_balance_response.rb +++ b/lib/xero-ruby/models/finance/trial_balance_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/user_activities_response.rb b/lib/xero-ruby/models/finance/user_activities_response.rb index 57f111c2..11730256 100644 --- a/lib/xero-ruby/models/finance/user_activities_response.rb +++ b/lib/xero-ruby/models/finance/user_activities_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/finance/user_response.rb b/lib/xero-ruby/models/finance/user_response.rb index 0399cb46..ff333991 100644 --- a/lib/xero-ruby/models/finance/user_response.rb +++ b/lib/xero-ruby/models/finance/user_response.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -74,8 +74,8 @@ def self.attribute_map def self.openapi_types { :'user_id' => :'String', - :'user_created_date_utc' => :'DateTime', - :'last_login_date_utc' => :'DateTime', + :'user_created_date_utc' => :'Time', + :'last_login_date_utc' => :'Time', :'is_external_partner' => :'Boolean', :'has_accountant_role' => :'Boolean', :'month_period' => :'String', diff --git a/lib/xero-ruby/models/payroll_au/account.rb b/lib/xero-ruby/models/payroll_au/account.rb index 5daf896e..430feae9 100644 --- a/lib/xero-ruby/models/payroll_au/account.rb +++ b/lib/xero-ruby/models/payroll_au/account.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/account_type.rb b/lib/xero-ruby/models/payroll_au/account_type.rb index 58de64ac..ac627eb7 100644 --- a/lib/xero-ruby/models/payroll_au/account_type.rb +++ b/lib/xero-ruby/models/payroll_au/account_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/allowance_category.rb b/lib/xero-ruby/models/payroll_au/allowance_category.rb index d80c49b5..a182bcf9 100644 --- a/lib/xero-ruby/models/payroll_au/allowance_category.rb +++ b/lib/xero-ruby/models/payroll_au/allowance_category.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/allowance_type.rb b/lib/xero-ruby/models/payroll_au/allowance_type.rb index 87f4a3e2..be8f7e8d 100644 --- a/lib/xero-ruby/models/payroll_au/allowance_type.rb +++ b/lib/xero-ruby/models/payroll_au/allowance_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/api_exception.rb b/lib/xero-ruby/models/payroll_au/api_exception.rb index fbf04706..a9b5a8df 100644 --- a/lib/xero-ruby/models/payroll_au/api_exception.rb +++ b/lib/xero-ruby/models/payroll_au/api_exception.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/bank_account.rb b/lib/xero-ruby/models/payroll_au/bank_account.rb index db169587..49a6de9e 100644 --- a/lib/xero-ruby/models/payroll_au/bank_account.rb +++ b/lib/xero-ruby/models/payroll_au/bank_account.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/calendar_type.rb b/lib/xero-ruby/models/payroll_au/calendar_type.rb index e3381787..78ad409d 100644 --- a/lib/xero-ruby/models/payroll_au/calendar_type.rb +++ b/lib/xero-ruby/models/payroll_au/calendar_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/country_of_residence.rb b/lib/xero-ruby/models/payroll_au/country_of_residence.rb index 328fbc09..81622465 100644 --- a/lib/xero-ruby/models/payroll_au/country_of_residence.rb +++ b/lib/xero-ruby/models/payroll_au/country_of_residence.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/deduction_line.rb b/lib/xero-ruby/models/payroll_au/deduction_line.rb index 27cf2a5c..e3220e3e 100644 --- a/lib/xero-ruby/models/payroll_au/deduction_line.rb +++ b/lib/xero-ruby/models/payroll_au/deduction_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/deduction_type.rb b/lib/xero-ruby/models/payroll_au/deduction_type.rb index ec8cfe01..89eef310 100644 --- a/lib/xero-ruby/models/payroll_au/deduction_type.rb +++ b/lib/xero-ruby/models/payroll_au/deduction_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/deduction_type_calculation_type.rb b/lib/xero-ruby/models/payroll_au/deduction_type_calculation_type.rb index 0af56965..75b59804 100644 --- a/lib/xero-ruby/models/payroll_au/deduction_type_calculation_type.rb +++ b/lib/xero-ruby/models/payroll_au/deduction_type_calculation_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/earnings_line.rb b/lib/xero-ruby/models/payroll_au/earnings_line.rb index c8ffcccd..e2315c44 100644 --- a/lib/xero-ruby/models/payroll_au/earnings_line.rb +++ b/lib/xero-ruby/models/payroll_au/earnings_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/earnings_rate.rb b/lib/xero-ruby/models/payroll_au/earnings_rate.rb index 85bdcc51..5ec74a30 100644 --- a/lib/xero-ruby/models/payroll_au/earnings_rate.rb +++ b/lib/xero-ruby/models/payroll_au/earnings_rate.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/earnings_rate_calculation_type.rb b/lib/xero-ruby/models/payroll_au/earnings_rate_calculation_type.rb index 315da62b..90ed7cf0 100644 --- a/lib/xero-ruby/models/payroll_au/earnings_rate_calculation_type.rb +++ b/lib/xero-ruby/models/payroll_au/earnings_rate_calculation_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/earnings_type.rb b/lib/xero-ruby/models/payroll_au/earnings_type.rb index 3f22a0a5..eaf3b4d0 100644 --- a/lib/xero-ruby/models/payroll_au/earnings_type.rb +++ b/lib/xero-ruby/models/payroll_au/earnings_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/employee.rb b/lib/xero-ruby/models/payroll_au/employee.rb index f8d6df6b..987c274b 100644 --- a/lib/xero-ruby/models/payroll_au/employee.rb +++ b/lib/xero-ruby/models/payroll_au/employee.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/employee_status.rb b/lib/xero-ruby/models/payroll_au/employee_status.rb index c3d143de..5788b90f 100644 --- a/lib/xero-ruby/models/payroll_au/employee_status.rb +++ b/lib/xero-ruby/models/payroll_au/employee_status.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/employees.rb b/lib/xero-ruby/models/payroll_au/employees.rb index b42388f1..aec9f6ee 100644 --- a/lib/xero-ruby/models/payroll_au/employees.rb +++ b/lib/xero-ruby/models/payroll_au/employees.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/employment_basis.rb b/lib/xero-ruby/models/payroll_au/employment_basis.rb index 45f435ba..faee1c5f 100644 --- a/lib/xero-ruby/models/payroll_au/employment_basis.rb +++ b/lib/xero-ruby/models/payroll_au/employment_basis.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/employment_termination_payment_type.rb b/lib/xero-ruby/models/payroll_au/employment_termination_payment_type.rb index f005c46d..64e5caf7 100644 --- a/lib/xero-ruby/models/payroll_au/employment_termination_payment_type.rb +++ b/lib/xero-ruby/models/payroll_au/employment_termination_payment_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/employment_type.rb b/lib/xero-ruby/models/payroll_au/employment_type.rb index 86c9df8d..4956cf47 100644 --- a/lib/xero-ruby/models/payroll_au/employment_type.rb +++ b/lib/xero-ruby/models/payroll_au/employment_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/entitlement_final_pay_payout_type.rb b/lib/xero-ruby/models/payroll_au/entitlement_final_pay_payout_type.rb index 5370f5c4..68aa88f0 100644 --- a/lib/xero-ruby/models/payroll_au/entitlement_final_pay_payout_type.rb +++ b/lib/xero-ruby/models/payroll_au/entitlement_final_pay_payout_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/home_address.rb b/lib/xero-ruby/models/payroll_au/home_address.rb index 7ae8243b..47e48be9 100644 --- a/lib/xero-ruby/models/payroll_au/home_address.rb +++ b/lib/xero-ruby/models/payroll_au/home_address.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/income_type.rb b/lib/xero-ruby/models/payroll_au/income_type.rb index d8867324..8875d25c 100644 --- a/lib/xero-ruby/models/payroll_au/income_type.rb +++ b/lib/xero-ruby/models/payroll_au/income_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/leave_accrual_line.rb b/lib/xero-ruby/models/payroll_au/leave_accrual_line.rb index 9f0b2bf6..0ea76144 100644 --- a/lib/xero-ruby/models/payroll_au/leave_accrual_line.rb +++ b/lib/xero-ruby/models/payroll_au/leave_accrual_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/leave_application.rb b/lib/xero-ruby/models/payroll_au/leave_application.rb index a35afd07..5c7340ad 100644 --- a/lib/xero-ruby/models/payroll_au/leave_application.rb +++ b/lib/xero-ruby/models/payroll_au/leave_application.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/leave_applications.rb b/lib/xero-ruby/models/payroll_au/leave_applications.rb index 9afdea0b..ede043f5 100644 --- a/lib/xero-ruby/models/payroll_au/leave_applications.rb +++ b/lib/xero-ruby/models/payroll_au/leave_applications.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/leave_balance.rb b/lib/xero-ruby/models/payroll_au/leave_balance.rb index a53556a7..869162aa 100644 --- a/lib/xero-ruby/models/payroll_au/leave_balance.rb +++ b/lib/xero-ruby/models/payroll_au/leave_balance.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/leave_category_code.rb b/lib/xero-ruby/models/payroll_au/leave_category_code.rb index a9cb2aef..56216baf 100644 --- a/lib/xero-ruby/models/payroll_au/leave_category_code.rb +++ b/lib/xero-ruby/models/payroll_au/leave_category_code.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/leave_earnings_line.rb b/lib/xero-ruby/models/payroll_au/leave_earnings_line.rb index adcd9a4a..fc377af8 100644 --- a/lib/xero-ruby/models/payroll_au/leave_earnings_line.rb +++ b/lib/xero-ruby/models/payroll_au/leave_earnings_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/leave_line.rb b/lib/xero-ruby/models/payroll_au/leave_line.rb index e077e742..6a82b288 100644 --- a/lib/xero-ruby/models/payroll_au/leave_line.rb +++ b/lib/xero-ruby/models/payroll_au/leave_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/leave_line_calculation_type.rb b/lib/xero-ruby/models/payroll_au/leave_line_calculation_type.rb index dbb35038..fcbe12bc 100644 --- a/lib/xero-ruby/models/payroll_au/leave_line_calculation_type.rb +++ b/lib/xero-ruby/models/payroll_au/leave_line_calculation_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/leave_lines.rb b/lib/xero-ruby/models/payroll_au/leave_lines.rb index 77f4f20e..a73f7548 100644 --- a/lib/xero-ruby/models/payroll_au/leave_lines.rb +++ b/lib/xero-ruby/models/payroll_au/leave_lines.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/leave_period.rb b/lib/xero-ruby/models/payroll_au/leave_period.rb index d4a064dc..f013018e 100644 --- a/lib/xero-ruby/models/payroll_au/leave_period.rb +++ b/lib/xero-ruby/models/payroll_au/leave_period.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/leave_period_status.rb b/lib/xero-ruby/models/payroll_au/leave_period_status.rb index 40e88553..6377cccf 100644 --- a/lib/xero-ruby/models/payroll_au/leave_period_status.rb +++ b/lib/xero-ruby/models/payroll_au/leave_period_status.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -16,6 +16,8 @@ module XeroRuby::PayrollAu class LeavePeriodStatus SCHEDULED ||= "SCHEDULED".freeze PROCESSED ||= "PROCESSED".freeze + REQUESTED ||= "REQUESTED".freeze + REJECTED ||= "REJECTED".freeze # Builds the enum from string # @param [String] The enum value in the form of the string diff --git a/lib/xero-ruby/models/payroll_au/leave_type.rb b/lib/xero-ruby/models/payroll_au/leave_type.rb index 4da3d0a0..8ce88d5e 100644 --- a/lib/xero-ruby/models/payroll_au/leave_type.rb +++ b/lib/xero-ruby/models/payroll_au/leave_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/leave_type_contribution_type.rb b/lib/xero-ruby/models/payroll_au/leave_type_contribution_type.rb index cb1ba269..ca24c1c5 100644 --- a/lib/xero-ruby/models/payroll_au/leave_type_contribution_type.rb +++ b/lib/xero-ruby/models/payroll_au/leave_type_contribution_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/manual_tax_type.rb b/lib/xero-ruby/models/payroll_au/manual_tax_type.rb index 223552ac..98c723c4 100644 --- a/lib/xero-ruby/models/payroll_au/manual_tax_type.rb +++ b/lib/xero-ruby/models/payroll_au/manual_tax_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/opening_balances.rb b/lib/xero-ruby/models/payroll_au/opening_balances.rb index facdd739..8ece421b 100644 --- a/lib/xero-ruby/models/payroll_au/opening_balances.rb +++ b/lib/xero-ruby/models/payroll_au/opening_balances.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/paid_leave_earnings_line.rb b/lib/xero-ruby/models/payroll_au/paid_leave_earnings_line.rb index 7a840384..0c1fc0ea 100644 --- a/lib/xero-ruby/models/payroll_au/paid_leave_earnings_line.rb +++ b/lib/xero-ruby/models/payroll_au/paid_leave_earnings_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/pay_item.rb b/lib/xero-ruby/models/payroll_au/pay_item.rb index 96e7c883..3961f5ac 100644 --- a/lib/xero-ruby/models/payroll_au/pay_item.rb +++ b/lib/xero-ruby/models/payroll_au/pay_item.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/pay_items.rb b/lib/xero-ruby/models/payroll_au/pay_items.rb index 5d2a45a5..cdcb9efc 100644 --- a/lib/xero-ruby/models/payroll_au/pay_items.rb +++ b/lib/xero-ruby/models/payroll_au/pay_items.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/pay_out_type.rb b/lib/xero-ruby/models/payroll_au/pay_out_type.rb index 21a84c61..c01dfcb2 100644 --- a/lib/xero-ruby/models/payroll_au/pay_out_type.rb +++ b/lib/xero-ruby/models/payroll_au/pay_out_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/pay_run.rb b/lib/xero-ruby/models/payroll_au/pay_run.rb index d8676045..adad6b9d 100644 --- a/lib/xero-ruby/models/payroll_au/pay_run.rb +++ b/lib/xero-ruby/models/payroll_au/pay_run.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/pay_run_status.rb b/lib/xero-ruby/models/payroll_au/pay_run_status.rb index 25c55eab..ea6b6d78 100644 --- a/lib/xero-ruby/models/payroll_au/pay_run_status.rb +++ b/lib/xero-ruby/models/payroll_au/pay_run_status.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/pay_runs.rb b/lib/xero-ruby/models/payroll_au/pay_runs.rb index dd8b1974..d51505ce 100644 --- a/lib/xero-ruby/models/payroll_au/pay_runs.rb +++ b/lib/xero-ruby/models/payroll_au/pay_runs.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/pay_template.rb b/lib/xero-ruby/models/payroll_au/pay_template.rb index c153aedc..b6e43d21 100644 --- a/lib/xero-ruby/models/payroll_au/pay_template.rb +++ b/lib/xero-ruby/models/payroll_au/pay_template.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/payment_frequency_type.rb b/lib/xero-ruby/models/payroll_au/payment_frequency_type.rb index 1ad37d22..8771621a 100644 --- a/lib/xero-ruby/models/payroll_au/payment_frequency_type.rb +++ b/lib/xero-ruby/models/payroll_au/payment_frequency_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/payroll_calendar.rb b/lib/xero-ruby/models/payroll_au/payroll_calendar.rb index 311b6daf..e511407f 100644 --- a/lib/xero-ruby/models/payroll_au/payroll_calendar.rb +++ b/lib/xero-ruby/models/payroll_au/payroll_calendar.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/payroll_calendars.rb b/lib/xero-ruby/models/payroll_au/payroll_calendars.rb index 05950313..f26b1c09 100644 --- a/lib/xero-ruby/models/payroll_au/payroll_calendars.rb +++ b/lib/xero-ruby/models/payroll_au/payroll_calendars.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/payslip.rb b/lib/xero-ruby/models/payroll_au/payslip.rb index cb2f49f7..60e8ef28 100644 --- a/lib/xero-ruby/models/payroll_au/payslip.rb +++ b/lib/xero-ruby/models/payroll_au/payslip.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/payslip_lines.rb b/lib/xero-ruby/models/payroll_au/payslip_lines.rb index e50e939f..ba9fa191 100644 --- a/lib/xero-ruby/models/payroll_au/payslip_lines.rb +++ b/lib/xero-ruby/models/payroll_au/payslip_lines.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/payslip_object.rb b/lib/xero-ruby/models/payroll_au/payslip_object.rb index 0ca8f496..b801becd 100644 --- a/lib/xero-ruby/models/payroll_au/payslip_object.rb +++ b/lib/xero-ruby/models/payroll_au/payslip_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/payslip_summary.rb b/lib/xero-ruby/models/payroll_au/payslip_summary.rb index 2930496d..f6763137 100644 --- a/lib/xero-ruby/models/payroll_au/payslip_summary.rb +++ b/lib/xero-ruby/models/payroll_au/payslip_summary.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/payslips.rb b/lib/xero-ruby/models/payroll_au/payslips.rb index 18fba1e0..d35c5147 100644 --- a/lib/xero-ruby/models/payroll_au/payslips.rb +++ b/lib/xero-ruby/models/payroll_au/payslips.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/rate_type.rb b/lib/xero-ruby/models/payroll_au/rate_type.rb index 57f0b043..cc60302b 100644 --- a/lib/xero-ruby/models/payroll_au/rate_type.rb +++ b/lib/xero-ruby/models/payroll_au/rate_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/reimbursement_line.rb b/lib/xero-ruby/models/payroll_au/reimbursement_line.rb index 83de1570..4ddfa62a 100644 --- a/lib/xero-ruby/models/payroll_au/reimbursement_line.rb +++ b/lib/xero-ruby/models/payroll_au/reimbursement_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/reimbursement_lines.rb b/lib/xero-ruby/models/payroll_au/reimbursement_lines.rb index 61afac3a..52b5ba44 100644 --- a/lib/xero-ruby/models/payroll_au/reimbursement_lines.rb +++ b/lib/xero-ruby/models/payroll_au/reimbursement_lines.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/reimbursement_type.rb b/lib/xero-ruby/models/payroll_au/reimbursement_type.rb index f92f5e8e..65fd056d 100644 --- a/lib/xero-ruby/models/payroll_au/reimbursement_type.rb +++ b/lib/xero-ruby/models/payroll_au/reimbursement_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/residency_status.rb b/lib/xero-ruby/models/payroll_au/residency_status.rb index 8b9a0693..95c10085 100644 --- a/lib/xero-ruby/models/payroll_au/residency_status.rb +++ b/lib/xero-ruby/models/payroll_au/residency_status.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/senior_marital_status.rb b/lib/xero-ruby/models/payroll_au/senior_marital_status.rb index e9d74856..00c9c837 100644 --- a/lib/xero-ruby/models/payroll_au/senior_marital_status.rb +++ b/lib/xero-ruby/models/payroll_au/senior_marital_status.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/settings.rb b/lib/xero-ruby/models/payroll_au/settings.rb index d8550559..a9f8a0e5 100644 --- a/lib/xero-ruby/models/payroll_au/settings.rb +++ b/lib/xero-ruby/models/payroll_au/settings.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/settings_object.rb b/lib/xero-ruby/models/payroll_au/settings_object.rb index 1e1db114..4b17d512 100644 --- a/lib/xero-ruby/models/payroll_au/settings_object.rb +++ b/lib/xero-ruby/models/payroll_au/settings_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/settings_tracking_categories.rb b/lib/xero-ruby/models/payroll_au/settings_tracking_categories.rb index a008b623..6e67f88e 100644 --- a/lib/xero-ruby/models/payroll_au/settings_tracking_categories.rb +++ b/lib/xero-ruby/models/payroll_au/settings_tracking_categories.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/settings_tracking_categories_employee_groups.rb b/lib/xero-ruby/models/payroll_au/settings_tracking_categories_employee_groups.rb index c123448d..2ed39bac 100644 --- a/lib/xero-ruby/models/payroll_au/settings_tracking_categories_employee_groups.rb +++ b/lib/xero-ruby/models/payroll_au/settings_tracking_categories_employee_groups.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/settings_tracking_categories_timesheet_categories.rb b/lib/xero-ruby/models/payroll_au/settings_tracking_categories_timesheet_categories.rb index dcd14871..928a5526 100644 --- a/lib/xero-ruby/models/payroll_au/settings_tracking_categories_timesheet_categories.rb +++ b/lib/xero-ruby/models/payroll_au/settings_tracking_categories_timesheet_categories.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/state.rb b/lib/xero-ruby/models/payroll_au/state.rb index a3b4c065..a2891586 100644 --- a/lib/xero-ruby/models/payroll_au/state.rb +++ b/lib/xero-ruby/models/payroll_au/state.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/super_fund.rb b/lib/xero-ruby/models/payroll_au/super_fund.rb index b65df1ec..54adb53f 100644 --- a/lib/xero-ruby/models/payroll_au/super_fund.rb +++ b/lib/xero-ruby/models/payroll_au/super_fund.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/super_fund_product.rb b/lib/xero-ruby/models/payroll_au/super_fund_product.rb index 12d9e4cf..c834e3c6 100644 --- a/lib/xero-ruby/models/payroll_au/super_fund_product.rb +++ b/lib/xero-ruby/models/payroll_au/super_fund_product.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/super_fund_products.rb b/lib/xero-ruby/models/payroll_au/super_fund_products.rb index 8c72c4ad..3850806b 100644 --- a/lib/xero-ruby/models/payroll_au/super_fund_products.rb +++ b/lib/xero-ruby/models/payroll_au/super_fund_products.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/super_fund_type.rb b/lib/xero-ruby/models/payroll_au/super_fund_type.rb index 50ad43b6..f44ac9a1 100644 --- a/lib/xero-ruby/models/payroll_au/super_fund_type.rb +++ b/lib/xero-ruby/models/payroll_au/super_fund_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/super_funds.rb b/lib/xero-ruby/models/payroll_au/super_funds.rb index 9a02ceb4..39dc3c94 100644 --- a/lib/xero-ruby/models/payroll_au/super_funds.rb +++ b/lib/xero-ruby/models/payroll_au/super_funds.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/super_line.rb b/lib/xero-ruby/models/payroll_au/super_line.rb index dd45b242..73ba5d34 100644 --- a/lib/xero-ruby/models/payroll_au/super_line.rb +++ b/lib/xero-ruby/models/payroll_au/super_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/super_membership.rb b/lib/xero-ruby/models/payroll_au/super_membership.rb index aa19178e..fb51abc8 100644 --- a/lib/xero-ruby/models/payroll_au/super_membership.rb +++ b/lib/xero-ruby/models/payroll_au/super_membership.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/superannuation_calculation_type.rb b/lib/xero-ruby/models/payroll_au/superannuation_calculation_type.rb index fca870bb..4ac5fabb 100644 --- a/lib/xero-ruby/models/payroll_au/superannuation_calculation_type.rb +++ b/lib/xero-ruby/models/payroll_au/superannuation_calculation_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/superannuation_contribution_type.rb b/lib/xero-ruby/models/payroll_au/superannuation_contribution_type.rb index e1dad732..983b9431 100644 --- a/lib/xero-ruby/models/payroll_au/superannuation_contribution_type.rb +++ b/lib/xero-ruby/models/payroll_au/superannuation_contribution_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/superannuation_line.rb b/lib/xero-ruby/models/payroll_au/superannuation_line.rb index 8aa90fb6..e48d46db 100644 --- a/lib/xero-ruby/models/payroll_au/superannuation_line.rb +++ b/lib/xero-ruby/models/payroll_au/superannuation_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/tax_declaration.rb b/lib/xero-ruby/models/payroll_au/tax_declaration.rb index c7a67426..51559c05 100644 --- a/lib/xero-ruby/models/payroll_au/tax_declaration.rb +++ b/lib/xero-ruby/models/payroll_au/tax_declaration.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/tax_line.rb b/lib/xero-ruby/models/payroll_au/tax_line.rb index 2dda2081..dec03079 100644 --- a/lib/xero-ruby/models/payroll_au/tax_line.rb +++ b/lib/xero-ruby/models/payroll_au/tax_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/tax_scale_type.rb b/lib/xero-ruby/models/payroll_au/tax_scale_type.rb index 658991bc..ad3a1833 100644 --- a/lib/xero-ruby/models/payroll_au/tax_scale_type.rb +++ b/lib/xero-ruby/models/payroll_au/tax_scale_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/tfn_exemption_type.rb b/lib/xero-ruby/models/payroll_au/tfn_exemption_type.rb index deac84e9..f670470e 100644 --- a/lib/xero-ruby/models/payroll_au/tfn_exemption_type.rb +++ b/lib/xero-ruby/models/payroll_au/tfn_exemption_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/timesheet.rb b/lib/xero-ruby/models/payroll_au/timesheet.rb index 73423605..d3989d83 100644 --- a/lib/xero-ruby/models/payroll_au/timesheet.rb +++ b/lib/xero-ruby/models/payroll_au/timesheet.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/timesheet_line.rb b/lib/xero-ruby/models/payroll_au/timesheet_line.rb index 484d02cc..75fbf676 100644 --- a/lib/xero-ruby/models/payroll_au/timesheet_line.rb +++ b/lib/xero-ruby/models/payroll_au/timesheet_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/timesheet_object.rb b/lib/xero-ruby/models/payroll_au/timesheet_object.rb index 32a9e348..43d9b9c4 100644 --- a/lib/xero-ruby/models/payroll_au/timesheet_object.rb +++ b/lib/xero-ruby/models/payroll_au/timesheet_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/timesheet_status.rb b/lib/xero-ruby/models/payroll_au/timesheet_status.rb index fc327175..b7f3ab7e 100644 --- a/lib/xero-ruby/models/payroll_au/timesheet_status.rb +++ b/lib/xero-ruby/models/payroll_au/timesheet_status.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/timesheets.rb b/lib/xero-ruby/models/payroll_au/timesheets.rb index 63f0ccc3..9f49ef16 100644 --- a/lib/xero-ruby/models/payroll_au/timesheets.rb +++ b/lib/xero-ruby/models/payroll_au/timesheets.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/validation_error.rb b/lib/xero-ruby/models/payroll_au/validation_error.rb index 19dadeed..3ae7f803 100644 --- a/lib/xero-ruby/models/payroll_au/validation_error.rb +++ b/lib/xero-ruby/models/payroll_au/validation_error.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_au/work_condition.rb b/lib/xero-ruby/models/payroll_au/work_condition.rb index 9baf1c57..b68e1a03 100644 --- a/lib/xero-ruby/models/payroll_au/work_condition.rb +++ b/lib/xero-ruby/models/payroll_au/work_condition.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/account.rb b/lib/xero-ruby/models/payroll_nz/account.rb index faf82d62..c2208566 100644 --- a/lib/xero-ruby/models/payroll_nz/account.rb +++ b/lib/xero-ruby/models/payroll_nz/account.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/accounts.rb b/lib/xero-ruby/models/payroll_nz/accounts.rb index ac94a90a..1e51ce6d 100644 --- a/lib/xero-ruby/models/payroll_nz/accounts.rb +++ b/lib/xero-ruby/models/payroll_nz/accounts.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/address.rb b/lib/xero-ruby/models/payroll_nz/address.rb index c7d4316a..c8d8c300 100644 --- a/lib/xero-ruby/models/payroll_nz/address.rb +++ b/lib/xero-ruby/models/payroll_nz/address.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/bank_account.rb b/lib/xero-ruby/models/payroll_nz/bank_account.rb index 007417c5..e3d8d82c 100644 --- a/lib/xero-ruby/models/payroll_nz/bank_account.rb +++ b/lib/xero-ruby/models/payroll_nz/bank_account.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/benefit.rb b/lib/xero-ruby/models/payroll_nz/benefit.rb index 8e8ca905..5682e550 100644 --- a/lib/xero-ruby/models/payroll_nz/benefit.rb +++ b/lib/xero-ruby/models/payroll_nz/benefit.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/calendar_type.rb b/lib/xero-ruby/models/payroll_nz/calendar_type.rb index 55a48606..0f0b2e54 100644 --- a/lib/xero-ruby/models/payroll_nz/calendar_type.rb +++ b/lib/xero-ruby/models/payroll_nz/calendar_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/deduction.rb b/lib/xero-ruby/models/payroll_nz/deduction.rb index d2d91681..73409845 100644 --- a/lib/xero-ruby/models/payroll_nz/deduction.rb +++ b/lib/xero-ruby/models/payroll_nz/deduction.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/deduction_line.rb b/lib/xero-ruby/models/payroll_nz/deduction_line.rb index 930e00c6..3124e073 100644 --- a/lib/xero-ruby/models/payroll_nz/deduction_line.rb +++ b/lib/xero-ruby/models/payroll_nz/deduction_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/deduction_object.rb b/lib/xero-ruby/models/payroll_nz/deduction_object.rb index 81a50b42..691f8f30 100644 --- a/lib/xero-ruby/models/payroll_nz/deduction_object.rb +++ b/lib/xero-ruby/models/payroll_nz/deduction_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/deductions.rb b/lib/xero-ruby/models/payroll_nz/deductions.rb index 77422f94..e92dac43 100644 --- a/lib/xero-ruby/models/payroll_nz/deductions.rb +++ b/lib/xero-ruby/models/payroll_nz/deductions.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/earnings_line.rb b/lib/xero-ruby/models/payroll_nz/earnings_line.rb index 1183eb0b..8769e67e 100644 --- a/lib/xero-ruby/models/payroll_nz/earnings_line.rb +++ b/lib/xero-ruby/models/payroll_nz/earnings_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/earnings_order.rb b/lib/xero-ruby/models/payroll_nz/earnings_order.rb index 5fd8a6e4..28afc446 100644 --- a/lib/xero-ruby/models/payroll_nz/earnings_order.rb +++ b/lib/xero-ruby/models/payroll_nz/earnings_order.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/earnings_order_object.rb b/lib/xero-ruby/models/payroll_nz/earnings_order_object.rb index 0978c04a..26c0dab3 100644 --- a/lib/xero-ruby/models/payroll_nz/earnings_order_object.rb +++ b/lib/xero-ruby/models/payroll_nz/earnings_order_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/earnings_orders.rb b/lib/xero-ruby/models/payroll_nz/earnings_orders.rb index 46b03f16..351f450d 100644 --- a/lib/xero-ruby/models/payroll_nz/earnings_orders.rb +++ b/lib/xero-ruby/models/payroll_nz/earnings_orders.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/earnings_rate.rb b/lib/xero-ruby/models/payroll_nz/earnings_rate.rb index 70c5eab9..caca7874 100644 --- a/lib/xero-ruby/models/payroll_nz/earnings_rate.rb +++ b/lib/xero-ruby/models/payroll_nz/earnings_rate.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/earnings_rate_object.rb b/lib/xero-ruby/models/payroll_nz/earnings_rate_object.rb index 4a8216a8..78b159de 100644 --- a/lib/xero-ruby/models/payroll_nz/earnings_rate_object.rb +++ b/lib/xero-ruby/models/payroll_nz/earnings_rate_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/earnings_rates.rb b/lib/xero-ruby/models/payroll_nz/earnings_rates.rb index a9750b90..bd554227 100644 --- a/lib/xero-ruby/models/payroll_nz/earnings_rates.rb +++ b/lib/xero-ruby/models/payroll_nz/earnings_rates.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/earnings_template.rb b/lib/xero-ruby/models/payroll_nz/earnings_template.rb index f41ee542..863278f7 100644 --- a/lib/xero-ruby/models/payroll_nz/earnings_template.rb +++ b/lib/xero-ruby/models/payroll_nz/earnings_template.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/earnings_template_object.rb b/lib/xero-ruby/models/payroll_nz/earnings_template_object.rb index c23d6c50..8c536db4 100644 --- a/lib/xero-ruby/models/payroll_nz/earnings_template_object.rb +++ b/lib/xero-ruby/models/payroll_nz/earnings_template_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee.rb b/lib/xero-ruby/models/payroll_nz/employee.rb index 3adc2442..520b5db4 100644 --- a/lib/xero-ruby/models/payroll_nz/employee.rb +++ b/lib/xero-ruby/models/payroll_nz/employee.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -117,8 +117,8 @@ def self.openapi_types :'start_date' => :'Date', :'end_date' => :'Date', :'payroll_calendar_id' => :'String', - :'updated_date_utc' => :'DateTime', - :'created_date_utc' => :'DateTime' + :'updated_date_utc' => :'Time', + :'created_date_utc' => :'Time' } end diff --git a/lib/xero-ruby/models/payroll_nz/employee_earnings_templates.rb b/lib/xero-ruby/models/payroll_nz/employee_earnings_templates.rb index 4cbb330d..757f492f 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_earnings_templates.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_earnings_templates.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_leave.rb b/lib/xero-ruby/models/payroll_nz/employee_leave.rb index 58c91929..67868f14 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_leave.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_leave.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -59,7 +59,7 @@ def self.openapi_types :'start_date' => :'Date', :'end_date' => :'Date', :'periods' => :'Array', - :'updated_date_utc' => :'DateTime' + :'updated_date_utc' => :'Time' } end diff --git a/lib/xero-ruby/models/payroll_nz/employee_leave_balance.rb b/lib/xero-ruby/models/payroll_nz/employee_leave_balance.rb index 5fa9a4a0..627e13a9 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_leave_balance.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_leave_balance.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_leave_balances.rb b/lib/xero-ruby/models/payroll_nz/employee_leave_balances.rb index ffc0cfad..894b2e18 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_leave_balances.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_leave_balances.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_leave_object.rb b/lib/xero-ruby/models/payroll_nz/employee_leave_object.rb index 29a93972..6a6cd926 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_leave_object.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_leave_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb b/lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb index 4f11d508..7e69d9d4 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_leave_setup_object.rb b/lib/xero-ruby/models/payroll_nz/employee_leave_setup_object.rb index b838afcf..d4a0e040 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_leave_setup_object.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_leave_setup_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_leave_type.rb b/lib/xero-ruby/models/payroll_nz/employee_leave_type.rb index ce73a60d..1a5343ea 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_leave_type.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_leave_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_leave_type_object.rb b/lib/xero-ruby/models/payroll_nz/employee_leave_type_object.rb index 078ef81c..ed309a0e 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_leave_type_object.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_leave_type_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_leave_types.rb b/lib/xero-ruby/models/payroll_nz/employee_leave_types.rb index 7419346f..dabe5c18 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_leave_types.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_leave_types.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_leaves.rb b/lib/xero-ruby/models/payroll_nz/employee_leaves.rb index 5f868a8e..7a07e58d 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_leaves.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_leaves.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_object.rb b/lib/xero-ruby/models/payroll_nz/employee_object.rb index 3fa43cda..8b0d189f 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_object.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_opening_balance.rb b/lib/xero-ruby/models/payroll_nz/employee_opening_balance.rb index a27ea6b6..8d1ca9a7 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_opening_balance.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_opening_balance.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_opening_balances_object.rb b/lib/xero-ruby/models/payroll_nz/employee_opening_balances_object.rb index a1b03caf..3171f0c1 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_opening_balances_object.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_opening_balances_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_pay_template.rb b/lib/xero-ruby/models/payroll_nz/employee_pay_template.rb index 892ab942..10249494 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_pay_template.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_pay_template.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_pay_template_object.rb b/lib/xero-ruby/models/payroll_nz/employee_pay_template_object.rb index 6d8fe3a8..e6766242 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_pay_template_object.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_pay_template_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_pay_templates.rb b/lib/xero-ruby/models/payroll_nz/employee_pay_templates.rb index 0dd0c21d..09eacb6d 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_pay_templates.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_pay_templates.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance.rb b/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance.rb index 7427f8cd..a347b777 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance_object.rb b/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance_object.rb index 848f372d..d1e50a27 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance_object.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_summary.rb b/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_summary.rb index d44c7428..d9e0b6ce 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_summary.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_summary.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_statutory_leaves_summaries.rb b/lib/xero-ruby/models/payroll_nz/employee_statutory_leaves_summaries.rb index 80fc7a9e..2247d7b5 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_statutory_leaves_summaries.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_statutory_leaves_summaries.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave.rb b/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave.rb index f1992f18..a4ffeba3 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave_object.rb b/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave_object.rb index 73db087d..4d61b123 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave_object.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leaves.rb b/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leaves.rb index 5409ea13..6b4c4e4f 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leaves.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leaves.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_tax.rb b/lib/xero-ruby/models/payroll_nz/employee_tax.rb index 595f192f..d89b65ad 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_tax.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_tax.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employee_tax_object.rb b/lib/xero-ruby/models/payroll_nz/employee_tax_object.rb index ce400da3..f7e64aba 100644 --- a/lib/xero-ruby/models/payroll_nz/employee_tax_object.rb +++ b/lib/xero-ruby/models/payroll_nz/employee_tax_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employees.rb b/lib/xero-ruby/models/payroll_nz/employees.rb index bad85da6..5b78699f 100644 --- a/lib/xero-ruby/models/payroll_nz/employees.rb +++ b/lib/xero-ruby/models/payroll_nz/employees.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employment.rb b/lib/xero-ruby/models/payroll_nz/employment.rb index f0cf7fce..dbae190f 100644 --- a/lib/xero-ruby/models/payroll_nz/employment.rb +++ b/lib/xero-ruby/models/payroll_nz/employment.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/employment_object.rb b/lib/xero-ruby/models/payroll_nz/employment_object.rb index 86a2eb87..9fe0c61a 100644 --- a/lib/xero-ruby/models/payroll_nz/employment_object.rb +++ b/lib/xero-ruby/models/payroll_nz/employment_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/gross_earnings_history.rb b/lib/xero-ruby/models/payroll_nz/gross_earnings_history.rb index 2ccf75ab..b64b121d 100644 --- a/lib/xero-ruby/models/payroll_nz/gross_earnings_history.rb +++ b/lib/xero-ruby/models/payroll_nz/gross_earnings_history.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/invalid_field.rb b/lib/xero-ruby/models/payroll_nz/invalid_field.rb index c8383e68..b81bedc0 100644 --- a/lib/xero-ruby/models/payroll_nz/invalid_field.rb +++ b/lib/xero-ruby/models/payroll_nz/invalid_field.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/leave_accrual_line.rb b/lib/xero-ruby/models/payroll_nz/leave_accrual_line.rb index c6298b58..96c0a3f6 100644 --- a/lib/xero-ruby/models/payroll_nz/leave_accrual_line.rb +++ b/lib/xero-ruby/models/payroll_nz/leave_accrual_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/leave_earnings_line.rb b/lib/xero-ruby/models/payroll_nz/leave_earnings_line.rb index 4a4a79c9..f6336b22 100644 --- a/lib/xero-ruby/models/payroll_nz/leave_earnings_line.rb +++ b/lib/xero-ruby/models/payroll_nz/leave_earnings_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/leave_period.rb b/lib/xero-ruby/models/payroll_nz/leave_period.rb index 0fad5ba1..bb75aa1a 100644 --- a/lib/xero-ruby/models/payroll_nz/leave_period.rb +++ b/lib/xero-ruby/models/payroll_nz/leave_period.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/leave_periods.rb b/lib/xero-ruby/models/payroll_nz/leave_periods.rb index 4b64cb4b..6f48059d 100644 --- a/lib/xero-ruby/models/payroll_nz/leave_periods.rb +++ b/lib/xero-ruby/models/payroll_nz/leave_periods.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/leave_type.rb b/lib/xero-ruby/models/payroll_nz/leave_type.rb index 58be8e22..640f3bd7 100644 --- a/lib/xero-ruby/models/payroll_nz/leave_type.rb +++ b/lib/xero-ruby/models/payroll_nz/leave_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -53,7 +53,7 @@ def self.openapi_types :'name' => :'String', :'is_paid_leave' => :'Boolean', :'show_on_payslip' => :'Boolean', - :'updated_date_utc' => :'DateTime', + :'updated_date_utc' => :'Time', :'is_active' => :'Boolean' } end diff --git a/lib/xero-ruby/models/payroll_nz/leave_type_object.rb b/lib/xero-ruby/models/payroll_nz/leave_type_object.rb index 25aee9d3..b3b34fd2 100644 --- a/lib/xero-ruby/models/payroll_nz/leave_type_object.rb +++ b/lib/xero-ruby/models/payroll_nz/leave_type_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/leave_types.rb b/lib/xero-ruby/models/payroll_nz/leave_types.rb index 7987bb6a..18354dfa 100644 --- a/lib/xero-ruby/models/payroll_nz/leave_types.rb +++ b/lib/xero-ruby/models/payroll_nz/leave_types.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/pagination.rb b/lib/xero-ruby/models/payroll_nz/pagination.rb index 1564c8c5..54771617 100644 --- a/lib/xero-ruby/models/payroll_nz/pagination.rb +++ b/lib/xero-ruby/models/payroll_nz/pagination.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/pay_run.rb b/lib/xero-ruby/models/payroll_nz/pay_run.rb index c9ce6c2b..148bebd7 100644 --- a/lib/xero-ruby/models/payroll_nz/pay_run.rb +++ b/lib/xero-ruby/models/payroll_nz/pay_run.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/pay_run_calendar.rb b/lib/xero-ruby/models/payroll_nz/pay_run_calendar.rb index 6ff5d31f..755a6d20 100644 --- a/lib/xero-ruby/models/payroll_nz/pay_run_calendar.rb +++ b/lib/xero-ruby/models/payroll_nz/pay_run_calendar.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -59,7 +59,7 @@ def self.openapi_types :'period_start_date' => :'Date', :'period_end_date' => :'Date', :'payment_date' => :'Date', - :'updated_date_utc' => :'DateTime' + :'updated_date_utc' => :'Time' } end diff --git a/lib/xero-ruby/models/payroll_nz/pay_run_calendar_object.rb b/lib/xero-ruby/models/payroll_nz/pay_run_calendar_object.rb index d46ba16f..5c48fd3c 100644 --- a/lib/xero-ruby/models/payroll_nz/pay_run_calendar_object.rb +++ b/lib/xero-ruby/models/payroll_nz/pay_run_calendar_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/pay_run_calendars.rb b/lib/xero-ruby/models/payroll_nz/pay_run_calendars.rb index 3473f337..0426c797 100644 --- a/lib/xero-ruby/models/payroll_nz/pay_run_calendars.rb +++ b/lib/xero-ruby/models/payroll_nz/pay_run_calendars.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/pay_run_object.rb b/lib/xero-ruby/models/payroll_nz/pay_run_object.rb index 45e45369..1cf06ae5 100644 --- a/lib/xero-ruby/models/payroll_nz/pay_run_object.rb +++ b/lib/xero-ruby/models/payroll_nz/pay_run_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/pay_runs.rb b/lib/xero-ruby/models/payroll_nz/pay_runs.rb index 65da1d03..cf4a3fbc 100644 --- a/lib/xero-ruby/models/payroll_nz/pay_runs.rb +++ b/lib/xero-ruby/models/payroll_nz/pay_runs.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/pay_slip.rb b/lib/xero-ruby/models/payroll_nz/pay_slip.rb index 6deeeb6c..4918f866 100644 --- a/lib/xero-ruby/models/payroll_nz/pay_slip.rb +++ b/lib/xero-ruby/models/payroll_nz/pay_slip.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/pay_slip_object.rb b/lib/xero-ruby/models/payroll_nz/pay_slip_object.rb index e11dc770..d2f3480b 100644 --- a/lib/xero-ruby/models/payroll_nz/pay_slip_object.rb +++ b/lib/xero-ruby/models/payroll_nz/pay_slip_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/pay_slips.rb b/lib/xero-ruby/models/payroll_nz/pay_slips.rb index 88345f42..b6df40f6 100644 --- a/lib/xero-ruby/models/payroll_nz/pay_slips.rb +++ b/lib/xero-ruby/models/payroll_nz/pay_slips.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/payment_line.rb b/lib/xero-ruby/models/payroll_nz/payment_line.rb index 3626dbb3..08a8d4a6 100644 --- a/lib/xero-ruby/models/payroll_nz/payment_line.rb +++ b/lib/xero-ruby/models/payroll_nz/payment_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/payment_method.rb b/lib/xero-ruby/models/payroll_nz/payment_method.rb index a58edc5f..4cfefacf 100644 --- a/lib/xero-ruby/models/payroll_nz/payment_method.rb +++ b/lib/xero-ruby/models/payroll_nz/payment_method.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/payment_method_object.rb b/lib/xero-ruby/models/payroll_nz/payment_method_object.rb index 8ea7ceef..adf333c1 100644 --- a/lib/xero-ruby/models/payroll_nz/payment_method_object.rb +++ b/lib/xero-ruby/models/payroll_nz/payment_method_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/problem.rb b/lib/xero-ruby/models/payroll_nz/problem.rb index 0037a187..2196bc46 100644 --- a/lib/xero-ruby/models/payroll_nz/problem.rb +++ b/lib/xero-ruby/models/payroll_nz/problem.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/reimbursement.rb b/lib/xero-ruby/models/payroll_nz/reimbursement.rb index 60354b2b..30270fba 100644 --- a/lib/xero-ruby/models/payroll_nz/reimbursement.rb +++ b/lib/xero-ruby/models/payroll_nz/reimbursement.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/reimbursement_line.rb b/lib/xero-ruby/models/payroll_nz/reimbursement_line.rb index 01719289..4b2d93a8 100644 --- a/lib/xero-ruby/models/payroll_nz/reimbursement_line.rb +++ b/lib/xero-ruby/models/payroll_nz/reimbursement_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/reimbursement_object.rb b/lib/xero-ruby/models/payroll_nz/reimbursement_object.rb index 49bdf006..a6a491e5 100644 --- a/lib/xero-ruby/models/payroll_nz/reimbursement_object.rb +++ b/lib/xero-ruby/models/payroll_nz/reimbursement_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/reimbursements.rb b/lib/xero-ruby/models/payroll_nz/reimbursements.rb index a4514b56..08e5668b 100644 --- a/lib/xero-ruby/models/payroll_nz/reimbursements.rb +++ b/lib/xero-ruby/models/payroll_nz/reimbursements.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/salary_and_wage.rb b/lib/xero-ruby/models/payroll_nz/salary_and_wage.rb index f38f52ee..ca4a0bb1 100644 --- a/lib/xero-ruby/models/payroll_nz/salary_and_wage.rb +++ b/lib/xero-ruby/models/payroll_nz/salary_and_wage.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/salary_and_wage_object.rb b/lib/xero-ruby/models/payroll_nz/salary_and_wage_object.rb index 15d7b0b3..51080811 100644 --- a/lib/xero-ruby/models/payroll_nz/salary_and_wage_object.rb +++ b/lib/xero-ruby/models/payroll_nz/salary_and_wage_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/salary_and_wages.rb b/lib/xero-ruby/models/payroll_nz/salary_and_wages.rb index 75bebe51..081341d1 100644 --- a/lib/xero-ruby/models/payroll_nz/salary_and_wages.rb +++ b/lib/xero-ruby/models/payroll_nz/salary_and_wages.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/settings.rb b/lib/xero-ruby/models/payroll_nz/settings.rb index 08a50f0f..982978ed 100644 --- a/lib/xero-ruby/models/payroll_nz/settings.rb +++ b/lib/xero-ruby/models/payroll_nz/settings.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/statutory_deduction.rb b/lib/xero-ruby/models/payroll_nz/statutory_deduction.rb index 50dbb155..2ce67934 100644 --- a/lib/xero-ruby/models/payroll_nz/statutory_deduction.rb +++ b/lib/xero-ruby/models/payroll_nz/statutory_deduction.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/statutory_deduction_category.rb b/lib/xero-ruby/models/payroll_nz/statutory_deduction_category.rb index a0404f4d..57ded741 100644 --- a/lib/xero-ruby/models/payroll_nz/statutory_deduction_category.rb +++ b/lib/xero-ruby/models/payroll_nz/statutory_deduction_category.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/statutory_deduction_line.rb b/lib/xero-ruby/models/payroll_nz/statutory_deduction_line.rb index 7684c440..683196f8 100644 --- a/lib/xero-ruby/models/payroll_nz/statutory_deduction_line.rb +++ b/lib/xero-ruby/models/payroll_nz/statutory_deduction_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/statutory_deduction_object.rb b/lib/xero-ruby/models/payroll_nz/statutory_deduction_object.rb index cc4b8f53..e80f548a 100644 --- a/lib/xero-ruby/models/payroll_nz/statutory_deduction_object.rb +++ b/lib/xero-ruby/models/payroll_nz/statutory_deduction_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/statutory_deductions.rb b/lib/xero-ruby/models/payroll_nz/statutory_deductions.rb index 4443ed0a..996b8cb5 100644 --- a/lib/xero-ruby/models/payroll_nz/statutory_deductions.rb +++ b/lib/xero-ruby/models/payroll_nz/statutory_deductions.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/superannuation_line.rb b/lib/xero-ruby/models/payroll_nz/superannuation_line.rb index 675168b8..b57eca11 100644 --- a/lib/xero-ruby/models/payroll_nz/superannuation_line.rb +++ b/lib/xero-ruby/models/payroll_nz/superannuation_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/superannuation_object.rb b/lib/xero-ruby/models/payroll_nz/superannuation_object.rb index 7984740f..5624998d 100644 --- a/lib/xero-ruby/models/payroll_nz/superannuation_object.rb +++ b/lib/xero-ruby/models/payroll_nz/superannuation_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/superannuations.rb b/lib/xero-ruby/models/payroll_nz/superannuations.rb index d2348b44..ce5013f9 100644 --- a/lib/xero-ruby/models/payroll_nz/superannuations.rb +++ b/lib/xero-ruby/models/payroll_nz/superannuations.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/tax_code.rb b/lib/xero-ruby/models/payroll_nz/tax_code.rb index 10016f0a..9bb7f0f9 100644 --- a/lib/xero-ruby/models/payroll_nz/tax_code.rb +++ b/lib/xero-ruby/models/payroll_nz/tax_code.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/tax_line.rb b/lib/xero-ruby/models/payroll_nz/tax_line.rb index 2c4f6661..d1d61831 100644 --- a/lib/xero-ruby/models/payroll_nz/tax_line.rb +++ b/lib/xero-ruby/models/payroll_nz/tax_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/tax_settings.rb b/lib/xero-ruby/models/payroll_nz/tax_settings.rb index 2f0c59a1..081a535d 100644 --- a/lib/xero-ruby/models/payroll_nz/tax_settings.rb +++ b/lib/xero-ruby/models/payroll_nz/tax_settings.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/timesheet.rb b/lib/xero-ruby/models/payroll_nz/timesheet.rb index 8031882f..b81546ca 100644 --- a/lib/xero-ruby/models/payroll_nz/timesheet.rb +++ b/lib/xero-ruby/models/payroll_nz/timesheet.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -94,7 +94,7 @@ def self.openapi_types :'end_date' => :'Date', :'status' => :'String', :'total_hours' => :'BigDecimal', - :'updated_date_utc' => :'DateTime', + :'updated_date_utc' => :'Time', :'timesheet_lines' => :'Array' } end diff --git a/lib/xero-ruby/models/payroll_nz/timesheet_earnings_line.rb b/lib/xero-ruby/models/payroll_nz/timesheet_earnings_line.rb index a0b97f55..0399f1d0 100644 --- a/lib/xero-ruby/models/payroll_nz/timesheet_earnings_line.rb +++ b/lib/xero-ruby/models/payroll_nz/timesheet_earnings_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/timesheet_line.rb b/lib/xero-ruby/models/payroll_nz/timesheet_line.rb index f9a2bafa..b856bd24 100644 --- a/lib/xero-ruby/models/payroll_nz/timesheet_line.rb +++ b/lib/xero-ruby/models/payroll_nz/timesheet_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/timesheet_line_object.rb b/lib/xero-ruby/models/payroll_nz/timesheet_line_object.rb index d179b771..9e68757c 100644 --- a/lib/xero-ruby/models/payroll_nz/timesheet_line_object.rb +++ b/lib/xero-ruby/models/payroll_nz/timesheet_line_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/timesheet_object.rb b/lib/xero-ruby/models/payroll_nz/timesheet_object.rb index 5ffce467..92d6a6c4 100644 --- a/lib/xero-ruby/models/payroll_nz/timesheet_object.rb +++ b/lib/xero-ruby/models/payroll_nz/timesheet_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/timesheets.rb b/lib/xero-ruby/models/payroll_nz/timesheets.rb index bf9f39fb..b68c789d 100644 --- a/lib/xero-ruby/models/payroll_nz/timesheets.rb +++ b/lib/xero-ruby/models/payroll_nz/timesheets.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/tracking_categories.rb b/lib/xero-ruby/models/payroll_nz/tracking_categories.rb index 35cc68f1..d666bd72 100644 --- a/lib/xero-ruby/models/payroll_nz/tracking_categories.rb +++ b/lib/xero-ruby/models/payroll_nz/tracking_categories.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_nz/tracking_category.rb b/lib/xero-ruby/models/payroll_nz/tracking_category.rb index 21650b00..5d23f1b3 100644 --- a/lib/xero-ruby/models/payroll_nz/tracking_category.rb +++ b/lib/xero-ruby/models/payroll_nz/tracking_category.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/account.rb b/lib/xero-ruby/models/payroll_uk/account.rb index 14dafb68..8b3be354 100644 --- a/lib/xero-ruby/models/payroll_uk/account.rb +++ b/lib/xero-ruby/models/payroll_uk/account.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/accounts.rb b/lib/xero-ruby/models/payroll_uk/accounts.rb index bb4b5aba..f05204c3 100644 --- a/lib/xero-ruby/models/payroll_uk/accounts.rb +++ b/lib/xero-ruby/models/payroll_uk/accounts.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/address.rb b/lib/xero-ruby/models/payroll_uk/address.rb index de8fe854..2eda48ec 100644 --- a/lib/xero-ruby/models/payroll_uk/address.rb +++ b/lib/xero-ruby/models/payroll_uk/address.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/bank_account.rb b/lib/xero-ruby/models/payroll_uk/bank_account.rb index 7531fd3a..4cbcd83f 100644 --- a/lib/xero-ruby/models/payroll_uk/bank_account.rb +++ b/lib/xero-ruby/models/payroll_uk/bank_account.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/benefit.rb b/lib/xero-ruby/models/payroll_uk/benefit.rb index 0fa290a0..f86de5a3 100644 --- a/lib/xero-ruby/models/payroll_uk/benefit.rb +++ b/lib/xero-ruby/models/payroll_uk/benefit.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/benefit_line.rb b/lib/xero-ruby/models/payroll_uk/benefit_line.rb index b2c56613..263412ce 100644 --- a/lib/xero-ruby/models/payroll_uk/benefit_line.rb +++ b/lib/xero-ruby/models/payroll_uk/benefit_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/benefit_object.rb b/lib/xero-ruby/models/payroll_uk/benefit_object.rb index fac01cf8..8eca09e6 100644 --- a/lib/xero-ruby/models/payroll_uk/benefit_object.rb +++ b/lib/xero-ruby/models/payroll_uk/benefit_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/benefits.rb b/lib/xero-ruby/models/payroll_uk/benefits.rb index f0bf249c..1ca5837d 100644 --- a/lib/xero-ruby/models/payroll_uk/benefits.rb +++ b/lib/xero-ruby/models/payroll_uk/benefits.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/court_order_line.rb b/lib/xero-ruby/models/payroll_uk/court_order_line.rb index 847dc469..58a19f01 100644 --- a/lib/xero-ruby/models/payroll_uk/court_order_line.rb +++ b/lib/xero-ruby/models/payroll_uk/court_order_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/deduction.rb b/lib/xero-ruby/models/payroll_uk/deduction.rb index 3314c808..51dafc9e 100644 --- a/lib/xero-ruby/models/payroll_uk/deduction.rb +++ b/lib/xero-ruby/models/payroll_uk/deduction.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/deduction_line.rb b/lib/xero-ruby/models/payroll_uk/deduction_line.rb index 5655df0b..9b1c1b9a 100644 --- a/lib/xero-ruby/models/payroll_uk/deduction_line.rb +++ b/lib/xero-ruby/models/payroll_uk/deduction_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/deduction_object.rb b/lib/xero-ruby/models/payroll_uk/deduction_object.rb index c7affc6e..5ec7c92c 100644 --- a/lib/xero-ruby/models/payroll_uk/deduction_object.rb +++ b/lib/xero-ruby/models/payroll_uk/deduction_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/deductions.rb b/lib/xero-ruby/models/payroll_uk/deductions.rb index c70561ab..8b24d1a6 100644 --- a/lib/xero-ruby/models/payroll_uk/deductions.rb +++ b/lib/xero-ruby/models/payroll_uk/deductions.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/earnings_line.rb b/lib/xero-ruby/models/payroll_uk/earnings_line.rb index cdf52f3f..bef97476 100644 --- a/lib/xero-ruby/models/payroll_uk/earnings_line.rb +++ b/lib/xero-ruby/models/payroll_uk/earnings_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/earnings_order.rb b/lib/xero-ruby/models/payroll_uk/earnings_order.rb index d29cb38a..fb24ee55 100644 --- a/lib/xero-ruby/models/payroll_uk/earnings_order.rb +++ b/lib/xero-ruby/models/payroll_uk/earnings_order.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/earnings_order_object.rb b/lib/xero-ruby/models/payroll_uk/earnings_order_object.rb index bc1e8d65..edbd2443 100644 --- a/lib/xero-ruby/models/payroll_uk/earnings_order_object.rb +++ b/lib/xero-ruby/models/payroll_uk/earnings_order_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/earnings_orders.rb b/lib/xero-ruby/models/payroll_uk/earnings_orders.rb index ce53c2be..5e63ed01 100644 --- a/lib/xero-ruby/models/payroll_uk/earnings_orders.rb +++ b/lib/xero-ruby/models/payroll_uk/earnings_orders.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/earnings_rate.rb b/lib/xero-ruby/models/payroll_uk/earnings_rate.rb index 3e4e06fe..aa1b107c 100644 --- a/lib/xero-ruby/models/payroll_uk/earnings_rate.rb +++ b/lib/xero-ruby/models/payroll_uk/earnings_rate.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/earnings_rate_object.rb b/lib/xero-ruby/models/payroll_uk/earnings_rate_object.rb index f2785df7..5d7abcdb 100644 --- a/lib/xero-ruby/models/payroll_uk/earnings_rate_object.rb +++ b/lib/xero-ruby/models/payroll_uk/earnings_rate_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/earnings_rates.rb b/lib/xero-ruby/models/payroll_uk/earnings_rates.rb index 77ced186..ddfd4998 100644 --- a/lib/xero-ruby/models/payroll_uk/earnings_rates.rb +++ b/lib/xero-ruby/models/payroll_uk/earnings_rates.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/earnings_template.rb b/lib/xero-ruby/models/payroll_uk/earnings_template.rb index 9dded667..d12594f8 100644 --- a/lib/xero-ruby/models/payroll_uk/earnings_template.rb +++ b/lib/xero-ruby/models/payroll_uk/earnings_template.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/earnings_template_object.rb b/lib/xero-ruby/models/payroll_uk/earnings_template_object.rb index 08054588..6721c906 100644 --- a/lib/xero-ruby/models/payroll_uk/earnings_template_object.rb +++ b/lib/xero-ruby/models/payroll_uk/earnings_template_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee.rb b/lib/xero-ruby/models/payroll_uk/employee.rb index 614e9358..a5baf005 100644 --- a/lib/xero-ruby/models/payroll_uk/employee.rb +++ b/lib/xero-ruby/models/payroll_uk/employee.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -125,8 +125,8 @@ def self.openapi_types :'start_date' => :'Date', :'end_date' => :'Date', :'payroll_calendar_id' => :'String', - :'updated_date_utc' => :'DateTime', - :'created_date_utc' => :'DateTime', + :'updated_date_utc' => :'Time', + :'created_date_utc' => :'Time', :'national_insurance_number' => :'String', :'is_off_payroll_worker' => :'Boolean' } diff --git a/lib/xero-ruby/models/payroll_uk/employee_leave.rb b/lib/xero-ruby/models/payroll_uk/employee_leave.rb index f790594a..e73a043b 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_leave.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_leave.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -59,7 +59,7 @@ def self.openapi_types :'start_date' => :'Date', :'end_date' => :'Date', :'periods' => :'Array', - :'updated_date_utc' => :'DateTime' + :'updated_date_utc' => :'Time' } end diff --git a/lib/xero-ruby/models/payroll_uk/employee_leave_balance.rb b/lib/xero-ruby/models/payroll_uk/employee_leave_balance.rb index 580dd862..84ff3236 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_leave_balance.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_leave_balance.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_leave_balances.rb b/lib/xero-ruby/models/payroll_uk/employee_leave_balances.rb index b1d4064b..440699a3 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_leave_balances.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_leave_balances.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_leave_object.rb b/lib/xero-ruby/models/payroll_uk/employee_leave_object.rb index 77ae5f86..67069196 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_leave_object.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_leave_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_leave_type.rb b/lib/xero-ruby/models/payroll_uk/employee_leave_type.rb index d3c60d04..4b9e284d 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_leave_type.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_leave_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_leave_type_object.rb b/lib/xero-ruby/models/payroll_uk/employee_leave_type_object.rb index 19fba8d2..830e3364 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_leave_type_object.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_leave_type_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_leave_types.rb b/lib/xero-ruby/models/payroll_uk/employee_leave_types.rb index 2c610961..1d94ee29 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_leave_types.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_leave_types.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_leaves.rb b/lib/xero-ruby/models/payroll_uk/employee_leaves.rb index 8a812953..dde9df22 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_leaves.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_leaves.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_object.rb b/lib/xero-ruby/models/payroll_uk/employee_object.rb index 9a91aba3..ad7ae5cd 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_object.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_opening_balances.rb b/lib/xero-ruby/models/payroll_uk/employee_opening_balances.rb index a52f619a..c41eab06 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_opening_balances.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_opening_balances.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_opening_balances_object.rb b/lib/xero-ruby/models/payroll_uk/employee_opening_balances_object.rb index 292369c2..7f50cf57 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_opening_balances_object.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_opening_balances_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_pay_template.rb b/lib/xero-ruby/models/payroll_uk/employee_pay_template.rb index 9bc744fe..aebc0020 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_pay_template.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_pay_template.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_pay_template_object.rb b/lib/xero-ruby/models/payroll_uk/employee_pay_template_object.rb index 9d2154aa..7f94e243 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_pay_template_object.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_pay_template_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_pay_templates.rb b/lib/xero-ruby/models/payroll_uk/employee_pay_templates.rb index 1afa136d..bea997cc 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_pay_templates.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_pay_templates.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance.rb b/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance.rb index 7264d768..eeb39986 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance_object.rb b/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance_object.rb index d6c6420b..3357b1bb 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance_object.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_summary.rb b/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_summary.rb index 443aa720..5a8afe39 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_summary.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_summary.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_statutory_leaves_summaries.rb b/lib/xero-ruby/models/payroll_uk/employee_statutory_leaves_summaries.rb index 7dfbfb5c..9993a26c 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_statutory_leaves_summaries.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_statutory_leaves_summaries.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb b/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb index 7328eca3..4de9ae45 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave_object.rb b/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave_object.rb index 059af483..d59f3980 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave_object.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leaves.rb b/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leaves.rb index 6e92d714..2849bd8b 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leaves.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leaves.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_tax.rb b/lib/xero-ruby/models/payroll_uk/employee_tax.rb index 77c125d3..3a68a7aa 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_tax.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_tax.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employee_tax_object.rb b/lib/xero-ruby/models/payroll_uk/employee_tax_object.rb index afdb6f7f..1b74f021 100644 --- a/lib/xero-ruby/models/payroll_uk/employee_tax_object.rb +++ b/lib/xero-ruby/models/payroll_uk/employee_tax_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employees.rb b/lib/xero-ruby/models/payroll_uk/employees.rb index 0e8716e9..4b889a50 100644 --- a/lib/xero-ruby/models/payroll_uk/employees.rb +++ b/lib/xero-ruby/models/payroll_uk/employees.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employment.rb b/lib/xero-ruby/models/payroll_uk/employment.rb index 70ef8c06..3477c831 100644 --- a/lib/xero-ruby/models/payroll_uk/employment.rb +++ b/lib/xero-ruby/models/payroll_uk/employment.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/employment_object.rb b/lib/xero-ruby/models/payroll_uk/employment_object.rb index 8e88edcb..61bafe16 100644 --- a/lib/xero-ruby/models/payroll_uk/employment_object.rb +++ b/lib/xero-ruby/models/payroll_uk/employment_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/invalid_field.rb b/lib/xero-ruby/models/payroll_uk/invalid_field.rb index 4496a272..1bb9799f 100644 --- a/lib/xero-ruby/models/payroll_uk/invalid_field.rb +++ b/lib/xero-ruby/models/payroll_uk/invalid_field.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/leave_accrual_line.rb b/lib/xero-ruby/models/payroll_uk/leave_accrual_line.rb index ea4ba481..37cfb602 100644 --- a/lib/xero-ruby/models/payroll_uk/leave_accrual_line.rb +++ b/lib/xero-ruby/models/payroll_uk/leave_accrual_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/leave_earnings_line.rb b/lib/xero-ruby/models/payroll_uk/leave_earnings_line.rb index 92a95e20..d3ac8745 100644 --- a/lib/xero-ruby/models/payroll_uk/leave_earnings_line.rb +++ b/lib/xero-ruby/models/payroll_uk/leave_earnings_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/leave_period.rb b/lib/xero-ruby/models/payroll_uk/leave_period.rb index bd909ea7..1fc72ae9 100644 --- a/lib/xero-ruby/models/payroll_uk/leave_period.rb +++ b/lib/xero-ruby/models/payroll_uk/leave_period.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/leave_periods.rb b/lib/xero-ruby/models/payroll_uk/leave_periods.rb index 56b4d796..4733dd76 100644 --- a/lib/xero-ruby/models/payroll_uk/leave_periods.rb +++ b/lib/xero-ruby/models/payroll_uk/leave_periods.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/leave_type.rb b/lib/xero-ruby/models/payroll_uk/leave_type.rb index 81fa8aa5..340620a2 100644 --- a/lib/xero-ruby/models/payroll_uk/leave_type.rb +++ b/lib/xero-ruby/models/payroll_uk/leave_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -62,7 +62,7 @@ def self.openapi_types :'name' => :'String', :'is_paid_leave' => :'Boolean', :'show_on_payslip' => :'Boolean', - :'updated_date_utc' => :'DateTime', + :'updated_date_utc' => :'Time', :'is_active' => :'Boolean', :'is_statutory_leave' => :'Boolean' } diff --git a/lib/xero-ruby/models/payroll_uk/leave_type_object.rb b/lib/xero-ruby/models/payroll_uk/leave_type_object.rb index 7d2f1cd1..eb8877be 100644 --- a/lib/xero-ruby/models/payroll_uk/leave_type_object.rb +++ b/lib/xero-ruby/models/payroll_uk/leave_type_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/leave_types.rb b/lib/xero-ruby/models/payroll_uk/leave_types.rb index 03fc54d3..5fee5aa2 100644 --- a/lib/xero-ruby/models/payroll_uk/leave_types.rb +++ b/lib/xero-ruby/models/payroll_uk/leave_types.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/pagination.rb b/lib/xero-ruby/models/payroll_uk/pagination.rb index 55e35bd8..c63eb7d1 100644 --- a/lib/xero-ruby/models/payroll_uk/pagination.rb +++ b/lib/xero-ruby/models/payroll_uk/pagination.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/pay_run.rb b/lib/xero-ruby/models/payroll_uk/pay_run.rb index 6b31b32b..289f1127 100644 --- a/lib/xero-ruby/models/payroll_uk/pay_run.rb +++ b/lib/xero-ruby/models/payroll_uk/pay_run.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb b/lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb index 42b2729b..7fae84c6 100644 --- a/lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb +++ b/lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -87,7 +87,7 @@ def self.openapi_types :'period_start_date' => :'Date', :'period_end_date' => :'Date', :'payment_date' => :'Date', - :'updated_date_utc' => :'DateTime' + :'updated_date_utc' => :'Time' } end diff --git a/lib/xero-ruby/models/payroll_uk/pay_run_calendar_object.rb b/lib/xero-ruby/models/payroll_uk/pay_run_calendar_object.rb index 1cfd695a..704025e9 100644 --- a/lib/xero-ruby/models/payroll_uk/pay_run_calendar_object.rb +++ b/lib/xero-ruby/models/payroll_uk/pay_run_calendar_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/pay_run_calendars.rb b/lib/xero-ruby/models/payroll_uk/pay_run_calendars.rb index 6c3d956e..8f1917cd 100644 --- a/lib/xero-ruby/models/payroll_uk/pay_run_calendars.rb +++ b/lib/xero-ruby/models/payroll_uk/pay_run_calendars.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/pay_run_object.rb b/lib/xero-ruby/models/payroll_uk/pay_run_object.rb index 58ecd292..f07d07bd 100644 --- a/lib/xero-ruby/models/payroll_uk/pay_run_object.rb +++ b/lib/xero-ruby/models/payroll_uk/pay_run_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/pay_runs.rb b/lib/xero-ruby/models/payroll_uk/pay_runs.rb index b1f0efd2..c3301002 100644 --- a/lib/xero-ruby/models/payroll_uk/pay_runs.rb +++ b/lib/xero-ruby/models/payroll_uk/pay_runs.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/payment_line.rb b/lib/xero-ruby/models/payroll_uk/payment_line.rb index df0c424f..9ae5688d 100644 --- a/lib/xero-ruby/models/payroll_uk/payment_line.rb +++ b/lib/xero-ruby/models/payroll_uk/payment_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/payment_method.rb b/lib/xero-ruby/models/payroll_uk/payment_method.rb index 645e4378..13cb3522 100644 --- a/lib/xero-ruby/models/payroll_uk/payment_method.rb +++ b/lib/xero-ruby/models/payroll_uk/payment_method.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/payment_method_object.rb b/lib/xero-ruby/models/payroll_uk/payment_method_object.rb index 6e763623..5987aa26 100644 --- a/lib/xero-ruby/models/payroll_uk/payment_method_object.rb +++ b/lib/xero-ruby/models/payroll_uk/payment_method_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/payslip.rb b/lib/xero-ruby/models/payroll_uk/payslip.rb index 20701283..2de79494 100644 --- a/lib/xero-ruby/models/payroll_uk/payslip.rb +++ b/lib/xero-ruby/models/payroll_uk/payslip.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/payslip_object.rb b/lib/xero-ruby/models/payroll_uk/payslip_object.rb index c7cb9a87..c66c1392 100644 --- a/lib/xero-ruby/models/payroll_uk/payslip_object.rb +++ b/lib/xero-ruby/models/payroll_uk/payslip_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/payslips.rb b/lib/xero-ruby/models/payroll_uk/payslips.rb index a2e65313..279e4ad5 100644 --- a/lib/xero-ruby/models/payroll_uk/payslips.rb +++ b/lib/xero-ruby/models/payroll_uk/payslips.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/problem.rb b/lib/xero-ruby/models/payroll_uk/problem.rb index 843833d3..8bf53a22 100644 --- a/lib/xero-ruby/models/payroll_uk/problem.rb +++ b/lib/xero-ruby/models/payroll_uk/problem.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/reimbursement.rb b/lib/xero-ruby/models/payroll_uk/reimbursement.rb index f86cc522..dd99d9ab 100644 --- a/lib/xero-ruby/models/payroll_uk/reimbursement.rb +++ b/lib/xero-ruby/models/payroll_uk/reimbursement.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/reimbursement_line.rb b/lib/xero-ruby/models/payroll_uk/reimbursement_line.rb index ce446aaf..ecd01a02 100644 --- a/lib/xero-ruby/models/payroll_uk/reimbursement_line.rb +++ b/lib/xero-ruby/models/payroll_uk/reimbursement_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/reimbursement_object.rb b/lib/xero-ruby/models/payroll_uk/reimbursement_object.rb index 2b60ef8d..d91dd5e5 100644 --- a/lib/xero-ruby/models/payroll_uk/reimbursement_object.rb +++ b/lib/xero-ruby/models/payroll_uk/reimbursement_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/reimbursements.rb b/lib/xero-ruby/models/payroll_uk/reimbursements.rb index c88329f9..55a0347a 100644 --- a/lib/xero-ruby/models/payroll_uk/reimbursements.rb +++ b/lib/xero-ruby/models/payroll_uk/reimbursements.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/salary_and_wage.rb b/lib/xero-ruby/models/payroll_uk/salary_and_wage.rb index fa1b458d..eb5150af 100644 --- a/lib/xero-ruby/models/payroll_uk/salary_and_wage.rb +++ b/lib/xero-ruby/models/payroll_uk/salary_and_wage.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/salary_and_wage_object.rb b/lib/xero-ruby/models/payroll_uk/salary_and_wage_object.rb index 4e2c9fb3..a70863ee 100644 --- a/lib/xero-ruby/models/payroll_uk/salary_and_wage_object.rb +++ b/lib/xero-ruby/models/payroll_uk/salary_and_wage_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/salary_and_wages.rb b/lib/xero-ruby/models/payroll_uk/salary_and_wages.rb index 61d0bb33..6655d2cf 100644 --- a/lib/xero-ruby/models/payroll_uk/salary_and_wages.rb +++ b/lib/xero-ruby/models/payroll_uk/salary_and_wages.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/settings.rb b/lib/xero-ruby/models/payroll_uk/settings.rb index 2c69400d..79868484 100644 --- a/lib/xero-ruby/models/payroll_uk/settings.rb +++ b/lib/xero-ruby/models/payroll_uk/settings.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/statutory_deduction.rb b/lib/xero-ruby/models/payroll_uk/statutory_deduction.rb index f32eae3c..bc4b8e8a 100644 --- a/lib/xero-ruby/models/payroll_uk/statutory_deduction.rb +++ b/lib/xero-ruby/models/payroll_uk/statutory_deduction.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/statutory_deduction_category.rb b/lib/xero-ruby/models/payroll_uk/statutory_deduction_category.rb index 32962f74..f89532cd 100644 --- a/lib/xero-ruby/models/payroll_uk/statutory_deduction_category.rb +++ b/lib/xero-ruby/models/payroll_uk/statutory_deduction_category.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/tax_line.rb b/lib/xero-ruby/models/payroll_uk/tax_line.rb index 278cf8bc..f11c19ec 100644 --- a/lib/xero-ruby/models/payroll_uk/tax_line.rb +++ b/lib/xero-ruby/models/payroll_uk/tax_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/timesheet.rb b/lib/xero-ruby/models/payroll_uk/timesheet.rb index b3305584..5e4378bf 100644 --- a/lib/xero-ruby/models/payroll_uk/timesheet.rb +++ b/lib/xero-ruby/models/payroll_uk/timesheet.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -93,7 +93,7 @@ def self.openapi_types :'end_date' => :'Date', :'status' => :'String', :'total_hours' => :'Float', - :'updated_date_utc' => :'DateTime', + :'updated_date_utc' => :'Time', :'timesheet_lines' => :'Array' } end diff --git a/lib/xero-ruby/models/payroll_uk/timesheet_earnings_line.rb b/lib/xero-ruby/models/payroll_uk/timesheet_earnings_line.rb index 8cd7febe..ac7f3129 100644 --- a/lib/xero-ruby/models/payroll_uk/timesheet_earnings_line.rb +++ b/lib/xero-ruby/models/payroll_uk/timesheet_earnings_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/timesheet_line.rb b/lib/xero-ruby/models/payroll_uk/timesheet_line.rb index dba49385..5ead00ec 100644 --- a/lib/xero-ruby/models/payroll_uk/timesheet_line.rb +++ b/lib/xero-ruby/models/payroll_uk/timesheet_line.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/timesheet_line_object.rb b/lib/xero-ruby/models/payroll_uk/timesheet_line_object.rb index d39554be..f012ded7 100644 --- a/lib/xero-ruby/models/payroll_uk/timesheet_line_object.rb +++ b/lib/xero-ruby/models/payroll_uk/timesheet_line_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/timesheet_object.rb b/lib/xero-ruby/models/payroll_uk/timesheet_object.rb index 3bd68e39..df86347e 100644 --- a/lib/xero-ruby/models/payroll_uk/timesheet_object.rb +++ b/lib/xero-ruby/models/payroll_uk/timesheet_object.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/timesheets.rb b/lib/xero-ruby/models/payroll_uk/timesheets.rb index 63381fb9..c2de6469 100644 --- a/lib/xero-ruby/models/payroll_uk/timesheets.rb +++ b/lib/xero-ruby/models/payroll_uk/timesheets.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/tracking_categories.rb b/lib/xero-ruby/models/payroll_uk/tracking_categories.rb index 9b2cb26f..ee10e9cc 100644 --- a/lib/xero-ruby/models/payroll_uk/tracking_categories.rb +++ b/lib/xero-ruby/models/payroll_uk/tracking_categories.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/payroll_uk/tracking_category.rb b/lib/xero-ruby/models/payroll_uk/tracking_category.rb index 38a0db63..cc403a26 100644 --- a/lib/xero-ruby/models/payroll_uk/tracking_category.rb +++ b/lib/xero-ruby/models/payroll_uk/tracking_category.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/projects/amount.rb b/lib/xero-ruby/models/projects/amount.rb index 4c6ce61e..cd30737d 100644 --- a/lib/xero-ruby/models/projects/amount.rb +++ b/lib/xero-ruby/models/projects/amount.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/projects/charge_type.rb b/lib/xero-ruby/models/projects/charge_type.rb index ae263c99..7a434e72 100644 --- a/lib/xero-ruby/models/projects/charge_type.rb +++ b/lib/xero-ruby/models/projects/charge_type.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/projects/currency_code.rb b/lib/xero-ruby/models/projects/currency_code.rb index 32e96f82..a11261e2 100644 --- a/lib/xero-ruby/models/projects/currency_code.rb +++ b/lib/xero-ruby/models/projects/currency_code.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/projects/error.rb b/lib/xero-ruby/models/projects/error.rb index af875d88..7c0c1a81 100644 --- a/lib/xero-ruby/models/projects/error.rb +++ b/lib/xero-ruby/models/projects/error.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/projects/pagination.rb b/lib/xero-ruby/models/projects/pagination.rb index ee8f73da..79f196cd 100644 --- a/lib/xero-ruby/models/projects/pagination.rb +++ b/lib/xero-ruby/models/projects/pagination.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/projects/project.rb b/lib/xero-ruby/models/projects/project.rb index b86a3a79..40281558 100644 --- a/lib/xero-ruby/models/projects/project.rb +++ b/lib/xero-ruby/models/projects/project.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -130,7 +130,7 @@ def self.openapi_types :'deposit' => :'Amount', :'deposit_applied' => :'Amount', :'credit_note_amount' => :'Amount', - :'deadline_utc' => :'DateTime', + :'deadline_utc' => :'Time', :'total_invoiced' => :'Amount', :'total_to_be_invoiced' => :'Amount', :'estimate' => :'Amount', diff --git a/lib/xero-ruby/models/projects/project_create_or_update.rb b/lib/xero-ruby/models/projects/project_create_or_update.rb index 8d2b3309..0c660a6b 100644 --- a/lib/xero-ruby/models/projects/project_create_or_update.rb +++ b/lib/xero-ruby/models/projects/project_create_or_update.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -44,7 +44,7 @@ def self.openapi_types :'contact_id' => :'String', :'name' => :'String', :'estimate_amount' => :'BigDecimal', - :'deadline_utc' => :'DateTime' + :'deadline_utc' => :'Time' } end diff --git a/lib/xero-ruby/models/projects/project_patch.rb b/lib/xero-ruby/models/projects/project_patch.rb index 0467305e..cafeebbd 100644 --- a/lib/xero-ruby/models/projects/project_patch.rb +++ b/lib/xero-ruby/models/projects/project_patch.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/projects/project_status.rb b/lib/xero-ruby/models/projects/project_status.rb index 8e124bc6..e01109b7 100644 --- a/lib/xero-ruby/models/projects/project_status.rb +++ b/lib/xero-ruby/models/projects/project_status.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/projects/project_user.rb b/lib/xero-ruby/models/projects/project_user.rb index dc2c978c..32139e2b 100644 --- a/lib/xero-ruby/models/projects/project_user.rb +++ b/lib/xero-ruby/models/projects/project_user.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/projects/project_users.rb b/lib/xero-ruby/models/projects/project_users.rb index e64688ae..d2cce27e 100644 --- a/lib/xero-ruby/models/projects/project_users.rb +++ b/lib/xero-ruby/models/projects/project_users.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/projects/projects.rb b/lib/xero-ruby/models/projects/projects.rb index 68be17ef..58610b9d 100644 --- a/lib/xero-ruby/models/projects/projects.rb +++ b/lib/xero-ruby/models/projects/projects.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/projects/task.rb b/lib/xero-ruby/models/projects/task.rb index eb613833..f914cc05 100644 --- a/lib/xero-ruby/models/projects/task.rb +++ b/lib/xero-ruby/models/projects/task.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/projects/task_create_or_update.rb b/lib/xero-ruby/models/projects/task_create_or_update.rb index d1799e8f..b77cda44 100644 --- a/lib/xero-ruby/models/projects/task_create_or_update.rb +++ b/lib/xero-ruby/models/projects/task_create_or_update.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -108,6 +108,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] name Value to be assigned + def name=(name) + if name.nil? + fail ArgumentError, 'name cannot be nil' + end + + @name = name + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/xero-ruby/models/projects/tasks.rb b/lib/xero-ruby/models/projects/tasks.rb index f3d503c3..fd374dcd 100644 --- a/lib/xero-ruby/models/projects/tasks.rb +++ b/lib/xero-ruby/models/projects/tasks.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/projects/time_entries.rb b/lib/xero-ruby/models/projects/time_entries.rb index 4814a1f7..01bc5884 100644 --- a/lib/xero-ruby/models/projects/time_entries.rb +++ b/lib/xero-ruby/models/projects/time_entries.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end diff --git a/lib/xero-ruby/models/projects/time_entry.rb b/lib/xero-ruby/models/projects/time_entry.rb index bee5896e..f0001a2a 100644 --- a/lib/xero-ruby/models/projects/time_entry.rb +++ b/lib/xero-ruby/models/projects/time_entry.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -90,8 +90,8 @@ def self.openapi_types :'user_id' => :'String', :'project_id' => :'String', :'task_id' => :'String', - :'date_utc' => :'DateTime', - :'date_entered_utc' => :'DateTime', + :'date_utc' => :'Time', + :'date_entered_utc' => :'Time', :'duration' => :'Integer', :'description' => :'String', :'status' => :'String' diff --git a/lib/xero-ruby/models/projects/time_entry_create_or_update.rb b/lib/xero-ruby/models/projects/time_entry_create_or_update.rb index 39d2df32..96b95826 100644 --- a/lib/xero-ruby/models/projects/time_entry_create_or_update.rb +++ b/lib/xero-ruby/models/projects/time_entry_create_or_update.rb @@ -5,7 +5,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -47,7 +47,7 @@ def self.openapi_types { :'user_id' => :'String', :'task_id' => :'String', - :'date_utc' => :'DateTime', + :'date_utc' => :'Time', :'duration' => :'Integer', :'description' => :'String' } diff --git a/lib/xero-ruby/version.rb b/lib/xero-ruby/version.rb index 89347445..49cb3eb6 100644 --- a/lib/xero-ruby/version.rb +++ b/lib/xero-ruby/version.rb @@ -5,11 +5,11 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 -The version of the XeroOpenAPI document: 2.38.0 +The version of the XeroOpenAPI document: 2.40.1 =end module XeroRuby - VERSION = '4.3.1' + VERSION = '4.2.0' end diff --git a/xero-ruby.gemspec b/xero-ruby.gemspec index 2662de90..701e6b31 100644 --- a/xero-ruby.gemspec +++ b/xero-ruby.gemspec @@ -7,7 +7,7 @@ Contact: api@xero.com Generated by: https://openapi-generator.tech -OpenAPI Generator version: 4.3.1 +OpenAPI Generator version: 5.4.0 =end @@ -28,7 +28,7 @@ Gem::Specification.new do |s| s.add_runtime_dependency 'faraday', '>= 2.0', '< 3.0' s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0' - s.add_runtime_dependency 'json-jwt', '~> 1.16', '>= 1.16.3' + s.add_runtime_dependency 'json-jwt', '~> 1.5', '>= 1.5.2' s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0' s.files = Dir.glob("{lib}/**/*") + %w(README.md)