From 68ad5981885e0f542a497d6f4e4f8d395b0e61b6 Mon Sep 17 00:00:00 2001 From: Rett Behrens Date: Tue, 28 Jun 2022 14:54:18 -0600 Subject: [PATCH 01/10] generates xero-ruby 3.11.0 from OAS 2.24.0 using cli v5.4.0 --- docs/accounting/AccountingApi.md | 1817 +++++++++-------- docs/accounting/RepeatingInvoice.md | 12 +- docs/accounting/index.html | 2 +- docs/app_store/AppStoreApi.md | 4 +- docs/app_store/ProblemDetails.md | 2 +- docs/app_store/Subscription.md | 6 +- docs/app_store/SubscriptionItem.md | 4 +- docs/app_store/index.html | 2 +- docs/assets/AssetApi.md | 24 +- docs/assets/index.html | 2 +- docs/files/FilesApi.md | 106 +- docs/files/UploadObject.md | 23 - docs/files/index.html | 2 +- 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 | 2 +- docs/payroll_au/PayrollAuApi.md | 172 +- docs/payroll_au/index.html | 2 +- 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 | 382 ++-- docs/payroll_nz/Timesheet.md | 2 +- docs/payroll_nz/index.html | 2 +- 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 | 400 ++-- docs/payroll_uk/Timesheet.md | 2 +- docs/payroll_uk/index.html | 2 +- docs/projects/Error.md | 2 +- docs/projects/Project.md | 2 +- docs/projects/ProjectApi.md | 152 +- docs/projects/ProjectCreateOrUpdate.md | 2 +- docs/projects/TimeEntry.md | 4 +- docs/projects/TimeEntryCreateOrUpdate.md | 2 +- docs/projects/index.html | 2 +- lib/xero-ruby.rb | 3 +- lib/xero-ruby/api/accounting_api.rb | 345 +++- lib/xero-ruby/api/app_store_api.rb | 2 +- lib/xero-ruby/api/asset_api.rb | 2 +- lib/xero-ruby/api/files_api.rb | 2 +- lib/xero-ruby/api/finance_api.rb | 2 +- lib/xero-ruby/api/payroll_au_api.rb | 30 +- lib/xero-ruby/api/payroll_nz_api.rb | 2 +- lib/xero-ruby/api/payroll_uk_api.rb | 2 +- lib/xero-ruby/api/project_api.rb | 10 +- 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 | 5 +- .../models/accounting/account_type.rb | 2 +- lib/xero-ruby/models/accounting/accounts.rb | 5 +- .../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 | 5 +- lib/xero-ruby/models/accounting/address.rb | 2 +- .../accounting/address_for_organisation.rb | 2 +- lib/xero-ruby/models/accounting/allocation.rb | 5 +- .../models/accounting/allocations.rb | 5 +- lib/xero-ruby/models/accounting/attachment.rb | 2 +- .../models/accounting/attachments.rb | 5 +- .../models/accounting/balance_details.rb | 2 +- lib/xero-ruby/models/accounting/balances.rb | 2 +- .../models/accounting/bank_transaction.rb | 8 +- .../models/accounting/bank_transactions.rb | 5 +- .../models/accounting/bank_transfer.rb | 5 +- .../models/accounting/bank_transfers.rb | 5 +- .../models/accounting/batch_payment.rb | 8 +- .../accounting/batch_payment_details.rb | 2 +- .../models/accounting/batch_payments.rb | 5 +- lib/xero-ruby/models/accounting/bill.rb | 2 +- .../models/accounting/branding_theme.rb | 2 +- .../models/accounting/branding_themes.rb | 5 +- lib/xero-ruby/models/accounting/budget.rb | 8 +- .../models/accounting/budget_balance.rb | 2 +- .../models/accounting/budget_line.rb | 5 +- lib/xero-ruby/models/accounting/budgets.rb | 5 +- .../models/accounting/cis_org_setting.rb | 2 +- .../models/accounting/cis_org_settings.rb | 5 +- .../models/accounting/cis_setting.rb | 2 +- .../models/accounting/cis_settings.rb | 5 +- lib/xero-ruby/models/accounting/contact.rb | 26 +- .../models/accounting/contact_group.rb | 5 +- .../models/accounting/contact_groups.rb | 5 +- .../models/accounting/contact_person.rb | 2 +- lib/xero-ruby/models/accounting/contacts.rb | 5 +- .../models/accounting/conversion_balances.rb | 5 +- .../models/accounting/conversion_date.rb | 2 +- .../models/accounting/country_code.rb | 2 +- .../models/accounting/credit_note.rb | 17 +- .../models/accounting/credit_notes.rb | 5 +- lib/xero-ruby/models/accounting/currencies.rb | 5 +- lib/xero-ruby/models/accounting/currency.rb | 2 +- .../models/accounting/currency_code.rb | 2 +- lib/xero-ruby/models/accounting/element.rb | 5 +- lib/xero-ruby/models/accounting/employee.rb | 5 +- lib/xero-ruby/models/accounting/employees.rb | 5 +- lib/xero-ruby/models/accounting/error.rb | 5 +- .../models/accounting/expense_claim.rb | 8 +- .../models/accounting/expense_claims.rb | 5 +- .../models/accounting/external_link.rb | 2 +- .../models/accounting/history_record.rb | 2 +- .../models/accounting/history_records.rb | 5 +- .../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 | 26 +- .../models/accounting/invoice_reminder.rb | 2 +- .../models/accounting/invoice_reminders.rb | 5 +- lib/xero-ruby/models/accounting/invoices.rb | 5 +- lib/xero-ruby/models/accounting/item.rb | 5 +- lib/xero-ruby/models/accounting/items.rb | 5 +- lib/xero-ruby/models/accounting/journal.rb | 5 +- .../models/accounting/journal_line.rb | 5 +- lib/xero-ruby/models/accounting/journals.rb | 5 +- .../models/accounting/line_amount_types.rb | 2 +- lib/xero-ruby/models/accounting/line_item.rb | 5 +- .../models/accounting/line_item_item.rb | 2 +- .../models/accounting/line_item_tracking.rb | 2 +- .../models/accounting/linked_transaction.rb | 5 +- .../models/accounting/linked_transactions.rb | 5 +- .../models/accounting/manual_journal.rb | 14 +- .../models/accounting/manual_journal_line.rb | 5 +- .../models/accounting/manual_journals.rb | 5 +- .../models/accounting/online_invoice.rb | 2 +- .../models/accounting/online_invoices.rb | 5 +- .../models/accounting/organisation.rb | 11 +- .../models/accounting/organisations.rb | 5 +- .../models/accounting/overpayment.rb | 14 +- .../models/accounting/overpayments.rb | 5 +- lib/xero-ruby/models/accounting/payment.rb | 5 +- .../models/accounting/payment_delete.rb | 2 +- .../models/accounting/payment_service.rb | 5 +- .../models/accounting/payment_services.rb | 5 +- .../models/accounting/payment_term.rb | 2 +- .../models/accounting/payment_term_type.rb | 2 +- lib/xero-ruby/models/accounting/payments.rb | 5 +- lib/xero-ruby/models/accounting/phone.rb | 2 +- lib/xero-ruby/models/accounting/prepayment.rb | 14 +- .../models/accounting/prepayments.rb | 5 +- lib/xero-ruby/models/accounting/purchase.rb | 2 +- .../models/accounting/purchase_order.rb | 14 +- .../models/accounting/purchase_orders.rb | 5 +- lib/xero-ruby/models/accounting/quote.rb | 8 +- .../accounting/quote_line_amount_types.rb | 2 +- .../models/accounting/quote_status_codes.rb | 2 +- lib/xero-ruby/models/accounting/quotes.rb | 5 +- lib/xero-ruby/models/accounting/receipt.rb | 14 +- lib/xero-ruby/models/accounting/receipts.rb | 5 +- .../models/accounting/repeating_invoice.rb | 66 +- .../models/accounting/repeating_invoices.rb | 5 +- lib/xero-ruby/models/accounting/report.rb | 5 +- .../models/accounting/report_attribute.rb | 2 +- .../models/accounting/report_cell.rb | 5 +- .../models/accounting/report_fields.rb | 2 +- lib/xero-ruby/models/accounting/report_row.rb | 5 +- .../models/accounting/report_rows.rb | 8 +- .../models/accounting/report_with_row.rb | 11 +- .../models/accounting/report_with_rows.rb | 5 +- lib/xero-ruby/models/accounting/reports.rb | 5 +- .../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 | 8 +- .../models/accounting/tax_component.rb | 2 +- lib/xero-ruby/models/accounting/tax_rate.rb | 5 +- lib/xero-ruby/models/accounting/tax_rates.rb | 5 +- lib/xero-ruby/models/accounting/tax_type.rb | 2 +- .../accounting/ten_ninety_nine_contact.rb | 2 +- lib/xero-ruby/models/accounting/time_zone.rb | 2 +- .../models/accounting/tracking_categories.rb | 5 +- .../models/accounting/tracking_category.rb | 5 +- .../models/accounting/tracking_option.rb | 2 +- .../models/accounting/tracking_options.rb | 5 +- lib/xero-ruby/models/accounting/user.rb | 2 +- lib/xero-ruby/models/accounting/users.rb | 5 +- .../models/accounting/validation_error.rb | 2 +- lib/xero-ruby/models/app_store/plan.rb | 5 +- 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 | 11 +- .../models/app_store/subscription_item.rb | 6 +- 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 | 5 +- .../models/assets/book_depreciation_detail.rb | 2 +- .../assets/book_depreciation_setting.rb | 2 +- lib/xero-ruby/models/assets/error.rb | 8 +- .../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 | 5 +- lib/xero-ruby/models/files/folder.rb | 2 +- lib/xero-ruby/models/files/folders.rb | 5 +- 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 | 5 +- .../finance/balance_sheet_account_detail.rb | 2 +- .../finance/balance_sheet_account_group.rb | 5 +- .../finance/balance_sheet_account_type.rb | 5 +- .../models/finance/balance_sheet_response.rb | 2 +- .../bank_statement_accounting_response.rb | 5 +- .../models/finance/bank_statement_response.rb | 2 +- .../finance/bank_transaction_response.rb | 5 +- .../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 | 5 +- .../models/finance/cashflow_response.rb | 5 +- lib/xero-ruby/models/finance/cashflow_type.rb | 5 +- .../models/finance/contact_detail.rb | 5 +- .../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 | 5 +- .../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 | 5 +- .../models/finance/invoice_response.rb | 5 +- .../models/finance/line_item_response.rb | 2 +- .../models/finance/lock_history_model.rb | 4 +- .../models/finance/lock_history_response.rb | 5 +- .../models/finance/manual_journal_total.rb | 2 +- .../models/finance/overpayment_response.rb | 5 +- .../models/finance/payment_response.rb | 2 +- lib/xero-ruby/models/finance/pnl_account.rb | 2 +- .../models/finance/pnl_account_class.rb | 5 +- .../models/finance/pnl_account_type.rb | 5 +- .../models/finance/practice_response.rb | 2 +- .../models/finance/prepayment_response.rb | 5 +- lib/xero-ruby/models/finance/problem.rb | 2 +- lib/xero-ruby/models/finance/problem_type.rb | 2 +- .../finance/profit_and_loss_response.rb | 2 +- .../models/finance/report_history_model.rb | 4 +- .../models/finance/report_history_response.rb | 5 +- .../finance/statement_balance_response.rb | 2 +- .../models/finance/statement_line_response.rb | 8 +- .../finance/statement_lines_response.rb | 2 +- .../models/finance/statement_response.rb | 7 +- 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 | 5 +- .../finance/user_activities_response.rb | 5 +- lib/xero-ruby/models/finance/user_response.rb | 12 +- 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/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 | 17 +- .../models/payroll_au/employee_status.rb | 2 +- lib/xero-ruby/models/payroll_au/employees.rb | 5 +- .../models/payroll_au/employment_basis.rb | 2 +- .../employment_termination_payment_type.rb | 2 +- .../entitlement_final_pay_payout_type.rb | 2 +- .../models/payroll_au/home_address.rb | 2 +- .../models/payroll_au/leave_accrual_line.rb | 2 +- .../models/payroll_au/leave_application.rb | 8 +- .../models/payroll_au/leave_applications.rb | 5 +- .../models/payroll_au/leave_balance.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 | 5 +- .../models/payroll_au/leave_period.rb | 2 +- .../models/payroll_au/leave_period_status.rb | 2 +- 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 | 17 +- lib/xero-ruby/models/payroll_au/pay_item.rb | 14 +- lib/xero-ruby/models/payroll_au/pay_items.rb | 2 +- lib/xero-ruby/models/payroll_au/pay_run.rb | 8 +- .../models/payroll_au/pay_run_status.rb | 2 +- lib/xero-ruby/models/payroll_au/pay_runs.rb | 5 +- .../models/payroll_au/pay_template.rb | 17 +- .../payroll_au/payment_frequency_type.rb | 2 +- .../models/payroll_au/payroll_calendar.rb | 5 +- .../models/payroll_au/payroll_calendars.rb | 5 +- lib/xero-ruby/models/payroll_au/payslip.rb | 26 +- .../models/payroll_au/payslip_lines.rb | 26 +- .../models/payroll_au/payslip_object.rb | 2 +- .../models/payroll_au/payslip_summary.rb | 2 +- lib/xero-ruby/models/payroll_au/payslips.rb | 5 +- lib/xero-ruby/models/payroll_au/rate_type.rb | 2 +- .../models/payroll_au/reimbursement_line.rb | 2 +- .../models/payroll_au/reimbursement_lines.rb | 5 +- .../models/payroll_au/reimbursement_type.rb | 2 +- .../models/payroll_au/residency_status.rb | 2 +- lib/xero-ruby/models/payroll_au/settings.rb | 5 +- .../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 | 5 +- .../models/payroll_au/super_fund_product.rb | 2 +- .../models/payroll_au/super_fund_products.rb | 5 +- .../models/payroll_au/super_fund_type.rb | 2 +- .../models/payroll_au/super_funds.rb | 5 +- 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/tfn_exemption_type.rb | 2 +- lib/xero-ruby/models/payroll_au/timesheet.rb | 8 +- .../models/payroll_au/timesheet_line.rb | 5 +- .../models/payroll_au/timesheet_object.rb | 2 +- .../models/payroll_au/timesheet_status.rb | 2 +- lib/xero-ruby/models/payroll_au/timesheets.rb | 5 +- .../models/payroll_au/validation_error.rb | 2 +- lib/xero-ruby/models/payroll_nz/account.rb | 2 +- lib/xero-ruby/models/payroll_nz/accounts.rb | 5 +- 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 | 5 +- .../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 | 5 +- .../models/payroll_nz/earnings_rate.rb | 2 +- .../models/payroll_nz/earnings_rate_object.rb | 2 +- .../models/payroll_nz/earnings_rates.rb | 5 +- .../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 | 5 +- .../models/payroll_nz/employee_leave.rb | 7 +- .../payroll_nz/employee_leave_balance.rb | 2 +- .../payroll_nz/employee_leave_balances.rb | 5 +- .../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 | 5 +- .../models/payroll_nz/employee_leaves.rb | 5 +- .../models/payroll_nz/employee_object.rb | 2 +- .../payroll_nz/employee_opening_balance.rb | 2 +- .../employee_opening_balances_object.rb | 5 +- .../payroll_nz/employee_pay_template.rb | 5 +- .../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 | 5 +- .../employee_statutory_sick_leave.rb | 8 +- .../employee_statutory_sick_leave_object.rb | 2 +- .../employee_statutory_sick_leaves.rb | 5 +- .../models/payroll_nz/employee_tax.rb | 2 +- .../models/payroll_nz/employee_tax_object.rb | 2 +- lib/xero-ruby/models/payroll_nz/employees.rb | 5 +- 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 | 5 +- lib/xero-ruby/models/payroll_nz/leave_type.rb | 4 +- .../models/payroll_nz/leave_type_object.rb | 2 +- .../models/payroll_nz/leave_types.rb | 5 +- lib/xero-ruby/models/payroll_nz/pagination.rb | 2 +- lib/xero-ruby/models/payroll_nz/pay_run.rb | 5 +- .../models/payroll_nz/pay_run_calendar.rb | 4 +- .../payroll_nz/pay_run_calendar_object.rb | 2 +- .../models/payroll_nz/pay_run_calendars.rb | 5 +- .../models/payroll_nz/pay_run_object.rb | 2 +- lib/xero-ruby/models/payroll_nz/pay_runs.rb | 5 +- lib/xero-ruby/models/payroll_nz/pay_slip.rb | 35 +- .../models/payroll_nz/pay_slip_object.rb | 2 +- lib/xero-ruby/models/payroll_nz/pay_slips.rb | 5 +- .../models/payroll_nz/payment_line.rb | 2 +- .../models/payroll_nz/payment_method.rb | 5 +- .../payroll_nz/payment_method_object.rb | 2 +- lib/xero-ruby/models/payroll_nz/problem.rb | 5 +- .../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 | 5 +- .../models/payroll_nz/salary_and_wage.rb | 2 +- .../payroll_nz/salary_and_wage_object.rb | 2 +- .../models/payroll_nz/salary_and_wages.rb | 5 +- 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 | 5 +- .../models/payroll_nz/superannuation_line.rb | 2 +- .../payroll_nz/superannuation_object.rb | 2 +- .../models/payroll_nz/superannuations.rb | 5 +- 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 | 7 +- .../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 | 5 +- .../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 | 5 +- 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 | 5 +- .../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 | 5 +- .../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 | 5 +- .../models/payroll_uk/earnings_rate.rb | 2 +- .../models/payroll_uk/earnings_rate_object.rb | 2 +- .../models/payroll_uk/earnings_rates.rb | 5 +- .../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 | 7 +- .../payroll_uk/employee_leave_balance.rb | 2 +- .../payroll_uk/employee_leave_balances.rb | 5 +- .../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 | 5 +- .../models/payroll_uk/employee_leaves.rb | 5 +- .../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 | 5 +- .../employee_pay_template_object.rb | 2 +- .../payroll_uk/employee_pay_templates.rb | 5 +- .../employee_statutory_leave_balance.rb | 2 +- ...employee_statutory_leave_balance_object.rb | 2 +- .../employee_statutory_leave_summary.rb | 2 +- .../employee_statutory_leaves_summaries.rb | 5 +- .../employee_statutory_sick_leave.rb | 8 +- .../employee_statutory_sick_leave_object.rb | 2 +- .../employee_statutory_sick_leaves.rb | 5 +- .../models/payroll_uk/employee_tax.rb | 2 +- .../models/payroll_uk/employee_tax_object.rb | 2 +- lib/xero-ruby/models/payroll_uk/employees.rb | 5 +- 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 | 5 +- lib/xero-ruby/models/payroll_uk/leave_type.rb | 4 +- .../models/payroll_uk/leave_type_object.rb | 2 +- .../models/payroll_uk/leave_types.rb | 5 +- lib/xero-ruby/models/payroll_uk/pagination.rb | 2 +- lib/xero-ruby/models/payroll_uk/pay_run.rb | 5 +- .../models/payroll_uk/pay_run_calendar.rb | 4 +- .../payroll_uk/pay_run_calendar_object.rb | 2 +- .../models/payroll_uk/pay_run_calendars.rb | 5 +- .../models/payroll_uk/pay_run_object.rb | 2 +- lib/xero-ruby/models/payroll_uk/pay_runs.rb | 5 +- .../models/payroll_uk/payment_line.rb | 2 +- .../models/payroll_uk/payment_method.rb | 5 +- .../payroll_uk/payment_method_object.rb | 2 +- lib/xero-ruby/models/payroll_uk/payslip.rb | 35 +- .../models/payroll_uk/payslip_object.rb | 2 +- lib/xero-ruby/models/payroll_uk/payslips.rb | 5 +- lib/xero-ruby/models/payroll_uk/problem.rb | 5 +- .../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 | 5 +- .../models/payroll_uk/salary_and_wage.rb | 2 +- .../payroll_uk/salary_and_wage_object.rb | 2 +- .../models/payroll_uk/salary_and_wages.rb | 5 +- 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 | 7 +- .../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 | 5 +- .../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 | 5 +- lib/xero-ruby/models/projects/projects.rb | 5 +- lib/xero-ruby/models/projects/task.rb | 2 +- .../models/projects/task_create_or_update.rb | 12 +- lib/xero-ruby/models/projects/tasks.rb | 5 +- lib/xero-ruby/models/projects/time_entries.rb | 5 +- 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 | 2 +- 558 files changed, 2643 insertions(+), 3306 deletions(-) delete mode 100644 docs/files/UploadObject.md delete mode 100644 lib/xero-ruby/models/files/upload_object.rb diff --git a/docs/accounting/AccountingApi.md b/docs/accounting/AccountingApi.md index 89906c91..5af148ef 100644 --- a/docs/accounting/AccountingApi.md +++ b/docs/accounting/AccountingApi.md @@ -56,6 +56,7 @@ Method | HTTP request | Description [**create_receipt_history**](AccountingApi.md#create_receipt_history) | **PUT** /Receipts/{ReceiptID}/History | Creates a history record for a specific receipt [**create_repeating_invoice_attachment_by_file_name**](AccountingApi.md#create_repeating_invoice_attachment_by_file_name) | **PUT** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} | Creates an attachment from a specific repeating invoices by file name [**create_repeating_invoice_history**](AccountingApi.md#create_repeating_invoice_history) | **PUT** /RepeatingInvoices/{RepeatingInvoiceID}/History | Creates a history record for a specific repeating invoice +[**create_repeating_invoices**](AccountingApi.md#create_repeating_invoices) | **PUT** /RepeatingInvoices | Creates one or more repeating invoice templates [**create_tax_rates**](AccountingApi.md#create_tax_rates) | **PUT** /TaxRates | Creates one or more tax rates [**create_tracking_category**](AccountingApi.md#create_tracking_category) | **PUT** /TrackingCategories | Create tracking categories [**create_tracking_options**](AccountingApi.md#create_tracking_options) | **PUT** /TrackingCategories/{TrackingCategoryID}/Options | Creates options for a specific tracking category @@ -221,12 +222,14 @@ Method | HTTP request | Description [**update_or_create_manual_journals**](AccountingApi.md#update_or_create_manual_journals) | **POST** /ManualJournals | Updates or creates a single manual journal [**update_or_create_purchase_orders**](AccountingApi.md#update_or_create_purchase_orders) | **POST** /PurchaseOrders | Updates or creates one or more purchase orders [**update_or_create_quotes**](AccountingApi.md#update_or_create_quotes) | **POST** /Quotes | Updates or creates one or more quotes +[**update_or_create_repeating_invoices**](AccountingApi.md#update_or_create_repeating_invoices) | **POST** /RepeatingInvoices | Creates or deletes one or more repeating invoice templates [**update_purchase_order**](AccountingApi.md#update_purchase_order) | **POST** /PurchaseOrders/{PurchaseOrderID} | Updates a specific purchase order [**update_purchase_order_attachment_by_file_name**](AccountingApi.md#update_purchase_order_attachment_by_file_name) | **POST** /PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName} | Updates a specific attachment for a specific purchase order by filename [**update_quote**](AccountingApi.md#update_quote) | **POST** /Quotes/{QuoteID} | Updates a specific quote [**update_quote_attachment_by_file_name**](AccountingApi.md#update_quote_attachment_by_file_name) | **POST** /Quotes/{QuoteID}/Attachments/{FileName} | Updates a specific attachment from a specific quote by filename [**update_receipt**](AccountingApi.md#update_receipt) | **POST** /Receipts/{ReceiptID} | Updates a specific draft expense claim receipts [**update_receipt_attachment_by_file_name**](AccountingApi.md#update_receipt_attachment_by_file_name) | **POST** /Receipts/{ReceiptID}/Attachments/{FileName} | Updates a specific attachment on a specific expense claim receipts by file name +[**update_repeating_invoice**](AccountingApi.md#update_repeating_invoice) | **POST** /RepeatingInvoices/{RepeatingInvoiceID} | Deletes a specific repeating invoice template [**update_repeating_invoice_attachment_by_file_name**](AccountingApi.md#update_repeating_invoice_attachment_by_file_name) | **POST** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} | Updates a specific attachment from a specific repeating invoices by file name [**update_tax_rate**](AccountingApi.md#update_tax_rate) | **POST** /TaxRates | Updates tax rates [**update_tracking_category**](AccountingApi.md#update_tracking_category) | **POST** /TrackingCategories/{TrackingCategoryID} | Updates a specific tracking category @@ -265,7 +268,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 account = { "Code":"123456", "Name":"Foobar", "Type":"EXPENSE", "Description":"Hello World" } # Account | Account object in body of request begin #Creates a new chart of accounts @@ -329,10 +332,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 -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 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) @@ -348,7 +351,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 | **body** | **String**| Byte array of file in body of request | @@ -397,10 +400,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 -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 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) @@ -416,7 +419,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 | **body** | **String**| Byte array of file in body of request | @@ -465,8 +468,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a history record for a specific bank transactions @@ -483,7 +486,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -531,10 +534,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 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 + 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 } @@ -603,7 +606,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 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 begin #Creates a bank transfer @@ -667,10 +670,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 -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 begin result = api_instance.create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) p result @@ -685,7 +688,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 | **body** | **String**| Byte array of file in body of request | @@ -734,8 +737,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a history record for a specific bank transfer @@ -752,7 +755,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -800,10 +803,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 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 } begin @@ -869,8 +872,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a history record for a specific batch payment @@ -887,7 +890,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -935,8 +938,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 payment_service = { "PaymentServiceID": "00000000-0000-0000-0000-000000000000", "PaymentServiceName": "Payments Service", "PaymentServiceUrl": "https://www.paymentservice.com/", "PayNowText": "Pay Now" } # PaymentService | PaymentService object in body of request begin #Creates a new custom payment service for a specific branding theme @@ -953,7 +956,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 | **payment_service** | [**PaymentService**](PaymentService.md)| PaymentService object in body of request | ### Return type @@ -1001,10 +1004,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 -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 begin result = api_instance.create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) p result @@ -1019,7 +1022,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 | **body** | **String**| Byte array of file in body of request | @@ -1068,7 +1071,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 contact_groups = { "ContactGroups": [{ "Name": "VIPs" }]} # ContactGroups | ContactGroups with an array of names in request body begin #Creates a contact group @@ -1132,8 +1135,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 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 begin #Creates contacts to a specific contact group @@ -1150,7 +1153,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 | **contacts** | [**Contacts**](Contacts.md)| Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request | ### Return type @@ -1198,8 +1201,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a new history record for a specific contact @@ -1216,7 +1219,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -1264,10 +1267,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 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 + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -1333,11 +1336,11 @@ 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 + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -1355,7 +1358,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 | **allocations** | [**Allocations**](Allocations.md)| Allocations with array of Allocation object 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] @@ -1404,12 +1407,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 -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 + include_online: true # Boolean | Allows an attachment to be seen by the end customer within their online invoice } begin @@ -1427,7 +1430,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 | **body** | **String**| Byte array of file in body of request | **include_online** | **Boolean**| Allows an attachment to be seen by the end customer within their online invoice | [optional] [default to false] @@ -1477,8 +1480,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Retrieves history records of a specific credit note @@ -1495,7 +1498,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -1543,10 +1546,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 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 + 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 } @@ -1615,7 +1618,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 currency = { "Code": "USD", "Description": "United States Dollar" } # Currency | Currency object in the body of request begin #Create a new currency for a Xero organisation @@ -1679,10 +1682,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 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 + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -1748,8 +1751,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a history record for a specific expense claim @@ -1766,7 +1769,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -1814,7 +1817,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 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 begin #Creates expense claims @@ -1878,12 +1881,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 -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 + include_online: true # Boolean | Allows an attachment to be seen by the end customer within their online invoice } begin @@ -1901,7 +1904,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 | **body** | **String**| Byte array of file in body of request | **include_online** | **Boolean**| Allows an attachment to be seen by the end customer within their online invoice | [optional] [default to false] @@ -1951,8 +1954,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a history record for a specific invoice @@ -1969,7 +1972,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -2017,10 +2020,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 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 + 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 } @@ -2089,8 +2092,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a history record for a specific item @@ -2107,7 +2110,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -2155,10 +2158,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 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 + 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 } @@ -2227,7 +2230,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 linked_transaction = { "LinkedTransactions": [ { "SourceTransactionID": "a848644a-f20f-4630-98c3-386bd7505631", "SourceLineItemID": "b0df260d-3cc8-4ced-9bd6-41924f624ed3" } ] } # LinkedTransaction | LinkedTransaction object in body of request begin #Creates linked transactions (billable expenses) @@ -2291,10 +2294,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 -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 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) @@ -2310,7 +2313,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 | **body** | **String**| Byte array of file in body of request | @@ -2359,8 +2362,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a history record for a specific manual journal @@ -2377,7 +2380,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -2425,10 +2428,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 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 + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -2494,11 +2497,11 @@ 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 + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -2516,7 +2519,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 | **allocations** | [**Allocations**](Allocations.md)| Allocations array with Allocation object 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] @@ -2565,8 +2568,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a history record for a specific overpayment @@ -2583,7 +2586,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -2631,7 +2634,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 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 begin #Creates a single payment for invoice or credit notes @@ -2695,8 +2698,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a history record for a specific payment @@ -2713,7 +2716,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -2761,7 +2764,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 payment_services = { "PaymentServices": [ { "PaymentServiceName": "PayUpNow", "PaymentServiceUrl": "https://www.payupnow.com/", "PayNowText": "Time To Pay" } ] } # PaymentServices | PaymentServices array with PaymentService object in body of request begin #Creates a payment service @@ -2825,10 +2828,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 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 + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -2894,11 +2897,11 @@ 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 + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -2916,7 +2919,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 | **allocations** | [**Allocations**](Allocations.md)| Allocations with an array of Allocation object 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] @@ -2965,8 +2968,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a history record for a specific prepayment @@ -2983,7 +2986,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -3031,10 +3034,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 -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 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) @@ -3050,7 +3053,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 | **body** | **String**| Byte array of file in body of request | @@ -3099,8 +3102,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a history record for a specific purchase orders @@ -3117,7 +3120,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -3165,10 +3168,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 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 + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -3234,10 +3237,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 -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 begin #Creates attachment for a specific quote result = api_instance.create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) @@ -3253,7 +3256,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 | **body** | **String**| Byte array of file in body of request | @@ -3302,8 +3305,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a history record for a specific quote @@ -3320,7 +3323,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -3368,10 +3371,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 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 + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -3437,7 +3440,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 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 = { unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts @@ -3506,10 +3509,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 -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 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) @@ -3525,7 +3528,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 | **body** | **String**| Byte array of file in body of request | @@ -3574,8 +3577,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a history record for a specific receipt @@ -3592,7 +3595,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -3640,10 +3643,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 -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 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) @@ -3659,7 +3662,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 | **body** | **String**| Byte array of file in body of request | @@ -3708,8 +3711,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 history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request begin #Creates a history record for a specific repeating invoice @@ -3726,7 +3729,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 | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | ### Return type @@ -3743,6 +3746,75 @@ Name | Type | Description | Notes - **Accept**: application/json +## create_repeating_invoices + +> RepeatingInvoices create_repeating_invoices(xero_tenant_id, repeating_invoices, opts) + +Creates one or more repeating invoice templates + +### Example + +```ruby +# load the gem +require 'xero-ruby' + +creds = { + client_id: ENV['CLIENT_ID'], + client_secret: ENV['CLIENT_SECRET'], + redirect_uri: ENV['REDIRECT_URI'], + scopes: ENV['SCOPES'] +} +xero_client = XeroRuby::ApiClient.new(credentials: creds) + +token_set = fetch_valid_token_set(user) # example + +xero_client.refresh_token_set(token_set) + +# You need to namespace your api method call to one of the following api sets +# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api] + +api_instance = xero_client. + + + +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: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors +} + +begin + #Creates one or more repeating invoice templates + result = api_instance.create_repeating_invoices(xero_tenant_id, repeating_invoices, opts) + p result +rescue XeroRuby::Accounting::ApiError => e + puts "Exception when calling AccountingApi->create_repeating_invoices: #{e}" +end +``` + +### Parameters + + +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 | + **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 + +[**RepeatingInvoices**](RepeatingInvoices.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + ## create_tax_rates > TaxRates create_tax_rates(xero_tenant_id, tax_rates) @@ -3774,7 +3846,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 tax_rates = { "TaxRates": [ { "Name": "CA State Tax", "TaxComponents": [ { "Name": "State Tax", "Rate": 2.25 } ] } ] } # TaxRates | TaxRates array with TaxRate object in body of request begin #Creates one or more tax rates @@ -3838,7 +3910,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 tracking_category = { name: "FooBar" } # TrackingCategory | TrackingCategory object in body of request begin #Create tracking categories @@ -3902,8 +3974,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 tracking_option = { name: " Bar" } # TrackingOption | TrackingOption object in body of request begin #Creates options for a specific tracking category @@ -3920,7 +3992,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 | **tracking_option** | [**TrackingOption**](TrackingOption.md)| TrackingOption object in body of request | ### Return type @@ -3968,8 +4040,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) @@ -3985,7 +4057,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 @@ -4032,9 +4104,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) @@ -4049,8 +4121,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 @@ -4097,8 +4169,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) @@ -4113,7 +4185,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 @@ -4160,8 +4232,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) @@ -4176,7 +4248,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 @@ -4223,8 +4295,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) @@ -4239,7 +4311,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 @@ -4286,8 +4358,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 payment_delete = { "Payments":[ { "Status":"DELETED" } ] } # PaymentDelete | begin #Updates a specific payment for invoices and credit notes @@ -4304,7 +4376,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 | **payment_delete** | [**PaymentDelete**](PaymentDelete.md)| | ### Return type @@ -4352,8 +4424,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) @@ -4369,7 +4441,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 @@ -4416,9 +4488,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) @@ -4434,8 +4506,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 @@ -4482,8 +4554,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 request_empty = {} # RequestEmpty | begin #Sends a copy of a specific invoice to related contact via email @@ -4499,7 +4571,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 | **request_empty** | [**RequestEmpty**](RequestEmpty.md)| | ### Return type @@ -4547,8 +4619,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) @@ -4564,7 +4636,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 @@ -4611,10 +4683,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) @@ -4630,7 +4702,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 | @@ -4679,10 +4751,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) @@ -4698,8 +4770,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 @@ -4747,8 +4819,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) @@ -4764,7 +4836,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 @@ -4811,13 +4883,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 @@ -4835,7 +4907,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] @@ -4884,8 +4956,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 } @@ -4905,7 +4977,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 @@ -4953,10 +5025,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) @@ -4972,7 +5044,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 | @@ -5021,10 +5093,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) @@ -5040,8 +5112,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 @@ -5089,8 +5161,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) @@ -5106,7 +5178,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 @@ -5153,13 +5225,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 @@ -5181,7 +5253,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] @@ -5232,8 +5304,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) @@ -5249,7 +5321,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 @@ -5296,8 +5368,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) @@ -5313,7 +5385,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 @@ -5360,10 +5432,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) @@ -5379,7 +5451,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 | @@ -5428,10 +5500,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) @@ -5447,8 +5519,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 @@ -5496,8 +5568,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) @@ -5513,7 +5585,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 @@ -5560,8 +5632,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) @@ -5577,7 +5649,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 @@ -5624,13 +5696,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 @@ -5648,7 +5720,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] @@ -5697,8 +5769,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) @@ -5714,7 +5786,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 @@ -5761,13 +5833,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 @@ -5785,7 +5857,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] @@ -5834,8 +5906,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) @@ -5851,7 +5923,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 @@ -5898,8 +5970,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) @@ -5915,7 +5987,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 @@ -5962,7 +6034,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) @@ -6024,12 +6096,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 @@ -6047,7 +6119,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] @@ -6096,13 +6168,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 @@ -6120,7 +6192,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] @@ -6169,8 +6241,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) @@ -6186,7 +6258,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 @@ -6233,10 +6305,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) @@ -6252,7 +6324,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 | @@ -6301,10 +6373,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) @@ -6320,8 +6392,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 @@ -6369,8 +6441,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) @@ -6386,7 +6458,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 @@ -6433,8 +6505,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) @@ -6497,8 +6569,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) @@ -6514,7 +6586,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 @@ -6561,8 +6633,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) @@ -6578,7 +6650,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 @@ -6625,11 +6697,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 @@ -6695,8 +6767,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) @@ -6712,7 +6784,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 @@ -6759,23 +6831,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: 'searchTerm=Joe Bloggs' # String | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. + search_term: searchTerm=Joe Bloggs # String | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. } begin @@ -6793,10 +6865,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] @@ -6847,8 +6919,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 } @@ -6868,7 +6940,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 @@ -6916,8 +6988,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) @@ -6933,7 +7005,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 @@ -6980,10 +7052,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) @@ -6999,7 +7071,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 | @@ -7048,10 +7120,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) @@ -7067,8 +7139,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 @@ -7116,8 +7188,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) @@ -7133,7 +7205,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 @@ -7180,8 +7252,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) @@ -7197,7 +7269,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 @@ -7244,13 +7316,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 @@ -7272,7 +7344,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] @@ -7323,11 +7395,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 @@ -7393,8 +7465,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) @@ -7410,7 +7482,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 @@ -7457,13 +7529,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 @@ -7481,7 +7553,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] @@ -7530,8 +7602,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) @@ -7547,7 +7619,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 @@ -7594,8 +7666,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) @@ -7611,7 +7683,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 @@ -7658,13 +7730,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 @@ -7682,7 +7754,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] @@ -7731,8 +7803,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 } @@ -7752,7 +7824,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 @@ -7800,8 +7872,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) @@ -7817,7 +7889,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 @@ -7864,10 +7936,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) @@ -7883,7 +7955,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 | @@ -7932,10 +8004,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) @@ -7951,8 +8023,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 @@ -8000,8 +8072,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) @@ -8017,7 +8089,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 @@ -8064,8 +8136,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) @@ -8081,7 +8153,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 @@ -8128,7 +8200,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) @@ -8190,21 +8262,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 @@ -8214,7 +8286,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 @@ -8232,12 +8304,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] @@ -8290,8 +8362,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 } @@ -8311,7 +8383,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 @@ -8359,8 +8431,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) @@ -8376,7 +8448,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 @@ -8423,13 +8495,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 } @@ -8449,7 +8521,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] @@ -8499,8 +8571,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) @@ -8516,7 +8588,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 @@ -8563,7 +8635,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. @@ -8627,9 +8699,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 @@ -8651,7 +8723,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] @@ -8700,8 +8772,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) @@ -8717,7 +8789,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 @@ -8764,19 +8836,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 @@ -8795,11 +8867,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 @@ -8846,8 +8918,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) @@ -8863,7 +8935,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 @@ -8910,10 +8982,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) @@ -8929,7 +9001,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 | @@ -8978,10 +9050,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) @@ -8997,8 +9069,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 @@ -9046,8 +9118,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) @@ -9063,7 +9135,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 @@ -9110,13 +9182,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 } @@ -9136,7 +9208,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] @@ -9186,8 +9258,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) @@ -9203,7 +9275,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 @@ -9250,8 +9322,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) @@ -9267,7 +9339,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 @@ -9314,7 +9386,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) @@ -9376,8 +9448,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) @@ -9393,7 +9465,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 @@ -9440,7 +9512,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) @@ -9502,8 +9574,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) @@ -9519,7 +9591,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 @@ -9566,8 +9638,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) @@ -9583,7 +9655,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 @@ -9630,13 +9702,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 @@ -9658,7 +9730,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] @@ -9709,8 +9781,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) @@ -9726,7 +9798,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 @@ -9773,8 +9845,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) @@ -9790,7 +9862,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 @@ -9837,7 +9909,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) @@ -9899,13 +9971,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 } @@ -9925,7 +9997,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] @@ -9975,8 +10047,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) @@ -9992,7 +10064,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 @@ -10039,8 +10111,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) @@ -10056,7 +10128,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 @@ -10103,13 +10175,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 @@ -10131,7 +10203,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] @@ -10182,8 +10254,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) @@ -10199,7 +10271,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 @@ -10246,8 +10318,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) @@ -10263,7 +10335,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 @@ -10310,10 +10382,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) @@ -10329,7 +10401,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 | @@ -10378,10 +10450,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) @@ -10397,8 +10469,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 @@ -10446,8 +10518,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) @@ -10463,7 +10535,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 @@ -10510,8 +10582,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) @@ -10574,8 +10646,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) @@ -10591,7 +10663,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 @@ -10638,17 +10710,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. } @@ -10668,7 +10740,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] @@ -10720,8 +10792,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) @@ -10737,7 +10809,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 @@ -10784,8 +10856,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) @@ -10801,7 +10873,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 @@ -10848,10 +10920,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) @@ -10867,7 +10939,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 | @@ -10916,10 +10988,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) @@ -10935,8 +11007,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 @@ -10984,8 +11056,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) @@ -11001,7 +11073,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 @@ -11048,8 +11120,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) @@ -11065,7 +11137,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 @@ -11112,27 +11184,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 @@ -11150,12 +11222,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] @@ -11206,8 +11278,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 } @@ -11227,7 +11299,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 @@ -11275,10 +11347,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) @@ -11294,7 +11366,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 | @@ -11343,10 +11415,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) @@ -11362,8 +11434,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 @@ -11411,8 +11483,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) @@ -11428,7 +11500,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 @@ -11475,8 +11547,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) @@ -11492,7 +11564,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 @@ -11539,13 +11611,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 } @@ -11565,7 +11637,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] @@ -11615,8 +11687,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) @@ -11632,7 +11704,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 @@ -11679,10 +11751,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) @@ -11698,7 +11770,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 | @@ -11747,10 +11819,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) @@ -11766,8 +11838,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 @@ -11815,8 +11887,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) @@ -11832,7 +11904,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 @@ -11879,8 +11951,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) @@ -11896,7 +11968,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 @@ -11943,11 +12015,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 @@ -12013,14 +12085,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 @@ -12038,7 +12110,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] @@ -12088,14 +12160,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 @@ -12113,7 +12185,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] @@ -12163,17 +12235,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 @@ -12248,11 +12320,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 @@ -12318,9 +12390,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) @@ -12391,9 +12463,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 @@ -12458,8 +12530,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) @@ -12522,23 +12594,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 @@ -12616,9 +12688,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 @@ -12683,9 +12755,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 } @@ -12753,7 +12825,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) @@ -12815,13 +12887,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 @@ -12888,11 +12960,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 } @@ -12961,8 +13033,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) @@ -12978,7 +13050,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 @@ -13025,8 +13097,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) @@ -13042,7 +13114,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 @@ -13089,13 +13161,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 @@ -13113,7 +13185,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] @@ -13162,7 +13234,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 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 begin #Sets the chart of accounts, the conversion date and conversion balances @@ -13226,8 +13298,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 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 begin #Updates a chart of accounts @@ -13244,7 +13316,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 | **accounts** | [**Accounts**](Accounts.md)| Request of type Accounts array with one Account | ### Return type @@ -13292,10 +13364,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 -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 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) @@ -13311,7 +13383,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 | **body** | **String**| Byte array of file in body of request | @@ -13360,8 +13432,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 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 = { unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts @@ -13382,7 +13454,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 | **bank_transactions** | [**BankTransactions**](BankTransactions.md)| | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -13431,10 +13503,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 -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 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) @@ -13450,7 +13522,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 | **body** | **String**| Byte array of file in body of request | @@ -13499,10 +13571,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 -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 begin result = api_instance.update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) p result @@ -13517,7 +13589,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 | **body** | **String**| Byte array of file in body of request | @@ -13566,8 +13638,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 contacts = { "Contacts": [{ "ContactID": "00000000-0000-0000-0000-000000000000", "Name": "Thanos" }]} # Contacts | an array of Contacts containing single Contact object with properties to update begin #Updates a specific contact in a Xero organisation @@ -13584,7 +13656,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 | **contacts** | [**Contacts**](Contacts.md)| an array of Contacts containing single Contact object with properties to update | ### Return type @@ -13632,10 +13704,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 -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 begin result = api_instance.update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) p result @@ -13650,7 +13722,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 | **body** | **String**| Byte array of file in body of request | @@ -13699,8 +13771,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 contact_groups = { "ContactGroups":[ { "Name":"Suppliers" } ] } # ContactGroups | an array of Contact groups with Name of specific group to update begin #Updates a specific contact group @@ -13717,7 +13789,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 | **contact_groups** | [**ContactGroups**](ContactGroups.md)| an array of Contact groups with Name of specific group to update | ### Return type @@ -13765,8 +13837,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 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 = { unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts @@ -13787,7 +13859,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 | **credit_notes** | [**CreditNotes**](CreditNotes.md)| an array of Credit Notes containing credit note details to update | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -13836,10 +13908,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 -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 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) @@ -13855,7 +13927,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 | **body** | **String**| Byte array of file in body of request | @@ -13904,8 +13976,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 expense_claims = { "ExpenseClaims": [ { "Status": "SUBMITTED", "User": { "UserID": "d1164823-0ac1-41ad-987b-b4e30fe0b273" }, "Receipts": [ { "Lineitems": [], "ReceiptID": "dc1c7f6d-0a4c-402f-acac-551d62ce5816" } ] } ] } # ExpenseClaims | begin #Updates a specific expense claims @@ -13922,7 +13994,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 | **expense_claims** | [**ExpenseClaims**](ExpenseClaims.md)| | ### Return type @@ -13970,8 +14042,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 invoices = { "Invoices": [{ Reference: "May the force be with you", "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }]} # Invoices | opts = { unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts @@ -13992,7 +14064,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 | **invoices** | [**Invoices**](Invoices.md)| | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -14041,10 +14113,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 -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 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) @@ -14060,7 +14132,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 | **body** | **String**| Byte array of file in body of request | @@ -14109,8 +14181,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 items = { "Items": [ { "Code": "ItemCode123", "Description": "Description 123" } ] } # Items | opts = { unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts @@ -14131,7 +14203,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 | **items** | [**Items**](Items.md)| | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -14180,8 +14252,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 linked_transactions = { "LinkedTransactions": [ { "SourceTransactionID": "00000000-0000-0000-0000-000000000000", "SourceLineItemID": "00000000-0000-0000-0000-000000000000" } ] } # LinkedTransactions | begin #Updates a specific linked transactions (billable expenses) @@ -14198,7 +14270,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 | **linked_transactions** | [**LinkedTransactions**](LinkedTransactions.md)| | ### Return type @@ -14246,8 +14318,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 manual_journals = { "ManualJournals": [ { "Narration": "Hello Xero", "ManualJournalID": "00000000-0000-0000-0000-000000000000", "JournalLines": [] } ] } # ManualJournals | begin #Updates a specific manual journal @@ -14264,7 +14336,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 | **manual_journals** | [**ManualJournals**](ManualJournals.md)| | ### Return type @@ -14312,10 +14384,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 -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 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) @@ -14331,7 +14403,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 | **body** | **String**| Byte array of file in body of request | @@ -14380,10 +14452,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 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 + 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 } @@ -14452,10 +14524,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 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 + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -14521,10 +14593,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 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 + 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 } @@ -14593,10 +14665,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 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 + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -14662,10 +14734,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 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 + 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 } @@ -14734,10 +14806,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 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 + 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 } @@ -14806,10 +14878,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 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 + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -14875,10 +14947,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 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 + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -14944,10 +15016,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 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 + summarize_errors: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors } begin @@ -14982,6 +15054,75 @@ Name | Type | Description | Notes - **Accept**: application/json +## update_or_create_repeating_invoices + +> RepeatingInvoices update_or_create_repeating_invoices(xero_tenant_id, repeating_invoices, opts) + +Creates or deletes one or more repeating invoice templates + +### Example + +```ruby +# load the gem +require 'xero-ruby' + +creds = { + client_id: ENV['CLIENT_ID'], + client_secret: ENV['CLIENT_SECRET'], + redirect_uri: ENV['REDIRECT_URI'], + scopes: ENV['SCOPES'] +} +xero_client = XeroRuby::ApiClient.new(credentials: creds) + +token_set = fetch_valid_token_set(user) # example + +xero_client.refresh_token_set(token_set) + +# You need to namespace your api method call to one of the following api sets +# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api] + +api_instance = xero_client. + + + +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: true # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors +} + +begin + #Creates or deletes one or more repeating invoice templates + result = api_instance.update_or_create_repeating_invoices(xero_tenant_id, repeating_invoices, opts) + p result +rescue XeroRuby::Accounting::ApiError => e + puts "Exception when calling AccountingApi->update_or_create_repeating_invoices: #{e}" +end +``` + +### Parameters + + +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 | + **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 + +[**RepeatingInvoices**](RepeatingInvoices.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + ## update_purchase_order > PurchaseOrders update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders) @@ -15013,8 +15154,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 purchase_orders = { "PurchaseOrders": [ { "AttentionTo": "Peter Parker", "LineItems": [], "Contact": {} } ] } # PurchaseOrders | begin #Updates a specific purchase order @@ -15031,7 +15172,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 | **purchase_orders** | [**PurchaseOrders**](PurchaseOrders.md)| | ### Return type @@ -15079,10 +15220,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 -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 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) @@ -15098,7 +15239,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 | **body** | **String**| Byte array of file in body of request | @@ -15147,8 +15288,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 quotes = { "Quotes": [ { "Reference": "I am an update", "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "Date": "2020-02-01" } ] } # Quotes | begin #Updates a specific quote @@ -15165,7 +15306,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 | **quotes** | [**Quotes**](Quotes.md)| | ### Return type @@ -15213,10 +15354,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 -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 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) @@ -15232,7 +15373,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 | **body** | **String**| Byte array of file in body of request | @@ -15281,8 +15422,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 receipts = { "Receipts": [ { "Lineitems": [], "User": { "UserID": "00000000-0000-0000-0000-000000000000" }, "Reference": "Foobar" } ] } # Receipts | opts = { unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts @@ -15303,7 +15444,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 | **receipts** | [**Receipts**](Receipts.md)| | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] @@ -15352,10 +15493,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 -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 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) @@ -15371,7 +15512,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 | **body** | **String**| Byte array of file in body of request | @@ -15389,6 +15530,72 @@ Name | Type | Description | Notes - **Accept**: application/json +## update_repeating_invoice + +> RepeatingInvoices update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_invoices) + +Deletes a specific repeating invoice template + +### 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 +repeating_invoice_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for a Repeating Invoice +repeating_invoices = { "Status": "DELETED" } # RepeatingInvoices | +begin + #Deletes a specific repeating invoice template + result = api_instance.update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_invoices) + p result +rescue XeroRuby::Accounting::ApiError => e + puts "Exception when calling AccountingApi->update_repeating_invoice: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **String**| Xero identifier for Tenant | + **repeating_invoice_id** | **String**| Unique identifier for a Repeating Invoice | + **repeating_invoices** | [**RepeatingInvoices**](RepeatingInvoices.md)| | + +### Return type + +[**RepeatingInvoices**](RepeatingInvoices.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + ## update_repeating_invoice_attachment_by_file_name > Attachments update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) @@ -15420,10 +15627,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 -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 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) @@ -15439,7 +15646,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 | **body** | **String**| Byte array of file in body of request | @@ -15488,7 +15695,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 tax_rates = { "TaxRates": [ { "Name": "State Tax NY", "TaxComponents": [ { "Name": "State Tax", "Rate": 2.25 } ], "Status": "DELETED", "ReportTaxType": "INPUT" } ] } # TaxRates | begin #Updates tax rates @@ -15552,8 +15759,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 tracking_category = { "Name": "Avengers" } # TrackingCategory | begin #Updates a specific tracking category @@ -15570,7 +15777,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 | **tracking_category** | [**TrackingCategory**](TrackingCategory.md)| | ### Return type @@ -15618,9 +15825,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 tracking_option = { name: "Vision" } # TrackingOption | begin #Updates a specific option for a specific tracking category @@ -15637,8 +15844,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 | **tracking_option** | [**TrackingOption**](TrackingOption.md)| | ### Return type diff --git a/docs/accounting/RepeatingInvoice.md b/docs/accounting/RepeatingInvoice.md index 639fe0be..e234077f 100644 --- a/docs/accounting/RepeatingInvoice.md +++ b/docs/accounting/RepeatingInvoice.md @@ -18,8 +18,12 @@ Name | Type | Description | Notes **total** | **BigDecimal** | Total of Invoice tax inclusive (i.e. SubTotal + TotalTax) | [optional] **repeating_invoice_id** | **String** | Xero generated unique identifier for repeating invoice template | [optional] **id** | **String** | Xero generated unique identifier for repeating invoice template | [optional] -**has_attachments** | **Boolean** | boolean to indicate if an invoice has an attachment | [optional] [default to false] +**has_attachments** | **Boolean** | Boolean to indicate if an invoice has an attachment | [optional] [default to false] **attachments** | [**Array<Attachment>**](Attachment.md) | Displays array of attachments from the API | [optional] +**approved_for_sending** | **Boolean** | Boolean to indicate whether the invoice has been approved for sending | [optional] [default to false] +**send_copy** | **Boolean** | Boolean to indicate whether a copy is sent to sender's email | [optional] [default to false] +**mark_as_sent** | **Boolean** | Boolean to indicate whether the invoice in the Xero app displays as \"sent\" | [optional] [default to false] +**include_pdf** | **Boolean** | Boolean to indicate whether to include PDF attachment | [optional] [default to false] ## Code Sample @@ -41,7 +45,11 @@ instance = XeroRuby::Accounting::RepeatingInvoice.new(type: null, repeating_invoice_id: null, id: null, has_attachments: false, - attachments: null) + attachments: null, + approved_for_sending: false, + send_copy: false, + mark_as_sent: false, + include_pdf: false) ``` diff --git a/docs/accounting/index.html b/docs/accounting/index.html index 544796fb..06d3118a 100644 --- a/docs/accounting/index.html +++ b/docs/accounting/index.html @@ -6008,7 +6008,7 @@