xero-ruby 2.4.0 → 2.4.1

data/docs/accounting/OnlineInvoice.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::OnlineInvoice
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**online_invoice_url** | **String** | the URL to an online invoice | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::OnlineInvoice.new(online_invoice_url: null)
-```
-
-

data/docs/accounting/OnlineInvoices.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::OnlineInvoices
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**online_invoices** | [**Array<OnlineInvoice>**](OnlineInvoice.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::OnlineInvoices.new(online_invoices: null)
-```
-
-

data/docs/accounting/Organisation.md

@@ -1,81 +0,0 @@
-# XeroRuby::Accounting::Organisation
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**organisation_id** | **String** | Unique Xero identifier | [optional] 
-**api_key** | **String** | Display a unique key used for Xero-to-Xero transactions | [optional] 
-**name** | **String** | Display name of organisation shown in Xero | [optional] 
-**legal_name** | **String** | Organisation name shown on Reports | [optional] 
-**pays_tax** | **Boolean** | Boolean to describe if organisation is registered with a local tax authority i.e. true, false | [optional] 
-**version** | **String** | See Version Types | [optional] 
-**organisation_type** | **String** | Organisation Type | [optional] 
-**base_currency** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
-**country_code** | [**CountryCode**](CountryCode.md) |  | [optional] 
-**is_demo_company** | **Boolean** | Boolean to describe if organisation is a demo company. | [optional] 
-**organisation_status** | **String** | Will be set to ACTIVE if you can connect to organisation via the Xero API | [optional] 
-**registration_number** | **String** | Shows for New Zealand, Australian and UK organisations | [optional] 
-**employer_identification_number** | **String** | Shown if set. US Only. | [optional] 
-**tax_number** | **String** | Shown if set. Displays in the Xero UI as Tax File Number (AU), GST Number (NZ), VAT Number (UK) and Tax ID Number (US & Global). | [optional] 
-**financial_year_end_day** | **Integer** | Calendar day e.g. 0-31 | [optional] 
-**financial_year_end_month** | **Integer** | Calendar Month e.g. 1-12 | [optional] 
-**sales_tax_basis** | **String** | The accounting basis used for tax returns. See Sales Tax Basis | [optional] 
-**sales_tax_period** | **String** | The frequency with which tax returns are processed. See Sales Tax Period | [optional] 
-**default_sales_tax** | **String** | The default for LineAmountTypes on sales transactions | [optional] 
-**default_purchases_tax** | **String** | The default for LineAmountTypes on purchase transactions | [optional] 
-**period_lock_date** | **Date** | Shown if set. See lock dates | [optional] 
-**end_of_year_lock_date** | **Date** | Shown if set. See lock dates | [optional] 
-**created_date_utc** | **DateTime** | Timestamp when the organisation was created in Xero | [optional] 
-**timezone** | [**TimeZone**](TimeZone.md) |  | [optional] 
-**organisation_entity_type** | **String** | Organisation Entity Type | [optional] 
-**short_code** | **String** | A unique identifier for the organisation. Potential uses. | [optional] 
-**_class** | **String** | Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM) | [optional] 
-**edition** | **String** | BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing) | [optional] 
-**line_of_business** | **String** | Description of business type as defined in Organisation settings | [optional] 
-**addresses** | [**Array<Address>**](Address.md) | Address details for organisation – see Addresses | [optional] 
-**phones** | [**Array<Phone>**](Phone.md) | Phones details for organisation – see Phones | [optional] 
-**external_links** | [**Array<ExternalLink>**](ExternalLink.md) | Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn. You can also add link to your website here. Shown if Organisation settings  is updated in Xero. See ExternalLinks below | [optional] 
-**payment_terms** | [**PaymentTerm**](PaymentTerm.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Organisation.new(organisation_id: 8be9db36-3598-4755-ba5c-c2dbc8c4a7a2,
-                                 api_key: null,
-                                 name: null,
-                                 legal_name: null,
-                                 pays_tax: null,
-                                 version: null,
-                                 organisation_type: null,
-                                 base_currency: null,
-                                 country_code: null,
-                                 is_demo_company: null,
-                                 organisation_status: null,
-                                 registration_number: null,
-                                 employer_identification_number: null,
-                                 tax_number: null,
-                                 financial_year_end_day: null,
-                                 financial_year_end_month: null,
-                                 sales_tax_basis: null,
-                                 sales_tax_period: null,
-                                 default_sales_tax: null,
-                                 default_purchases_tax: null,
-                                 period_lock_date: null,
-                                 end_of_year_lock_date: null,
-                                 created_date_utc: /Date(1573755038314)/,
-                                 timezone: null,
-                                 organisation_entity_type: null,
-                                 short_code: null,
-                                 _class: null,
-                                 edition: null,
-                                 line_of_business: null,
-                                 addresses: null,
-                                 phones: null,
-                                 external_links: null,
-                                 payment_terms: null)
-```
-
-

data/docs/accounting/Organisations.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::Organisations
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**organisations** | [**Array<Organisation>**](Organisation.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Organisations.new(organisations: null)
-```
-
-

data/docs/accounting/Overpayment.md

@@ -1,53 +0,0 @@
-# XeroRuby::Accounting::Overpayment
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **String** | See Overpayment Types | [optional] 
-**contact** | [**Contact**](Contact.md) |  | [optional] 
-**date** | **Date** | The date the overpayment is created YYYY-MM-DD | [optional] 
-**status** | **String** | See Overpayment Status Codes | [optional] 
-**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
-**line_items** | [**Array<LineItem>**](LineItem.md) | See Overpayment Line Items | [optional] 
-**sub_total** | **BigDecimal** | The subtotal of the overpayment excluding taxes | [optional] 
-**total_tax** | **BigDecimal** | The total tax on the overpayment | [optional] 
-**total** | **BigDecimal** | The total of the overpayment (subtotal + total tax) | [optional] 
-**updated_date_utc** | **DateTime** | UTC timestamp of last update to the overpayment | [optional] 
-**currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
-**overpayment_id** | **String** | Xero generated unique identifier | [optional] 
-**currency_rate** | **BigDecimal** | The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used | [optional] 
-**remaining_credit** | **BigDecimal** | The remaining credit balance on the overpayment | [optional] 
-**allocations** | [**Array<Allocation>**](Allocation.md) | See Allocations | [optional] 
-**applied_amount** | **Float** | The amount of applied to an invoice | [optional] 
-**payments** | [**Array<Payment>**](Payment.md) | See Payments | [optional] 
-**has_attachments** | **Boolean** | boolean to indicate if a overpayment has an attachment | [optional] [default to false]
-**attachments** | [**Array<Attachment>**](Attachment.md) | See Attachments | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Overpayment.new(type: null,
-                                 contact: null,
-                                 date: null,
-                                 status: null,
-                                 line_amount_types: null,
-                                 line_items: null,
-                                 sub_total: null,
-                                 total_tax: null,
-                                 total: null,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 currency_code: null,
-                                 overpayment_id: null,
-                                 currency_rate: null,
-                                 remaining_credit: null,
-                                 allocations: null,
-                                 applied_amount: 2.0,
-                                 payments: null,
-                                 has_attachments: false,
-                                 attachments: null)
-```
-
-

data/docs/accounting/Overpayments.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::Overpayments
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**overpayments** | [**Array<Overpayment>**](Overpayment.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Overpayments.new(overpayments: null)
-```
-
-

data/docs/accounting/Payment.md

@@ -1,63 +0,0 @@
-# XeroRuby::Accounting::Payment
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**invoice** | [**Invoice**](Invoice.md) |  | [optional] 
-**credit_note** | [**CreditNote**](CreditNote.md) |  | [optional] 
-**prepayment** | [**Prepayment**](Prepayment.md) |  | [optional] 
-**overpayment** | [**Overpayment**](Overpayment.md) |  | [optional] 
-**invoice_number** | **String** | Number of invoice or credit note you are applying payment to e.g.INV-4003 | [optional] 
-**credit_note_number** | **String** | Number of invoice or credit note you are applying payment to e.g. INV-4003 | [optional] 
-**account** | [**Account**](Account.md) |  | [optional] 
-**code** | **String** | Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value) | [optional] 
-**date** | **Date** | Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 | [optional] 
-**currency_rate** | **BigDecimal** | Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500 | [optional] 
-**amount** | **BigDecimal** | The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00 | [optional] 
-**reference** | **String** | An optional description for the payment e.g. Direct Debit | [optional] 
-**is_reconciled** | **Boolean** | An optional parameter for the payment. A boolean indicating whether you would like the payment to be created as reconciled when using PUT, or whether a payment has been reconciled when using GET | [optional] 
-**status** | **String** | The status of the payment. | [optional] 
-**payment_type** | **String** | See Payment Types. | [optional] 
-**updated_date_utc** | **DateTime** | UTC timestamp of last update to the payment | [optional] 
-**payment_id** | **String** | The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional] 
-**bank_account_number** | **String** | The suppliers bank account number the payment is being made to | [optional] 
-**particulars** | **String** | The suppliers bank account number the payment is being made to | [optional] 
-**details** | **String** | The information to appear on the supplier's bank account | [optional] 
-**has_account** | **Boolean** | A boolean to indicate if a contact has an validation errors | [optional] [default to false]
-**has_validation_errors** | **Boolean** | A boolean to indicate if a contact has an validation errors | [optional] [default to false]
-**status_attribute_string** | **String** | A string to indicate if a invoice status | [optional] 
-**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Payment.new(invoice: null,
-                                 credit_note: null,
-                                 prepayment: null,
-                                 overpayment: null,
-                                 invoice_number: null,
-                                 credit_note_number: null,
-                                 account: null,
-                                 code: null,
-                                 date: null,
-                                 currency_rate: null,
-                                 amount: null,
-                                 reference: null,
-                                 is_reconciled: null,
-                                 status: null,
-                                 payment_type: null,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 payment_id: null,
-                                 bank_account_number: null,
-                                 particulars: null,
-                                 details: null,
-                                 has_account: false,
-                                 has_validation_errors: false,
-                                 status_attribute_string: null,
-                                 validation_errors: null)
-```
-
-

data/docs/accounting/PaymentDelete.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::PaymentDelete
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | **String** | The status of the payment. | [default to 'DELETED']
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::PaymentDelete.new(status: null)
-```
-
-

