xero-ruby 2.5.0 → 2.7.0

data/docs/accounting/CountryCode.md

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

data/docs/accounting/CreditNote.md

@@ -1,73 +0,0 @@
-# XeroRuby::Accounting::CreditNote
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **String** | See Credit Note Types | [optional] 
-**contact** | [**Contact**](Contact.md) |  | [optional] 
-**date** | **Date** | The date the credit note is issued YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation | [optional] 
-**due_date** | **Date** | Date invoice is due – YYYY-MM-DD | [optional] 
-**status** | **String** | See Credit Note Status Codes | [optional] 
-**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
-**line_items** | [**Array<LineItem>**](LineItem.md) | See Invoice Line Items | [optional] 
-**sub_total** | **BigDecimal** | The subtotal of the credit note excluding taxes | [optional] 
-**total_tax** | **BigDecimal** | The total tax on the credit note | [optional] 
-**total** | **BigDecimal** | The total of the Credit Note(subtotal + total tax) | [optional] 
-**cis_deduction** | **BigDecimal** | CIS deduction for UK contractors | [optional] 
-**cis_rate** | **BigDecimal** | CIS Deduction rate for the organisation | [optional] 
-**updated_date_utc** | **DateTime** | UTC timestamp of last update to the credit note | [optional] 
-**currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
-**fully_paid_on_date** | **Date** | Date when credit note was fully paid(UTC format) | [optional] 
-**credit_note_id** | **String** | Xero generated unique identifier | [optional] 
-**credit_note_number** | **String** | ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings) | [optional] 
-**reference** | **String** | ACCRECCREDIT only – additional reference number | [optional] 
-**sent_to_contact** | **Boolean** | boolean to indicate if a credit note has been sent to a contact via  the Xero app (currently read only) | [optional] 
-**currency_rate** | **BigDecimal** | The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used | [optional] 
-**remaining_credit** | **BigDecimal** | The remaining credit balance on the Credit Note | [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] 
-**branding_theme_id** | **String** | See BrandingThemes | [optional] 
-**status_attribute_string** | **String** | A string to indicate if a invoice status | [optional] 
-**has_attachments** | **Boolean** | boolean to indicate if a credit note has an attachment | [optional] [default to false]
-**has_errors** | **Boolean** | A boolean to indicate if a credit note has an validation errors | [optional] [default to false]
-**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::CreditNote.new(type: null,
-                                 contact: null,
-                                 date: null,
-                                 due_date: null,
-                                 status: null,
-                                 line_amount_types: null,
-                                 line_items: null,
-                                 sub_total: null,
-                                 total_tax: null,
-                                 total: null,
-                                 cis_deduction: null,
-                                 cis_rate: null,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 currency_code: null,
-                                 fully_paid_on_date: null,
-                                 credit_note_id: null,
-                                 credit_note_number: null,
-                                 reference: null,
-                                 sent_to_contact: null,
-                                 currency_rate: null,
-                                 remaining_credit: null,
-                                 allocations: null,
-                                 applied_amount: 2.0,
-                                 payments: null,
-                                 branding_theme_id: null,
-                                 status_attribute_string: null,
-                                 has_attachments: false,
-                                 has_errors: false,
-                                 validation_errors: null)
-```
-
-

data/docs/accounting/CreditNotes.md

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

data/docs/accounting/Currencies.md

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

data/docs/accounting/Currency.md

@@ -1,19 +0,0 @@
-# XeroRuby::Accounting::Currency
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
-**description** | **String** | Name of Currency | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Currency.new(code: null,
-                                 description: null)
-```
-
-

data/docs/accounting/CurrencyCode.md

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

data/docs/accounting/Element.md

@@ -1,31 +0,0 @@
-# XeroRuby::Accounting::Element
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Array of Validation Error message | [optional] 
-**batch_payment_id** | **String** | Unique ID for batch payment object with validation error | [optional] 
-**bank_transaction_id** | **String** |  | [optional] 
-**credit_note_id** | **String** |  | [optional] 
-**contact_id** | **String** |  | [optional] 
-**invoice_id** | **String** |  | [optional] 
-**item_id** | **String** |  | [optional] 
-**purchase_order_id** | **String** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Element.new(validation_errors: null,
-                                 batch_payment_id: null,
-                                 bank_transaction_id: null,
-                                 credit_note_id: null,
-                                 contact_id: null,
-                                 invoice_id: null,
-                                 item_id: null,
-                                 purchase_order_id: null)
-```
-
-

data/docs/accounting/Employee.md

@@ -1,31 +0,0 @@
-# XeroRuby::Accounting::Employee
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**employee_id** | **String** | The Xero identifier for an employee e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional] 
-**status** | **String** | Current status of an employee – see contact status types | [optional] 
-**first_name** | **String** | First name of an employee (max length = 255) | [optional] 
-**last_name** | **String** | Last name of an employee (max length = 255) | [optional] 
-**external_link** | [**ExternalLink**](ExternalLink.md) |  | [optional] 
-**updated_date_utc** | **DateTime** |  | [optional] 
-**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::Employee.new(employee_id: null,
-                                 status: null,
-                                 first_name: null,
-                                 last_name: null,
-                                 external_link: null,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 status_attribute_string: ERROR,
-                                 validation_errors: null)
-```
-
-

