xero-ruby 0.2.3 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CODE_OF_CONDUCT.md +76 -0
- data/CONTRIBUTING.md +82 -0
- data/Gemfile.lock +68 -0
- data/LICENSE +21 -0
- data/README.md +132 -438
- data/docs/{Account.md → accounting/Account.md} +5 -5
- data/docs/accounting/AccountType.md +16 -0
- data/docs/{AccountingApi.md → accounting/AccountingApi.md} +4973 -1782
- data/docs/{Accounts.md → accounting/Accounts.md} +3 -3
- data/docs/{AccountsPayable.md → accounting/AccountsPayable.md} +3 -3
- data/docs/{AccountsReceivable.md → accounting/AccountsReceivable.md} +3 -3
- data/docs/{Address.md → accounting/Address.md} +3 -3
- data/docs/accounting/Allocation.md +31 -0
- data/docs/{Allocations.md → accounting/Allocations.md} +3 -3
- data/docs/{Attachment.md → accounting/Attachment.md} +3 -3
- data/docs/{Attachments.md → accounting/Attachments.md} +3 -3
- data/docs/{Balances.md → accounting/Balances.md} +3 -3
- data/docs/{BankTransaction.md → accounting/BankTransaction.md} +5 -5
- data/docs/{BankTransactions.md → accounting/BankTransactions.md} +3 -3
- data/docs/{BankTransfer.md → accounting/BankTransfer.md} +6 -6
- data/docs/{BankTransfers.md → accounting/BankTransfers.md} +3 -3
- data/docs/{BatchPayment.md → accounting/BatchPayment.md} +4 -4
- data/docs/{BatchPaymentDetails.md → accounting/BatchPaymentDetails.md} +3 -3
- data/docs/{BatchPayments.md → accounting/BatchPayments.md} +3 -3
- data/docs/{Bill.md → accounting/Bill.md} +3 -3
- data/docs/{BrandingTheme.md → accounting/BrandingTheme.md} +3 -3
- data/docs/{BrandingThemes.md → accounting/BrandingThemes.md} +3 -3
- data/docs/{CISOrgSetting.md → accounting/CISOrgSetting.md} +3 -3
- data/docs/{CISSetting.md → accounting/CISSetting.md} +3 -3
- data/docs/{CISSettings.md → accounting/CISSettings.md} +3 -3
- data/docs/{Contact.md → accounting/Contact.md} +7 -7
- data/docs/{ContactGroup.md → accounting/ContactGroup.md} +3 -3
- data/docs/{ContactGroups.md → accounting/ContactGroups.md} +3 -3
- data/docs/{ContactPerson.md → accounting/ContactPerson.md} +3 -3
- data/docs/{Contacts.md → accounting/Contacts.md} +3 -3
- data/docs/accounting/CountryCode.md +16 -0
- data/docs/{CreditNote.md → accounting/CreditNote.md} +9 -7
- data/docs/{CreditNotes.md → accounting/CreditNotes.md} +3 -3
- data/docs/{Currencies.md → accounting/Currencies.md} +3 -3
- data/docs/{Currency.md → accounting/Currency.md} +3 -3
- data/docs/accounting/CurrencyCode.md +16 -0
- data/docs/{Element.md → accounting/Element.md} +3 -3
- data/docs/{Employee.md → accounting/Employee.md} +3 -3
- data/docs/{Employees.md → accounting/Employees.md} +3 -3
- data/docs/{Error.md → accounting/Error.md} +3 -3
- data/docs/{ExpenseClaim.md → accounting/ExpenseClaim.md} +3 -3
- data/docs/{ExpenseClaims.md → accounting/ExpenseClaims.md} +3 -3
- data/docs/{ExternalLink.md → accounting/ExternalLink.md} +3 -3
- data/docs/{HistoryRecord.md → accounting/HistoryRecord.md} +3 -3
- data/docs/{HistoryRecords.md → accounting/HistoryRecords.md} +3 -3
- data/docs/{Invoice.md → accounting/Invoice.md} +7 -7
- data/docs/{InvoiceReminder.md → accounting/InvoiceReminder.md} +3 -3
- data/docs/{InvoiceReminders.md → accounting/InvoiceReminders.md} +3 -3
- data/docs/{Invoices.md → accounting/Invoices.md} +3 -3
- data/docs/{Item.md → accounting/Item.md} +3 -3
- data/docs/{Items.md → accounting/Items.md} +3 -3
- data/docs/{Journal.md → accounting/Journal.md} +4 -4
- data/docs/{JournalLine.md → accounting/JournalLine.md} +3 -3
- data/docs/{Journals.md → accounting/Journals.md} +3 -3
- data/docs/accounting/LineAmountTypes.md +16 -0
- data/docs/{LineItem.md → accounting/LineItem.md} +3 -3
- data/docs/{LineItemTracking.md → accounting/LineItemTracking.md} +3 -3
- data/docs/{LinkedTransaction.md → accounting/LinkedTransaction.md} +3 -3
- data/docs/{LinkedTransactions.md → accounting/LinkedTransactions.md} +3 -3
- data/docs/{ManualJournal.md → accounting/ManualJournal.md} +5 -5
- data/docs/{ManualJournalLine.md → accounting/ManualJournalLine.md} +3 -3
- data/docs/{ManualJournals.md → accounting/ManualJournals.md} +3 -3
- data/docs/{OnlineInvoice.md → accounting/OnlineInvoice.md} +3 -3
- data/docs/{OnlineInvoices.md → accounting/OnlineInvoices.md} +3 -3
- data/docs/{Organisation.md → accounting/Organisation.md} +5 -3
- data/docs/{Organisations.md → accounting/Organisations.md} +3 -3
- data/docs/{Overpayment.md → accounting/Overpayment.md} +5 -5
- data/docs/{Overpayments.md → accounting/Overpayments.md} +3 -3
- data/docs/{Payment.md → accounting/Payment.md} +9 -7
- data/docs/{PaymentDelete.md → accounting/PaymentDelete.md} +3 -3
- data/docs/{PaymentService.md → accounting/PaymentService.md} +3 -3
- data/docs/{PaymentServices.md → accounting/PaymentServices.md} +3 -3
- data/docs/{PaymentTerm.md → accounting/PaymentTerm.md} +3 -3
- data/docs/{PaymentTermType.md → accounting/PaymentTermType.md} +3 -3
- data/docs/{Payments.md → accounting/Payments.md} +3 -3
- data/docs/{Phone.md → accounting/Phone.md} +3 -3
- data/docs/{Prepayment.md → accounting/Prepayment.md} +5 -5
- data/docs/{Prepayments.md → accounting/Prepayments.md} +3 -3
- data/docs/{Purchase.md → accounting/Purchase.md} +3 -3
- data/docs/{PurchaseOrder.md → accounting/PurchaseOrder.md} +5 -5
- data/docs/{PurchaseOrders.md → accounting/PurchaseOrders.md} +3 -3
- data/docs/{Quote.md → accounting/Quote.md} +8 -4
- data/docs/{QuoteLineAmountTypes.md → accounting/QuoteLineAmountTypes.md} +3 -3
- data/docs/{QuoteStatusCodes.md → accounting/QuoteStatusCodes.md} +3 -3
- data/docs/{Quotes.md → accounting/Quotes.md} +3 -3
- data/docs/{Receipt.md → accounting/Receipt.md} +5 -5
- data/docs/{Receipts.md → accounting/Receipts.md} +3 -3
- data/docs/{RepeatingInvoice.md → accounting/RepeatingInvoice.md} +5 -5
- data/docs/{RepeatingInvoices.md → accounting/RepeatingInvoices.md} +3 -3
- data/docs/{Report.md → accounting/Report.md} +3 -3
- data/docs/{ReportAttribute.md → accounting/ReportAttribute.md} +3 -3
- data/docs/{ReportCell.md → accounting/ReportCell.md} +3 -3
- data/docs/{ReportFields.md → accounting/ReportFields.md} +3 -3
- data/docs/{ReportRow.md → accounting/ReportRow.md} +3 -3
- data/docs/{ReportRows.md → accounting/ReportRows.md} +3 -3
- data/docs/{ReportWithRow.md → accounting/ReportWithRow.md} +3 -3
- data/docs/{ReportWithRows.md → accounting/ReportWithRows.md} +3 -3
- data/docs/{Reports.md → accounting/Reports.md} +3 -3
- data/docs/{RequestEmpty.md → accounting/RequestEmpty.md} +3 -3
- data/docs/{RowType.md → accounting/RowType.md} +3 -3
- data/docs/{SalesTrackingCategory.md → accounting/SalesTrackingCategory.md} +3 -3
- data/docs/{Schedule.md → accounting/Schedule.md} +3 -3
- data/docs/{TaxComponent.md → accounting/TaxComponent.md} +3 -3
- data/docs/{TaxRate.md → accounting/TaxRate.md} +3 -3
- data/docs/{TaxRates.md → accounting/TaxRates.md} +3 -3
- data/docs/{TaxType.md → accounting/TaxType.md} +3 -3
- data/docs/{TenNinteyNineContact.md → accounting/TenNinteyNineContact.md} +3 -3
- data/docs/{TimeZone.md → accounting/TimeZone.md} +3 -3
- data/docs/{TrackingCategories.md → accounting/TrackingCategories.md} +3 -3
- data/docs/{TrackingCategory.md → accounting/TrackingCategory.md} +3 -3
- data/docs/{TrackingOption.md → accounting/TrackingOption.md} +3 -3
- data/docs/{TrackingOptions.md → accounting/TrackingOptions.md} +3 -3
- data/docs/{User.md → accounting/User.md} +3 -3
- data/docs/{Users.md → accounting/Users.md} +3 -3
- data/docs/{ValidationError.md → accounting/ValidationError.md} +3 -3
- data/docs/assets/Asset.md +45 -0
- data/docs/assets/AssetApi.md +438 -0
- data/docs/{CurrencyCode.md → assets/AssetStatus.md} +3 -3
- data/docs/assets/AssetStatusQueryParam.md +16 -0
- data/docs/assets/AssetType.md +29 -0
- data/docs/assets/Assets.md +19 -0
- data/docs/assets/BookDepreciationDetail.md +29 -0
- data/docs/assets/BookDepreciationSetting.md +31 -0
- data/docs/assets/Error.md +25 -0
- data/docs/assets/FieldValidationErrorsElement.md +27 -0
- data/docs/assets/Pagination.md +23 -0
- data/docs/assets/ResourceValidationErrorsElement.md +25 -0
- data/docs/assets/Setting.md +31 -0
- data/docs/projects/Amount.md +19 -0
- data/docs/{AccountType.md → projects/ChargeType.md} +3 -3
- data/docs/{CountryCode.md → projects/CurrencyCode.md} +3 -3
- data/docs/projects/Error.md +19 -0
- data/docs/projects/Pagination.md +23 -0
- data/docs/projects/Project.md +59 -0
- data/docs/projects/ProjectApi.md +979 -0
- data/docs/projects/ProjectCreateOrUpdate.md +23 -0
- data/docs/projects/ProjectPatch.md +17 -0
- data/docs/{LineAmountTypes.md → projects/ProjectStatus.md} +3 -3
- data/docs/projects/ProjectUser.md +21 -0
- data/docs/projects/ProjectUsers.md +19 -0
- data/docs/projects/Projects.md +19 -0
- data/docs/projects/Task.md +45 -0
- data/docs/projects/TaskCreateOrUpdate.md +23 -0
- data/docs/projects/Tasks.md +19 -0
- data/docs/projects/TimeEntries.md +19 -0
- data/docs/projects/TimeEntry.md +33 -0
- data/docs/projects/TimeEntryCreateOrUpdate.md +25 -0
- data/lib/xero-ruby.rb +148 -122
- data/lib/xero-ruby/api/accounting_api.rb +165 -42
- data/lib/xero-ruby/api/asset_api.rb +452 -0
- data/lib/xero-ruby/api/project_api.rb +1035 -0
- data/lib/xero-ruby/api_client.rb +172 -44
- data/lib/xero-ruby/api_error.rb +2 -2
- data/lib/xero-ruby/configuration.rb +35 -22
- data/lib/xero-ruby/models/{account.rb → accounting/account.rb} +62 -24
- data/lib/xero-ruby/models/{account_type.rb → accounting/account_type.rb} +3 -3
- data/lib/xero-ruby/models/{accounts.rb → accounting/accounts.rb} +8 -7
- data/lib/xero-ruby/models/{accounts_payable.rb → accounting/accounts_payable.rb} +9 -7
- data/lib/xero-ruby/models/{accounts_receivable.rb → accounting/accounts_receivable.rb} +9 -7
- data/lib/xero-ruby/models/{address.rb → accounting/address.rb} +19 -16
- data/lib/xero-ruby/models/accounting/allocation.rb +291 -0
- data/lib/xero-ruby/models/{allocations.rb → accounting/allocations.rb} +8 -7
- data/lib/xero-ruby/models/{attachment.rb → accounting/attachment.rb} +12 -12
- data/lib/xero-ruby/models/{attachments.rb → accounting/attachments.rb} +8 -7
- data/lib/xero-ruby/models/{balances.rb → accounting/balances.rb} +9 -7
- data/lib/xero-ruby/models/{bank_transaction.rb → accounting/bank_transaction.rb} +41 -24
- data/lib/xero-ruby/models/{bank_transactions.rb → accounting/bank_transactions.rb} +8 -7
- data/lib/xero-ruby/models/{bank_transfer.rb → accounting/bank_transfer.rb} +21 -17
- data/lib/xero-ruby/models/{bank_transfers.rb → accounting/bank_transfers.rb} +8 -7
- data/lib/xero-ruby/models/{batch_payment.rb → accounting/batch_payment.rb} +28 -22
- data/lib/xero-ruby/models/{batch_payment_details.rb → accounting/batch_payment_details.rb} +11 -11
- data/lib/xero-ruby/models/{batch_payments.rb → accounting/batch_payments.rb} +8 -7
- data/lib/xero-ruby/models/{bill.rb → accounting/bill.rb} +8 -7
- data/lib/xero-ruby/models/{branding_theme.rb → accounting/branding_theme.rb} +13 -12
- data/lib/xero-ruby/models/{branding_themes.rb → accounting/branding_themes.rb} +8 -7
- data/lib/xero-ruby/models/{cis_org_setting.rb → accounting/cis_org_setting.rb} +9 -9
- data/lib/xero-ruby/models/{cis_setting.rb → accounting/cis_setting.rb} +8 -8
- data/lib/xero-ruby/models/{cis_settings.rb → accounting/cis_settings.rb} +8 -7
- data/lib/xero-ruby/models/{contact.rb → accounting/contact.rb} +52 -40
- data/lib/xero-ruby/models/{contact_group.rb → accounting/contact_group.rb} +12 -10
- data/lib/xero-ruby/models/{contact_groups.rb → accounting/contact_groups.rb} +8 -7
- data/lib/xero-ruby/models/{contact_person.rb → accounting/contact_person.rb} +10 -10
- data/lib/xero-ruby/models/{contacts.rb → accounting/contacts.rb} +8 -7
- data/lib/xero-ruby/models/{country_code.rb → accounting/country_code.rb} +3 -3
- data/lib/xero-ruby/models/{credit_note.rb → accounting/credit_note.rb} +54 -29
- data/lib/xero-ruby/models/{credit_notes.rb → accounting/credit_notes.rb} +8 -7
- data/lib/xero-ruby/models/{currencies.rb → accounting/currencies.rb} +8 -7
- data/lib/xero-ruby/models/{currency.rb → accounting/currency.rb} +9 -8
- data/lib/xero-ruby/models/{currency_code.rb → accounting/currency_code.rb} +5 -5
- data/lib/xero-ruby/models/{element.rb → accounting/element.rb} +14 -8
- data/lib/xero-ruby/models/{employee.rb → accounting/employee.rb} +17 -12
- data/lib/xero-ruby/models/{employees.rb → accounting/employees.rb} +8 -7
- data/lib/xero-ruby/models/{error.rb → accounting/error.rb} +10 -10
- data/lib/xero-ruby/models/{expense_claim.rb → accounting/expense_claim.rb} +23 -16
- data/lib/xero-ruby/models/{expense_claims.rb → accounting/expense_claims.rb} +8 -7
- data/lib/xero-ruby/models/{external_link.rb → accounting/external_link.rb} +14 -8
- data/lib/xero-ruby/models/{history_record.rb → accounting/history_record.rb} +10 -10
- data/lib/xero-ruby/models/{history_records.rb → accounting/history_records.rb} +8 -7
- data/lib/xero-ruby/models/{invoice.rb → accounting/invoice.rb} +62 -41
- data/lib/xero-ruby/models/{invoice_reminder.rb → accounting/invoice_reminder.rb} +7 -7
- data/lib/xero-ruby/models/{invoice_reminders.rb → accounting/invoice_reminders.rb} +8 -7
- data/lib/xero-ruby/models/{invoices.rb → accounting/invoices.rb} +8 -7
- data/lib/xero-ruby/models/{item.rb → accounting/item.rb} +22 -20
- data/lib/xero-ruby/models/{items.rb → accounting/items.rb} +8 -7
- data/lib/xero-ruby/models/{journal.rb → accounting/journal.rb} +40 -15
- data/lib/xero-ruby/models/{journal_line.rb → accounting/journal_line.rb} +18 -17
- data/lib/xero-ruby/models/{journals.rb → accounting/journals.rb} +8 -7
- data/lib/xero-ruby/models/{line_amount_types.rb → accounting/line_amount_types.rb} +3 -3
- data/lib/xero-ruby/models/{line_item.rb → accounting/line_item.rb} +19 -19
- data/lib/xero-ruby/models/{line_item_tracking.rb → accounting/line_item_tracking.rb} +10 -10
- data/lib/xero-ruby/models/{linked_transaction.rb → accounting/linked_transaction.rb} +25 -17
- data/lib/xero-ruby/models/{linked_transactions.rb → accounting/linked_transactions.rb} +8 -7
- data/lib/xero-ruby/models/{manual_journal.rb → accounting/manual_journal.rb} +27 -19
- data/lib/xero-ruby/models/{manual_journal_line.rb → accounting/manual_journal_line.rb} +13 -13
- data/lib/xero-ruby/models/{manual_journals.rb → accounting/manual_journals.rb} +8 -7
- data/lib/xero-ruby/models/{online_invoice.rb → accounting/online_invoice.rb} +7 -7
- data/lib/xero-ruby/models/{online_invoices.rb → accounting/online_invoices.rb} +8 -7
- data/lib/xero-ruby/models/{organisation.rb → accounting/organisation.rb} +107 -47
- data/lib/xero-ruby/models/{organisations.rb → accounting/organisations.rb} +8 -7
- data/lib/xero-ruby/models/{overpayment.rb → accounting/overpayment.rb} +33 -22
- data/lib/xero-ruby/models/{overpayments.rb → accounting/overpayments.rb} +8 -7
- data/lib/xero-ruby/models/{payment.rb → accounting/payment.rb} +55 -26
- data/lib/xero-ruby/models/{payment_delete.rb → accounting/payment_delete.rb} +7 -7
- data/lib/xero-ruby/models/{payment_service.rb → accounting/payment_service.rb} +12 -12
- data/lib/xero-ruby/models/{payment_services.rb → accounting/payment_services.rb} +8 -7
- data/lib/xero-ruby/models/{payment_term.rb → accounting/payment_term.rb} +9 -7
- data/lib/xero-ruby/models/{payment_term_type.rb → accounting/payment_term_type.rb} +3 -3
- data/lib/xero-ruby/models/{payments.rb → accounting/payments.rb} +8 -7
- data/lib/xero-ruby/models/{phone.rb → accounting/phone.rb} +16 -10
- data/lib/xero-ruby/models/{prepayment.rb → accounting/prepayment.rb} +34 -22
- data/lib/xero-ruby/models/{prepayments.rb → accounting/prepayments.rb} +8 -7
- data/lib/xero-ruby/models/{purchase.rb → accounting/purchase.rb} +10 -10
- data/lib/xero-ruby/models/{purchase_order.rb → accounting/purchase_order.rb} +42 -32
- data/lib/xero-ruby/models/{purchase_orders.rb → accounting/purchase_orders.rb} +8 -7
- data/lib/xero-ruby/models/{quote.rb → accounting/quote.rb} +54 -28
- data/lib/xero-ruby/models/{quote_line_amount_types.rb → accounting/quote_line_amount_types.rb} +3 -3
- data/lib/xero-ruby/models/{quote_status_codes.rb → accounting/quote_status_codes.rb} +3 -3
- data/lib/xero-ruby/models/{quotes.rb → accounting/quotes.rb} +8 -7
- data/lib/xero-ruby/models/{receipt.rb → accounting/receipt.rb} +31 -20
- data/lib/xero-ruby/models/{receipts.rb → accounting/receipts.rb} +8 -7
- data/lib/xero-ruby/models/{repeating_invoice.rb → accounting/repeating_invoice.rb} +29 -18
- data/lib/xero-ruby/models/{repeating_invoices.rb → accounting/repeating_invoices.rb} +8 -7
- data/lib/xero-ruby/models/{report.rb → accounting/report.rb} +14 -12
- data/lib/xero-ruby/models/{report_attribute.rb → accounting/report_attribute.rb} +9 -7
- data/lib/xero-ruby/models/{report_cell.rb → accounting/report_cell.rb} +9 -7
- data/lib/xero-ruby/models/{report_fields.rb → accounting/report_fields.rb} +10 -7
- data/lib/xero-ruby/models/{report_row.rb → accounting/report_row.rb} +10 -7
- data/lib/xero-ruby/models/{report_rows.rb → accounting/report_rows.rb} +11 -7
- data/lib/xero-ruby/models/{report_with_row.rb → accounting/report_with_row.rb} +15 -13
- data/lib/xero-ruby/models/{report_with_rows.rb → accounting/report_with_rows.rb} +8 -7
- data/lib/xero-ruby/models/{reports.rb → accounting/reports.rb} +8 -7
- data/lib/xero-ruby/models/{request_empty.rb → accounting/request_empty.rb} +7 -7
- data/lib/xero-ruby/models/{row_type.rb → accounting/row_type.rb} +3 -3
- data/lib/xero-ruby/models/{sales_tracking_category.rb → accounting/sales_tracking_category.rb} +8 -8
- data/lib/xero-ruby/models/{schedule.rb → accounting/schedule.rb} +23 -15
- data/lib/xero-ruby/models/{tax_component.rb → accounting/tax_component.rb} +10 -10
- data/lib/xero-ruby/models/{tax_rate.rb → accounting/tax_rate.rb} +98 -20
- data/lib/xero-ruby/models/{tax_rates.rb → accounting/tax_rates.rb} +8 -7
- data/lib/xero-ruby/models/{tax_type.rb → accounting/tax_type.rb} +7 -3
- data/lib/xero-ruby/models/{ten_nintey_nine_contact.rb → accounting/ten_nintey_nine_contact.rb} +28 -28
- data/lib/xero-ruby/models/{time_zone.rb → accounting/time_zone.rb} +3 -3
- data/lib/xero-ruby/models/{tracking_categories.rb → accounting/tracking_categories.rb} +8 -7
- data/lib/xero-ruby/models/{tracking_category.rb → accounting/tracking_category.rb} +15 -12
- data/lib/xero-ruby/models/{tracking_option.rb → accounting/tracking_option.rb} +13 -10
- data/lib/xero-ruby/models/{tracking_options.rb → accounting/tracking_options.rb} +8 -7
- data/lib/xero-ruby/models/{user.rb → accounting/user.rb} +20 -13
- data/lib/xero-ruby/models/{users.rb → accounting/users.rb} +8 -7
- data/lib/xero-ruby/models/{validation_error.rb → accounting/validation_error.rb} +7 -7
- data/lib/xero-ruby/models/assets/asset.rb +349 -0
- data/lib/xero-ruby/models/assets/asset_status.rb +38 -0
- data/lib/xero-ruby/models/assets/asset_status_query_param.rb +38 -0
- data/lib/xero-ruby/models/assets/asset_type.rb +274 -0
- data/lib/xero-ruby/models/assets/assets.rb +216 -0
- data/lib/xero-ruby/models/assets/book_depreciation_detail.rb +264 -0
- data/lib/xero-ruby/models/assets/book_depreciation_setting.rb +343 -0
- data/lib/xero-ruby/models/assets/error.rb +248 -0
- data/lib/xero-ruby/models/assets/field_validation_errors_element.rb +254 -0
- data/lib/xero-ruby/models/assets/pagination.rb +234 -0
- data/lib/xero-ruby/models/assets/resource_validation_errors_element.rb +244 -0
- data/lib/xero-ruby/models/assets/setting.rb +274 -0
- data/lib/xero-ruby/models/projects/amount.rb +214 -0
- data/lib/xero-ruby/models/projects/charge_type.rb +38 -0
- data/lib/xero-ruby/models/projects/currency_code.rb +199 -0
- data/lib/xero-ruby/models/projects/error.rb +214 -0
- data/lib/xero-ruby/models/{allocation.rb → projects/pagination.rb} +44 -48
- data/lib/xero-ruby/models/projects/project.rb +419 -0
- data/lib/xero-ruby/models/projects/project_create_or_update.rb +239 -0
- data/lib/xero-ruby/models/projects/project_patch.rb +209 -0
- data/lib/xero-ruby/models/projects/project_status.rb +37 -0
- data/lib/xero-ruby/models/projects/project_user.rb +224 -0
- data/lib/xero-ruby/models/projects/project_users.rb +216 -0
- data/lib/xero-ruby/models/projects/projects.rb +216 -0
- data/lib/xero-ruby/models/projects/task.rb +381 -0
- data/lib/xero-ruby/models/projects/task_create_or_update.rb +249 -0
- data/lib/xero-ruby/models/projects/tasks.rb +216 -0
- data/lib/xero-ruby/models/projects/time_entries.rb +216 -0
- data/lib/xero-ruby/models/projects/time_entry.rb +320 -0
- data/lib/xero-ruby/models/projects/time_entry_create_or_update.rb +264 -0
- data/lib/xero-ruby/version.rb +3 -3
- data/spec/{api → accounting/api}/accounting_api_spec.rb +44 -20
- data/spec/{models → accounting/models}/account_spec.rb +5 -5
- data/spec/{models → accounting/models}/account_type_spec.rb +5 -5
- data/spec/{models → accounting/models}/accounts_payable_spec.rb +5 -5
- data/spec/{models → accounting/models}/accounts_receivable_spec.rb +5 -5
- data/spec/{models → accounting/models}/accounts_spec.rb +5 -5
- data/spec/{models → accounting/models}/address_spec.rb +5 -5
- data/spec/{models → accounting/models}/allocation_spec.rb +5 -5
- data/spec/{models → accounting/models}/allocations_spec.rb +5 -5
- data/spec/{models → accounting/models}/attachment_spec.rb +5 -5
- data/spec/{models → accounting/models}/attachments_spec.rb +5 -5
- data/spec/{models → accounting/models}/balances_spec.rb +5 -5
- data/spec/{models → accounting/models}/bank_transaction_spec.rb +5 -5
- data/spec/{models → accounting/models}/bank_transactions_spec.rb +5 -5
- data/spec/{models → accounting/models}/bank_transfer_spec.rb +5 -5
- data/spec/{models → accounting/models}/bank_transfers_spec.rb +5 -5
- data/spec/{models → accounting/models}/batch_payment_details_spec.rb +5 -5
- data/spec/{models → accounting/models}/batch_payment_spec.rb +5 -5
- data/spec/{models → accounting/models}/batch_payments_spec.rb +5 -5
- data/spec/{models → accounting/models}/bill_spec.rb +5 -5
- data/spec/{models → accounting/models}/branding_theme_spec.rb +5 -5
- data/spec/{models → accounting/models}/branding_themes_spec.rb +5 -5
- data/spec/{models → accounting/models}/cis_org_setting_spec.rb +5 -5
- data/spec/{models → accounting/models}/cis_setting_spec.rb +5 -5
- data/spec/{models → accounting/models}/cis_settings_spec.rb +5 -5
- data/spec/{models → accounting/models}/contact_group_spec.rb +5 -5
- data/spec/{models → accounting/models}/contact_groups_spec.rb +5 -5
- data/spec/{models → accounting/models}/contact_person_spec.rb +5 -5
- data/spec/{models → accounting/models}/contact_spec.rb +5 -5
- data/spec/{models → accounting/models}/contacts_spec.rb +5 -5
- data/spec/{models → accounting/models}/country_code_spec.rb +5 -5
- data/spec/{models → accounting/models}/credit_note_spec.rb +11 -5
- data/spec/{models → accounting/models}/credit_notes_spec.rb +5 -5
- data/spec/{models → accounting/models}/currencies_spec.rb +5 -5
- data/spec/{models → accounting/models}/currency_code_spec.rb +5 -5
- data/spec/{models → accounting/models}/currency_spec.rb +5 -5
- data/spec/{models → accounting/models}/element_spec.rb +5 -5
- data/spec/{models → accounting/models}/employee_spec.rb +5 -5
- data/spec/{models → accounting/models}/employees_spec.rb +5 -5
- data/spec/{models → accounting/models}/error_spec.rb +5 -5
- data/spec/{models → accounting/models}/expense_claim_spec.rb +5 -5
- data/spec/{models → accounting/models}/expense_claims_spec.rb +5 -5
- data/spec/{models → accounting/models}/external_link_spec.rb +5 -5
- data/spec/{models → accounting/models}/history_record_spec.rb +5 -5
- data/spec/{models → accounting/models}/history_records_spec.rb +5 -5
- data/spec/{models → accounting/models}/invoice_reminder_spec.rb +5 -5
- data/spec/{models → accounting/models}/invoice_reminders_spec.rb +5 -5
- data/spec/{models → accounting/models}/invoice_spec.rb +6 -6
- data/spec/{models → accounting/models}/invoices_spec.rb +5 -5
- data/spec/{models → accounting/models}/item_spec.rb +5 -5
- data/spec/{models → accounting/models}/items_spec.rb +5 -5
- data/spec/{models → accounting/models}/journal_line_spec.rb +5 -5
- data/spec/{models → accounting/models}/journal_spec.rb +5 -5
- data/spec/{models → accounting/models}/journals_spec.rb +5 -5
- data/spec/{models → accounting/models}/line_amount_types_spec.rb +5 -5
- data/spec/{models → accounting/models}/line_item_spec.rb +5 -5
- data/spec/{models → accounting/models}/line_item_tracking_spec.rb +5 -5
- data/spec/{models → accounting/models}/linked_transaction_spec.rb +5 -5
- data/spec/{models → accounting/models}/linked_transactions_spec.rb +5 -5
- data/spec/{models → accounting/models}/manual_journal_line_spec.rb +5 -5
- data/spec/{models → accounting/models}/manual_journal_spec.rb +5 -5
- data/spec/{models → accounting/models}/manual_journals_spec.rb +5 -5
- data/spec/{models → accounting/models}/online_invoice_spec.rb +5 -5
- data/spec/{models → accounting/models}/online_invoices_spec.rb +5 -5
- data/spec/{models → accounting/models}/organisation_spec.rb +5 -5
- data/spec/{models → accounting/models}/organisations_spec.rb +5 -5
- data/spec/{models → accounting/models}/overpayment_spec.rb +5 -5
- data/spec/{models → accounting/models}/overpayments_spec.rb +5 -5
- data/spec/{models → accounting/models}/payment_delete_spec.rb +5 -5
- data/spec/{models → accounting/models}/payment_service_spec.rb +5 -5
- data/spec/{models → accounting/models}/payment_services_spec.rb +5 -5
- data/spec/{models → accounting/models}/payment_spec.rb +11 -5
- data/spec/{models → accounting/models}/payment_term_spec.rb +5 -5
- data/spec/{models → accounting/models}/payment_term_type_spec.rb +5 -5
- data/spec/{models → accounting/models}/payments_spec.rb +5 -5
- data/spec/{models → accounting/models}/phone_spec.rb +5 -5
- data/spec/{models → accounting/models}/prepayment_spec.rb +5 -5
- data/spec/{models → accounting/models}/prepayments_spec.rb +5 -5
- data/spec/{models → accounting/models}/purchase_order_spec.rb +5 -5
- data/spec/{models → accounting/models}/purchase_orders_spec.rb +5 -5
- data/spec/{models → accounting/models}/purchase_spec.rb +5 -5
- data/spec/{models → accounting/models}/quote_line_amount_types_spec.rb +5 -5
- data/spec/{models → accounting/models}/quote_spec.rb +5 -5
- data/spec/{models → accounting/models}/quote_status_codes_spec.rb +5 -5
- data/spec/{models → accounting/models}/quotes_spec.rb +5 -5
- data/spec/{models → accounting/models}/receipt_spec.rb +5 -5
- data/spec/{models → accounting/models}/receipts_spec.rb +5 -5
- data/spec/{models → accounting/models}/repeating_invoice_spec.rb +5 -5
- data/spec/{models → accounting/models}/repeating_invoices_spec.rb +5 -5
- data/spec/{models → accounting/models}/report_attribute_spec.rb +5 -5
- data/spec/{models → accounting/models}/report_cell_spec.rb +5 -5
- data/spec/{models → accounting/models}/report_fields_spec.rb +5 -5
- data/spec/{models → accounting/models}/report_row_spec.rb +5 -5
- data/spec/{models → accounting/models}/report_rows_spec.rb +5 -5
- data/spec/{models → accounting/models}/report_spec.rb +5 -5
- data/spec/{models → accounting/models}/report_with_row_spec.rb +5 -5
- data/spec/{models → accounting/models}/report_with_rows_spec.rb +5 -5
- data/spec/{models → accounting/models}/reports_spec.rb +5 -5
- data/spec/{models → accounting/models}/request_empty_spec.rb +5 -5
- data/spec/{models → accounting/models}/row_type_spec.rb +5 -5
- data/spec/{models → accounting/models}/sales_tracking_category_spec.rb +5 -5
- data/spec/{models → accounting/models}/schedule_spec.rb +5 -5
- data/spec/{models → accounting/models}/tax_component_spec.rb +5 -5
- data/spec/{models → accounting/models}/tax_rate_spec.rb +6 -6
- data/spec/{models → accounting/models}/tax_rates_spec.rb +5 -5
- data/spec/{models → accounting/models}/tax_type_spec.rb +5 -5
- data/spec/{models → accounting/models}/ten_nintey_nine_contact_spec.rb +5 -5
- data/spec/{models → accounting/models}/time_zone_spec.rb +5 -5
- data/spec/{models → accounting/models}/tracking_categories_spec.rb +5 -5
- data/spec/{models → accounting/models}/tracking_category_spec.rb +5 -5
- data/spec/{models → accounting/models}/tracking_option_spec.rb +5 -5
- data/spec/{models → accounting/models}/tracking_options_spec.rb +5 -5
- data/spec/{models → accounting/models}/user_spec.rb +5 -5
- data/spec/{models → accounting/models}/users_spec.rb +5 -5
- data/spec/{models → accounting/models}/validation_error_spec.rb +5 -5
- data/spec/api_client_spec.rb +5 -43
- data/spec/assets/api/asset_api_spec.rb +116 -0
- data/spec/assets/models/asset_spec.rb +125 -0
- data/spec/assets/models/asset_status_query_param_spec.rb +35 -0
- data/spec/assets/models/asset_status_spec.rb +35 -0
- data/spec/assets/models/asset_type_spec.rb +77 -0
- data/spec/assets/models/assets_spec.rb +47 -0
- data/spec/assets/models/book_depreciation_detail_spec.rb +77 -0
- data/spec/assets/models/book_depreciation_setting_spec.rb +95 -0
- data/spec/assets/models/error_spec.rb +65 -0
- data/spec/assets/models/field_validation_errors_element_spec.rb +71 -0
- data/spec/assets/models/pagination_spec.rb +59 -0
- data/spec/assets/models/resource_validation_errors_element_spec.rb +65 -0
- data/spec/assets/models/setting_spec.rb +83 -0
- data/spec/configuration_spec.rb +7 -23
- data/spec/projects/api/project_api_spec.rb +229 -0
- data/spec/projects/models/amount_spec.rb +47 -0
- data/spec/projects/models/charge_type_spec.rb +35 -0
- data/spec/projects/models/currency_code_spec.rb +35 -0
- data/spec/projects/models/error_spec.rb +47 -0
- data/spec/projects/models/pagination_spec.rb +59 -0
- data/spec/projects/models/project_create_or_update_spec.rb +59 -0
- data/spec/projects/models/project_patch_spec.rb +41 -0
- data/spec/projects/models/project_spec.rb +167 -0
- data/spec/projects/models/project_status_spec.rb +35 -0
- data/spec/projects/models/project_user_spec.rb +53 -0
- data/spec/projects/models/project_users_spec.rb +47 -0
- data/spec/projects/models/projects_spec.rb +47 -0
- data/spec/projects/models/task_create_or_update_spec.rb +59 -0
- data/spec/projects/models/task_spec.rb +129 -0
- data/spec/projects/models/tasks_spec.rb +47 -0
- data/spec/projects/models/time_entries_spec.rb +47 -0
- data/spec/projects/models/time_entry_create_or_update_spec.rb +65 -0
- data/spec/projects/models/time_entry_spec.rb +93 -0
- data/spec/spec_helper.rb +2 -2
- data/xero-ruby.gem +0 -0
- data/xero-ruby.gemspec +4 -4
- metadata +611 -482
- data/docs/Allocation.md +0 -21
- data/lib/.DS_Store +0 -0
- data/pkg/xero-ruby-0.1.3.gem +0 -0
- data/pkg/xero-ruby-0.2.2.gem +0 -0
- data/pkg/xero-ruby-0.2.3.gem +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b7e332228c5727298e0b8c261d41c8045836097801b3394df3e4162113ddcac1
|
|
4
|
+
data.tar.gz: f140c421f16483696de6b103c9a56abdb38719174a11ac8d64aa14bf3c29a41b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 23448878790a25e553a847cab323c44b8588d18bd365a5dd0c9f32fefad1c38cdad24647fbd84935c4d75e15d725829ba8a12072561615c1ff90635b69ce098c
|
|
7
|
+
data.tar.gz: a63e52f263263545f63e1b402ffb29d1ada1d5dff9bdb7ccc9ba0a728458d8e18643f144590f41948f356b9b00b32135a00e06aefe4bc57cbddb41efc5876c7d
|
data/CODE_OF_CONDUCT.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
|
8
|
+
size, disability, ethnicity, sex characteristics, gender identity and expression,
|
|
9
|
+
level of experience, education, socio-economic status, nationality, personal
|
|
10
|
+
appearance, race, religion, or sexual identity and orientation.
|
|
11
|
+
|
|
12
|
+
## Our Standards
|
|
13
|
+
|
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
|
15
|
+
include:
|
|
16
|
+
|
|
17
|
+
* Using welcoming and inclusive language
|
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
|
19
|
+
* Gracefully accepting constructive criticism
|
|
20
|
+
* Focusing on what is best for the community
|
|
21
|
+
* Showing empathy towards other community members
|
|
22
|
+
|
|
23
|
+
Examples of unacceptable behavior by participants include:
|
|
24
|
+
|
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
|
26
|
+
advances
|
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
|
28
|
+
* Public or private harassment
|
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
|
30
|
+
address, without explicit permission
|
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
32
|
+
professional setting
|
|
33
|
+
|
|
34
|
+
## Our Responsibilities
|
|
35
|
+
|
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
|
38
|
+
response to any instances of unacceptable behavior.
|
|
39
|
+
|
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
|
44
|
+
threatening, offensive, or harmful.
|
|
45
|
+
|
|
46
|
+
## Scope
|
|
47
|
+
|
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
|
49
|
+
when an individual is representing the project or its community. Examples of
|
|
50
|
+
representing a project or community include using an official project e-mail
|
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
|
53
|
+
further defined and clarified by project maintainers.
|
|
54
|
+
|
|
55
|
+
## Enforcement
|
|
56
|
+
|
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
58
|
+
reported by contacting the project team at api@xero.com. All
|
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
|
63
|
+
|
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
|
66
|
+
members of the project's leadership.
|
|
67
|
+
|
|
68
|
+
## Attribution
|
|
69
|
+
|
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
|
71
|
+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
|
72
|
+
|
|
73
|
+
[homepage]: https://www.contributor-covenant.org
|
|
74
|
+
|
|
75
|
+
For answers to common questions about this code of conduct, see
|
|
76
|
+
https://www.contributor-covenant.org/faq
|
data/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# Contributing to xero-ruby
|
|
2
|
+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
|
|
3
|
+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
|
|
4
|
+
|
|
5
|
+
We want to make contributing to this project as easy and transparent as possible, whether it's:
|
|
6
|
+
|
|
7
|
+
The following is a set of guidelines for contributing to Xero and its projects, which are hosted in the [XeroAPI Organization](https://github.com/XeroAPI) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
|
|
8
|
+
|
|
9
|
+
### Table Of Contents
|
|
10
|
+
[Code of Conduct](#code-of-conduct)
|
|
11
|
+
|
|
12
|
+
[I don't want to read this whole thing, I just have a question!!!](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question)
|
|
13
|
+
|
|
14
|
+
[How Can I Contribute?](#how-can-i-contribute)
|
|
15
|
+
* [Which version of SDK are you using?](#Which-version-of-the-SDK-are-you-using)
|
|
16
|
+
* [Reporting Bugs](#reporting-bugs)
|
|
17
|
+
* [Suggesting Enhancements](#suggesting-enhancements)
|
|
18
|
+
* [Pull Requests](#pull-requests)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
## Code of Conduct
|
|
22
|
+
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/XeroAPI/xero-ruby/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
|
|
23
|
+
|
|
24
|
+
## I don't want to read this whole thing I just have a question!!!
|
|
25
|
+
|
|
26
|
+
> **Note:** Please don't file an issue to ask a question. You'll get faster results by using the resources below.
|
|
27
|
+
We have an official [message board](https://community.xero.com/developer) where Xero API support and the community chimes in with helpful advice if you have questions.
|
|
28
|
+
|
|
29
|
+
* [API Documentation](https://developer.xero.com/documentation/)
|
|
30
|
+
* [Xero FAQ](https://developer.xero.com/faq)
|
|
31
|
+
* [Community, the official Xero message board](https://community.xero.com/developer)
|
|
32
|
+
* [Stackoverflow - Xero related](https://stackoverflow.com/questions/tagged/xero-api?sort=Newest)
|
|
33
|
+
* [Submit requests for support](https://developer.xero.com/contact-xero-developer-platform-support/) to our API Support team.
|
|
34
|
+
|
|
35
|
+
# How Can I Contribute?
|
|
36
|
+
|
|
37
|
+
You can contribute by reporting bugs, suggesting enhancements, improving documentation i.e. [README](https://github.com/XeroAPI/xero-ruby/README.md) or submitting a pull request.
|
|
38
|
+
|
|
39
|
+
## Reporting Bugs
|
|
40
|
+
|
|
41
|
+
Bugs are tracked as issues in this repository.
|
|
42
|
+
|
|
43
|
+
Before opening a new issue:
|
|
44
|
+
* **check [the README](https://github.com/XeroAPI/xero-ruby/README.md)** to see if the behavior you observed might be expected and if configuration options are available to provide you with the desired behavior.
|
|
45
|
+
|
|
46
|
+
* **perform a cursory search** to see if there's [an existing issue](https://github.com/XeroAPI/xero-ruby/issues) covering your feedback. If there is one and the issue is still open, **add a :+1: reaction** on the issue to express interest in the issue being resolved. That will help the team gauge interest without the noise of comments which trigger notifications to all watchers. Comments should be used only if you have new and useful information to share.
|
|
47
|
+
|
|
48
|
+
### Write bug reports with detail, background, and sample code
|
|
49
|
+
|
|
50
|
+
- Which version of the SDK are you using?
|
|
51
|
+
- A quick summary and/or background
|
|
52
|
+
- Steps to reproduce
|
|
53
|
+
- Be specific!
|
|
54
|
+
- Give sample code if you can.
|
|
55
|
+
- What you expected would happen
|
|
56
|
+
- What actually happens
|
|
57
|
+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
|
|
58
|
+
|
|
59
|
+
## Suggesting Enhancements
|
|
60
|
+
|
|
61
|
+
When opening an issue for a feature request:
|
|
62
|
+
* **use a clear and descriptive title** for the issue to identify the problem.
|
|
63
|
+
* **include as many details as possible in the body**. Explain your use-case, the problems you're hitting and the solutions you'd like to see to address those problems.
|
|
64
|
+
|
|
65
|
+
## Pull requests
|
|
66
|
+
|
|
67
|
+
We welcome your feedback and pull requests. Be aware some code is generated and pull requests may not be the best solution - see below.
|
|
68
|
+
|
|
69
|
+
### We Use OpenAPI Generator
|
|
70
|
+
The best way to propose changes to the codebase is to open an [issue](https://github.com/XeroAPI/xero-ruby/issues) and discuss with our team.
|
|
71
|
+
|
|
72
|
+
We are using [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) and [our OpenAPI specs](https://github.com/XeroAPI/Xero-OpenAPI), to create and update our models and client classes. Improvements may require updates to our OAS or our customized mustache templates instead of modifying via pull request.
|
|
73
|
+
|
|
74
|
+
### Submit a pull request
|
|
75
|
+
|
|
76
|
+
Xero's supported SDK's are mostly auto-generated based on an [OpenAPISpec](https://github.com/XeroAPI/Xero-OpenAPI) that utilizes [openapi-generator](https://github.com/OpenAPITools/openapi-generator).
|
|
77
|
+
> You can read more about our process here: https://devblog.xero.com/building-sdks-for-the-future-b79ff726dfd6
|
|
78
|
+
### Style Guide
|
|
79
|
+
* 2 spaces for indentation rather than tabs
|
|
80
|
+
|
|
81
|
+
## License
|
|
82
|
+
By contributing, you agree that your contributions will be licensed under its MIT License.
|
data/Gemfile.lock
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
PATH
|
|
2
|
+
remote: .
|
|
3
|
+
specs:
|
|
4
|
+
xero-ruby (0.4.1)
|
|
5
|
+
faraday (~> 0.14, >= 0.14.0)
|
|
6
|
+
json (~> 2.1, >= 2.1.0)
|
|
7
|
+
|
|
8
|
+
GEM
|
|
9
|
+
remote: https://rubygems.org/
|
|
10
|
+
specs:
|
|
11
|
+
ast (2.4.1)
|
|
12
|
+
byebug (11.1.3)
|
|
13
|
+
coderay (1.1.3)
|
|
14
|
+
diff-lcs (1.3)
|
|
15
|
+
faraday (0.17.3)
|
|
16
|
+
multipart-post (>= 1.2, < 3)
|
|
17
|
+
jaro_winkler (1.5.4)
|
|
18
|
+
json (2.3.0)
|
|
19
|
+
method_source (1.0.0)
|
|
20
|
+
multipart-post (2.1.1)
|
|
21
|
+
parallel (1.19.1)
|
|
22
|
+
parser (2.7.1.3)
|
|
23
|
+
ast (~> 2.4.0)
|
|
24
|
+
pry (0.13.1)
|
|
25
|
+
coderay (~> 1.1)
|
|
26
|
+
method_source (~> 1.0)
|
|
27
|
+
pry-byebug (3.9.0)
|
|
28
|
+
byebug (~> 11.0)
|
|
29
|
+
pry (~> 0.13.0)
|
|
30
|
+
psych (3.1.0)
|
|
31
|
+
rainbow (3.0.0)
|
|
32
|
+
rake (12.3.3)
|
|
33
|
+
rspec (3.9.0)
|
|
34
|
+
rspec-core (~> 3.9.0)
|
|
35
|
+
rspec-expectations (~> 3.9.0)
|
|
36
|
+
rspec-mocks (~> 3.9.0)
|
|
37
|
+
rspec-core (3.9.2)
|
|
38
|
+
rspec-support (~> 3.9.3)
|
|
39
|
+
rspec-expectations (3.9.2)
|
|
40
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
41
|
+
rspec-support (~> 3.9.0)
|
|
42
|
+
rspec-mocks (3.9.1)
|
|
43
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
44
|
+
rspec-support (~> 3.9.0)
|
|
45
|
+
rspec-support (3.9.3)
|
|
46
|
+
rubocop (0.66.0)
|
|
47
|
+
jaro_winkler (~> 1.5.1)
|
|
48
|
+
parallel (~> 1.10)
|
|
49
|
+
parser (>= 2.5, != 2.5.1.1)
|
|
50
|
+
psych (>= 3.1.0)
|
|
51
|
+
rainbow (>= 2.2.2, < 4.0)
|
|
52
|
+
ruby-progressbar (~> 1.7)
|
|
53
|
+
unicode-display_width (>= 1.4.0, < 1.6)
|
|
54
|
+
ruby-progressbar (1.10.1)
|
|
55
|
+
unicode-display_width (1.5.0)
|
|
56
|
+
|
|
57
|
+
PLATFORMS
|
|
58
|
+
ruby
|
|
59
|
+
|
|
60
|
+
DEPENDENCIES
|
|
61
|
+
pry-byebug
|
|
62
|
+
rake (~> 12.3.3)
|
|
63
|
+
rspec
|
|
64
|
+
rubocop (~> 0.66.0)
|
|
65
|
+
xero-ruby!
|
|
66
|
+
|
|
67
|
+
BUNDLED WITH
|
|
68
|
+
2.1.2
|
data/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2019 Xero Developer API
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
data/README.md
CHANGED
|
@@ -1,470 +1,164 @@
|
|
|
1
1
|
# xero-ruby
|
|
2
|
+
Xero Ruby SDK for OAuth 2.0 generated from [Xero API OpenAPI Spec](https://github.com/XeroAPI/Xero-OpenAPI)
|
|
2
3
|
|
|
3
|
-
|
|
4
|
+
[](https://rubygems.org/gems/xero-ruby)
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
## Current release of SDK with OAuth 2.0 support
|
|
7
|
+
Xero Ruby SDK supports Xero's OAuth2.0 authentication (token generation & refresh) and supports the following Xero API sets.
|
|
8
|
+
* [accounting](https://developer.xero.com/documentation/api/api-overview)
|
|
9
|
+
* [assets](https://developer.xero.com/documentation/assets-api/overview)
|
|
6
10
|
|
|
7
|
-
|
|
11
|
+
Coming soon
|
|
12
|
+
* bank feeds
|
|
13
|
+
* payroll (AU))
|
|
14
|
+
* payroll (NZ/UK)
|
|
15
|
+
* files
|
|
16
|
+
* projects
|
|
17
|
+
* xero hq
|
|
8
18
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
|
-
For more information, please visit [https://developer.xero.com](https://developer.xero.com)
|
|
19
|
+
## Looking for OAuth 1.0a support?
|
|
20
|
+
Check out the [Xeroizer](https://github.com/waynerobinson/xeroizer) gem (maintained by community)
|
|
13
21
|
|
|
22
|
+
---
|
|
14
23
|
## Installation
|
|
24
|
+
This SDK is published as a gem on RubyGems as [xero-ruby](https://rubygems.org/gems/xero-ruby) To install this gem to your current gemset, run:
|
|
15
25
|
|
|
16
|
-
|
|
26
|
+
```
|
|
27
|
+
gem install 'xero-ruby'
|
|
28
|
+
```
|
|
29
|
+
Or, add this to your gemfile:
|
|
30
|
+
```
|
|
31
|
+
gem 'xero-ruby'
|
|
32
|
+
```
|
|
17
33
|
|
|
18
|
-
|
|
34
|
+
## Getting Started
|
|
35
|
+
* Create a [free Xero user account](https://www.xero.com/us/signup/api/)
|
|
36
|
+
* Login to your Xero developer [/myapps](https://developer.xero.com/myapps) dashboard & create an API application and note your API app's credentials.
|
|
19
37
|
|
|
20
|
-
|
|
21
|
-
|
|
38
|
+
### Creating a Client
|
|
39
|
+
Require the gem:
|
|
22
40
|
```
|
|
41
|
+
require 'xero-ruby'
|
|
42
|
+
```
|
|
43
|
+
Then create a client by passing in a named hash object `credentials:`.
|
|
23
44
|
|
|
24
|
-
|
|
45
|
+
> *client_id*, *client_secret*, *redirect_uri*: Get this from your API application in /myapps dashboard.
|
|
46
|
+
*scopes*: Include scopes as comma seperated list, https://developer.xero.com/documentation/oauth2/scopes
|
|
47
|
+
**ex:** 'openid profile email accounting.transactions'
|
|
25
48
|
|
|
26
|
-
```
|
|
27
|
-
|
|
49
|
+
```ruby
|
|
50
|
+
creds = {
|
|
51
|
+
client_id: ENV['CLIENT_ID'],
|
|
52
|
+
client_secret: ENV['CLIENT_SECRET'],
|
|
53
|
+
redirect_uri: ENV['REDIRECT_URI'],
|
|
54
|
+
scopes: ENV['SCOPES']
|
|
55
|
+
}
|
|
56
|
+
xero_client ||= XeroRuby::ApiClient.new(credentials: creds)
|
|
28
57
|
```
|
|
29
58
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
59
|
+
## Authorization & Callback
|
|
60
|
+
All API requests require a valid access token to be set on the client. If this is the first time you are calling the Xero API on a users behalf you will need to generate an authorized token set, which will look something like this:
|
|
61
|
+
```json
|
|
62
|
+
{
|
|
63
|
+
"id_token": "xxx.yyy.zz",
|
|
64
|
+
"access_token": "xxx.yyy.zzz",
|
|
65
|
+
"expires_in": 1800,
|
|
66
|
+
"token_type": "Bearer",
|
|
67
|
+
"refresh_token": "xxxxxx",
|
|
68
|
+
"scope": "email profile openid accounting.transactions offline_access"
|
|
69
|
+
}
|
|
70
|
+
```
|
|
33
71
|
|
|
34
|
-
|
|
72
|
+
To generate a valid token_set with this SDK from Xero, have your user follow the authorization url:
|
|
73
|
+
```ruby
|
|
74
|
+
@authorization_url = xero_client.authorization_url
|
|
75
|
+
# https://login.xero.com/identity/connect/authorize?response_type=code&client_id=<xxx>&redirect_uri=<redirect_uri>&scope=<scopes>
|
|
76
|
+
```
|
|
35
77
|
|
|
36
|
-
|
|
78
|
+
> The `get_token_set_from_callback` method will set the `token_set` on the client, however you can also initialize a client and set the `token_set` explicitely using `set_token_set` or `refresh_token_set`.
|
|
37
79
|
|
|
38
|
-
|
|
80
|
+
```ruby
|
|
81
|
+
# /my-redirect-uri
|
|
82
|
+
token_set = xero_client.get_token_set_from_callback(params)
|
|
39
83
|
|
|
40
|
-
|
|
84
|
+
# this is where you will want to save the token set for future API usage..
|
|
85
|
+
# ex: user.update!(xero_token_set: token_set)
|
|
41
86
|
|
|
42
|
-
|
|
87
|
+
# if you already saved a token_set you don't need the user to authenticate via UI
|
|
88
|
+
# and can just set the token on the client by refreshing it.
|
|
89
|
+
xero_client.refresh_token_set(user.token_set)
|
|
90
|
+
```
|
|
43
91
|
|
|
44
|
-
|
|
92
|
+
## Token & SDK Helpers
|
|
45
93
|
|
|
46
|
-
|
|
94
|
+
Token Sets contain information about your API connection, but most important are the access_token, refresh_token, and the expiry:
|
|
95
|
+
* An `access_token` is valid 30 minutes and a `refresh_token` is valid for 60 days
|
|
47
96
|
|
|
48
|
-
```
|
|
49
|
-
|
|
97
|
+
```ruby
|
|
98
|
+
@token_set = xero_client.refresh_token_set(user.token_set)
|
|
99
|
+
|
|
100
|
+
# TIP: the `updatedDateUtc` will show you the most recently authorized Tenant (AKA Organisation)
|
|
101
|
+
connections = xero_client.connections
|
|
102
|
+
[{
|
|
103
|
+
"id" => "xxx-yyy-zzz",
|
|
104
|
+
"tenantId" => "xxx-yyy-zzz",
|
|
105
|
+
"tenantType" => "ORGANISATION",
|
|
106
|
+
"tenantName" => "Demo Company (US)",
|
|
107
|
+
"createdDateUtc" => "2019-11-01T20:08:03.0766400",
|
|
108
|
+
"updatedDateUtc" => "2020-04-15T22:37:10.4943410"
|
|
109
|
+
}]
|
|
110
|
+
|
|
111
|
+
# disconnect an org from a user's connections. Pass the connection ['id'] not ['tenantId'].
|
|
112
|
+
remaining_connections = xero_client.disconnect(connections[0]['id'])
|
|
113
|
+
|
|
114
|
+
# set token_set
|
|
115
|
+
token_set = xero_client.set_token_set(user.token_set)
|
|
116
|
+
|
|
117
|
+
# access token_set
|
|
118
|
+
token_set = xero_client.token_set
|
|
50
119
|
```
|
|
51
120
|
|
|
52
|
-
##
|
|
53
|
-
|
|
54
|
-
Please follow the [installation](#installation) procedure and then run the following code:
|
|
55
|
-
|
|
121
|
+
## API Usage
|
|
56
122
|
```ruby
|
|
57
|
-
|
|
58
|
-
|
|
123
|
+
require 'xero-ruby'
|
|
124
|
+
|
|
125
|
+
# reference `Authorization & Callback` to first store a valid token_set on the `xero_client`
|
|
126
|
+
xero_client.refresh_token_set(user.token_set)
|
|
127
|
+
|
|
128
|
+
# Accounting API set (https://github.com/XeroAPI/xero-ruby/blob/master/accounting/lib/xero-ruby/api/accounting_api.rb)
|
|
129
|
+
invoices = xero_client.accounting_api.get_invoices(user.active_tenant_id).invoices
|
|
130
|
+
accounts = xero_client.accounting_api.get_accounts(user.active_tenant_id).accounts
|
|
131
|
+
contacts = xero_client.accounting_api.get_contacts(user.active_tenant_id).contacts
|
|
132
|
+
|
|
133
|
+
# Asset API set (https://github.com/XeroAPI/xero-ruby/blob/master/accounting/lib/xero-ruby/api/asset_api.rb)
|
|
134
|
+
asset = {
|
|
135
|
+
"assetName": "AssetName: #{rand(10000)}",
|
|
136
|
+
"assetNumber": "Asset: #{rand(10000)}",
|
|
137
|
+
"assetStatus": "DRAFT"
|
|
138
|
+
}
|
|
139
|
+
asset = xero_client.asset_api.create_asset(current_user.active_tenant_id, asset)
|
|
140
|
+
```
|
|
59
141
|
|
|
60
|
-
|
|
61
|
-
XeroRuby.configure do |config|
|
|
62
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
|
63
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
64
|
-
end
|
|
142
|
+
If you have use cases outside of these examples or this readmy, please let us know!
|
|
65
143
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
144
|
+
## Sample App
|
|
145
|
+
The best resource to understanding how to best leverage this SDK is to clone down our Sample Rails application which showcases all the features of this project. The sample app can help you quickly understand how to:
|
|
146
|
+
> https://github.com/XeroAPI/xero-ruby-oauth2-app
|
|
69
147
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
148
|
+
* Complete the OAuth2.0 Authorization flow
|
|
149
|
+
* Store token_sets against a user object in a DB
|
|
150
|
+
* Storing info about active connections
|
|
151
|
+
* Change the active tenant & make api calls to multiple orgs
|
|
152
|
+
* Refreshing your token sets
|
|
153
|
+
* Decoding your token_set items and strategy around how/when to refresh
|
|
154
|
+
* Disconnecting a connection for a user
|
|
77
155
|
|
|
78
|
-
|
|
156
|
+
## Additional Documentation for API Endpoints
|
|
79
157
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
Class | Method | HTTP request | Description
|
|
85
|
-
------------ | ------------- | ------------- | -------------
|
|
86
|
-
*XeroRuby::AccountingApi* | [**create_account**](docs/AccountingApi.md#create_account) | **PUT** /Accounts | Allows you to create a new chart of accounts
|
|
87
|
-
*XeroRuby::AccountingApi* | [**create_account_attachment_by_file_name**](docs/AccountingApi.md#create_account_attachment_by_file_name) | **PUT** /Accounts/{AccountID}/Attachments/{FileName} | Allows you to create Attachment on Account
|
|
88
|
-
*XeroRuby::AccountingApi* | [**create_bank_transaction_attachment_by_file_name**](docs/AccountingApi.md#create_bank_transaction_attachment_by_file_name) | **PUT** /BankTransactions/{BankTransactionID}/Attachments/{FileName} | Allows you to createa an Attachment on BankTransaction by Filename
|
|
89
|
-
*XeroRuby::AccountingApi* | [**create_bank_transaction_history_record**](docs/AccountingApi.md#create_bank_transaction_history_record) | **PUT** /BankTransactions/{BankTransactionID}/History | Allows you to create history record for a bank transactions
|
|
90
|
-
*XeroRuby::AccountingApi* | [**create_bank_transactions**](docs/AccountingApi.md#create_bank_transactions) | **PUT** /BankTransactions | Allows you to create one or more spend or receive money transaction
|
|
91
|
-
*XeroRuby::AccountingApi* | [**create_bank_transfer**](docs/AccountingApi.md#create_bank_transfer) | **PUT** /BankTransfers | Allows you to create a bank transfers
|
|
92
|
-
*XeroRuby::AccountingApi* | [**create_bank_transfer_attachment_by_file_name**](docs/AccountingApi.md#create_bank_transfer_attachment_by_file_name) | **PUT** /BankTransfers/{BankTransferID}/Attachments/{FileName} |
|
|
93
|
-
*XeroRuby::AccountingApi* | [**create_bank_transfer_history_record**](docs/AccountingApi.md#create_bank_transfer_history_record) | **PUT** /BankTransfers/{BankTransferID}/History |
|
|
94
|
-
*XeroRuby::AccountingApi* | [**create_batch_payment**](docs/AccountingApi.md#create_batch_payment) | **PUT** /BatchPayments | Create one or many BatchPayments for invoices
|
|
95
|
-
*XeroRuby::AccountingApi* | [**create_batch_payment_history_record**](docs/AccountingApi.md#create_batch_payment_history_record) | **PUT** /BatchPayments/{BatchPaymentID}/History | Allows you to create a history record for a Batch Payment
|
|
96
|
-
*XeroRuby::AccountingApi* | [**create_branding_theme_payment_services**](docs/AccountingApi.md#create_branding_theme_payment_services) | **POST** /BrandingThemes/{BrandingThemeID}/PaymentServices | Allow for the creation of new custom payment service for specified Branding Theme
|
|
97
|
-
*XeroRuby::AccountingApi* | [**create_contact_attachment_by_file_name**](docs/AccountingApi.md#create_contact_attachment_by_file_name) | **PUT** /Contacts/{ContactID}/Attachments/{FileName} |
|
|
98
|
-
*XeroRuby::AccountingApi* | [**create_contact_group**](docs/AccountingApi.md#create_contact_group) | **PUT** /ContactGroups | Allows you to create a contact group
|
|
99
|
-
*XeroRuby::AccountingApi* | [**create_contact_group_contacts**](docs/AccountingApi.md#create_contact_group_contacts) | **PUT** /ContactGroups/{ContactGroupID}/Contacts | Allows you to add Contacts to a Contact Group
|
|
100
|
-
*XeroRuby::AccountingApi* | [**create_contact_history**](docs/AccountingApi.md#create_contact_history) | **PUT** /Contacts/{ContactID}/History | Allows you to retrieve a history records of an Contact
|
|
101
|
-
*XeroRuby::AccountingApi* | [**create_contacts**](docs/AccountingApi.md#create_contacts) | **PUT** /Contacts | Allows you to create a multiple contacts (bulk) in a Xero organisation
|
|
102
|
-
*XeroRuby::AccountingApi* | [**create_credit_note_allocation**](docs/AccountingApi.md#create_credit_note_allocation) | **PUT** /CreditNotes/{CreditNoteID}/Allocations | Allows you to create Allocation on CreditNote
|
|
103
|
-
*XeroRuby::AccountingApi* | [**create_credit_note_attachment_by_file_name**](docs/AccountingApi.md#create_credit_note_attachment_by_file_name) | **PUT** /CreditNotes/{CreditNoteID}/Attachments/{FileName} | Allows you to create Attachments on CreditNote by file name
|
|
104
|
-
*XeroRuby::AccountingApi* | [**create_credit_note_history**](docs/AccountingApi.md#create_credit_note_history) | **PUT** /CreditNotes/{CreditNoteID}/History | Allows you to retrieve a history records of an CreditNote
|
|
105
|
-
*XeroRuby::AccountingApi* | [**create_credit_notes**](docs/AccountingApi.md#create_credit_notes) | **PUT** /CreditNotes | Allows you to create a credit note
|
|
106
|
-
*XeroRuby::AccountingApi* | [**create_currency**](docs/AccountingApi.md#create_currency) | **PUT** /Currencies |
|
|
107
|
-
*XeroRuby::AccountingApi* | [**create_employees**](docs/AccountingApi.md#create_employees) | **PUT** /Employees | Allows you to create new employees used in Xero payrun
|
|
108
|
-
*XeroRuby::AccountingApi* | [**create_expense_claim_history**](docs/AccountingApi.md#create_expense_claim_history) | **PUT** /ExpenseClaims/{ExpenseClaimID}/History | Allows you to create a history records of an ExpenseClaim
|
|
109
|
-
*XeroRuby::AccountingApi* | [**create_expense_claims**](docs/AccountingApi.md#create_expense_claims) | **PUT** /ExpenseClaims | Allows you to retrieve expense claims
|
|
110
|
-
*XeroRuby::AccountingApi* | [**create_invoice_attachment_by_file_name**](docs/AccountingApi.md#create_invoice_attachment_by_file_name) | **PUT** /Invoices/{InvoiceID}/Attachments/{FileName} | Allows you to create an Attachment on invoices or purchase bills by it's filename
|
|
111
|
-
*XeroRuby::AccountingApi* | [**create_invoice_history**](docs/AccountingApi.md#create_invoice_history) | **PUT** /Invoices/{InvoiceID}/History | Allows you to retrieve a history records of an invoice
|
|
112
|
-
*XeroRuby::AccountingApi* | [**create_invoices**](docs/AccountingApi.md#create_invoices) | **PUT** /Invoices | Allows you to create one or more sales invoices or purchase bills
|
|
113
|
-
*XeroRuby::AccountingApi* | [**create_item_history**](docs/AccountingApi.md#create_item_history) | **PUT** /Items/{ItemID}/History | Allows you to create a history record for items
|
|
114
|
-
*XeroRuby::AccountingApi* | [**create_items**](docs/AccountingApi.md#create_items) | **PUT** /Items | Allows you to create one or more items
|
|
115
|
-
*XeroRuby::AccountingApi* | [**create_linked_transaction**](docs/AccountingApi.md#create_linked_transaction) | **PUT** /LinkedTransactions | Allows you to create linked transactions (billable expenses)
|
|
116
|
-
*XeroRuby::AccountingApi* | [**create_manual_journal_attachment_by_file_name**](docs/AccountingApi.md#create_manual_journal_attachment_by_file_name) | **PUT** /ManualJournals/{ManualJournalID}/Attachments/{FileName} | Allows you to create a specified Attachment on ManualJournal by file name
|
|
117
|
-
*XeroRuby::AccountingApi* | [**create_manual_journals**](docs/AccountingApi.md#create_manual_journals) | **PUT** /ManualJournals | Allows you to create one or more manual journals
|
|
118
|
-
*XeroRuby::AccountingApi* | [**create_overpayment_allocations**](docs/AccountingApi.md#create_overpayment_allocations) | **PUT** /Overpayments/{OverpaymentID}/Allocations | Allows you to create a single allocation for an overpayment
|
|
119
|
-
*XeroRuby::AccountingApi* | [**create_overpayment_history**](docs/AccountingApi.md#create_overpayment_history) | **PUT** /Overpayments/{OverpaymentID}/History | Allows you to create history records of an Overpayment
|
|
120
|
-
*XeroRuby::AccountingApi* | [**create_payment**](docs/AccountingApi.md#create_payment) | **POST** /Payments | Allows you to create a single payment for invoices or credit notes
|
|
121
|
-
*XeroRuby::AccountingApi* | [**create_payment_history**](docs/AccountingApi.md#create_payment_history) | **PUT** /Payments/{PaymentID}/History | Allows you to create a history record for a payment
|
|
122
|
-
*XeroRuby::AccountingApi* | [**create_payment_service**](docs/AccountingApi.md#create_payment_service) | **PUT** /PaymentServices | Allows you to create payment services
|
|
123
|
-
*XeroRuby::AccountingApi* | [**create_payments**](docs/AccountingApi.md#create_payments) | **PUT** /Payments | Allows you to create multiple payments for invoices or credit notes
|
|
124
|
-
*XeroRuby::AccountingApi* | [**create_prepayment_allocations**](docs/AccountingApi.md#create_prepayment_allocations) | **PUT** /Prepayments/{PrepaymentID}/Allocations | Allows you to create an Allocation for prepayments
|
|
125
|
-
*XeroRuby::AccountingApi* | [**create_prepayment_history**](docs/AccountingApi.md#create_prepayment_history) | **PUT** /Prepayments/{PrepaymentID}/History | Allows you to create a history record for an Prepayment
|
|
126
|
-
*XeroRuby::AccountingApi* | [**create_purchase_order_history**](docs/AccountingApi.md#create_purchase_order_history) | **PUT** /PurchaseOrders/{PurchaseOrderID}/History | Allows you to create HistoryRecord for purchase orders
|
|
127
|
-
*XeroRuby::AccountingApi* | [**create_purchase_orders**](docs/AccountingApi.md#create_purchase_orders) | **PUT** /PurchaseOrders | Allows you to create one or more purchase orders
|
|
128
|
-
*XeroRuby::AccountingApi* | [**create_quote_attachment_by_file_name**](docs/AccountingApi.md#create_quote_attachment_by_file_name) | **PUT** /Quotes/{QuoteID}/Attachments/{FileName} | Allows you to create Attachment on Quote
|
|
129
|
-
*XeroRuby::AccountingApi* | [**create_quote_history**](docs/AccountingApi.md#create_quote_history) | **PUT** /Quotes/{QuoteID}/History | Allows you to retrieve a history records of an quote
|
|
130
|
-
*XeroRuby::AccountingApi* | [**create_quotes**](docs/AccountingApi.md#create_quotes) | **PUT** /Quotes | Allows you to create one or more quotes
|
|
131
|
-
*XeroRuby::AccountingApi* | [**create_receipt**](docs/AccountingApi.md#create_receipt) | **PUT** /Receipts | Allows you to create draft expense claim receipts for any user
|
|
132
|
-
*XeroRuby::AccountingApi* | [**create_receipt_attachment_by_file_name**](docs/AccountingApi.md#create_receipt_attachment_by_file_name) | **PUT** /Receipts/{ReceiptID}/Attachments/{FileName} | Allows you to create Attachment on expense claim receipts by file name
|
|
133
|
-
*XeroRuby::AccountingApi* | [**create_receipt_history**](docs/AccountingApi.md#create_receipt_history) | **PUT** /Receipts/{ReceiptID}/History | Allows you to retrieve a history records of an Receipt
|
|
134
|
-
*XeroRuby::AccountingApi* | [**create_repeating_invoice_attachment_by_file_name**](docs/AccountingApi.md#create_repeating_invoice_attachment_by_file_name) | **PUT** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} | Allows you to create attachment on repeating invoices by file name
|
|
135
|
-
*XeroRuby::AccountingApi* | [**create_repeating_invoice_history**](docs/AccountingApi.md#create_repeating_invoice_history) | **PUT** /RepeatingInvoices/{RepeatingInvoiceID}/History | Allows you to create history for a repeating invoice
|
|
136
|
-
*XeroRuby::AccountingApi* | [**create_tax_rates**](docs/AccountingApi.md#create_tax_rates) | **PUT** /TaxRates | Allows you to create one or more Tax Rates
|
|
137
|
-
*XeroRuby::AccountingApi* | [**create_tracking_category**](docs/AccountingApi.md#create_tracking_category) | **PUT** /TrackingCategories | Allows you to create tracking categories
|
|
138
|
-
*XeroRuby::AccountingApi* | [**create_tracking_options**](docs/AccountingApi.md#create_tracking_options) | **PUT** /TrackingCategories/{TrackingCategoryID}/Options | Allows you to create options for a specified tracking category
|
|
139
|
-
*XeroRuby::AccountingApi* | [**delete_account**](docs/AccountingApi.md#delete_account) | **DELETE** /Accounts/{AccountID} | Allows you to delete a chart of accounts
|
|
140
|
-
*XeroRuby::AccountingApi* | [**delete_contact_group_contact**](docs/AccountingApi.md#delete_contact_group_contact) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts/{ContactID} | Allows you to delete a specific Contact from a Contact Group
|
|
141
|
-
*XeroRuby::AccountingApi* | [**delete_contact_group_contacts**](docs/AccountingApi.md#delete_contact_group_contacts) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts | Allows you to delete all Contacts from a Contact Group
|
|
142
|
-
*XeroRuby::AccountingApi* | [**delete_item**](docs/AccountingApi.md#delete_item) | **DELETE** /Items/{ItemID} | Allows you to delete a specified item
|
|
143
|
-
*XeroRuby::AccountingApi* | [**delete_linked_transaction**](docs/AccountingApi.md#delete_linked_transaction) | **DELETE** /LinkedTransactions/{LinkedTransactionID} | Allows you to delete a specified linked transactions (billable expenses)
|
|
144
|
-
*XeroRuby::AccountingApi* | [**delete_payment**](docs/AccountingApi.md#delete_payment) | **POST** /Payments/{PaymentID} | Allows you to update a specified payment for invoices and credit notes
|
|
145
|
-
*XeroRuby::AccountingApi* | [**delete_tracking_category**](docs/AccountingApi.md#delete_tracking_category) | **DELETE** /TrackingCategories/{TrackingCategoryID} | Allows you to delete tracking categories
|
|
146
|
-
*XeroRuby::AccountingApi* | [**delete_tracking_options**](docs/AccountingApi.md#delete_tracking_options) | **DELETE** /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID} | Allows you to delete a specified option for a specified tracking category
|
|
147
|
-
*XeroRuby::AccountingApi* | [**email_invoice**](docs/AccountingApi.md#email_invoice) | **POST** /Invoices/{InvoiceID}/Email | Allows you to email a copy of invoice to related Contact
|
|
148
|
-
*XeroRuby::AccountingApi* | [**get_account**](docs/AccountingApi.md#get_account) | **GET** /Accounts/{AccountID} | Allows you to retrieve a single chart of accounts
|
|
149
|
-
*XeroRuby::AccountingApi* | [**get_account_attachment_by_file_name**](docs/AccountingApi.md#get_account_attachment_by_file_name) | **GET** /Accounts/{AccountID}/Attachments/{FileName} | Allows you to retrieve Attachment on Account by Filename
|
|
150
|
-
*XeroRuby::AccountingApi* | [**get_account_attachment_by_id**](docs/AccountingApi.md#get_account_attachment_by_id) | **GET** /Accounts/{AccountID}/Attachments/{AttachmentID} | Allows you to retrieve specific Attachment on Account
|
|
151
|
-
*XeroRuby::AccountingApi* | [**get_account_attachments**](docs/AccountingApi.md#get_account_attachments) | **GET** /Accounts/{AccountID}/Attachments | Allows you to retrieve Attachments for accounts
|
|
152
|
-
*XeroRuby::AccountingApi* | [**get_accounts**](docs/AccountingApi.md#get_accounts) | **GET** /Accounts | Allows you to retrieve the full chart of accounts
|
|
153
|
-
*XeroRuby::AccountingApi* | [**get_bank_transaction**](docs/AccountingApi.md#get_bank_transaction) | **GET** /BankTransactions/{BankTransactionID} | Allows you to retrieve a single spend or receive money transaction
|
|
154
|
-
*XeroRuby::AccountingApi* | [**get_bank_transaction_attachment_by_file_name**](docs/AccountingApi.md#get_bank_transaction_attachment_by_file_name) | **GET** /BankTransactions/{BankTransactionID}/Attachments/{FileName} | Allows you to retrieve Attachments on BankTransaction by Filename
|
|
155
|
-
*XeroRuby::AccountingApi* | [**get_bank_transaction_attachment_by_id**](docs/AccountingApi.md#get_bank_transaction_attachment_by_id) | **GET** /BankTransactions/{BankTransactionID}/Attachments/{AttachmentID} | Allows you to retrieve Attachments on a specific BankTransaction
|
|
156
|
-
*XeroRuby::AccountingApi* | [**get_bank_transaction_attachments**](docs/AccountingApi.md#get_bank_transaction_attachments) | **GET** /BankTransactions/{BankTransactionID}/Attachments | Allows you to retrieve any attachments to bank transactions
|
|
157
|
-
*XeroRuby::AccountingApi* | [**get_bank_transactions**](docs/AccountingApi.md#get_bank_transactions) | **GET** /BankTransactions | Allows you to retrieve any spend or receive money transactions
|
|
158
|
-
*XeroRuby::AccountingApi* | [**get_bank_transactions_history**](docs/AccountingApi.md#get_bank_transactions_history) | **GET** /BankTransactions/{BankTransactionID}/History | Allows you to retrieve history from a bank transactions
|
|
159
|
-
*XeroRuby::AccountingApi* | [**get_bank_transfer**](docs/AccountingApi.md#get_bank_transfer) | **GET** /BankTransfers/{BankTransferID} | Allows you to retrieve any bank transfers
|
|
160
|
-
*XeroRuby::AccountingApi* | [**get_bank_transfer_attachment_by_file_name**](docs/AccountingApi.md#get_bank_transfer_attachment_by_file_name) | **GET** /BankTransfers/{BankTransferID}/Attachments/{FileName} | Allows you to retrieve Attachments on BankTransfer by file name
|
|
161
|
-
*XeroRuby::AccountingApi* | [**get_bank_transfer_attachment_by_id**](docs/AccountingApi.md#get_bank_transfer_attachment_by_id) | **GET** /BankTransfers/{BankTransferID}/Attachments/{AttachmentID} | Allows you to retrieve Attachments on BankTransfer
|
|
162
|
-
*XeroRuby::AccountingApi* | [**get_bank_transfer_attachments**](docs/AccountingApi.md#get_bank_transfer_attachments) | **GET** /BankTransfers/{BankTransferID}/Attachments | Allows you to retrieve Attachments from bank transfers
|
|
163
|
-
*XeroRuby::AccountingApi* | [**get_bank_transfer_history**](docs/AccountingApi.md#get_bank_transfer_history) | **GET** /BankTransfers/{BankTransferID}/History | Allows you to retrieve history from a bank transfers
|
|
164
|
-
*XeroRuby::AccountingApi* | [**get_bank_transfers**](docs/AccountingApi.md#get_bank_transfers) | **GET** /BankTransfers | Allows you to retrieve all bank transfers
|
|
165
|
-
*XeroRuby::AccountingApi* | [**get_batch_payment_history**](docs/AccountingApi.md#get_batch_payment_history) | **GET** /BatchPayments/{BatchPaymentID}/History | Allows you to retrieve history from a Batch Payment
|
|
166
|
-
*XeroRuby::AccountingApi* | [**get_batch_payments**](docs/AccountingApi.md#get_batch_payments) | **GET** /BatchPayments | Retrieve either one or many BatchPayments for invoices
|
|
167
|
-
*XeroRuby::AccountingApi* | [**get_branding_theme**](docs/AccountingApi.md#get_branding_theme) | **GET** /BrandingThemes/{BrandingThemeID} | Allows you to retrieve a specific BrandingThemes
|
|
168
|
-
*XeroRuby::AccountingApi* | [**get_branding_theme_payment_services**](docs/AccountingApi.md#get_branding_theme_payment_services) | **GET** /BrandingThemes/{BrandingThemeID}/PaymentServices | Allows you to retrieve the Payment services for a Branding Theme
|
|
169
|
-
*XeroRuby::AccountingApi* | [**get_branding_themes**](docs/AccountingApi.md#get_branding_themes) | **GET** /BrandingThemes | Allows you to retrieve all the BrandingThemes
|
|
170
|
-
*XeroRuby::AccountingApi* | [**get_contact**](docs/AccountingApi.md#get_contact) | **GET** /Contacts/{ContactID} | Allows you to retrieve, add and update contacts in a Xero organisation
|
|
171
|
-
*XeroRuby::AccountingApi* | [**get_contact_attachment_by_file_name**](docs/AccountingApi.md#get_contact_attachment_by_file_name) | **GET** /Contacts/{ContactID}/Attachments/{FileName} | Allows you to retrieve Attachments on Contacts by file name
|
|
172
|
-
*XeroRuby::AccountingApi* | [**get_contact_attachment_by_id**](docs/AccountingApi.md#get_contact_attachment_by_id) | **GET** /Contacts/{ContactID}/Attachments/{AttachmentID} | Allows you to retrieve Attachments on Contacts
|
|
173
|
-
*XeroRuby::AccountingApi* | [**get_contact_attachments**](docs/AccountingApi.md#get_contact_attachments) | **GET** /Contacts/{ContactID}/Attachments | Allows you to retrieve, add and update contacts in a Xero organisation
|
|
174
|
-
*XeroRuby::AccountingApi* | [**get_contact_cis_settings**](docs/AccountingApi.md#get_contact_cis_settings) | **GET** /Contacts/{ContactID}/CISSettings | Allows you to retrieve CISSettings for a contact in a Xero organisation
|
|
175
|
-
*XeroRuby::AccountingApi* | [**get_contact_group**](docs/AccountingApi.md#get_contact_group) | **GET** /ContactGroups/{ContactGroupID} | Allows you to retrieve a unique Contact Group by ID
|
|
176
|
-
*XeroRuby::AccountingApi* | [**get_contact_groups**](docs/AccountingApi.md#get_contact_groups) | **GET** /ContactGroups | Allows you to retrieve the ContactID and Name of all the contacts in a contact group
|
|
177
|
-
*XeroRuby::AccountingApi* | [**get_contact_history**](docs/AccountingApi.md#get_contact_history) | **GET** /Contacts/{ContactID}/History | Allows you to retrieve a history records of an Contact
|
|
178
|
-
*XeroRuby::AccountingApi* | [**get_contacts**](docs/AccountingApi.md#get_contacts) | **GET** /Contacts | Allows you to retrieve, add and update contacts in a Xero organisation
|
|
179
|
-
*XeroRuby::AccountingApi* | [**get_credit_note**](docs/AccountingApi.md#get_credit_note) | **GET** /CreditNotes/{CreditNoteID} | Allows you to retrieve a specific credit note
|
|
180
|
-
*XeroRuby::AccountingApi* | [**get_credit_note_as_pdf**](docs/AccountingApi.md#get_credit_note_as_pdf) | **GET** /CreditNotes/{CreditNoteID}/pdf | Allows you to retrieve Credit Note as PDF files
|
|
181
|
-
*XeroRuby::AccountingApi* | [**get_credit_note_attachment_by_file_name**](docs/AccountingApi.md#get_credit_note_attachment_by_file_name) | **GET** /CreditNotes/{CreditNoteID}/Attachments/{FileName} | Allows you to retrieve Attachments on CreditNote by file name
|
|
182
|
-
*XeroRuby::AccountingApi* | [**get_credit_note_attachment_by_id**](docs/AccountingApi.md#get_credit_note_attachment_by_id) | **GET** /CreditNotes/{CreditNoteID}/Attachments/{AttachmentID} | Allows you to retrieve Attachments on CreditNote
|
|
183
|
-
*XeroRuby::AccountingApi* | [**get_credit_note_attachments**](docs/AccountingApi.md#get_credit_note_attachments) | **GET** /CreditNotes/{CreditNoteID}/Attachments | Allows you to retrieve Attachments for credit notes
|
|
184
|
-
*XeroRuby::AccountingApi* | [**get_credit_note_history**](docs/AccountingApi.md#get_credit_note_history) | **GET** /CreditNotes/{CreditNoteID}/History | Allows you to retrieve a history records of an CreditNote
|
|
185
|
-
*XeroRuby::AccountingApi* | [**get_credit_notes**](docs/AccountingApi.md#get_credit_notes) | **GET** /CreditNotes | Allows you to retrieve any credit notes
|
|
186
|
-
*XeroRuby::AccountingApi* | [**get_currencies**](docs/AccountingApi.md#get_currencies) | **GET** /Currencies | Allows you to retrieve currencies for your organisation
|
|
187
|
-
*XeroRuby::AccountingApi* | [**get_employee**](docs/AccountingApi.md#get_employee) | **GET** /Employees/{EmployeeID} | Allows you to retrieve a specific employee used in Xero payrun
|
|
188
|
-
*XeroRuby::AccountingApi* | [**get_employees**](docs/AccountingApi.md#get_employees) | **GET** /Employees | Allows you to retrieve employees used in Xero payrun
|
|
189
|
-
*XeroRuby::AccountingApi* | [**get_expense_claim**](docs/AccountingApi.md#get_expense_claim) | **GET** /ExpenseClaims/{ExpenseClaimID} | Allows you to retrieve a specified expense claim
|
|
190
|
-
*XeroRuby::AccountingApi* | [**get_expense_claim_history**](docs/AccountingApi.md#get_expense_claim_history) | **GET** /ExpenseClaims/{ExpenseClaimID}/History | Allows you to retrieve a history records of an ExpenseClaim
|
|
191
|
-
*XeroRuby::AccountingApi* | [**get_expense_claims**](docs/AccountingApi.md#get_expense_claims) | **GET** /ExpenseClaims | Allows you to retrieve expense claims
|
|
192
|
-
*XeroRuby::AccountingApi* | [**get_invoice**](docs/AccountingApi.md#get_invoice) | **GET** /Invoices/{InvoiceID} | Allows you to retrieve a specified sales invoice or purchase bill
|
|
193
|
-
*XeroRuby::AccountingApi* | [**get_invoice_as_pdf**](docs/AccountingApi.md#get_invoice_as_pdf) | **GET** /Invoices/{InvoiceID}/pdf | Allows you to retrieve invoices or purchase bills as PDF files
|
|
194
|
-
*XeroRuby::AccountingApi* | [**get_invoice_attachment_by_file_name**](docs/AccountingApi.md#get_invoice_attachment_by_file_name) | **GET** /Invoices/{InvoiceID}/Attachments/{FileName} | Allows you to retrieve Attachment on invoices or purchase bills by it's filename
|
|
195
|
-
*XeroRuby::AccountingApi* | [**get_invoice_attachment_by_id**](docs/AccountingApi.md#get_invoice_attachment_by_id) | **GET** /Invoices/{InvoiceID}/Attachments/{AttachmentID} | Allows you to retrieve a specified Attachment on invoices or purchase bills by it's ID
|
|
196
|
-
*XeroRuby::AccountingApi* | [**get_invoice_attachments**](docs/AccountingApi.md#get_invoice_attachments) | **GET** /Invoices/{InvoiceID}/Attachments | Allows you to retrieve Attachments on invoices or purchase bills
|
|
197
|
-
*XeroRuby::AccountingApi* | [**get_invoice_history**](docs/AccountingApi.md#get_invoice_history) | **GET** /Invoices/{InvoiceID}/History | Allows you to retrieve a history records of an invoice
|
|
198
|
-
*XeroRuby::AccountingApi* | [**get_invoice_reminders**](docs/AccountingApi.md#get_invoice_reminders) | **GET** /InvoiceReminders/Settings | Allows you to retrieve invoice reminder settings
|
|
199
|
-
*XeroRuby::AccountingApi* | [**get_invoices**](docs/AccountingApi.md#get_invoices) | **GET** /Invoices | Allows you to retrieve any sales invoices or purchase bills
|
|
200
|
-
*XeroRuby::AccountingApi* | [**get_item**](docs/AccountingApi.md#get_item) | **GET** /Items/{ItemID} | Allows you to retrieve a specified item
|
|
201
|
-
*XeroRuby::AccountingApi* | [**get_item_history**](docs/AccountingApi.md#get_item_history) | **GET** /Items/{ItemID}/History | Allows you to retrieve history for items
|
|
202
|
-
*XeroRuby::AccountingApi* | [**get_items**](docs/AccountingApi.md#get_items) | **GET** /Items | Allows you to retrieve any items
|
|
203
|
-
*XeroRuby::AccountingApi* | [**get_journal**](docs/AccountingApi.md#get_journal) | **GET** /Journals/{JournalID} | Allows you to retrieve a specified journals.
|
|
204
|
-
*XeroRuby::AccountingApi* | [**get_journals**](docs/AccountingApi.md#get_journals) | **GET** /Journals | Allows you to retrieve any journals.
|
|
205
|
-
*XeroRuby::AccountingApi* | [**get_linked_transaction**](docs/AccountingApi.md#get_linked_transaction) | **GET** /LinkedTransactions/{LinkedTransactionID} | Allows you to retrieve a specified linked transactions (billable expenses)
|
|
206
|
-
*XeroRuby::AccountingApi* | [**get_linked_transactions**](docs/AccountingApi.md#get_linked_transactions) | **GET** /LinkedTransactions | Retrieve linked transactions (billable expenses)
|
|
207
|
-
*XeroRuby::AccountingApi* | [**get_manual_journal**](docs/AccountingApi.md#get_manual_journal) | **GET** /ManualJournals/{ManualJournalID} | Allows you to retrieve a specified manual journals
|
|
208
|
-
*XeroRuby::AccountingApi* | [**get_manual_journal_attachment_by_file_name**](docs/AccountingApi.md#get_manual_journal_attachment_by_file_name) | **GET** /ManualJournals/{ManualJournalID}/Attachments/{FileName} | Allows you to retrieve specified Attachment on ManualJournal by file name
|
|
209
|
-
*XeroRuby::AccountingApi* | [**get_manual_journal_attachment_by_id**](docs/AccountingApi.md#get_manual_journal_attachment_by_id) | **GET** /ManualJournals/{ManualJournalID}/Attachments/{AttachmentID} | Allows you to retrieve specified Attachment on ManualJournals
|
|
210
|
-
*XeroRuby::AccountingApi* | [**get_manual_journal_attachments**](docs/AccountingApi.md#get_manual_journal_attachments) | **GET** /ManualJournals/{ManualJournalID}/Attachments | Allows you to retrieve Attachment for manual journals
|
|
211
|
-
*XeroRuby::AccountingApi* | [**get_manual_journals**](docs/AccountingApi.md#get_manual_journals) | **GET** /ManualJournals | Allows you to retrieve any manual journals
|
|
212
|
-
*XeroRuby::AccountingApi* | [**get_online_invoice**](docs/AccountingApi.md#get_online_invoice) | **GET** /Invoices/{InvoiceID}/OnlineInvoice | Allows you to retrieve a URL to an online invoice
|
|
213
|
-
*XeroRuby::AccountingApi* | [**get_organisation_cis_settings**](docs/AccountingApi.md#get_organisation_cis_settings) | **GET** /Organisation/{OrganisationID}/CISSettings | Allows you To verify if an organisation is using contruction industry scheme, you can retrieve the CIS settings for the organistaion.
|
|
214
|
-
*XeroRuby::AccountingApi* | [**get_organisations**](docs/AccountingApi.md#get_organisations) | **GET** /Organisation | Allows you to retrieve Organisation details
|
|
215
|
-
*XeroRuby::AccountingApi* | [**get_overpayment**](docs/AccountingApi.md#get_overpayment) | **GET** /Overpayments/{OverpaymentID} | Allows you to retrieve a specified overpayments
|
|
216
|
-
*XeroRuby::AccountingApi* | [**get_overpayment_history**](docs/AccountingApi.md#get_overpayment_history) | **GET** /Overpayments/{OverpaymentID}/History | Allows you to retrieve a history records of an Overpayment
|
|
217
|
-
*XeroRuby::AccountingApi* | [**get_overpayments**](docs/AccountingApi.md#get_overpayments) | **GET** /Overpayments | Allows you to retrieve overpayments
|
|
218
|
-
*XeroRuby::AccountingApi* | [**get_payment**](docs/AccountingApi.md#get_payment) | **GET** /Payments/{PaymentID} | Allows you to retrieve a specified payment for invoices and credit notes
|
|
219
|
-
*XeroRuby::AccountingApi* | [**get_payment_history**](docs/AccountingApi.md#get_payment_history) | **GET** /Payments/{PaymentID}/History | Allows you to retrieve history records of a payment
|
|
220
|
-
*XeroRuby::AccountingApi* | [**get_payment_services**](docs/AccountingApi.md#get_payment_services) | **GET** /PaymentServices | Allows you to retrieve payment services
|
|
221
|
-
*XeroRuby::AccountingApi* | [**get_payments**](docs/AccountingApi.md#get_payments) | **GET** /Payments | Allows you to retrieve payments for invoices and credit notes
|
|
222
|
-
*XeroRuby::AccountingApi* | [**get_prepayment**](docs/AccountingApi.md#get_prepayment) | **GET** /Prepayments/{PrepaymentID} | Allows you to retrieve a specified prepayments
|
|
223
|
-
*XeroRuby::AccountingApi* | [**get_prepayment_history**](docs/AccountingApi.md#get_prepayment_history) | **GET** /Prepayments/{PrepaymentID}/History | Allows you to retrieve a history records of an Prepayment
|
|
224
|
-
*XeroRuby::AccountingApi* | [**get_prepayments**](docs/AccountingApi.md#get_prepayments) | **GET** /Prepayments | Allows you to retrieve prepayments
|
|
225
|
-
*XeroRuby::AccountingApi* | [**get_purchase_order**](docs/AccountingApi.md#get_purchase_order) | **GET** /PurchaseOrders/{PurchaseOrderID} | Allows you to retrieve a specified purchase orders
|
|
226
|
-
*XeroRuby::AccountingApi* | [**get_purchase_order_by_number**](docs/AccountingApi.md#get_purchase_order_by_number) | **GET** /PurchaseOrders/{PurchaseOrderNumber} | Allows you to retrieve a specified purchase orders
|
|
227
|
-
*XeroRuby::AccountingApi* | [**get_purchase_order_history**](docs/AccountingApi.md#get_purchase_order_history) | **GET** /PurchaseOrders/{PurchaseOrderID}/History | Allows you to retrieve history for PurchaseOrder
|
|
228
|
-
*XeroRuby::AccountingApi* | [**get_purchase_orders**](docs/AccountingApi.md#get_purchase_orders) | **GET** /PurchaseOrders | Allows you to retrieve purchase orders
|
|
229
|
-
*XeroRuby::AccountingApi* | [**get_quote**](docs/AccountingApi.md#get_quote) | **GET** /Quotes/{QuoteID} | Allows you to retrieve a specified quote
|
|
230
|
-
*XeroRuby::AccountingApi* | [**get_quote_as_pdf**](docs/AccountingApi.md#get_quote_as_pdf) | **GET** /Quotes/{QuotesID}/pdf | Allows you to retrieve quotes as PDF files
|
|
231
|
-
*XeroRuby::AccountingApi* | [**get_quote_attachment_by_file_name**](docs/AccountingApi.md#get_quote_attachment_by_file_name) | **GET** /Quotes/{QuoteID}/Attachments/{FileName} | Allows you to retrieve Attachment on Quote by Filename
|
|
232
|
-
*XeroRuby::AccountingApi* | [**get_quote_attachment_by_id**](docs/AccountingApi.md#get_quote_attachment_by_id) | **GET** /Quotes/{QuoteID}/Attachments/{AttachmentID} | Allows you to retrieve specific Attachment on Quote
|
|
233
|
-
*XeroRuby::AccountingApi* | [**get_quote_attachments**](docs/AccountingApi.md#get_quote_attachments) | **GET** /Quotes/{QuoteID}/Attachments | Allows you to retrieve Attachments for Quotes
|
|
234
|
-
*XeroRuby::AccountingApi* | [**get_quote_history**](docs/AccountingApi.md#get_quote_history) | **GET** /Quotes/{QuoteID}/History | Allows you to retrieve a history records of an quote
|
|
235
|
-
*XeroRuby::AccountingApi* | [**get_quotes**](docs/AccountingApi.md#get_quotes) | **GET** /Quotes | Allows you to retrieve any sales quotes
|
|
236
|
-
*XeroRuby::AccountingApi* | [**get_receipt**](docs/AccountingApi.md#get_receipt) | **GET** /Receipts/{ReceiptID} | Allows you to retrieve a specified draft expense claim receipts
|
|
237
|
-
*XeroRuby::AccountingApi* | [**get_receipt_attachment_by_file_name**](docs/AccountingApi.md#get_receipt_attachment_by_file_name) | **GET** /Receipts/{ReceiptID}/Attachments/{FileName} | Allows you to retrieve Attachments on expense claim receipts by file name
|
|
238
|
-
*XeroRuby::AccountingApi* | [**get_receipt_attachment_by_id**](docs/AccountingApi.md#get_receipt_attachment_by_id) | **GET** /Receipts/{ReceiptID}/Attachments/{AttachmentID} | Allows you to retrieve Attachments on expense claim receipts by ID
|
|
239
|
-
*XeroRuby::AccountingApi* | [**get_receipt_attachments**](docs/AccountingApi.md#get_receipt_attachments) | **GET** /Receipts/{ReceiptID}/Attachments | Allows you to retrieve Attachments for expense claim receipts
|
|
240
|
-
*XeroRuby::AccountingApi* | [**get_receipt_history**](docs/AccountingApi.md#get_receipt_history) | **GET** /Receipts/{ReceiptID}/History | Allows you to retrieve a history records of an Receipt
|
|
241
|
-
*XeroRuby::AccountingApi* | [**get_receipts**](docs/AccountingApi.md#get_receipts) | **GET** /Receipts | Allows you to retrieve draft expense claim receipts for any user
|
|
242
|
-
*XeroRuby::AccountingApi* | [**get_repeating_invoice**](docs/AccountingApi.md#get_repeating_invoice) | **GET** /RepeatingInvoices/{RepeatingInvoiceID} | Allows you to retrieve a specified repeating invoice
|
|
243
|
-
*XeroRuby::AccountingApi* | [**get_repeating_invoice_attachment_by_file_name**](docs/AccountingApi.md#get_repeating_invoice_attachment_by_file_name) | **GET** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} | Allows you to retrieve specified attachment on repeating invoices by file name
|
|
244
|
-
*XeroRuby::AccountingApi* | [**get_repeating_invoice_attachment_by_id**](docs/AccountingApi.md#get_repeating_invoice_attachment_by_id) | **GET** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID} | Allows you to retrieve a specified Attachments on repeating invoices
|
|
245
|
-
*XeroRuby::AccountingApi* | [**get_repeating_invoice_attachments**](docs/AccountingApi.md#get_repeating_invoice_attachments) | **GET** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments | Allows you to retrieve Attachments on repeating invoice
|
|
246
|
-
*XeroRuby::AccountingApi* | [**get_repeating_invoice_history**](docs/AccountingApi.md#get_repeating_invoice_history) | **GET** /RepeatingInvoices/{RepeatingInvoiceID}/History | Allows you to retrieve history for a repeating invoice
|
|
247
|
-
*XeroRuby::AccountingApi* | [**get_repeating_invoices**](docs/AccountingApi.md#get_repeating_invoices) | **GET** /RepeatingInvoices | Allows you to retrieve any repeating invoices
|
|
248
|
-
*XeroRuby::AccountingApi* | [**get_report_aged_payables_by_contact**](docs/AccountingApi.md#get_report_aged_payables_by_contact) | **GET** /Reports/AgedPayablesByContact | Allows you to retrieve report for AgedPayablesByContact
|
|
249
|
-
*XeroRuby::AccountingApi* | [**get_report_aged_receivables_by_contact**](docs/AccountingApi.md#get_report_aged_receivables_by_contact) | **GET** /Reports/AgedReceivablesByContact | Allows you to retrieve report for AgedReceivablesByContact
|
|
250
|
-
*XeroRuby::AccountingApi* | [**get_report_ba_sor_gst**](docs/AccountingApi.md#get_report_ba_sor_gst) | **GET** /Reports/{ReportID} | Allows you to retrieve report for BAS only valid for AU orgs
|
|
251
|
-
*XeroRuby::AccountingApi* | [**get_report_ba_sor_gst_list**](docs/AccountingApi.md#get_report_ba_sor_gst_list) | **GET** /Reports | Allows you to retrieve report for BAS only valid for AU orgs
|
|
252
|
-
*XeroRuby::AccountingApi* | [**get_report_balance_sheet**](docs/AccountingApi.md#get_report_balance_sheet) | **GET** /Reports/BalanceSheet | Allows you to retrieve report for BalanceSheet
|
|
253
|
-
*XeroRuby::AccountingApi* | [**get_report_bank_summary**](docs/AccountingApi.md#get_report_bank_summary) | **GET** /Reports/BankSummary | Allows you to retrieve report for BankSummary
|
|
254
|
-
*XeroRuby::AccountingApi* | [**get_report_budget_summary**](docs/AccountingApi.md#get_report_budget_summary) | **GET** /Reports/BudgetSummary | Allows you to retrieve report for Budget Summary
|
|
255
|
-
*XeroRuby::AccountingApi* | [**get_report_executive_summary**](docs/AccountingApi.md#get_report_executive_summary) | **GET** /Reports/ExecutiveSummary | Allows you to retrieve report for ExecutiveSummary
|
|
256
|
-
*XeroRuby::AccountingApi* | [**get_report_profit_and_loss**](docs/AccountingApi.md#get_report_profit_and_loss) | **GET** /Reports/ProfitAndLoss | Allows you to retrieve report for ProfitAndLoss
|
|
257
|
-
*XeroRuby::AccountingApi* | [**get_report_ten_ninety_nine**](docs/AccountingApi.md#get_report_ten_ninety_nine) | **GET** /Reports/TenNinetyNine | Allows you to retrieve report for TenNinetyNine
|
|
258
|
-
*XeroRuby::AccountingApi* | [**get_report_trial_balance**](docs/AccountingApi.md#get_report_trial_balance) | **GET** /Reports/TrialBalance | Allows you to retrieve report for TrialBalance
|
|
259
|
-
*XeroRuby::AccountingApi* | [**get_tax_rates**](docs/AccountingApi.md#get_tax_rates) | **GET** /TaxRates | Allows you to retrieve Tax Rates
|
|
260
|
-
*XeroRuby::AccountingApi* | [**get_tracking_categories**](docs/AccountingApi.md#get_tracking_categories) | **GET** /TrackingCategories | Allows you to retrieve tracking categories and options
|
|
261
|
-
*XeroRuby::AccountingApi* | [**get_tracking_category**](docs/AccountingApi.md#get_tracking_category) | **GET** /TrackingCategories/{TrackingCategoryID} | Allows you to retrieve tracking categories and options for specified category
|
|
262
|
-
*XeroRuby::AccountingApi* | [**get_user**](docs/AccountingApi.md#get_user) | **GET** /Users/{UserID} | Allows you to retrieve a specified user
|
|
263
|
-
*XeroRuby::AccountingApi* | [**get_users**](docs/AccountingApi.md#get_users) | **GET** /Users | Allows you to retrieve users
|
|
264
|
-
*XeroRuby::AccountingApi* | [**update_account**](docs/AccountingApi.md#update_account) | **POST** /Accounts/{AccountID} | Allows you to update a chart of accounts
|
|
265
|
-
*XeroRuby::AccountingApi* | [**update_account_attachment_by_file_name**](docs/AccountingApi.md#update_account_attachment_by_file_name) | **POST** /Accounts/{AccountID}/Attachments/{FileName} | Allows you to update Attachment on Account by Filename
|
|
266
|
-
*XeroRuby::AccountingApi* | [**update_bank_transaction**](docs/AccountingApi.md#update_bank_transaction) | **POST** /BankTransactions/{BankTransactionID} | Allows you to update a single spend or receive money transaction
|
|
267
|
-
*XeroRuby::AccountingApi* | [**update_bank_transaction_attachment_by_file_name**](docs/AccountingApi.md#update_bank_transaction_attachment_by_file_name) | **POST** /BankTransactions/{BankTransactionID}/Attachments/{FileName} | Allows you to update an Attachment on BankTransaction by Filename
|
|
268
|
-
*XeroRuby::AccountingApi* | [**update_bank_transfer_attachment_by_file_name**](docs/AccountingApi.md#update_bank_transfer_attachment_by_file_name) | **POST** /BankTransfers/{BankTransferID}/Attachments/{FileName} |
|
|
269
|
-
*XeroRuby::AccountingApi* | [**update_contact**](docs/AccountingApi.md#update_contact) | **POST** /Contacts/{ContactID} |
|
|
270
|
-
*XeroRuby::AccountingApi* | [**update_contact_attachment_by_file_name**](docs/AccountingApi.md#update_contact_attachment_by_file_name) | **POST** /Contacts/{ContactID}/Attachments/{FileName} |
|
|
271
|
-
*XeroRuby::AccountingApi* | [**update_contact_group**](docs/AccountingApi.md#update_contact_group) | **POST** /ContactGroups/{ContactGroupID} | Allows you to update a Contact Group
|
|
272
|
-
*XeroRuby::AccountingApi* | [**update_credit_note**](docs/AccountingApi.md#update_credit_note) | **POST** /CreditNotes/{CreditNoteID} | Allows you to update a specific credit note
|
|
273
|
-
*XeroRuby::AccountingApi* | [**update_credit_note_attachment_by_file_name**](docs/AccountingApi.md#update_credit_note_attachment_by_file_name) | **POST** /CreditNotes/{CreditNoteID}/Attachments/{FileName} | Allows you to update Attachments on CreditNote by file name
|
|
274
|
-
*XeroRuby::AccountingApi* | [**update_expense_claim**](docs/AccountingApi.md#update_expense_claim) | **POST** /ExpenseClaims/{ExpenseClaimID} | Allows you to update specified expense claims
|
|
275
|
-
*XeroRuby::AccountingApi* | [**update_invoice**](docs/AccountingApi.md#update_invoice) | **POST** /Invoices/{InvoiceID} | Allows you to update a specified sales invoices or purchase bills
|
|
276
|
-
*XeroRuby::AccountingApi* | [**update_invoice_attachment_by_file_name**](docs/AccountingApi.md#update_invoice_attachment_by_file_name) | **POST** /Invoices/{InvoiceID}/Attachments/{FileName} | Allows you to update Attachment on invoices or purchase bills by it's filename
|
|
277
|
-
*XeroRuby::AccountingApi* | [**update_item**](docs/AccountingApi.md#update_item) | **POST** /Items/{ItemID} | Allows you to update a specified item
|
|
278
|
-
*XeroRuby::AccountingApi* | [**update_linked_transaction**](docs/AccountingApi.md#update_linked_transaction) | **POST** /LinkedTransactions/{LinkedTransactionID} | Allows you to update a specified linked transactions (billable expenses)
|
|
279
|
-
*XeroRuby::AccountingApi* | [**update_manual_journal**](docs/AccountingApi.md#update_manual_journal) | **POST** /ManualJournals/{ManualJournalID} | Allows you to update a specified manual journal
|
|
280
|
-
*XeroRuby::AccountingApi* | [**update_manual_journal_attachment_by_file_name**](docs/AccountingApi.md#update_manual_journal_attachment_by_file_name) | **POST** /ManualJournals/{ManualJournalID}/Attachments/{FileName} | Allows you to update a specified Attachment on ManualJournal by file name
|
|
281
|
-
*XeroRuby::AccountingApi* | [**update_or_create_bank_transactions**](docs/AccountingApi.md#update_or_create_bank_transactions) | **POST** /BankTransactions | Allows you to update or create one or more spend or receive money transaction
|
|
282
|
-
*XeroRuby::AccountingApi* | [**update_or_create_contacts**](docs/AccountingApi.md#update_or_create_contacts) | **POST** /Contacts | Allows you to update OR create one or more contacts in a Xero organisation
|
|
283
|
-
*XeroRuby::AccountingApi* | [**update_or_create_credit_notes**](docs/AccountingApi.md#update_or_create_credit_notes) | **POST** /CreditNotes | Allows you to update OR create one or more credit notes
|
|
284
|
-
*XeroRuby::AccountingApi* | [**update_or_create_employees**](docs/AccountingApi.md#update_or_create_employees) | **POST** /Employees | Allows you to create a single new employees used in Xero payrun
|
|
285
|
-
*XeroRuby::AccountingApi* | [**update_or_create_invoices**](docs/AccountingApi.md#update_or_create_invoices) | **POST** /Invoices | Allows you to update OR create one or more sales invoices or purchase bills
|
|
286
|
-
*XeroRuby::AccountingApi* | [**update_or_create_items**](docs/AccountingApi.md#update_or_create_items) | **POST** /Items | Allows you to update or create one or more items
|
|
287
|
-
*XeroRuby::AccountingApi* | [**update_or_create_manual_journals**](docs/AccountingApi.md#update_or_create_manual_journals) | **POST** /ManualJournals | Allows you to create a single manual journal
|
|
288
|
-
*XeroRuby::AccountingApi* | [**update_or_create_purchase_orders**](docs/AccountingApi.md#update_or_create_purchase_orders) | **POST** /PurchaseOrders | Allows you to update or create one or more purchase orders
|
|
289
|
-
*XeroRuby::AccountingApi* | [**update_or_create_quotes**](docs/AccountingApi.md#update_or_create_quotes) | **POST** /Quotes | Allows you to update OR create one or more quotes
|
|
290
|
-
*XeroRuby::AccountingApi* | [**update_purchase_order**](docs/AccountingApi.md#update_purchase_order) | **POST** /PurchaseOrders/{PurchaseOrderID} | Allows you to update a specified purchase order
|
|
291
|
-
*XeroRuby::AccountingApi* | [**update_quote**](docs/AccountingApi.md#update_quote) | **POST** /Quotes/{QuoteID} | Allows you to update a specified quote
|
|
292
|
-
*XeroRuby::AccountingApi* | [**update_quote_attachment_by_file_name**](docs/AccountingApi.md#update_quote_attachment_by_file_name) | **POST** /Quotes/{QuoteID}/Attachments/{FileName} | Allows you to update Attachment on Quote by Filename
|
|
293
|
-
*XeroRuby::AccountingApi* | [**update_receipt**](docs/AccountingApi.md#update_receipt) | **POST** /Receipts/{ReceiptID} | Allows you to retrieve a specified draft expense claim receipts
|
|
294
|
-
*XeroRuby::AccountingApi* | [**update_receipt_attachment_by_file_name**](docs/AccountingApi.md#update_receipt_attachment_by_file_name) | **POST** /Receipts/{ReceiptID}/Attachments/{FileName} | Allows you to update Attachment on expense claim receipts by file name
|
|
295
|
-
*XeroRuby::AccountingApi* | [**update_repeating_invoice_attachment_by_file_name**](docs/AccountingApi.md#update_repeating_invoice_attachment_by_file_name) | **POST** /RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName} | Allows you to update specified attachment on repeating invoices by file name
|
|
296
|
-
*XeroRuby::AccountingApi* | [**update_tax_rate**](docs/AccountingApi.md#update_tax_rate) | **POST** /TaxRates | Allows you to update Tax Rates
|
|
297
|
-
*XeroRuby::AccountingApi* | [**update_tracking_category**](docs/AccountingApi.md#update_tracking_category) | **POST** /TrackingCategories/{TrackingCategoryID} | Allows you to update tracking categories
|
|
298
|
-
*XeroRuby::AccountingApi* | [**update_tracking_options**](docs/AccountingApi.md#update_tracking_options) | **POST** /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID} | Allows you to update options for a specified tracking category
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
## Documentation for Models
|
|
302
|
-
|
|
303
|
-
- [XeroRuby::Account](docs/Account.md)
|
|
304
|
-
- [XeroRuby::AccountType](docs/AccountType.md)
|
|
305
|
-
- [XeroRuby::Accounts](docs/Accounts.md)
|
|
306
|
-
- [XeroRuby::AccountsPayable](docs/AccountsPayable.md)
|
|
307
|
-
- [XeroRuby::AccountsReceivable](docs/AccountsReceivable.md)
|
|
308
|
-
- [XeroRuby::Address](docs/Address.md)
|
|
309
|
-
- [XeroRuby::Allocation](docs/Allocation.md)
|
|
310
|
-
- [XeroRuby::Allocations](docs/Allocations.md)
|
|
311
|
-
- [XeroRuby::Attachment](docs/Attachment.md)
|
|
312
|
-
- [XeroRuby::Attachments](docs/Attachments.md)
|
|
313
|
-
- [XeroRuby::Balances](docs/Balances.md)
|
|
314
|
-
- [XeroRuby::BankTransaction](docs/BankTransaction.md)
|
|
315
|
-
- [XeroRuby::BankTransactions](docs/BankTransactions.md)
|
|
316
|
-
- [XeroRuby::BankTransfer](docs/BankTransfer.md)
|
|
317
|
-
- [XeroRuby::BankTransfers](docs/BankTransfers.md)
|
|
318
|
-
- [XeroRuby::BatchPayment](docs/BatchPayment.md)
|
|
319
|
-
- [XeroRuby::BatchPaymentDetails](docs/BatchPaymentDetails.md)
|
|
320
|
-
- [XeroRuby::BatchPayments](docs/BatchPayments.md)
|
|
321
|
-
- [XeroRuby::Bill](docs/Bill.md)
|
|
322
|
-
- [XeroRuby::BrandingTheme](docs/BrandingTheme.md)
|
|
323
|
-
- [XeroRuby::BrandingThemes](docs/BrandingThemes.md)
|
|
324
|
-
- [XeroRuby::CISOrgSetting](docs/CISOrgSetting.md)
|
|
325
|
-
- [XeroRuby::CISSetting](docs/CISSetting.md)
|
|
326
|
-
- [XeroRuby::CISSettings](docs/CISSettings.md)
|
|
327
|
-
- [XeroRuby::Contact](docs/Contact.md)
|
|
328
|
-
- [XeroRuby::ContactGroup](docs/ContactGroup.md)
|
|
329
|
-
- [XeroRuby::ContactGroups](docs/ContactGroups.md)
|
|
330
|
-
- [XeroRuby::ContactPerson](docs/ContactPerson.md)
|
|
331
|
-
- [XeroRuby::Contacts](docs/Contacts.md)
|
|
332
|
-
- [XeroRuby::CountryCode](docs/CountryCode.md)
|
|
333
|
-
- [XeroRuby::CreditNote](docs/CreditNote.md)
|
|
334
|
-
- [XeroRuby::CreditNotes](docs/CreditNotes.md)
|
|
335
|
-
- [XeroRuby::Currencies](docs/Currencies.md)
|
|
336
|
-
- [XeroRuby::Currency](docs/Currency.md)
|
|
337
|
-
- [XeroRuby::CurrencyCode](docs/CurrencyCode.md)
|
|
338
|
-
- [XeroRuby::Element](docs/Element.md)
|
|
339
|
-
- [XeroRuby::Employee](docs/Employee.md)
|
|
340
|
-
- [XeroRuby::Employees](docs/Employees.md)
|
|
341
|
-
- [XeroRuby::Error](docs/Error.md)
|
|
342
|
-
- [XeroRuby::ExpenseClaim](docs/ExpenseClaim.md)
|
|
343
|
-
- [XeroRuby::ExpenseClaims](docs/ExpenseClaims.md)
|
|
344
|
-
- [XeroRuby::ExternalLink](docs/ExternalLink.md)
|
|
345
|
-
- [XeroRuby::HistoryRecord](docs/HistoryRecord.md)
|
|
346
|
-
- [XeroRuby::HistoryRecords](docs/HistoryRecords.md)
|
|
347
|
-
- [XeroRuby::Invoice](docs/Invoice.md)
|
|
348
|
-
- [XeroRuby::InvoiceReminder](docs/InvoiceReminder.md)
|
|
349
|
-
- [XeroRuby::InvoiceReminders](docs/InvoiceReminders.md)
|
|
350
|
-
- [XeroRuby::Invoices](docs/Invoices.md)
|
|
351
|
-
- [XeroRuby::Item](docs/Item.md)
|
|
352
|
-
- [XeroRuby::Items](docs/Items.md)
|
|
353
|
-
- [XeroRuby::Journal](docs/Journal.md)
|
|
354
|
-
- [XeroRuby::JournalLine](docs/JournalLine.md)
|
|
355
|
-
- [XeroRuby::Journals](docs/Journals.md)
|
|
356
|
-
- [XeroRuby::LineAmountTypes](docs/LineAmountTypes.md)
|
|
357
|
-
- [XeroRuby::LineItem](docs/LineItem.md)
|
|
358
|
-
- [XeroRuby::LineItemTracking](docs/LineItemTracking.md)
|
|
359
|
-
- [XeroRuby::LinkedTransaction](docs/LinkedTransaction.md)
|
|
360
|
-
- [XeroRuby::LinkedTransactions](docs/LinkedTransactions.md)
|
|
361
|
-
- [XeroRuby::ManualJournal](docs/ManualJournal.md)
|
|
362
|
-
- [XeroRuby::ManualJournalLine](docs/ManualJournalLine.md)
|
|
363
|
-
- [XeroRuby::ManualJournals](docs/ManualJournals.md)
|
|
364
|
-
- [XeroRuby::OnlineInvoice](docs/OnlineInvoice.md)
|
|
365
|
-
- [XeroRuby::OnlineInvoices](docs/OnlineInvoices.md)
|
|
366
|
-
- [XeroRuby::Organisation](docs/Organisation.md)
|
|
367
|
-
- [XeroRuby::Organisations](docs/Organisations.md)
|
|
368
|
-
- [XeroRuby::Overpayment](docs/Overpayment.md)
|
|
369
|
-
- [XeroRuby::Overpayments](docs/Overpayments.md)
|
|
370
|
-
- [XeroRuby::Payment](docs/Payment.md)
|
|
371
|
-
- [XeroRuby::PaymentDelete](docs/PaymentDelete.md)
|
|
372
|
-
- [XeroRuby::PaymentService](docs/PaymentService.md)
|
|
373
|
-
- [XeroRuby::PaymentServices](docs/PaymentServices.md)
|
|
374
|
-
- [XeroRuby::PaymentTerm](docs/PaymentTerm.md)
|
|
375
|
-
- [XeroRuby::PaymentTermType](docs/PaymentTermType.md)
|
|
376
|
-
- [XeroRuby::Payments](docs/Payments.md)
|
|
377
|
-
- [XeroRuby::Phone](docs/Phone.md)
|
|
378
|
-
- [XeroRuby::Prepayment](docs/Prepayment.md)
|
|
379
|
-
- [XeroRuby::Prepayments](docs/Prepayments.md)
|
|
380
|
-
- [XeroRuby::Purchase](docs/Purchase.md)
|
|
381
|
-
- [XeroRuby::PurchaseOrder](docs/PurchaseOrder.md)
|
|
382
|
-
- [XeroRuby::PurchaseOrders](docs/PurchaseOrders.md)
|
|
383
|
-
- [XeroRuby::Quote](docs/Quote.md)
|
|
384
|
-
- [XeroRuby::QuoteLineAmountTypes](docs/QuoteLineAmountTypes.md)
|
|
385
|
-
- [XeroRuby::QuoteStatusCodes](docs/QuoteStatusCodes.md)
|
|
386
|
-
- [XeroRuby::Quotes](docs/Quotes.md)
|
|
387
|
-
- [XeroRuby::Receipt](docs/Receipt.md)
|
|
388
|
-
- [XeroRuby::Receipts](docs/Receipts.md)
|
|
389
|
-
- [XeroRuby::RepeatingInvoice](docs/RepeatingInvoice.md)
|
|
390
|
-
- [XeroRuby::RepeatingInvoices](docs/RepeatingInvoices.md)
|
|
391
|
-
- [XeroRuby::Report](docs/Report.md)
|
|
392
|
-
- [XeroRuby::ReportAttribute](docs/ReportAttribute.md)
|
|
393
|
-
- [XeroRuby::ReportCell](docs/ReportCell.md)
|
|
394
|
-
- [XeroRuby::ReportFields](docs/ReportFields.md)
|
|
395
|
-
- [XeroRuby::ReportRow](docs/ReportRow.md)
|
|
396
|
-
- [XeroRuby::ReportRows](docs/ReportRows.md)
|
|
397
|
-
- [XeroRuby::ReportWithRow](docs/ReportWithRow.md)
|
|
398
|
-
- [XeroRuby::ReportWithRows](docs/ReportWithRows.md)
|
|
399
|
-
- [XeroRuby::Reports](docs/Reports.md)
|
|
400
|
-
- [XeroRuby::RequestEmpty](docs/RequestEmpty.md)
|
|
401
|
-
- [XeroRuby::RowType](docs/RowType.md)
|
|
402
|
-
- [XeroRuby::SalesTrackingCategory](docs/SalesTrackingCategory.md)
|
|
403
|
-
- [XeroRuby::Schedule](docs/Schedule.md)
|
|
404
|
-
- [XeroRuby::TaxComponent](docs/TaxComponent.md)
|
|
405
|
-
- [XeroRuby::TaxRate](docs/TaxRate.md)
|
|
406
|
-
- [XeroRuby::TaxRates](docs/TaxRates.md)
|
|
407
|
-
- [XeroRuby::TaxType](docs/TaxType.md)
|
|
408
|
-
- [XeroRuby::TenNinteyNineContact](docs/TenNinteyNineContact.md)
|
|
409
|
-
- [XeroRuby::TimeZone](docs/TimeZone.md)
|
|
410
|
-
- [XeroRuby::TrackingCategories](docs/TrackingCategories.md)
|
|
411
|
-
- [XeroRuby::TrackingCategory](docs/TrackingCategory.md)
|
|
412
|
-
- [XeroRuby::TrackingOption](docs/TrackingOption.md)
|
|
413
|
-
- [XeroRuby::TrackingOptions](docs/TrackingOptions.md)
|
|
414
|
-
- [XeroRuby::User](docs/User.md)
|
|
415
|
-
- [XeroRuby::Users](docs/Users.md)
|
|
416
|
-
- [XeroRuby::ValidationError](docs/ValidationError.md)
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
## Documentation for Authorization
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
### OAuth2
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
- **Type**: OAuth
|
|
426
|
-
- **Flow**: accessCode
|
|
427
|
-
- **Authorization URL**: https://login.xero.com/identity/connect/authorize
|
|
428
|
-
- **Scopes**:
|
|
429
|
-
- email: Grant read-only access to your email
|
|
430
|
-
- openid: Grant read-only access to your open id
|
|
431
|
-
- profile: your profile information
|
|
432
|
-
- accounting.transactions: Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
|
|
433
|
-
- accounting.transactions.read: Grant read-only access to invoices
|
|
434
|
-
- accounting.reports.read: Grant read-only access to accounting reports
|
|
435
|
-
- accounting.journals.read: Grant read-only access to journals
|
|
436
|
-
- accounting.settings: Grant read-write access to organisation and account settings
|
|
437
|
-
- accounting.settings.read: Grant read-only access to organisation and account settings
|
|
438
|
-
- accounting.contacts: Grant read-write access to contacts and contact groups
|
|
439
|
-
- accounting.contacts.read: Grant read-only access to contacts and contact groups
|
|
440
|
-
- accounting.attachments: Grant read-write access to attachments
|
|
441
|
-
- accounting.attachments.read: Grant read-only access to attachments
|
|
442
|
-
- assets: Grant read-write access to assets
|
|
443
|
-
- assets.read: Grant read-only access to fixed assets
|
|
444
|
-
- bankfeeds: Grant read-write access to bankfeeds
|
|
445
|
-
- files: Grant read-write access to files and folders
|
|
446
|
-
- files.read: Grant read-only access to files and folders
|
|
447
|
-
- payroll: Grant read-write access to payroll
|
|
448
|
-
- payroll.read: Grant read-only access to payroll
|
|
449
|
-
- payroll.employees: Grant read-write access to payroll employees
|
|
450
|
-
- payroll.employees.read: Grant read-only access to payroll employees
|
|
451
|
-
- payroll.leaveapplications: Grant read-write access to payroll leaveapplications
|
|
452
|
-
- payroll.leaveapplications.read: Grant read-only access to payroll leaveapplications
|
|
453
|
-
- payroll.payitems: Grant read-write access to payroll payitems
|
|
454
|
-
- payroll.payitems.read: Grant read-only access to payroll payitems
|
|
455
|
-
- payroll.payrollcalendars: Grant read-write access to payroll calendars
|
|
456
|
-
- payroll.payrollcalendars.read: Grant read-only access to payroll calendars
|
|
457
|
-
- payroll.payruns: Grant read-write access to payroll payruns
|
|
458
|
-
- payroll.payruns.read: Grant read-only access to payroll payruns
|
|
459
|
-
- payroll.payslip: Grant read-write access to payroll payslips
|
|
460
|
-
- payroll.payslip.read: Grant read-only access to payroll payslips
|
|
461
|
-
- payroll.settings.read: Grant read-only access to payroll settings
|
|
462
|
-
- payroll.superfunds: Grant read-write access to payroll superfunds
|
|
463
|
-
- payroll.superfunds.read: Grant read-only access to payroll superfunds
|
|
464
|
-
- payroll.superfundproducts.read: Grant read-only access to payroll superfundproducts
|
|
465
|
-
- payroll.timesheets: Grant read-write access to payroll timesheets
|
|
466
|
-
- payroll.timesheets.read: Grant read-only access to payroll timesheets
|
|
467
|
-
- paymentservices: Grant read-write access to payment services
|
|
468
|
-
- projects: Grant read-write access to projects
|
|
469
|
-
- projects.read: Grant read-only access to projects
|
|
158
|
+
### APIS
|
|
159
|
+
* [Accounting Api Docs](/docs/accounting/AccountingApi.md)
|
|
160
|
+
* [Asset Api Docs](/docs/assets/AssetApi.md)
|
|
470
161
|
|
|
162
|
+
## Models
|
|
163
|
+
* [Accounting Models Docs](/docs/accounting/)
|
|
164
|
+
* [Asset Models Docs](/docs/assets/)
|