xero-ruby 0.2.0 → 0.2.1
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/README.md +16 -10
- data/docs/AccountingApi.md +349 -15
- data/docs/CreditNote.md +2 -0
- data/docs/Overpayment.md +2 -0
- data/docs/Prepayment.md +2 -0
- data/lib/xero-ruby/api/accounting_api.rb +467 -11
- data/lib/xero-ruby/api_client.rb +1 -1
- data/lib/xero-ruby/api_error.rb +1 -1
- data/lib/xero-ruby/configuration.rb +1 -1
- data/lib/xero-ruby/models/account.rb +1 -1
- data/lib/xero-ruby/models/account_type.rb +1 -1
- data/lib/xero-ruby/models/accounts.rb +1 -1
- data/lib/xero-ruby/models/accounts_payable.rb +1 -1
- data/lib/xero-ruby/models/accounts_receivable.rb +1 -1
- data/lib/xero-ruby/models/address.rb +1 -1
- data/lib/xero-ruby/models/allocation.rb +1 -1
- data/lib/xero-ruby/models/allocations.rb +1 -1
- data/lib/xero-ruby/models/attachment.rb +1 -1
- data/lib/xero-ruby/models/attachments.rb +1 -1
- data/lib/xero-ruby/models/balances.rb +1 -1
- data/lib/xero-ruby/models/bank_transaction.rb +1 -1
- data/lib/xero-ruby/models/bank_transactions.rb +1 -1
- data/lib/xero-ruby/models/bank_transfer.rb +1 -1
- data/lib/xero-ruby/models/bank_transfers.rb +1 -1
- data/lib/xero-ruby/models/batch_payment.rb +1 -1
- data/lib/xero-ruby/models/batch_payment_details.rb +1 -1
- data/lib/xero-ruby/models/batch_payments.rb +1 -1
- data/lib/xero-ruby/models/bill.rb +1 -1
- data/lib/xero-ruby/models/branding_theme.rb +1 -1
- data/lib/xero-ruby/models/branding_themes.rb +1 -1
- data/lib/xero-ruby/models/cis_org_setting.rb +1 -1
- data/lib/xero-ruby/models/cis_setting.rb +1 -1
- data/lib/xero-ruby/models/cis_settings.rb +1 -1
- data/lib/xero-ruby/models/contact.rb +1 -1
- data/lib/xero-ruby/models/contact_group.rb +1 -1
- data/lib/xero-ruby/models/contact_groups.rb +1 -1
- data/lib/xero-ruby/models/contact_person.rb +1 -1
- data/lib/xero-ruby/models/contacts.rb +1 -1
- data/lib/xero-ruby/models/country_code.rb +1 -1
- data/lib/xero-ruby/models/credit_note.rb +12 -2
- data/lib/xero-ruby/models/credit_notes.rb +1 -1
- data/lib/xero-ruby/models/currencies.rb +1 -1
- data/lib/xero-ruby/models/currency.rb +1 -1
- data/lib/xero-ruby/models/currency_code.rb +1 -1
- data/lib/xero-ruby/models/element.rb +1 -1
- data/lib/xero-ruby/models/employee.rb +1 -1
- data/lib/xero-ruby/models/employees.rb +1 -1
- data/lib/xero-ruby/models/error.rb +1 -1
- data/lib/xero-ruby/models/expense_claim.rb +1 -1
- data/lib/xero-ruby/models/expense_claims.rb +1 -1
- data/lib/xero-ruby/models/external_link.rb +1 -1
- data/lib/xero-ruby/models/history_record.rb +1 -1
- data/lib/xero-ruby/models/history_records.rb +1 -1
- data/lib/xero-ruby/models/invoice.rb +1 -1
- data/lib/xero-ruby/models/invoice_reminder.rb +1 -1
- data/lib/xero-ruby/models/invoice_reminders.rb +1 -1
- data/lib/xero-ruby/models/invoices.rb +1 -1
- data/lib/xero-ruby/models/item.rb +1 -1
- data/lib/xero-ruby/models/items.rb +1 -1
- data/lib/xero-ruby/models/journal.rb +1 -1
- data/lib/xero-ruby/models/journal_line.rb +1 -1
- data/lib/xero-ruby/models/journals.rb +1 -1
- data/lib/xero-ruby/models/line_amount_types.rb +1 -1
- data/lib/xero-ruby/models/line_item.rb +1 -1
- data/lib/xero-ruby/models/line_item_tracking.rb +1 -1
- data/lib/xero-ruby/models/linked_transaction.rb +1 -1
- data/lib/xero-ruby/models/linked_transactions.rb +1 -1
- data/lib/xero-ruby/models/manual_journal.rb +1 -1
- data/lib/xero-ruby/models/manual_journal_line.rb +1 -1
- data/lib/xero-ruby/models/manual_journals.rb +1 -1
- data/lib/xero-ruby/models/online_invoice.rb +1 -1
- data/lib/xero-ruby/models/online_invoices.rb +1 -1
- data/lib/xero-ruby/models/organisation.rb +1 -1
- data/lib/xero-ruby/models/organisations.rb +1 -1
- data/lib/xero-ruby/models/overpayment.rb +12 -2
- data/lib/xero-ruby/models/overpayments.rb +1 -1
- data/lib/xero-ruby/models/payment.rb +1 -1
- data/lib/xero-ruby/models/payment_service.rb +1 -1
- data/lib/xero-ruby/models/payment_services.rb +1 -1
- data/lib/xero-ruby/models/payment_term.rb +1 -1
- data/lib/xero-ruby/models/payment_term_type.rb +1 -1
- data/lib/xero-ruby/models/payments.rb +1 -1
- data/lib/xero-ruby/models/phone.rb +1 -1
- data/lib/xero-ruby/models/prepayment.rb +12 -2
- data/lib/xero-ruby/models/prepayments.rb +1 -1
- data/lib/xero-ruby/models/purchase.rb +1 -1
- data/lib/xero-ruby/models/purchase_order.rb +1 -1
- data/lib/xero-ruby/models/purchase_orders.rb +1 -1
- data/lib/xero-ruby/models/quote.rb +1 -1
- data/lib/xero-ruby/models/quote_line_amount_types.rb +1 -1
- data/lib/xero-ruby/models/quote_status_codes.rb +1 -1
- data/lib/xero-ruby/models/quotes.rb +1 -1
- data/lib/xero-ruby/models/receipt.rb +1 -1
- data/lib/xero-ruby/models/receipts.rb +1 -1
- data/lib/xero-ruby/models/repeating_invoice.rb +1 -1
- data/lib/xero-ruby/models/repeating_invoices.rb +1 -1
- data/lib/xero-ruby/models/report.rb +1 -1
- data/lib/xero-ruby/models/report_attribute.rb +1 -1
- data/lib/xero-ruby/models/report_cell.rb +1 -1
- data/lib/xero-ruby/models/report_fields.rb +1 -1
- data/lib/xero-ruby/models/report_row.rb +1 -1
- data/lib/xero-ruby/models/report_rows.rb +1 -1
- data/lib/xero-ruby/models/report_with_row.rb +1 -1
- data/lib/xero-ruby/models/report_with_rows.rb +1 -1
- data/lib/xero-ruby/models/reports.rb +1 -1
- data/lib/xero-ruby/models/request_empty.rb +1 -1
- data/lib/xero-ruby/models/row_type.rb +1 -1
- data/lib/xero-ruby/models/sales_tracking_category.rb +1 -1
- data/lib/xero-ruby/models/schedule.rb +1 -1
- data/lib/xero-ruby/models/tax_component.rb +1 -1
- data/lib/xero-ruby/models/tax_rate.rb +1 -1
- data/lib/xero-ruby/models/tax_rates.rb +1 -1
- data/lib/xero-ruby/models/tax_type.rb +1 -1
- data/lib/xero-ruby/models/ten_nintey_nine_contact.rb +1 -1
- data/lib/xero-ruby/models/time_zone.rb +1 -1
- data/lib/xero-ruby/models/tracking_categories.rb +1 -1
- data/lib/xero-ruby/models/tracking_category.rb +1 -1
- data/lib/xero-ruby/models/tracking_option.rb +1 -1
- data/lib/xero-ruby/models/tracking_options.rb +1 -1
- data/lib/xero-ruby/models/user.rb +1 -1
- data/lib/xero-ruby/models/users.rb +1 -1
- data/lib/xero-ruby/models/validation_error.rb +1 -1
- data/lib/xero-ruby/version.rb +2 -2
- data/lib/xero-ruby.rb +1 -1
- data/pkg/xero-ruby-0.1.3.gem +0 -0
- data/pkg/xero-ruby-0.2.1.gem +0 -0
- data/spec/api/accounting_api_spec.rb +86 -6
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/account_spec.rb +1 -1
- data/spec/models/account_type_spec.rb +1 -1
- data/spec/models/accounts_payable_spec.rb +1 -1
- data/spec/models/accounts_receivable_spec.rb +1 -1
- data/spec/models/accounts_spec.rb +1 -1
- data/spec/models/address_spec.rb +1 -1
- data/spec/models/allocation_spec.rb +1 -1
- data/spec/models/allocations_spec.rb +1 -1
- data/spec/models/attachment_spec.rb +1 -1
- data/spec/models/attachments_spec.rb +1 -1
- data/spec/models/balances_spec.rb +1 -1
- data/spec/models/bank_transaction_spec.rb +1 -1
- data/spec/models/bank_transactions_spec.rb +1 -1
- data/spec/models/bank_transfer_spec.rb +1 -1
- data/spec/models/bank_transfers_spec.rb +1 -1
- data/spec/models/batch_payment_details_spec.rb +1 -1
- data/spec/models/batch_payment_spec.rb +1 -1
- data/spec/models/batch_payments_spec.rb +1 -1
- data/spec/models/bill_spec.rb +1 -1
- data/spec/models/branding_theme_spec.rb +1 -1
- data/spec/models/branding_themes_spec.rb +1 -1
- data/spec/models/cis_org_setting_spec.rb +1 -1
- data/spec/models/cis_setting_spec.rb +1 -1
- data/spec/models/cis_settings_spec.rb +1 -1
- data/spec/models/contact_group_spec.rb +1 -1
- data/spec/models/contact_groups_spec.rb +1 -1
- data/spec/models/contact_person_spec.rb +1 -1
- data/spec/models/contact_spec.rb +1 -1
- data/spec/models/contacts_spec.rb +1 -1
- data/spec/models/country_code_spec.rb +1 -1
- data/spec/models/credit_note_spec.rb +7 -1
- data/spec/models/credit_notes_spec.rb +1 -1
- data/spec/models/currencies_spec.rb +1 -1
- data/spec/models/currency_code_spec.rb +1 -1
- data/spec/models/currency_spec.rb +1 -1
- data/spec/models/element_spec.rb +1 -1
- data/spec/models/employee_spec.rb +1 -1
- data/spec/models/employees_spec.rb +1 -1
- data/spec/models/error_spec.rb +1 -1
- data/spec/models/expense_claim_spec.rb +1 -1
- data/spec/models/expense_claims_spec.rb +1 -1
- data/spec/models/external_link_spec.rb +1 -1
- data/spec/models/history_record_spec.rb +1 -1
- data/spec/models/history_records_spec.rb +1 -1
- data/spec/models/invoice_reminder_spec.rb +1 -1
- data/spec/models/invoice_reminders_spec.rb +1 -1
- data/spec/models/invoice_spec.rb +1 -1
- data/spec/models/invoices_spec.rb +1 -1
- data/spec/models/item_spec.rb +1 -1
- data/spec/models/items_spec.rb +1 -1
- data/spec/models/journal_line_spec.rb +1 -1
- data/spec/models/journal_spec.rb +1 -1
- data/spec/models/journals_spec.rb +1 -1
- data/spec/models/line_amount_types_spec.rb +1 -1
- data/spec/models/line_item_spec.rb +1 -1
- data/spec/models/line_item_tracking_spec.rb +1 -1
- data/spec/models/linked_transaction_spec.rb +1 -1
- data/spec/models/linked_transactions_spec.rb +1 -1
- data/spec/models/manual_journal_line_spec.rb +1 -1
- data/spec/models/manual_journal_spec.rb +1 -1
- data/spec/models/manual_journals_spec.rb +1 -1
- data/spec/models/online_invoice_spec.rb +1 -1
- data/spec/models/online_invoices_spec.rb +1 -1
- data/spec/models/organisation_spec.rb +1 -1
- data/spec/models/organisations_spec.rb +1 -1
- data/spec/models/overpayment_spec.rb +7 -1
- data/spec/models/overpayments_spec.rb +1 -1
- data/spec/models/payment_service_spec.rb +1 -1
- data/spec/models/payment_services_spec.rb +1 -1
- data/spec/models/payment_spec.rb +1 -1
- data/spec/models/payment_term_spec.rb +1 -1
- data/spec/models/payment_term_type_spec.rb +1 -1
- data/spec/models/payments_spec.rb +1 -1
- data/spec/models/phone_spec.rb +1 -1
- data/spec/models/prepayment_spec.rb +7 -1
- data/spec/models/prepayments_spec.rb +1 -1
- data/spec/models/purchase_order_spec.rb +1 -1
- data/spec/models/purchase_orders_spec.rb +1 -1
- data/spec/models/purchase_spec.rb +1 -1
- data/spec/models/receipt_spec.rb +1 -1
- data/spec/models/receipts_spec.rb +1 -1
- data/spec/models/repeating_invoice_spec.rb +1 -1
- data/spec/models/repeating_invoices_spec.rb +1 -1
- data/spec/models/report_attribute_spec.rb +1 -1
- data/spec/models/report_cell_spec.rb +1 -1
- data/spec/models/report_fields_spec.rb +1 -1
- data/spec/models/report_row_spec.rb +1 -1
- data/spec/models/report_rows_spec.rb +1 -1
- data/spec/models/report_spec.rb +1 -1
- data/spec/models/report_with_row_spec.rb +1 -1
- data/spec/models/report_with_rows_spec.rb +1 -1
- data/spec/models/reports_spec.rb +1 -1
- data/spec/models/request_empty_spec.rb +1 -1
- data/spec/models/row_type_spec.rb +1 -1
- data/spec/models/sales_tracking_category_spec.rb +1 -1
- data/spec/models/schedule_spec.rb +1 -1
- data/spec/models/tax_component_spec.rb +1 -1
- data/spec/models/tax_rate_spec.rb +1 -1
- data/spec/models/tax_rates_spec.rb +1 -1
- data/spec/models/tax_type_spec.rb +1 -1
- data/spec/models/ten_nintey_nine_contact_spec.rb +1 -1
- data/spec/models/time_zone_spec.rb +1 -1
- data/spec/models/tracking_categories_spec.rb +1 -1
- data/spec/models/tracking_category_spec.rb +1 -1
- data/spec/models/tracking_option_spec.rb +1 -1
- data/spec/models/tracking_options_spec.rb +1 -1
- data/spec/models/user_spec.rb +1 -1
- data/spec/models/users_spec.rb +1 -1
- data/spec/models/validation_error_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/xero-ruby.gemspec +1 -1
- metadata +4 -3
- data/pkg/xero-ruby-0.2.0.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: 75dc889b459c0c8a13c610a0ecb36edc37f339b4a7f6c5dfbd34c1ff8c848845
|
|
4
|
+
data.tar.gz: 50e55319a1f16e11689d8a348de1e58808728a035b00c3dc551d07765089345b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 50fe4d94a218a1177382711bdb688d4a6c8cd97cf2e47f18b4c133d339f10da3562afb8d6aabb1129c2027e34eae59c238f1e45fa5a37349c11fca020fb3ed17
|
|
7
|
+
data.tar.gz: ad922ce7e1e217271d01e311d6bb3a17488a8799e552ace39c0a46ccc1ba734f230165b5be5e655ba760f5279031b140d61110600c31059ed0526fd2e18bcd12
|
data/README.md
CHANGED
|
@@ -6,8 +6,8 @@ No description provided (generated by Openapi Generator https://github.com/opena
|
|
|
6
6
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
|
-
- API version: 2.0.
|
|
10
|
-
- Package version: 0.2.
|
|
9
|
+
- API version: 2.0.3
|
|
10
|
+
- Package version: 0.2.1
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
For more information, please visit [https://developer.xero.com](https://developer.xero.com)
|
|
13
13
|
|
|
@@ -24,16 +24,16 @@ gem build xero-ruby.gemspec
|
|
|
24
24
|
Then either install the gem locally:
|
|
25
25
|
|
|
26
26
|
```shell
|
|
27
|
-
gem install ./xero-ruby-0.2.
|
|
27
|
+
gem install ./xero-ruby-0.2.1.gem
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
(for development, run `gem install --dev ./xero-ruby-0.2.
|
|
30
|
+
(for development, run `gem install --dev ./xero-ruby-0.2.1.gem` to install the development dependencies)
|
|
31
31
|
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
33
33
|
|
|
34
34
|
Finally add this to the Gemfile:
|
|
35
35
|
|
|
36
|
-
gem 'xero-ruby', '~> 0.2.
|
|
36
|
+
gem 'xero-ruby', '~> 0.2.1'
|
|
37
37
|
|
|
38
38
|
### Install from Git
|
|
39
39
|
|
|
@@ -96,7 +96,7 @@ Class | Method | HTTP request | Description
|
|
|
96
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
97
|
*XeroRuby::AccountingApi* | [**create_contact_attachment_by_file_name**](docs/AccountingApi.md#create_contact_attachment_by_file_name) | **PUT** /Contacts/{ContactID}/Attachments/{FileName} |
|
|
98
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
|
|
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
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
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
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
|
|
@@ -125,6 +125,7 @@ Class | Method | HTTP request | Description
|
|
|
125
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
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
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
|
|
128
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
|
|
129
130
|
*XeroRuby::AccountingApi* | [**create_quotes**](docs/AccountingApi.md#create_quotes) | **PUT** /Quotes | Allows you to create one or more quotes
|
|
130
131
|
*XeroRuby::AccountingApi* | [**create_receipt**](docs/AccountingApi.md#create_receipt) | **PUT** /Receipts | Allows you to create draft expense claim receipts for any user
|
|
@@ -136,8 +137,8 @@ Class | Method | HTTP request | Description
|
|
|
136
137
|
*XeroRuby::AccountingApi* | [**create_tracking_category**](docs/AccountingApi.md#create_tracking_category) | **PUT** /TrackingCategories | Allows you to create tracking categories
|
|
137
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
|
|
138
139
|
*XeroRuby::AccountingApi* | [**delete_account**](docs/AccountingApi.md#delete_account) | **DELETE** /Accounts/{AccountID} | Allows you to delete a chart of accounts
|
|
139
|
-
*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
|
|
140
|
-
*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
|
|
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
|
|
141
142
|
*XeroRuby::AccountingApi* | [**delete_item**](docs/AccountingApi.md#delete_item) | **DELETE** /Items/{ItemID} | Allows you to delete a specified item
|
|
142
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)
|
|
143
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
|
|
@@ -171,7 +172,7 @@ Class | Method | HTTP request | Description
|
|
|
171
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
|
|
172
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
|
|
173
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
|
|
174
|
-
*XeroRuby::AccountingApi* | [**get_contact_group**](docs/AccountingApi.md#get_contact_group) | **GET** /ContactGroups/{ContactGroupID} | Allows you to retrieve a unique
|
|
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
|
|
175
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
|
|
176
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
|
|
177
178
|
*XeroRuby::AccountingApi* | [**get_contacts**](docs/AccountingApi.md#get_contacts) | **GET** /Contacts | Allows you to retrieve, add and update contacts in a Xero organisation
|
|
@@ -222,9 +223,13 @@ Class | Method | HTTP request | Description
|
|
|
222
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
|
|
223
224
|
*XeroRuby::AccountingApi* | [**get_prepayments**](docs/AccountingApi.md#get_prepayments) | **GET** /Prepayments | Allows you to retrieve prepayments
|
|
224
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
|
|
225
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
|
|
226
228
|
*XeroRuby::AccountingApi* | [**get_purchase_orders**](docs/AccountingApi.md#get_purchase_orders) | **GET** /PurchaseOrders | Allows you to retrieve purchase orders
|
|
227
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_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
|
|
231
|
+
*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
|
|
232
|
+
*XeroRuby::AccountingApi* | [**get_quote_attachments**](docs/AccountingApi.md#get_quote_attachments) | **GET** /Quotes/{QuoteID}/Attachments | Allows you to retrieve Attachments for Quotes
|
|
228
233
|
*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
|
|
229
234
|
*XeroRuby::AccountingApi* | [**get_quotes**](docs/AccountingApi.md#get_quotes) | **GET** /Quotes | Allows you to retrieve any sales quotes
|
|
230
235
|
*XeroRuby::AccountingApi* | [**get_receipt**](docs/AccountingApi.md#get_receipt) | **GET** /Receipts/{ReceiptID} | Allows you to retrieve a specified draft expense claim receipts
|
|
@@ -262,7 +267,7 @@ Class | Method | HTTP request | Description
|
|
|
262
267
|
*XeroRuby::AccountingApi* | [**update_bank_transfer_attachment_by_file_name**](docs/AccountingApi.md#update_bank_transfer_attachment_by_file_name) | **POST** /BankTransfers/{BankTransferID}/Attachments/{FileName} |
|
|
263
268
|
*XeroRuby::AccountingApi* | [**update_contact**](docs/AccountingApi.md#update_contact) | **POST** /Contacts/{ContactID} |
|
|
264
269
|
*XeroRuby::AccountingApi* | [**update_contact_attachment_by_file_name**](docs/AccountingApi.md#update_contact_attachment_by_file_name) | **POST** /Contacts/{ContactID}/Attachments/{FileName} |
|
|
265
|
-
*XeroRuby::AccountingApi* | [**update_contact_group**](docs/AccountingApi.md#update_contact_group) | **POST** /ContactGroups/{ContactGroupID} | Allows you to update a
|
|
270
|
+
*XeroRuby::AccountingApi* | [**update_contact_group**](docs/AccountingApi.md#update_contact_group) | **POST** /ContactGroups/{ContactGroupID} | Allows you to update a Contact Group
|
|
266
271
|
*XeroRuby::AccountingApi* | [**update_credit_note**](docs/AccountingApi.md#update_credit_note) | **POST** /CreditNotes/{CreditNoteID} | Allows you to update a specific credit note
|
|
267
272
|
*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
|
|
268
273
|
*XeroRuby::AccountingApi* | [**update_employee**](docs/AccountingApi.md#update_employee) | **POST** /Employees/{EmployeeID} | Allows you to update a specific employee used in Xero payrun
|
|
@@ -284,6 +289,7 @@ Class | Method | HTTP request | Description
|
|
|
284
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
|
|
285
290
|
*XeroRuby::AccountingApi* | [**update_purchase_order**](docs/AccountingApi.md#update_purchase_order) | **POST** /PurchaseOrders/{PurchaseOrderID} | Allows you to update a specified purchase order
|
|
286
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
|
|
287
293
|
*XeroRuby::AccountingApi* | [**update_receipt**](docs/AccountingApi.md#update_receipt) | **POST** /Receipts/{ReceiptID} | Allows you to retrieve a specified draft expense claim receipts
|
|
288
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
|
|
289
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
|
data/docs/AccountingApi.md
CHANGED
|
@@ -17,7 +17,7 @@ Method | HTTP request | Description
|
|
|
17
17
|
[**create_branding_theme_payment_services**](AccountingApi.md#create_branding_theme_payment_services) | **POST** /BrandingThemes/{BrandingThemeID}/PaymentServices | Allow for the creation of new custom payment service for specified Branding Theme
|
|
18
18
|
[**create_contact_attachment_by_file_name**](AccountingApi.md#create_contact_attachment_by_file_name) | **PUT** /Contacts/{ContactID}/Attachments/{FileName} |
|
|
19
19
|
[**create_contact_group**](AccountingApi.md#create_contact_group) | **PUT** /ContactGroups | Allows you to create a contact group
|
|
20
|
-
[**create_contact_group_contacts**](AccountingApi.md#create_contact_group_contacts) | **PUT** /ContactGroups/{ContactGroupID}/Contacts | Allows you to add Contacts to a
|
|
20
|
+
[**create_contact_group_contacts**](AccountingApi.md#create_contact_group_contacts) | **PUT** /ContactGroups/{ContactGroupID}/Contacts | Allows you to add Contacts to a Contact Group
|
|
21
21
|
[**create_contact_history**](AccountingApi.md#create_contact_history) | **PUT** /Contacts/{ContactID}/History | Allows you to retrieve a history records of an Contact
|
|
22
22
|
[**create_contacts**](AccountingApi.md#create_contacts) | **PUT** /Contacts | Allows you to create a multiple contacts (bulk) in a Xero organisation
|
|
23
23
|
[**create_credit_note_allocation**](AccountingApi.md#create_credit_note_allocation) | **PUT** /CreditNotes/{CreditNoteID}/Allocations | Allows you to create Allocation on CreditNote
|
|
@@ -46,6 +46,7 @@ Method | HTTP request | Description
|
|
|
46
46
|
[**create_prepayment_history**](AccountingApi.md#create_prepayment_history) | **PUT** /Prepayments/{PrepaymentID}/History | Allows you to create a history record for an Prepayment
|
|
47
47
|
[**create_purchase_order_history**](AccountingApi.md#create_purchase_order_history) | **PUT** /PurchaseOrders/{PurchaseOrderID}/History | Allows you to create HistoryRecord for purchase orders
|
|
48
48
|
[**create_purchase_orders**](AccountingApi.md#create_purchase_orders) | **PUT** /PurchaseOrders | Allows you to create one or more purchase orders
|
|
49
|
+
[**create_quote_attachment_by_file_name**](AccountingApi.md#create_quote_attachment_by_file_name) | **PUT** /Quotes/{QuoteID}/Attachments/{FileName} | Allows you to create Attachment on Quote
|
|
49
50
|
[**create_quote_history**](AccountingApi.md#create_quote_history) | **PUT** /Quotes/{QuoteID}/History | Allows you to retrieve a history records of an quote
|
|
50
51
|
[**create_quotes**](AccountingApi.md#create_quotes) | **PUT** /Quotes | Allows you to create one or more quotes
|
|
51
52
|
[**create_receipt**](AccountingApi.md#create_receipt) | **PUT** /Receipts | Allows you to create draft expense claim receipts for any user
|
|
@@ -57,8 +58,8 @@ Method | HTTP request | Description
|
|
|
57
58
|
[**create_tracking_category**](AccountingApi.md#create_tracking_category) | **PUT** /TrackingCategories | Allows you to create tracking categories
|
|
58
59
|
[**create_tracking_options**](AccountingApi.md#create_tracking_options) | **PUT** /TrackingCategories/{TrackingCategoryID}/Options | Allows you to create options for a specified tracking category
|
|
59
60
|
[**delete_account**](AccountingApi.md#delete_account) | **DELETE** /Accounts/{AccountID} | Allows you to delete a chart of accounts
|
|
60
|
-
[**delete_contact_group_contact**](AccountingApi.md#delete_contact_group_contact) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts/{ContactID} | Allows you to delete a specific Contact from a
|
|
61
|
-
[**delete_contact_group_contacts**](AccountingApi.md#delete_contact_group_contacts) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts | Allows you to delete all Contacts from a
|
|
61
|
+
[**delete_contact_group_contact**](AccountingApi.md#delete_contact_group_contact) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts/{ContactID} | Allows you to delete a specific Contact from a Contact Group
|
|
62
|
+
[**delete_contact_group_contacts**](AccountingApi.md#delete_contact_group_contacts) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts | Allows you to delete all Contacts from a Contact Group
|
|
62
63
|
[**delete_item**](AccountingApi.md#delete_item) | **DELETE** /Items/{ItemID} | Allows you to delete a specified item
|
|
63
64
|
[**delete_linked_transaction**](AccountingApi.md#delete_linked_transaction) | **DELETE** /LinkedTransactions/{LinkedTransactionID} | Allows you to delete a specified linked transactions (billable expenses)
|
|
64
65
|
[**delete_payment**](AccountingApi.md#delete_payment) | **POST** /Payments/{PaymentID} | Allows you to update a specified payment for invoices and credit notes
|
|
@@ -92,7 +93,7 @@ Method | HTTP request | Description
|
|
|
92
93
|
[**get_contact_attachment_by_id**](AccountingApi.md#get_contact_attachment_by_id) | **GET** /Contacts/{ContactID}/Attachments/{AttachmentID} | Allows you to retrieve Attachments on Contacts
|
|
93
94
|
[**get_contact_attachments**](AccountingApi.md#get_contact_attachments) | **GET** /Contacts/{ContactID}/Attachments | Allows you to retrieve, add and update contacts in a Xero organisation
|
|
94
95
|
[**get_contact_cis_settings**](AccountingApi.md#get_contact_cis_settings) | **GET** /Contacts/{ContactID}/CISSettings | Allows you to retrieve CISSettings for a contact in a Xero organisation
|
|
95
|
-
[**get_contact_group**](AccountingApi.md#get_contact_group) | **GET** /ContactGroups/{ContactGroupID} | Allows you to retrieve a unique
|
|
96
|
+
[**get_contact_group**](AccountingApi.md#get_contact_group) | **GET** /ContactGroups/{ContactGroupID} | Allows you to retrieve a unique Contact Group by ID
|
|
96
97
|
[**get_contact_groups**](AccountingApi.md#get_contact_groups) | **GET** /ContactGroups | Allows you to retrieve the ContactID and Name of all the contacts in a contact group
|
|
97
98
|
[**get_contact_history**](AccountingApi.md#get_contact_history) | **GET** /Contacts/{ContactID}/History | Allows you to retrieve a history records of an Contact
|
|
98
99
|
[**get_contacts**](AccountingApi.md#get_contacts) | **GET** /Contacts | Allows you to retrieve, add and update contacts in a Xero organisation
|
|
@@ -143,9 +144,13 @@ Method | HTTP request | Description
|
|
|
143
144
|
[**get_prepayment_history**](AccountingApi.md#get_prepayment_history) | **GET** /Prepayments/{PrepaymentID}/History | Allows you to retrieve a history records of an Prepayment
|
|
144
145
|
[**get_prepayments**](AccountingApi.md#get_prepayments) | **GET** /Prepayments | Allows you to retrieve prepayments
|
|
145
146
|
[**get_purchase_order**](AccountingApi.md#get_purchase_order) | **GET** /PurchaseOrders/{PurchaseOrderID} | Allows you to retrieve a specified purchase orders
|
|
147
|
+
[**get_purchase_order_by_number**](AccountingApi.md#get_purchase_order_by_number) | **GET** /PurchaseOrders/{PurchaseOrderNumber} | Allows you to retrieve a specified purchase orders
|
|
146
148
|
[**get_purchase_order_history**](AccountingApi.md#get_purchase_order_history) | **GET** /PurchaseOrders/{PurchaseOrderID}/History | Allows you to retrieve history for PurchaseOrder
|
|
147
149
|
[**get_purchase_orders**](AccountingApi.md#get_purchase_orders) | **GET** /PurchaseOrders | Allows you to retrieve purchase orders
|
|
148
150
|
[**get_quote**](AccountingApi.md#get_quote) | **GET** /Quotes/{QuoteID} | Allows you to retrieve a specified quote
|
|
151
|
+
[**get_quote_attachment_by_file_name**](AccountingApi.md#get_quote_attachment_by_file_name) | **GET** /Quotes/{QuoteID}/Attachments/{FileName} | Allows you to retrieve Attachment on Quote by Filename
|
|
152
|
+
[**get_quote_attachment_by_id**](AccountingApi.md#get_quote_attachment_by_id) | **GET** /Quotes/{QuoteID}/Attachments/{AttachmentID} | Allows you to retrieve specific Attachment on Quote
|
|
153
|
+
[**get_quote_attachments**](AccountingApi.md#get_quote_attachments) | **GET** /Quotes/{QuoteID}/Attachments | Allows you to retrieve Attachments for Quotes
|
|
149
154
|
[**get_quote_history**](AccountingApi.md#get_quote_history) | **GET** /Quotes/{QuoteID}/History | Allows you to retrieve a history records of an quote
|
|
150
155
|
[**get_quotes**](AccountingApi.md#get_quotes) | **GET** /Quotes | Allows you to retrieve any sales quotes
|
|
151
156
|
[**get_receipt**](AccountingApi.md#get_receipt) | **GET** /Receipts/{ReceiptID} | Allows you to retrieve a specified draft expense claim receipts
|
|
@@ -183,7 +188,7 @@ Method | HTTP request | Description
|
|
|
183
188
|
[**update_bank_transfer_attachment_by_file_name**](AccountingApi.md#update_bank_transfer_attachment_by_file_name) | **POST** /BankTransfers/{BankTransferID}/Attachments/{FileName} |
|
|
184
189
|
[**update_contact**](AccountingApi.md#update_contact) | **POST** /Contacts/{ContactID} |
|
|
185
190
|
[**update_contact_attachment_by_file_name**](AccountingApi.md#update_contact_attachment_by_file_name) | **POST** /Contacts/{ContactID}/Attachments/{FileName} |
|
|
186
|
-
[**update_contact_group**](AccountingApi.md#update_contact_group) | **POST** /ContactGroups/{ContactGroupID} | Allows you to update a
|
|
191
|
+
[**update_contact_group**](AccountingApi.md#update_contact_group) | **POST** /ContactGroups/{ContactGroupID} | Allows you to update a Contact Group
|
|
187
192
|
[**update_credit_note**](AccountingApi.md#update_credit_note) | **POST** /CreditNotes/{CreditNoteID} | Allows you to update a specific credit note
|
|
188
193
|
[**update_credit_note_attachment_by_file_name**](AccountingApi.md#update_credit_note_attachment_by_file_name) | **POST** /CreditNotes/{CreditNoteID}/Attachments/{FileName} | Allows you to update Attachments on CreditNote by file name
|
|
189
194
|
[**update_employee**](AccountingApi.md#update_employee) | **POST** /Employees/{EmployeeID} | Allows you to update a specific employee used in Xero payrun
|
|
@@ -205,6 +210,7 @@ Method | HTTP request | Description
|
|
|
205
210
|
[**update_or_create_quotes**](AccountingApi.md#update_or_create_quotes) | **POST** /Quotes | Allows you to update OR create one or more quotes
|
|
206
211
|
[**update_purchase_order**](AccountingApi.md#update_purchase_order) | **POST** /PurchaseOrders/{PurchaseOrderID} | Allows you to update a specified purchase order
|
|
207
212
|
[**update_quote**](AccountingApi.md#update_quote) | **POST** /Quotes/{QuoteID} | Allows you to update a specified quote
|
|
213
|
+
[**update_quote_attachment_by_file_name**](AccountingApi.md#update_quote_attachment_by_file_name) | **POST** /Quotes/{QuoteID}/Attachments/{FileName} | Allows you to update Attachment on Quote by Filename
|
|
208
214
|
[**update_receipt**](AccountingApi.md#update_receipt) | **POST** /Receipts/{ReceiptID} | Allows you to retrieve a specified draft expense claim receipts
|
|
209
215
|
[**update_receipt_attachment_by_file_name**](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
|
|
210
216
|
[**update_repeating_invoice_attachment_by_file_name**](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
|
|
@@ -925,7 +931,7 @@ Name | Type | Description | Notes
|
|
|
925
931
|
|
|
926
932
|
> Contacts create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts)
|
|
927
933
|
|
|
928
|
-
Allows you to add Contacts to a
|
|
934
|
+
Allows you to add Contacts to a Contact Group
|
|
929
935
|
|
|
930
936
|
### Example
|
|
931
937
|
|
|
@@ -944,7 +950,7 @@ contact_group_id = '00000000-0000-0000-000-000000000000' # String | Unique ident
|
|
|
944
950
|
contacts = { contacts:[ { contactID:"a3675fc4-f8dd-4f03-ba5b-f1870566bcd7" }, { contactID:"4e1753b9-018a-4775-b6aa-1bc7871cfee3" } ] } # Contacts | Contacts with array of contacts specifiying the ContactID to be added to ContactGroup in body of request
|
|
945
951
|
|
|
946
952
|
begin
|
|
947
|
-
#Allows you to add Contacts to a
|
|
953
|
+
#Allows you to add Contacts to a Contact Group
|
|
948
954
|
result = api_instance.create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts)
|
|
949
955
|
p result
|
|
950
956
|
rescue XeroRuby::ApiError => e
|
|
@@ -2512,6 +2518,62 @@ Name | Type | Description | Notes
|
|
|
2512
2518
|
- **Accept**: application/json
|
|
2513
2519
|
|
|
2514
2520
|
|
|
2521
|
+
## create_quote_attachment_by_file_name
|
|
2522
|
+
|
|
2523
|
+
> Attachments create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body)
|
|
2524
|
+
|
|
2525
|
+
Allows you to create Attachment on Quote
|
|
2526
|
+
|
|
2527
|
+
### Example
|
|
2528
|
+
|
|
2529
|
+
```ruby
|
|
2530
|
+
# load the gem
|
|
2531
|
+
require 'xero-ruby'
|
|
2532
|
+
# setup authorization
|
|
2533
|
+
XeroRuby.configure do |config|
|
|
2534
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
2535
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
2536
|
+
end
|
|
2537
|
+
|
|
2538
|
+
api_instance = XeroRuby::AccountingApi.new
|
|
2539
|
+
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
|
2540
|
+
quote_id = '00000000-0000-0000-000-000000000000' # String | Unique identifier for Quote object
|
|
2541
|
+
file_name = 'xero-dev.jpg' # String | Name of the attachment
|
|
2542
|
+
body = 'body_example' # String | Byte array of file in body of request
|
|
2543
|
+
|
|
2544
|
+
begin
|
|
2545
|
+
#Allows you to create Attachment on Quote
|
|
2546
|
+
result = api_instance.create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body)
|
|
2547
|
+
p result
|
|
2548
|
+
rescue XeroRuby::ApiError => e
|
|
2549
|
+
puts "Exception when calling AccountingApi->create_quote_attachment_by_file_name: #{e}"
|
|
2550
|
+
end
|
|
2551
|
+
```
|
|
2552
|
+
|
|
2553
|
+
### Parameters
|
|
2554
|
+
|
|
2555
|
+
|
|
2556
|
+
Name | Type | Description | Notes
|
|
2557
|
+
------------- | ------------- | ------------- | -------------
|
|
2558
|
+
**xero_tenant_id** | **String**| Xero identifier for Tenant |
|
|
2559
|
+
**quote_id** | [**String**](.md)| Unique identifier for Quote object |
|
|
2560
|
+
**file_name** | **String**| Name of the attachment |
|
|
2561
|
+
**body** | **String**| Byte array of file in body of request |
|
|
2562
|
+
|
|
2563
|
+
### Return type
|
|
2564
|
+
|
|
2565
|
+
[**Attachments**](Attachments.md)
|
|
2566
|
+
|
|
2567
|
+
### Authorization
|
|
2568
|
+
|
|
2569
|
+
[OAuth2](../README.md#OAuth2)
|
|
2570
|
+
|
|
2571
|
+
### HTTP request headers
|
|
2572
|
+
|
|
2573
|
+
- **Content-Type**: application/octet-stream
|
|
2574
|
+
- **Accept**: application/json
|
|
2575
|
+
|
|
2576
|
+
|
|
2515
2577
|
## create_quote_history
|
|
2516
2578
|
|
|
2517
2579
|
> HistoryRecords create_quote_history(xero_tenant_id, quote_id, history_records)
|
|
@@ -3112,7 +3174,7 @@ Name | Type | Description | Notes
|
|
|
3112
3174
|
|
|
3113
3175
|
> delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id)
|
|
3114
3176
|
|
|
3115
|
-
Allows you to delete a specific Contact from a
|
|
3177
|
+
Allows you to delete a specific Contact from a Contact Group
|
|
3116
3178
|
|
|
3117
3179
|
### Example
|
|
3118
3180
|
|
|
@@ -3131,7 +3193,7 @@ contact_group_id = '00000000-0000-0000-000-000000000000' # String | Unique ident
|
|
|
3131
3193
|
contact_id = '00000000-0000-0000-000-000000000000' # String | Unique identifier for a Contact
|
|
3132
3194
|
|
|
3133
3195
|
begin
|
|
3134
|
-
#Allows you to delete a specific Contact from a
|
|
3196
|
+
#Allows you to delete a specific Contact from a Contact Group
|
|
3135
3197
|
api_instance.delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id)
|
|
3136
3198
|
rescue XeroRuby::ApiError => e
|
|
3137
3199
|
puts "Exception when calling AccountingApi->delete_contact_group_contact: #{e}"
|
|
@@ -3165,7 +3227,7 @@ nil (empty response body)
|
|
|
3165
3227
|
|
|
3166
3228
|
> delete_contact_group_contacts(xero_tenant_id, contact_group_id)
|
|
3167
3229
|
|
|
3168
|
-
Allows you to delete all Contacts from a
|
|
3230
|
+
Allows you to delete all Contacts from a Contact Group
|
|
3169
3231
|
|
|
3170
3232
|
### Example
|
|
3171
3233
|
|
|
@@ -3183,7 +3245,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
|
|
3183
3245
|
contact_group_id = '00000000-0000-0000-000-000000000000' # String | Unique identifier for a Contact Group
|
|
3184
3246
|
|
|
3185
3247
|
begin
|
|
3186
|
-
#Allows you to delete all Contacts from a
|
|
3248
|
+
#Allows you to delete all Contacts from a Contact Group
|
|
3187
3249
|
api_instance.delete_contact_group_contacts(xero_tenant_id, contact_group_id)
|
|
3188
3250
|
rescue XeroRuby::ApiError => e
|
|
3189
3251
|
puts "Exception when calling AccountingApi->delete_contact_group_contacts: #{e}"
|
|
@@ -4997,7 +5059,7 @@ Name | Type | Description | Notes
|
|
|
4997
5059
|
|
|
4998
5060
|
> ContactGroups get_contact_group(xero_tenant_id, contact_group_id)
|
|
4999
5061
|
|
|
5000
|
-
Allows you to retrieve a unique
|
|
5062
|
+
Allows you to retrieve a unique Contact Group by ID
|
|
5001
5063
|
|
|
5002
5064
|
### Example
|
|
5003
5065
|
|
|
@@ -5015,7 +5077,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
|
|
5015
5077
|
contact_group_id = '00000000-0000-0000-000-000000000000' # String | Unique identifier for a Contact Group
|
|
5016
5078
|
|
|
5017
5079
|
begin
|
|
5018
|
-
#Allows you to retrieve a unique
|
|
5080
|
+
#Allows you to retrieve a unique Contact Group by ID
|
|
5019
5081
|
result = api_instance.get_contact_group(xero_tenant_id, contact_group_id)
|
|
5020
5082
|
p result
|
|
5021
5083
|
rescue XeroRuby::ApiError => e
|
|
@@ -7799,6 +7861,58 @@ Name | Type | Description | Notes
|
|
|
7799
7861
|
- **Accept**: application/json
|
|
7800
7862
|
|
|
7801
7863
|
|
|
7864
|
+
## get_purchase_order_by_number
|
|
7865
|
+
|
|
7866
|
+
> PurchaseOrders get_purchase_order_by_number(xero_tenant_id, purchase_order_number)
|
|
7867
|
+
|
|
7868
|
+
Allows you to retrieve a specified purchase orders
|
|
7869
|
+
|
|
7870
|
+
### Example
|
|
7871
|
+
|
|
7872
|
+
```ruby
|
|
7873
|
+
# load the gem
|
|
7874
|
+
require 'xero-ruby'
|
|
7875
|
+
# setup authorization
|
|
7876
|
+
XeroRuby.configure do |config|
|
|
7877
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
7878
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
7879
|
+
end
|
|
7880
|
+
|
|
7881
|
+
api_instance = XeroRuby::AccountingApi.new
|
|
7882
|
+
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
|
7883
|
+
purchase_order_number = 'PO1234' # String | Unique identifier for a PurchaseOrder
|
|
7884
|
+
|
|
7885
|
+
begin
|
|
7886
|
+
#Allows you to retrieve a specified purchase orders
|
|
7887
|
+
result = api_instance.get_purchase_order_by_number(xero_tenant_id, purchase_order_number)
|
|
7888
|
+
p result
|
|
7889
|
+
rescue XeroRuby::ApiError => e
|
|
7890
|
+
puts "Exception when calling AccountingApi->get_purchase_order_by_number: #{e}"
|
|
7891
|
+
end
|
|
7892
|
+
```
|
|
7893
|
+
|
|
7894
|
+
### Parameters
|
|
7895
|
+
|
|
7896
|
+
|
|
7897
|
+
Name | Type | Description | Notes
|
|
7898
|
+
------------- | ------------- | ------------- | -------------
|
|
7899
|
+
**xero_tenant_id** | **String**| Xero identifier for Tenant |
|
|
7900
|
+
**purchase_order_number** | **String**| Unique identifier for a PurchaseOrder |
|
|
7901
|
+
|
|
7902
|
+
### Return type
|
|
7903
|
+
|
|
7904
|
+
[**PurchaseOrders**](PurchaseOrders.md)
|
|
7905
|
+
|
|
7906
|
+
### Authorization
|
|
7907
|
+
|
|
7908
|
+
[OAuth2](../README.md#OAuth2)
|
|
7909
|
+
|
|
7910
|
+
### HTTP request headers
|
|
7911
|
+
|
|
7912
|
+
- **Content-Type**: Not defined
|
|
7913
|
+
- **Accept**: application/json
|
|
7914
|
+
|
|
7915
|
+
|
|
7802
7916
|
## get_purchase_order_history
|
|
7803
7917
|
|
|
7804
7918
|
> HistoryRecords get_purchase_order_history(xero_tenant_id, purchase_order_id)
|
|
@@ -7967,6 +8081,170 @@ Name | Type | Description | Notes
|
|
|
7967
8081
|
- **Accept**: application/json
|
|
7968
8082
|
|
|
7969
8083
|
|
|
8084
|
+
## get_quote_attachment_by_file_name
|
|
8085
|
+
|
|
8086
|
+
> File get_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, content_type)
|
|
8087
|
+
|
|
8088
|
+
Allows you to retrieve Attachment on Quote by Filename
|
|
8089
|
+
|
|
8090
|
+
### Example
|
|
8091
|
+
|
|
8092
|
+
```ruby
|
|
8093
|
+
# load the gem
|
|
8094
|
+
require 'xero-ruby'
|
|
8095
|
+
# setup authorization
|
|
8096
|
+
XeroRuby.configure do |config|
|
|
8097
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
8098
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
8099
|
+
end
|
|
8100
|
+
|
|
8101
|
+
api_instance = XeroRuby::AccountingApi.new
|
|
8102
|
+
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
|
8103
|
+
quote_id = '00000000-0000-0000-000-000000000000' # String | Unique identifier for Quote object
|
|
8104
|
+
file_name = 'xero-dev.jpg' # String | Name of the attachment
|
|
8105
|
+
content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
8106
|
+
|
|
8107
|
+
begin
|
|
8108
|
+
#Allows you to retrieve Attachment on Quote by Filename
|
|
8109
|
+
result = api_instance.get_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, content_type)
|
|
8110
|
+
p result
|
|
8111
|
+
rescue XeroRuby::ApiError => e
|
|
8112
|
+
puts "Exception when calling AccountingApi->get_quote_attachment_by_file_name: #{e}"
|
|
8113
|
+
end
|
|
8114
|
+
```
|
|
8115
|
+
|
|
8116
|
+
### Parameters
|
|
8117
|
+
|
|
8118
|
+
|
|
8119
|
+
Name | Type | Description | Notes
|
|
8120
|
+
------------- | ------------- | ------------- | -------------
|
|
8121
|
+
**xero_tenant_id** | **String**| Xero identifier for Tenant |
|
|
8122
|
+
**quote_id** | [**String**](.md)| Unique identifier for Quote object |
|
|
8123
|
+
**file_name** | **String**| Name of the attachment |
|
|
8124
|
+
**content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf |
|
|
8125
|
+
|
|
8126
|
+
### Return type
|
|
8127
|
+
|
|
8128
|
+
**File**
|
|
8129
|
+
|
|
8130
|
+
### Authorization
|
|
8131
|
+
|
|
8132
|
+
[OAuth2](../README.md#OAuth2)
|
|
8133
|
+
|
|
8134
|
+
### HTTP request headers
|
|
8135
|
+
|
|
8136
|
+
- **Content-Type**: Not defined
|
|
8137
|
+
- **Accept**: application/octet-stream
|
|
8138
|
+
|
|
8139
|
+
|
|
8140
|
+
## get_quote_attachment_by_id
|
|
8141
|
+
|
|
8142
|
+
> File get_quote_attachment_by_id(xero_tenant_id, quote_id, attachment_id, content_type)
|
|
8143
|
+
|
|
8144
|
+
Allows you to retrieve specific Attachment on Quote
|
|
8145
|
+
|
|
8146
|
+
### Example
|
|
8147
|
+
|
|
8148
|
+
```ruby
|
|
8149
|
+
# load the gem
|
|
8150
|
+
require 'xero-ruby'
|
|
8151
|
+
# setup authorization
|
|
8152
|
+
XeroRuby.configure do |config|
|
|
8153
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
8154
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
8155
|
+
end
|
|
8156
|
+
|
|
8157
|
+
api_instance = XeroRuby::AccountingApi.new
|
|
8158
|
+
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
|
8159
|
+
quote_id = '00000000-0000-0000-000-000000000000' # String | Unique identifier for Quote object
|
|
8160
|
+
attachment_id = '00000000-0000-0000-000-000000000000' # String | Unique identifier for Attachment object
|
|
8161
|
+
content_type = 'image/jpg' # String | The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
8162
|
+
|
|
8163
|
+
begin
|
|
8164
|
+
#Allows you to retrieve specific Attachment on Quote
|
|
8165
|
+
result = api_instance.get_quote_attachment_by_id(xero_tenant_id, quote_id, attachment_id, content_type)
|
|
8166
|
+
p result
|
|
8167
|
+
rescue XeroRuby::ApiError => e
|
|
8168
|
+
puts "Exception when calling AccountingApi->get_quote_attachment_by_id: #{e}"
|
|
8169
|
+
end
|
|
8170
|
+
```
|
|
8171
|
+
|
|
8172
|
+
### Parameters
|
|
8173
|
+
|
|
8174
|
+
|
|
8175
|
+
Name | Type | Description | Notes
|
|
8176
|
+
------------- | ------------- | ------------- | -------------
|
|
8177
|
+
**xero_tenant_id** | **String**| Xero identifier for Tenant |
|
|
8178
|
+
**quote_id** | [**String**](.md)| Unique identifier for Quote object |
|
|
8179
|
+
**attachment_id** | [**String**](.md)| Unique identifier for Attachment object |
|
|
8180
|
+
**content_type** | **String**| The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf |
|
|
8181
|
+
|
|
8182
|
+
### Return type
|
|
8183
|
+
|
|
8184
|
+
**File**
|
|
8185
|
+
|
|
8186
|
+
### Authorization
|
|
8187
|
+
|
|
8188
|
+
[OAuth2](../README.md#OAuth2)
|
|
8189
|
+
|
|
8190
|
+
### HTTP request headers
|
|
8191
|
+
|
|
8192
|
+
- **Content-Type**: Not defined
|
|
8193
|
+
- **Accept**: application/octet-stream
|
|
8194
|
+
|
|
8195
|
+
|
|
8196
|
+
## get_quote_attachments
|
|
8197
|
+
|
|
8198
|
+
> Attachments get_quote_attachments(xero_tenant_id, quote_id)
|
|
8199
|
+
|
|
8200
|
+
Allows you to retrieve Attachments for Quotes
|
|
8201
|
+
|
|
8202
|
+
### Example
|
|
8203
|
+
|
|
8204
|
+
```ruby
|
|
8205
|
+
# load the gem
|
|
8206
|
+
require 'xero-ruby'
|
|
8207
|
+
# setup authorization
|
|
8208
|
+
XeroRuby.configure do |config|
|
|
8209
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
8210
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
8211
|
+
end
|
|
8212
|
+
|
|
8213
|
+
api_instance = XeroRuby::AccountingApi.new
|
|
8214
|
+
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
|
8215
|
+
quote_id = '00000000-0000-0000-000-000000000000' # String | Unique identifier for Quote object
|
|
8216
|
+
|
|
8217
|
+
begin
|
|
8218
|
+
#Allows you to retrieve Attachments for Quotes
|
|
8219
|
+
result = api_instance.get_quote_attachments(xero_tenant_id, quote_id)
|
|
8220
|
+
p result
|
|
8221
|
+
rescue XeroRuby::ApiError => e
|
|
8222
|
+
puts "Exception when calling AccountingApi->get_quote_attachments: #{e}"
|
|
8223
|
+
end
|
|
8224
|
+
```
|
|
8225
|
+
|
|
8226
|
+
### Parameters
|
|
8227
|
+
|
|
8228
|
+
|
|
8229
|
+
Name | Type | Description | Notes
|
|
8230
|
+
------------- | ------------- | ------------- | -------------
|
|
8231
|
+
**xero_tenant_id** | **String**| Xero identifier for Tenant |
|
|
8232
|
+
**quote_id** | [**String**](.md)| Unique identifier for Quote object |
|
|
8233
|
+
|
|
8234
|
+
### Return type
|
|
8235
|
+
|
|
8236
|
+
[**Attachments**](Attachments.md)
|
|
8237
|
+
|
|
8238
|
+
### Authorization
|
|
8239
|
+
|
|
8240
|
+
[OAuth2](../README.md#OAuth2)
|
|
8241
|
+
|
|
8242
|
+
### HTTP request headers
|
|
8243
|
+
|
|
8244
|
+
- **Content-Type**: Not defined
|
|
8245
|
+
- **Accept**: application/json
|
|
8246
|
+
|
|
8247
|
+
|
|
7970
8248
|
## get_quote_history
|
|
7971
8249
|
|
|
7972
8250
|
> HistoryRecords get_quote_history(xero_tenant_id, quote_id)
|
|
@@ -10052,7 +10330,7 @@ Name | Type | Description | Notes
|
|
|
10052
10330
|
|
|
10053
10331
|
> ContactGroups update_contact_group(xero_tenant_id, contact_group_id, contact_groups)
|
|
10054
10332
|
|
|
10055
|
-
Allows you to update a
|
|
10333
|
+
Allows you to update a Contact Group
|
|
10056
10334
|
|
|
10057
10335
|
### Example
|
|
10058
10336
|
|
|
@@ -10071,7 +10349,7 @@ contact_group_id = '00000000-0000-0000-000-000000000000' # String | Unique ident
|
|
|
10071
10349
|
contact_groups = { contactGroups:[ { name:"Vendor" } ] } # ContactGroups | an array of Contact groups with Name of specific group to update
|
|
10072
10350
|
|
|
10073
10351
|
begin
|
|
10074
|
-
#Allows you to update a
|
|
10352
|
+
#Allows you to update a Contact Group
|
|
10075
10353
|
result = api_instance.update_contact_group(xero_tenant_id, contact_group_id, contact_groups)
|
|
10076
10354
|
p result
|
|
10077
10355
|
rescue XeroRuby::ApiError => e
|
|
@@ -11280,6 +11558,62 @@ Name | Type | Description | Notes
|
|
|
11280
11558
|
- **Accept**: application/json
|
|
11281
11559
|
|
|
11282
11560
|
|
|
11561
|
+
## update_quote_attachment_by_file_name
|
|
11562
|
+
|
|
11563
|
+
> Attachments update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body)
|
|
11564
|
+
|
|
11565
|
+
Allows you to update Attachment on Quote by Filename
|
|
11566
|
+
|
|
11567
|
+
### Example
|
|
11568
|
+
|
|
11569
|
+
```ruby
|
|
11570
|
+
# load the gem
|
|
11571
|
+
require 'xero-ruby'
|
|
11572
|
+
# setup authorization
|
|
11573
|
+
XeroRuby.configure do |config|
|
|
11574
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
11575
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
11576
|
+
end
|
|
11577
|
+
|
|
11578
|
+
api_instance = XeroRuby::AccountingApi.new
|
|
11579
|
+
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
|
11580
|
+
quote_id = '00000000-0000-0000-000-000000000000' # String | Unique identifier for Quote object
|
|
11581
|
+
file_name = 'xero-dev.jpg' # String | Name of the attachment
|
|
11582
|
+
body = 'body_example' # String | Byte array of file in body of request
|
|
11583
|
+
|
|
11584
|
+
begin
|
|
11585
|
+
#Allows you to update Attachment on Quote by Filename
|
|
11586
|
+
result = api_instance.update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body)
|
|
11587
|
+
p result
|
|
11588
|
+
rescue XeroRuby::ApiError => e
|
|
11589
|
+
puts "Exception when calling AccountingApi->update_quote_attachment_by_file_name: #{e}"
|
|
11590
|
+
end
|
|
11591
|
+
```
|
|
11592
|
+
|
|
11593
|
+
### Parameters
|
|
11594
|
+
|
|
11595
|
+
|
|
11596
|
+
Name | Type | Description | Notes
|
|
11597
|
+
------------- | ------------- | ------------- | -------------
|
|
11598
|
+
**xero_tenant_id** | **String**| Xero identifier for Tenant |
|
|
11599
|
+
**quote_id** | [**String**](.md)| Unique identifier for Quote object |
|
|
11600
|
+
**file_name** | **String**| Name of the attachment |
|
|
11601
|
+
**body** | **String**| Byte array of file in body of request |
|
|
11602
|
+
|
|
11603
|
+
### Return type
|
|
11604
|
+
|
|
11605
|
+
[**Attachments**](Attachments.md)
|
|
11606
|
+
|
|
11607
|
+
### Authorization
|
|
11608
|
+
|
|
11609
|
+
[OAuth2](../README.md#OAuth2)
|
|
11610
|
+
|
|
11611
|
+
### HTTP request headers
|
|
11612
|
+
|
|
11613
|
+
- **Content-Type**: application/octet-stream
|
|
11614
|
+
- **Accept**: application/json
|
|
11615
|
+
|
|
11616
|
+
|
|
11283
11617
|
## update_receipt
|
|
11284
11618
|
|
|
11285
11619
|
> Receipts update_receipt(xero_tenant_id, receipt_id, receipts, opts)
|
data/docs/CreditNote.md
CHANGED
|
@@ -23,6 +23,7 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**currency_rate** | **Float** | The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used | [optional]
|
|
24
24
|
**remaining_credit** | **Float** | The remaining credit balance on the Credit Note | [optional]
|
|
25
25
|
**allocations** | [**Array<Allocation>**](Allocation.md) | See Allocations | [optional]
|
|
26
|
+
**applied_amount** | **Float** | The amount of applied to an invoice | [optional]
|
|
26
27
|
**payments** | [**Array<Payment>**](Payment.md) | See Payments | [optional]
|
|
27
28
|
**branding_theme_id** | **String** | See BrandingThemes | [optional]
|
|
28
29
|
**has_attachments** | **Boolean** | boolean to indicate if a credit note has an attachment | [optional]
|
|
@@ -53,6 +54,7 @@ instance = XeroRuby::CreditNote.new(type: null,
|
|
|
53
54
|
currency_rate: null,
|
|
54
55
|
remaining_credit: null,
|
|
55
56
|
allocations: null,
|
|
57
|
+
applied_amount: 2.0,
|
|
56
58
|
payments: null,
|
|
57
59
|
branding_theme_id: null,
|
|
58
60
|
has_attachments: null,
|