xero-ruby
XeroRuby - the Ruby gem for the Accounting API
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 2.0.1
- Package version: 0.2.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://developer.xero.com
Installation
Build a gem
To build the Ruby code into a gem:
gem build xero-ruby.gemspec
Then either install the gem locally:
gem install ./xero-ruby-0.2.0.gem
(for development, run gem install --dev ./xero-ruby-0.2.0.gem to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'xero-ruby', '~> 0.2.0'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/XeroAPI/xero-ruby, then add the following in the Gemfile:
gem 'xero-ruby', :git => 'https://github.com/XeroAPI/xero-ruby.git'
Include the Ruby code directly
Include the Ruby code directly using -I as follows:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# Load the gem
require 'xero-ruby'
# Setup authorization
XeroRuby.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = XeroRuby::AccountingApi.new
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
account = { code: "123456", name: "Foobar", type: AccountType.EXPENSE, description: "Hello World" } # Account | Account object in body of request
begin
#Allows you to create a new chart of accounts
result = api_instance.create_account(xero_tenant_id, account)
p result
rescue XeroRuby::ApiError => e
puts "Exception when calling AccountingApi->create_account: #{e}"
end
Documentation for API Endpoints
All URIs are relative to https://api.xero.com/api.xro/2.0
| Class | Method | HTTP request | Description |
|---|---|---|---|
| XeroRuby::AccountingApi | create_account | PUT /Accounts | Allows you to create a new chart of accounts |
| XeroRuby::AccountingApi | create_account_attachment_by_file_name | PUT /Accounts/AccountID/Attachments/FileName | Allows you to create Attachment on Account |
| XeroRuby::AccountingApi | create_bank_transaction_attachment_by_file_name | PUT /BankTransactions/BankTransactionID/Attachments/FileName | Allows you to createa an Attachment on BankTransaction by Filename |
| XeroRuby::AccountingApi | create_bank_transaction_history_record | PUT /BankTransactions/BankTransactionID/History | Allows you to create history record for a bank transactions |
| XeroRuby::AccountingApi | create_bank_transactions | PUT /BankTransactions | Allows you to create one or more spend or receive money transaction |
| XeroRuby::AccountingApi | create_bank_transfer | PUT /BankTransfers | Allows you to create a bank transfers |
| XeroRuby::AccountingApi | create_bank_transfer_attachment_by_file_name | PUT /BankTransfers/BankTransferID/Attachments/FileName | |
| XeroRuby::AccountingApi | create_bank_transfer_history_record | PUT /BankTransfers/BankTransferID/History | |
| XeroRuby::AccountingApi | create_batch_payment | PUT /BatchPayments | Create one or many BatchPayments for invoices |
| XeroRuby::AccountingApi | create_batch_payment_history_record | PUT /BatchPayments/BatchPaymentID/History | Allows you to create a history record for a Batch Payment |
| XeroRuby::AccountingApi | create_branding_theme_payment_services | POST /BrandingThemes/BrandingThemeID/PaymentServices | Allow for the creation of new custom payment service for specified Branding Theme |
| XeroRuby::AccountingApi | create_contact_attachment_by_file_name | PUT /Contacts/ContactID/Attachments/FileName | |
| XeroRuby::AccountingApi | create_contact_group | PUT /ContactGroups | Allows you to create a contact group |
| XeroRuby::AccountingApi | create_contact_group_contacts | PUT /ContactGroups/ContactGroupID/Contacts | Allows you to add Contacts to a Contract Group |
| XeroRuby::AccountingApi | create_contact_history | PUT /Contacts/ContactID/History | Allows you to retrieve a history records of an Contact |
| XeroRuby::AccountingApi | create_contacts | PUT /Contacts | Allows you to create a multiple contacts (bulk) in a Xero organisation |
| XeroRuby::AccountingApi | create_credit_note_allocation | PUT /CreditNotes/CreditNoteID/Allocations | Allows you to create Allocation on CreditNote |
| XeroRuby::AccountingApi | create_credit_note_attachment_by_file_name | PUT /CreditNotes/CreditNoteID/Attachments/FileName | Allows you to create Attachments on CreditNote by file name |
| XeroRuby::AccountingApi | create_credit_note_history | PUT /CreditNotes/CreditNoteID/History | Allows you to retrieve a history records of an CreditNote |
| XeroRuby::AccountingApi | create_credit_notes | PUT /CreditNotes | Allows you to create a credit note |
| XeroRuby::AccountingApi | create_currency | PUT /Currencies | |
| XeroRuby::AccountingApi | create_employees | PUT /Employees | Allows you to create new employees used in Xero payrun |
| XeroRuby::AccountingApi | create_expense_claim_history | PUT /ExpenseClaims/ExpenseClaimID/History | Allows you to create a history records of an ExpenseClaim |
| XeroRuby::AccountingApi | create_expense_claims | PUT /ExpenseClaims | Allows you to retrieve expense claims |
| XeroRuby::AccountingApi | 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 |
| XeroRuby::AccountingApi | create_invoice_history | PUT /Invoices/InvoiceID/History | Allows you to retrieve a history records of an invoice |
| XeroRuby::AccountingApi | create_invoices | PUT /Invoices | Allows you to create one or more sales invoices or purchase bills |
| XeroRuby::AccountingApi | create_item_history | PUT /Items/ItemID/History | Allows you to create a history record for items |
| XeroRuby::AccountingApi | create_items | PUT /Items | Allows you to create one or more items |
| XeroRuby::AccountingApi | create_linked_transaction | PUT /LinkedTransactions | Allows you to create linked transactions (billable expenses) |
| XeroRuby::AccountingApi | create_manual_journal_attachment_by_file_name | PUT /ManualJournals/ManualJournalID/Attachments/FileName | Allows you to create a specified Attachment on ManualJournal by file name |
| XeroRuby::AccountingApi | create_manual_journals | PUT /ManualJournals | Allows you to create one or more manual journals |
| XeroRuby::AccountingApi | create_overpayment_allocations | PUT /Overpayments/OverpaymentID/Allocations | Allows you to create a single allocation for an overpayment |
| XeroRuby::AccountingApi | create_overpayment_history | PUT /Overpayments/OverpaymentID/History | Allows you to create history records of an Overpayment |
| XeroRuby::AccountingApi | create_payment | POST /Payments | Allows you to create a single payment for invoices or credit notes |
| XeroRuby::AccountingApi | create_payment_history | PUT /Payments/PaymentID/History | Allows you to create a history record for a payment |
| XeroRuby::AccountingApi | create_payment_service | PUT /PaymentServices | Allows you to create payment services |
| XeroRuby::AccountingApi | create_payments | PUT /Payments | Allows you to create multiple payments for invoices or credit notes |
| XeroRuby::AccountingApi | create_prepayment_allocations | PUT /Prepayments/PrepaymentID/Allocations | Allows you to create an Allocation for prepayments |
| XeroRuby::AccountingApi | create_prepayment_history | PUT /Prepayments/PrepaymentID/History | Allows you to create a history record for an Prepayment |
| XeroRuby::AccountingApi | create_purchase_order_history | PUT /PurchaseOrders/PurchaseOrderID/History | Allows you to create HistoryRecord for purchase orders |
| XeroRuby::AccountingApi | create_purchase_orders | PUT /PurchaseOrders | Allows you to create one or more purchase orders |
| XeroRuby::AccountingApi | create_quote_history | PUT /Quotes/QuoteID/History | Allows you to retrieve a history records of an quote |
| XeroRuby::AccountingApi | create_quotes | PUT /Quotes | Allows you to create one or more quotes |
| XeroRuby::AccountingApi | create_receipt | PUT /Receipts | Allows you to create draft expense claim receipts for any user |
| XeroRuby::AccountingApi | create_receipt_attachment_by_file_name | PUT /Receipts/ReceiptID/Attachments/FileName | Allows you to create Attachment on expense claim receipts by file name |
| XeroRuby::AccountingApi | create_receipt_history | PUT /Receipts/ReceiptID/History | Allows you to retrieve a history records of an Receipt |
| XeroRuby::AccountingApi | create_repeating_invoice_attachment_by_file_name | PUT /RepeatingInvoices/RepeatingInvoiceID/Attachments/FileName | Allows you to create attachment on repeating invoices by file name |
| XeroRuby::AccountingApi | create_repeating_invoice_history | PUT /RepeatingInvoices/RepeatingInvoiceID/History | Allows you to create history for a repeating invoice |
| XeroRuby::AccountingApi | create_tax_rates | PUT /TaxRates | Allows you to create one or more Tax Rates |
| XeroRuby::AccountingApi | create_tracking_category | PUT /TrackingCategories | Allows you to create tracking categories |
| XeroRuby::AccountingApi | create_tracking_options | PUT /TrackingCategories/TrackingCategoryID/Options | Allows you to create options for a specified tracking category |
| XeroRuby::AccountingApi | delete_account | DELETE /Accounts/AccountID | Allows you to delete a chart of accounts |
| XeroRuby::AccountingApi | delete_contact_group_contact | DELETE /ContactGroups/ContactGroupID/Contacts/ContactID | Allows you to delete a specific Contact from a Contract Group |
| XeroRuby::AccountingApi | delete_contact_group_contacts | DELETE /ContactGroups/ContactGroupID/Contacts | Allows you to delete all Contacts from a Contract Group |
| XeroRuby::AccountingApi | delete_item | DELETE /Items/ItemID | Allows you to delete a specified item |
| XeroRuby::AccountingApi | delete_linked_transaction | DELETE /LinkedTransactions/LinkedTransactionID | Allows you to delete a specified linked transactions (billable expenses) |
| XeroRuby::AccountingApi | delete_payment | POST /Payments/PaymentID | Allows you to update a specified payment for invoices and credit notes |
| XeroRuby::AccountingApi | delete_tracking_category | DELETE /TrackingCategories/TrackingCategoryID | Allows you to delete tracking categories |
| XeroRuby::AccountingApi | delete_tracking_options | DELETE /TrackingCategories/TrackingCategoryID/Options/TrackingOptionID | Allows you to delete a specified option for a specified tracking category |
| XeroRuby::AccountingApi | email_invoice | POST /Invoices/InvoiceID/Email | Allows you to email a copy of invoice to related Contact |
| XeroRuby::AccountingApi | get_account | GET /Accounts/AccountID | Allows you to retrieve a single chart of accounts |
| XeroRuby::AccountingApi | get_account_attachment_by_file_name | GET /Accounts/AccountID/Attachments/FileName | Allows you to retrieve Attachment on Account by Filename |
| XeroRuby::AccountingApi | get_account_attachment_by_id | GET /Accounts/AccountID/Attachments/AttachmentID | Allows you to retrieve specific Attachment on Account |
| XeroRuby::AccountingApi | get_account_attachments | GET /Accounts/AccountID/Attachments | Allows you to retrieve Attachments for accounts |
| XeroRuby::AccountingApi | get_accounts | GET /Accounts | Allows you to retrieve the full chart of accounts |
| XeroRuby::AccountingApi | get_bank_transaction | GET /BankTransactions/BankTransactionID | Allows you to retrieve a single spend or receive money transaction |
| XeroRuby::AccountingApi | get_bank_transaction_attachment_by_file_name | GET /BankTransactions/BankTransactionID/Attachments/FileName | Allows you to retrieve Attachments on BankTransaction by Filename |
| XeroRuby::AccountingApi | get_bank_transaction_attachment_by_id | GET /BankTransactions/BankTransactionID/Attachments/AttachmentID | Allows you to retrieve Attachments on a specific BankTransaction |
| XeroRuby::AccountingApi | get_bank_transaction_attachments | GET /BankTransactions/BankTransactionID/Attachments | Allows you to retrieve any attachments to bank transactions |
| XeroRuby::AccountingApi | get_bank_transactions | GET /BankTransactions | Allows you to retrieve any spend or receive money transactions |
| XeroRuby::AccountingApi | get_bank_transactions_history | GET /BankTransactions/BankTransactionID/History | Allows you to retrieve history from a bank transactions |
| XeroRuby::AccountingApi | get_bank_transfer | GET /BankTransfers/BankTransferID | Allows you to retrieve any bank transfers |
| XeroRuby::AccountingApi | get_bank_transfer_attachment_by_file_name | GET /BankTransfers/BankTransferID/Attachments/FileName | Allows you to retrieve Attachments on BankTransfer by file name |
| XeroRuby::AccountingApi | get_bank_transfer_attachment_by_id | GET /BankTransfers/BankTransferID/Attachments/AttachmentID | Allows you to retrieve Attachments on BankTransfer |
| XeroRuby::AccountingApi | get_bank_transfer_attachments | GET /BankTransfers/BankTransferID/Attachments | Allows you to retrieve Attachments from bank transfers |
| XeroRuby::AccountingApi | get_bank_transfer_history | GET /BankTransfers/BankTransferID/History | Allows you to retrieve history from a bank transfers |
| XeroRuby::AccountingApi | get_bank_transfers | GET /BankTransfers | Allows you to retrieve all bank transfers |
| XeroRuby::AccountingApi | get_batch_payment_history | GET /BatchPayments/BatchPaymentID/History | Allows you to retrieve history from a Batch Payment |
| XeroRuby::AccountingApi | get_batch_payments | GET /BatchPayments | Retrieve either one or many BatchPayments for invoices |
| XeroRuby::AccountingApi | get_branding_theme | GET /BrandingThemes/BrandingThemeID | Allows you to retrieve a specific BrandingThemes |
| XeroRuby::AccountingApi | get_branding_theme_payment_services | GET /BrandingThemes/BrandingThemeID/PaymentServices | Allows you to retrieve the Payment services for a Branding Theme |
| XeroRuby::AccountingApi | get_branding_themes | GET /BrandingThemes | Allows you to retrieve all the BrandingThemes |
| XeroRuby::AccountingApi | get_contact | GET /Contacts/ContactID | Allows you to retrieve, add and update contacts in a Xero organisation |
| XeroRuby::AccountingApi | get_contact_attachment_by_file_name | GET /Contacts/ContactID/Attachments/FileName | Allows you to retrieve Attachments on Contacts by file name |
| XeroRuby::AccountingApi | get_contact_attachment_by_id | GET /Contacts/ContactID/Attachments/AttachmentID | Allows you to retrieve Attachments on Contacts |
| XeroRuby::AccountingApi | get_contact_attachments | GET /Contacts/ContactID/Attachments | Allows you to retrieve, add and update contacts in a Xero organisation |
| XeroRuby::AccountingApi | get_contact_cis_settings | GET /Contacts/ContactID/CISSettings | Allows you to retrieve CISSettings for a contact in a Xero organisation |
| XeroRuby::AccountingApi | get_contact_group | GET /ContactGroups/ContactGroupID | Allows you to retrieve a unique Contract Group by ID |
| XeroRuby::AccountingApi | get_contact_groups | GET /ContactGroups | Allows you to retrieve the ContactID and Name of all the contacts in a contact group |
| XeroRuby::AccountingApi | get_contact_history | GET /Contacts/ContactID/History | Allows you to retrieve a history records of an Contact |
| XeroRuby::AccountingApi | get_contacts | GET /Contacts | Allows you to retrieve, add and update contacts in a Xero organisation |
| XeroRuby::AccountingApi | get_credit_note | GET /CreditNotes/CreditNoteID | Allows you to retrieve a specific credit note |
| XeroRuby::AccountingApi | get_credit_note_as_pdf | GET /CreditNotes/CreditNoteID/pdf | Allows you to retrieve Credit Note as PDF files |
| XeroRuby::AccountingApi | get_credit_note_attachment_by_file_name | GET /CreditNotes/CreditNoteID/Attachments/FileName | Allows you to retrieve Attachments on CreditNote by file name |
| XeroRuby::AccountingApi | get_credit_note_attachment_by_id | GET /CreditNotes/CreditNoteID/Attachments/AttachmentID | Allows you to retrieve Attachments on CreditNote |
| XeroRuby::AccountingApi | get_credit_note_attachments | GET /CreditNotes/CreditNoteID/Attachments | Allows you to retrieve Attachments for credit notes |
| XeroRuby::AccountingApi | get_credit_note_history | GET /CreditNotes/CreditNoteID/History | Allows you to retrieve a history records of an CreditNote |
| XeroRuby::AccountingApi | get_credit_notes | GET /CreditNotes | Allows you to retrieve any credit notes |
| XeroRuby::AccountingApi | get_currencies | GET /Currencies | Allows you to retrieve currencies for your organisation |
| XeroRuby::AccountingApi | get_employee | GET /Employees/EmployeeID | Allows you to retrieve a specific employee used in Xero payrun |
| XeroRuby::AccountingApi | get_employees | GET /Employees | Allows you to retrieve employees used in Xero payrun |
| XeroRuby::AccountingApi | get_expense_claim | GET /ExpenseClaims/ExpenseClaimID | Allows you to retrieve a specified expense claim |
| XeroRuby::AccountingApi | get_expense_claim_history | GET /ExpenseClaims/ExpenseClaimID/History | Allows you to retrieve a history records of an ExpenseClaim |
| XeroRuby::AccountingApi | get_expense_claims | GET /ExpenseClaims | Allows you to retrieve expense claims |
| XeroRuby::AccountingApi | get_invoice | GET /Invoices/InvoiceID | Allows you to retrieve a specified sales invoice or purchase bill |
| XeroRuby::AccountingApi | get_invoice_as_pdf | GET /Invoices/InvoiceID/pdf | Allows you to retrieve invoices or purchase bills as PDF files |
| XeroRuby::AccountingApi | 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 |
| XeroRuby::AccountingApi | 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 |
| XeroRuby::AccountingApi | get_invoice_attachments | GET /Invoices/InvoiceID/Attachments | Allows you to retrieve Attachments on invoices or purchase bills |
| XeroRuby::AccountingApi | get_invoice_history | GET /Invoices/InvoiceID/History | Allows you to retrieve a history records of an invoice |
| XeroRuby::AccountingApi | get_invoice_reminders | GET /InvoiceReminders/Settings | Allows you to retrieve invoice reminder settings |
| XeroRuby::AccountingApi | get_invoices | GET /Invoices | Allows you to retrieve any sales invoices or purchase bills |
| XeroRuby::AccountingApi | get_item | GET /Items/ItemID | Allows you to retrieve a specified item |
| XeroRuby::AccountingApi | get_item_history | GET /Items/ItemID/History | Allows you to retrieve history for items |
| XeroRuby::AccountingApi | get_items | GET /Items | Allows you to retrieve any items |
| XeroRuby::AccountingApi | get_journal | GET /Journals/JournalID | Allows you to retrieve a specified journals. |
| XeroRuby::AccountingApi | get_journals | GET /Journals | Allows you to retrieve any journals. |
| XeroRuby::AccountingApi | get_linked_transaction | GET /LinkedTransactions/LinkedTransactionID | Allows you to retrieve a specified linked transactions (billable expenses) |
| XeroRuby::AccountingApi | get_linked_transactions | GET /LinkedTransactions | Retrieve linked transactions (billable expenses) |
| XeroRuby::AccountingApi | get_manual_journal | GET /ManualJournals/ManualJournalID | Allows you to retrieve a specified manual journals |
| XeroRuby::AccountingApi | get_manual_journal_attachment_by_file_name | GET /ManualJournals/ManualJournalID/Attachments/FileName | Allows you to retrieve specified Attachment on ManualJournal by file name |
| XeroRuby::AccountingApi | get_manual_journal_attachment_by_id | GET /ManualJournals/ManualJournalID/Attachments/AttachmentID | Allows you to retrieve specified Attachment on ManualJournals |
| XeroRuby::AccountingApi | get_manual_journal_attachments | GET /ManualJournals/ManualJournalID/Attachments | Allows you to retrieve Attachment for manual journals |
| XeroRuby::AccountingApi | get_manual_journals | GET /ManualJournals | Allows you to retrieve any manual journals |
| XeroRuby::AccountingApi | get_online_invoice | GET /Invoices/InvoiceID/OnlineInvoice | Allows you to retrieve a URL to an online invoice |
| XeroRuby::AccountingApi | 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. |
| XeroRuby::AccountingApi | get_organisations | GET /Organisation | Allows you to retrieve Organisation details |
| XeroRuby::AccountingApi | get_overpayment | GET /Overpayments/OverpaymentID | Allows you to retrieve a specified overpayments |
| XeroRuby::AccountingApi | get_overpayment_history | GET /Overpayments/OverpaymentID/History | Allows you to retrieve a history records of an Overpayment |
| XeroRuby::AccountingApi | get_overpayments | GET /Overpayments | Allows you to retrieve overpayments |
| XeroRuby::AccountingApi | get_payment | GET /Payments/PaymentID | Allows you to retrieve a specified payment for invoices and credit notes |
| XeroRuby::AccountingApi | get_payment_history | GET /Payments/PaymentID/History | Allows you to retrieve history records of a payment |
| XeroRuby::AccountingApi | get_payment_services | GET /PaymentServices | Allows you to retrieve payment services |
| XeroRuby::AccountingApi | get_payments | GET /Payments | Allows you to retrieve payments for invoices and credit notes |
| XeroRuby::AccountingApi | get_prepayment | GET /Prepayments/PrepaymentID | Allows you to retrieve a specified prepayments |
| XeroRuby::AccountingApi | get_prepayment_history | GET /Prepayments/PrepaymentID/History | Allows you to retrieve a history records of an Prepayment |
| XeroRuby::AccountingApi | get_prepayments | GET /Prepayments | Allows you to retrieve prepayments |
| XeroRuby::AccountingApi | get_purchase_order | GET /PurchaseOrders/PurchaseOrderID | Allows you to retrieve a specified purchase orders |
| XeroRuby::AccountingApi | get_purchase_order_history | GET /PurchaseOrders/PurchaseOrderID/History | Allows you to retrieve history for PurchaseOrder |
| XeroRuby::AccountingApi | get_purchase_orders | GET /PurchaseOrders | Allows you to retrieve purchase orders |
| XeroRuby::AccountingApi | get_quote | GET /Quotes/QuoteID | Allows you to retrieve a specified quote |
| XeroRuby::AccountingApi | get_quote_history | GET /Quotes/QuoteID/History | Allows you to retrieve a history records of an quote |
| XeroRuby::AccountingApi | get_quotes | GET /Quotes | Allows you to retrieve any sales quotes |
| XeroRuby::AccountingApi | get_receipt | GET /Receipts/ReceiptID | Allows you to retrieve a specified draft expense claim receipts |
| XeroRuby::AccountingApi | get_receipt_attachment_by_file_name | GET /Receipts/ReceiptID/Attachments/FileName | Allows you to retrieve Attachments on expense claim receipts by file name |
| XeroRuby::AccountingApi | get_receipt_attachment_by_id | GET /Receipts/ReceiptID/Attachments/AttachmentID | Allows you to retrieve Attachments on expense claim receipts by ID |
| XeroRuby::AccountingApi | get_receipt_attachments | GET /Receipts/ReceiptID/Attachments | Allows you to retrieve Attachments for expense claim receipts |
| XeroRuby::AccountingApi | get_receipt_history | GET /Receipts/ReceiptID/History | Allows you to retrieve a history records of an Receipt |
| XeroRuby::AccountingApi | get_receipts | GET /Receipts | Allows you to retrieve draft expense claim receipts for any user |
| XeroRuby::AccountingApi | get_repeating_invoice | GET /RepeatingInvoices/RepeatingInvoiceID | Allows you to retrieve a specified repeating invoice |
| XeroRuby::AccountingApi | get_repeating_invoice_attachment_by_file_name | GET /RepeatingInvoices/RepeatingInvoiceID/Attachments/FileName | Allows you to retrieve specified attachment on repeating invoices by file name |
| XeroRuby::AccountingApi | get_repeating_invoice_attachment_by_id | GET /RepeatingInvoices/RepeatingInvoiceID/Attachments/AttachmentID | Allows you to retrieve a specified Attachments on repeating invoices |
| XeroRuby::AccountingApi | get_repeating_invoice_attachments | GET /RepeatingInvoices/RepeatingInvoiceID/Attachments | Allows you to retrieve Attachments on repeating invoice |
| XeroRuby::AccountingApi | get_repeating_invoice_history | GET /RepeatingInvoices/RepeatingInvoiceID/History | Allows you to retrieve history for a repeating invoice |
| XeroRuby::AccountingApi | get_repeating_invoices | GET /RepeatingInvoices | Allows you to retrieve any repeating invoices |
| XeroRuby::AccountingApi | get_report_aged_payables_by_contact | GET /Reports/AgedPayablesByContact | Allows you to retrieve report for AgedPayablesByContact |
| XeroRuby::AccountingApi | get_report_aged_receivables_by_contact | GET /Reports/AgedReceivablesByContact | Allows you to retrieve report for AgedReceivablesByContact |
| XeroRuby::AccountingApi | get_report_ba_sor_gst | GET /Reports/ReportID | Allows you to retrieve report for BAS only valid for AU orgs |
| XeroRuby::AccountingApi | get_report_ba_sor_gst_list | GET /Reports | Allows you to retrieve report for BAS only valid for AU orgs |
| XeroRuby::AccountingApi | get_report_balance_sheet | GET /Reports/BalanceSheet | Allows you to retrieve report for BalanceSheet |
| XeroRuby::AccountingApi | get_report_bank_summary | GET /Reports/BankSummary | Allows you to retrieve report for BankSummary |
| XeroRuby::AccountingApi | get_report_budget_summary | GET /Reports/BudgetSummary | Allows you to retrieve report for Budget Summary |
| XeroRuby::AccountingApi | get_report_executive_summary | GET /Reports/ExecutiveSummary | Allows you to retrieve report for ExecutiveSummary |
| XeroRuby::AccountingApi | get_report_profit_and_loss | GET /Reports/ProfitAndLoss | Allows you to retrieve report for ProfitAndLoss |
| XeroRuby::AccountingApi | get_report_ten_ninety_nine | GET /Reports/TenNinetyNine | Allows you to retrieve report for TenNinetyNine |
| XeroRuby::AccountingApi | get_report_trial_balance | GET /Reports/TrialBalance | Allows you to retrieve report for TrialBalance |
| XeroRuby::AccountingApi | get_tax_rates | GET /TaxRates | Allows you to retrieve Tax Rates |
| XeroRuby::AccountingApi | get_tracking_categories | GET /TrackingCategories | Allows you to retrieve tracking categories and options |
| XeroRuby::AccountingApi | get_tracking_category | GET /TrackingCategories/TrackingCategoryID | Allows you to retrieve tracking categories and options for specified category |
| XeroRuby::AccountingApi | get_user | GET /Users/UserID | Allows you to retrieve a specified user |
| XeroRuby::AccountingApi | get_users | GET /Users | Allows you to retrieve users |
| XeroRuby::AccountingApi | update_account | POST /Accounts/AccountID | Allows you to update a chart of accounts |
| XeroRuby::AccountingApi | update_account_attachment_by_file_name | POST /Accounts/AccountID/Attachments/FileName | Allows you to update Attachment on Account by Filename |
| XeroRuby::AccountingApi | update_bank_transaction | POST /BankTransactions/BankTransactionID | Allows you to update a single spend or receive money transaction |
| XeroRuby::AccountingApi | update_bank_transaction_attachment_by_file_name | POST /BankTransactions/BankTransactionID/Attachments/FileName | Allows you to update an Attachment on BankTransaction by Filename |
| XeroRuby::AccountingApi | update_bank_transfer_attachment_by_file_name | POST /BankTransfers/BankTransferID/Attachments/FileName | |
| XeroRuby::AccountingApi | update_contact | POST /Contacts/ContactID | |
| XeroRuby::AccountingApi | update_contact_attachment_by_file_name | POST /Contacts/ContactID/Attachments/FileName | |
| XeroRuby::AccountingApi | update_contact_group | POST /ContactGroups/ContactGroupID | Allows you to update a Contract Group |
| XeroRuby::AccountingApi | update_credit_note | POST /CreditNotes/CreditNoteID | Allows you to update a specific credit note |
| XeroRuby::AccountingApi | update_credit_note_attachment_by_file_name | POST /CreditNotes/CreditNoteID/Attachments/FileName | Allows you to update Attachments on CreditNote by file name |
| XeroRuby::AccountingApi | update_employee | POST /Employees/EmployeeID | Allows you to update a specific employee used in Xero payrun |
| XeroRuby::AccountingApi | update_expense_claim | POST /ExpenseClaims/ExpenseClaimID | Allows you to update specified expense claims |
| XeroRuby::AccountingApi | update_invoice | POST /Invoices/InvoiceID | Allows you to update a specified sales invoices or purchase bills |
| XeroRuby::AccountingApi | 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 |
| XeroRuby::AccountingApi | update_item | POST /Items/ItemID | Allows you to update a specified item |
| XeroRuby::AccountingApi | update_linked_transaction | POST /LinkedTransactions/LinkedTransactionID | Allows you to update a specified linked transactions (billable expenses) |
| XeroRuby::AccountingApi | update_manual_journal | POST /ManualJournals/ManualJournalID | Allows you to update a specified manual journal |
| XeroRuby::AccountingApi | update_manual_journal_attachment_by_file_name | POST /ManualJournals/ManualJournalID/Attachments/FileName | Allows you to update a specified Attachment on ManualJournal by file name |
| XeroRuby::AccountingApi | update_or_create_bank_transactions | POST /BankTransactions | Allows you to update or create one or more spend or receive money transaction |
| XeroRuby::AccountingApi | update_or_create_contacts | POST /Contacts | Allows you to update OR create one or more contacts in a Xero organisation |
| XeroRuby::AccountingApi | update_or_create_credit_notes | POST /CreditNotes | Allows you to update OR create one or more credit notes |
| XeroRuby::AccountingApi | update_or_create_employees | POST /Employees | Allows you to create a single new employees used in Xero payrun |
| XeroRuby::AccountingApi | update_or_create_invoices | POST /Invoices | Allows you to update OR create one or more sales invoices or purchase bills |
| XeroRuby::AccountingApi | update_or_create_items | POST /Items | Allows you to update or create one or more items |
| XeroRuby::AccountingApi | update_or_create_manual_journals | POST /ManualJournals | Allows you to create a single manual journal |
| XeroRuby::AccountingApi | update_or_create_purchase_orders | POST /PurchaseOrders | Allows you to update or create one or more purchase orders |
| XeroRuby::AccountingApi | update_or_create_quotes | POST /Quotes | Allows you to update OR create one or more quotes |
| XeroRuby::AccountingApi | update_purchase_order | POST /PurchaseOrders/PurchaseOrderID | Allows you to update a specified purchase order |
| XeroRuby::AccountingApi | update_quote | POST /Quotes/QuoteID | Allows you to update a specified quote |
| XeroRuby::AccountingApi | update_receipt | POST /Receipts/ReceiptID | Allows you to retrieve a specified draft expense claim receipts |
| XeroRuby::AccountingApi | update_receipt_attachment_by_file_name | POST /Receipts/ReceiptID/Attachments/FileName | Allows you to update Attachment on expense claim receipts by file name |
| XeroRuby::AccountingApi | update_repeating_invoice_attachment_by_file_name | POST /RepeatingInvoices/RepeatingInvoiceID/Attachments/FileName | Allows you to update specified attachment on repeating invoices by file name |
| XeroRuby::AccountingApi | update_tax_rate | POST /TaxRates | Allows you to update Tax Rates |
| XeroRuby::AccountingApi | update_tracking_category | POST /TrackingCategories/TrackingCategoryID | Allows you to update tracking categories |
| XeroRuby::AccountingApi | update_tracking_options | POST /TrackingCategories/TrackingCategoryID/Options/TrackingOptionID | Allows you to update options for a specified tracking category |
Documentation for Models
- XeroRuby::Account
- XeroRuby::AccountType
- XeroRuby::Accounts
- XeroRuby::AccountsPayable
- XeroRuby::AccountsReceivable
- XeroRuby::Address
- XeroRuby::Allocation
- XeroRuby::Allocations
- XeroRuby::Attachment
- XeroRuby::Attachments
- XeroRuby::Balances
- XeroRuby::BankTransaction
- XeroRuby::BankTransactions
- XeroRuby::BankTransfer
- XeroRuby::BankTransfers
- XeroRuby::BatchPayment
- XeroRuby::BatchPaymentDetails
- XeroRuby::BatchPayments
- XeroRuby::Bill
- XeroRuby::BrandingTheme
- XeroRuby::BrandingThemes
- XeroRuby::CISOrgSetting
- XeroRuby::CISSetting
- XeroRuby::CISSettings
- XeroRuby::Contact
- XeroRuby::ContactGroup
- XeroRuby::ContactGroups
- XeroRuby::ContactPerson
- XeroRuby::Contacts
- XeroRuby::CountryCode
- XeroRuby::CreditNote
- XeroRuby::CreditNotes
- XeroRuby::Currencies
- XeroRuby::Currency
- XeroRuby::CurrencyCode
- XeroRuby::Element
- XeroRuby::Employee
- XeroRuby::Employees
- XeroRuby::Error
- XeroRuby::ExpenseClaim
- XeroRuby::ExpenseClaims
- XeroRuby::ExternalLink
- XeroRuby::HistoryRecord
- XeroRuby::HistoryRecords
- XeroRuby::Invoice
- XeroRuby::InvoiceReminder
- XeroRuby::InvoiceReminders
- XeroRuby::Invoices
- XeroRuby::Item
- XeroRuby::Items
- XeroRuby::Journal
- XeroRuby::JournalLine
- XeroRuby::Journals
- XeroRuby::LineAmountTypes
- XeroRuby::LineItem
- XeroRuby::LineItemTracking
- XeroRuby::LinkedTransaction
- XeroRuby::LinkedTransactions
- XeroRuby::ManualJournal
- XeroRuby::ManualJournalLine
- XeroRuby::ManualJournals
- XeroRuby::OnlineInvoice
- XeroRuby::OnlineInvoices
- XeroRuby::Organisation
- XeroRuby::Organisations
- XeroRuby::Overpayment
- XeroRuby::Overpayments
- XeroRuby::Payment
- XeroRuby::PaymentService
- XeroRuby::PaymentServices
- XeroRuby::PaymentTerm
- XeroRuby::PaymentTermType
- XeroRuby::Payments
- XeroRuby::Phone
- XeroRuby::Prepayment
- XeroRuby::Prepayments
- XeroRuby::Purchase
- XeroRuby::PurchaseOrder
- XeroRuby::PurchaseOrders
- XeroRuby::Quote
- XeroRuby::QuoteLineAmountTypes
- XeroRuby::QuoteStatusCodes
- XeroRuby::Quotes
- XeroRuby::Receipt
- XeroRuby::Receipts
- XeroRuby::RepeatingInvoice
- XeroRuby::RepeatingInvoices
- XeroRuby::Report
- XeroRuby::ReportAttribute
- XeroRuby::ReportCell
- XeroRuby::ReportFields
- XeroRuby::ReportRow
- XeroRuby::ReportRows
- XeroRuby::ReportWithRow
- XeroRuby::ReportWithRows
- XeroRuby::Reports
- XeroRuby::RequestEmpty
- XeroRuby::RowType
- XeroRuby::SalesTrackingCategory
- XeroRuby::Schedule
- XeroRuby::TaxComponent
- XeroRuby::TaxRate
- XeroRuby::TaxRates
- XeroRuby::TaxType
- XeroRuby::TenNinteyNineContact
- XeroRuby::TimeZone
- XeroRuby::TrackingCategories
- XeroRuby::TrackingCategory
- XeroRuby::TrackingOption
- XeroRuby::TrackingOptions
- XeroRuby::User
- XeroRuby::Users
- XeroRuby::ValidationError
Documentation for Authorization
OAuth2
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://login.xero.com/identity/connect/authorize
- Scopes:
- email: Grant read-only access to your email
- openid: Grant read-only access to your open id
- profile: your profile information
- accounting.transactions: Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
- accounting.transactions.read: Grant read-only access to invoices
- accounting.reports.read: Grant read-only access to accounting reports
- accounting.journals.read: Grant read-only access to journals
- accounting.settings: Grant read-write access to organisation and account settings
- accounting.settings.read: Grant read-only access to organisation and account settings
- accounting.contacts: Grant read-write access to contacts and contact groups
- accounting.contacts.read: Grant read-only access to contacts and contact groups
- accounting.attachments: Grant read-write access to attachments
- accounting.attachments.read: Grant read-only access to attachments
- assets: Grant read-write access to assets
- assets.read: Grant read-only access to fixed assets
- bankfeeds: Grant read-write access to bankfeeds
- files: Grant read-write access to files and folders
- files.read: Grant read-only access to files and folders
- payroll: Grant read-write access to payroll
- payroll.read: Grant read-only access to payroll
- payroll.employees: Grant read-write access to payroll employees
- payroll.employees.read: Grant read-only access to payroll employees
- payroll.leaveapplications: Grant read-write access to payroll leaveapplications
- payroll.leaveapplications.read: Grant read-only access to payroll leaveapplications
- payroll.payitems: Grant read-write access to payroll payitems
- payroll.payitems.read: Grant read-only access to payroll payitems
- payroll.payrollcalendars: Grant read-write access to payroll calendars
- payroll.payrollcalendars.read: Grant read-only access to payroll calendars
- payroll.payruns: Grant read-write access to payroll payruns
- payroll.payruns.read: Grant read-only access to payroll payruns
- payroll.payslip: Grant read-write access to payroll payslips
- payroll.payslip.read: Grant read-only access to payroll payslips
- payroll.settings.read: Grant read-only access to payroll settings
- payroll.superfunds: Grant read-write access to payroll superfunds
- payroll.superfunds.read: Grant read-only access to payroll superfunds
- payroll.superfundproducts.read: Grant read-only access to payroll superfundproducts
- payroll.timesheets: Grant read-write access to payroll timesheets
- payroll.timesheets.read: Grant read-only access to payroll timesheets
- paymentservices: Grant read-write access to payment services
- projects: Grant read-write access to projects
- projects.read: Grant read-only access to projects