data/docs/accounting/Employees.md

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

data/docs/accounting/Error.md

@@ -1,23 +0,0 @@
-# XeroRuby::Accounting::Error
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**error_number** | **Integer** | Exception number | [optional] 
-**type** | **String** | Exception type | [optional] 
-**message** | **String** | Exception message | [optional] 
-**elements** | [**Array<Element>**](Element.md) | Array of Elements of validation Errors | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Error.new(error_number: null,
-                                 type: null,
-                                 message: null,
-                                 elements: null)
-```
-
-

data/docs/accounting/ExpenseClaim.md

@@ -1,39 +0,0 @@
-# XeroRuby::Accounting::ExpenseClaim
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**expense_claim_id** | **String** | Xero generated unique identifier for an expense claim | [optional] 
-**status** | **String** | Current status of an expense claim – see status types | [optional] 
-**payments** | [**Array<Payment>**](Payment.md) | See Payments | [optional] 
-**user** | [**User**](User.md) |  | [optional] 
-**receipts** | [**Array<Receipt>**](Receipt.md) |  | [optional] 
-**updated_date_utc** | **DateTime** | Last modified date UTC format | [optional] 
-**total** | **BigDecimal** | The total of an expense claim being paid | [optional] 
-**amount_due** | **BigDecimal** | The amount due to be paid for an expense claim | [optional] 
-**amount_paid** | **BigDecimal** | The amount still to pay for an expense claim | [optional] 
-**payment_due_date** | **Date** | The date when the expense claim is due to be paid YYYY-MM-DD | [optional] 
-**reporting_date** | **Date** | The date the expense claim will be reported in Xero YYYY-MM-DD | [optional] 
-**receipt_id** | **String** | The Xero identifier for the Receipt e.g. e59a2c7f-1306-4078-a0f3-73537afcbba9 | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::ExpenseClaim.new(expense_claim_id: null,
-                                 status: null,
-                                 payments: null,
-                                 user: null,
-                                 receipts: null,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 total: null,
-                                 amount_due: null,
-                                 amount_paid: null,
-                                 payment_due_date: null,
-                                 reporting_date: null,
-                                 receipt_id: null)
-```
-
-

data/docs/accounting/ExpenseClaims.md

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

data/docs/accounting/ExternalLink.md

@@ -1,21 +0,0 @@
-# XeroRuby::Accounting::ExternalLink
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**link_type** | **String** | See External link types | [optional] 
-**url** | **String** | URL for service e.g. http://twitter.com/xeroapi | [optional] 
-**description** | **String** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::ExternalLink.new(link_type: null,
-                                 url: null,
-                                 description: null)
-```
-
-

data/docs/accounting/HistoryRecord.md

@@ -1,23 +0,0 @@
-# XeroRuby::Accounting::HistoryRecord
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**details** | **String** | details | [optional] 
-**changes** | **String** | Name of branding theme | [optional] 
-**user** | **String** | has a value of 0 | [optional] 
-**date_utc** | **DateTime** | UTC timestamp of creation date of branding theme | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::HistoryRecord.new(details: null,
-                                 changes: null,
-                                 user: null,
-                                 date_utc: /Date(1573755038314)/)
-```
-
-

data/docs/accounting/HistoryRecords.md

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

data/docs/accounting/ImportSummary.md

@@ -1,19 +0,0 @@
-# XeroRuby::Accounting::ImportSummary
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accounts** | [**ImportSummaryAccounts**](ImportSummaryAccounts.md) |  | [optional] 
-**organisation** | [**ImportSummaryOrganisation**](ImportSummaryOrganisation.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::ImportSummary.new(accounts: null,
-                                 organisation: null)
-```
-
-

data/docs/accounting/ImportSummaryAccounts.md

@@ -1,33 +0,0 @@
-# XeroRuby::Accounting::ImportSummaryAccounts
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**total** | **Float** | The total number of accounts in the org | [optional] 
-**new** | **Float** | The number of new accounts created | [optional] 
-**updated** | **Float** | The number of accounts updated | [optional] 
-**deleted** | **Float** | The number of accounts deleted | [optional] 
-**locked** | **Float** | The number of locked accounts | [optional] 
-**system** | **Float** | The number of system accounts | [optional] 
-**errored** | **Float** | The number of accounts that had an error | [optional] 
-**present** | **Boolean** |  | [optional] 
-**new_or_updated** | **Float** | The number of new or updated accounts | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::ImportSummaryAccounts.new(total: null,
-                                 new: null,
-                                 updated: null,
-                                 deleted: null,
-                                 locked: null,
-                                 system: null,
-                                 errored: null,
-                                 present: null,
-                                 new_or_updated: null)
-```
-
-