data/docs/accounting/PaymentService.md

@@ -1,27 +0,0 @@
-# XeroRuby::Accounting::PaymentService
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payment_service_id** | **String** | Xero identifier | [optional] 
-**payment_service_name** | **String** | Name of payment service | [optional] 
-**payment_service_url** | **String** | The custom payment URL | [optional] 
-**pay_now_text** | **String** | The text displayed on the Pay Now button in Xero Online Invoicing. If this is not set it will default to Pay by credit card | [optional] 
-**payment_service_type** | **String** | This will always be CUSTOM for payment services created via the API. | [optional] 
-**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::PaymentService.new(payment_service_id: null,
-                                 payment_service_name: null,
-                                 payment_service_url: null,
-                                 pay_now_text: null,
-                                 payment_service_type: null,
-                                 validation_errors: null)
-```
-
-

data/docs/accounting/PaymentServices.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::PaymentServices
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payment_services** | [**Array<PaymentService>**](PaymentService.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::PaymentServices.new(payment_services: null)
-```
-
-

data/docs/accounting/PaymentTerm.md

@@ -1,19 +0,0 @@
-# XeroRuby::Accounting::PaymentTerm
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bills** | [**Bill**](Bill.md) |  | [optional] 
-**sales** | [**Bill**](Bill.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::PaymentTerm.new(bills: null,
-                                 sales: null)
-```
-
-

data/docs/accounting/PaymentTermType.md

@@ -1,16 +0,0 @@
-# XeroRuby::Accounting::PaymentTermType
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::PaymentTermType.new()
-```
-
-

data/docs/accounting/Payments.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::Payments
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payments** | [**Array<Payment>**](Payment.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Payments.new(payments: null)
-```
-
-

data/docs/accounting/Phone.md

@@ -1,23 +0,0 @@
-# XeroRuby::Accounting::Phone
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phone_type** | **String** |  | [optional] 
-**phone_number** | **String** | max length = 50 | [optional] 
-**phone_area_code** | **String** | max length = 10 | [optional] 
-**phone_country_code** | **String** | max length = 20 | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Phone.new(phone_type: null,
-                                 phone_number: null,
-                                 phone_area_code: null,
-                                 phone_country_code: null)
-```
-
-

data/docs/accounting/Prepayment.md

@@ -1,53 +0,0 @@
-# XeroRuby::Accounting::Prepayment
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **String** | See Prepayment Types | [optional] 
-**contact** | [**Contact**](Contact.md) |  | [optional] 
-**date** | **Date** | The date the prepayment is created YYYY-MM-DD | [optional] 
-**status** | **String** | See Prepayment Status Codes | [optional] 
-**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
-**line_items** | [**Array<LineItem>**](LineItem.md) | See Prepayment Line Items | [optional] 
-**sub_total** | **BigDecimal** | The subtotal of the prepayment excluding taxes | [optional] 
-**total_tax** | **BigDecimal** | The total tax on the prepayment | [optional] 
-**total** | **BigDecimal** | The total of the prepayment(subtotal + total tax) | [optional] 
-**reference** | **String** | Returns Invoice number field. Reference field isn't available. | [optional] 
-**updated_date_utc** | **DateTime** | UTC timestamp of last update to the prepayment | [optional] 
-**currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
-**prepayment_id** | **String** | Xero generated unique identifier | [optional] 
-**currency_rate** | **BigDecimal** | The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used | [optional] 
-**remaining_credit** | **BigDecimal** | The remaining credit balance on the prepayment | [optional] 
-**allocations** | [**Array<Allocation>**](Allocation.md) | See Allocations | [optional] 
-**applied_amount** | **Float** | The amount of applied to an invoice | [optional] 
-**has_attachments** | **Boolean** | boolean to indicate if a prepayment has an attachment | [optional] [default to false]
-**attachments** | [**Array<Attachment>**](Attachment.md) | See Attachments | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Prepayment.new(type: null,
-                                 contact: null,
-                                 date: null,
-                                 status: null,
-                                 line_amount_types: null,
-                                 line_items: null,
-                                 sub_total: null,
-                                 total_tax: null,
-                                 total: null,
-                                 reference: null,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 currency_code: null,
-                                 prepayment_id: null,
-                                 currency_rate: null,
-                                 remaining_credit: null,
-                                 allocations: null,
-                                 applied_amount: 2.0,
-                                 has_attachments: false,
-                                 attachments: null)
-```
-
-