xero-ruby 2.2.3 → 2.4.1

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/Invoice.md

@@ -1,93 +0,0 @@
-# XeroRuby::Accounting::Invoice
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **String** | See Invoice Types | [optional] 
-**contact** | [**Contact**](Contact.md) |  | [optional] 
-**line_items** | [**Array<LineItem>**](LineItem.md) | See LineItems | [optional] 
-**date** | **Date** | Date invoice was issued – YYYY-MM-DD. If the Date element is not specified 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] 
-**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
-**invoice_number** | **String** | ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255) | [optional] 
-**reference** | **String** | ACCREC only – additional reference number (max length = 255) | [optional] 
-**branding_theme_id** | **String** | See BrandingThemes | [optional] 
-**url** | **String** | URL link to a source document – shown as “Go to [appName]” in the Xero app | [optional] 
-**currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
-**currency_rate** | **BigDecimal** | The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6]) | [optional] 
-**status** | **String** | See Invoice Status Codes | [optional] 
-**sent_to_contact** | **Boolean** | Boolean to set whether the invoice in the Xero app should be marked as “sent”. This can be set only on invoices that have been approved | [optional] 
-**expected_payment_date** | **Date** | Shown on sales invoices (Accounts Receivable) when this has been set | [optional] 
-**planned_payment_date** | **Date** | Shown on bills (Accounts Payable) when this has been set | [optional] 
-**cis_deduction** | **BigDecimal** | CIS deduction for UK contractors | [optional] 
-**sub_total** | **BigDecimal** | Total of invoice excluding taxes | [optional] 
-**total_tax** | **BigDecimal** | Total tax on invoice | [optional] 
-**total** | **BigDecimal** | Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts | [optional] 
-**total_discount** | **BigDecimal** | Total of discounts applied on the invoice line items | [optional] 
-**invoice_id** | **String** | Xero generated unique identifier for invoice | [optional] 
-**repeating_invoice_id** | **String** | Xero generated unique identifier for repeating invoices | [optional] 
-**has_attachments** | **Boolean** | boolean to indicate if an invoice has an attachment | [optional] [default to false]
-**is_discounted** | **Boolean** | boolean to indicate if an invoice has a discount | [optional] 
-**payments** | [**Array<Payment>**](Payment.md) | See Payments | [optional] 
-**prepayments** | [**Array<Prepayment>**](Prepayment.md) | See Prepayments | [optional] 
-**overpayments** | [**Array<Overpayment>**](Overpayment.md) | See Overpayments | [optional] 
-**amount_due** | **BigDecimal** | Amount remaining to be paid on invoice | [optional] 
-**amount_paid** | **BigDecimal** | Sum of payments received for invoice | [optional] 
-**fully_paid_on_date** | **Date** | The date the invoice was fully paid. Only returned on fully paid invoices | [optional] 
-**amount_credited** | **BigDecimal** | Sum of all credit notes, over-payments and pre-payments applied to invoice | [optional] 
-**updated_date_utc** | **DateTime** | Last modified date UTC format | [optional] 
-**credit_notes** | [**Array<CreditNote>**](CreditNote.md) | Details of credit notes that have been applied to an invoice | [optional] 
-**attachments** | [**Array<Attachment>**](Attachment.md) | Displays array of attachments from the API | [optional] 
-**has_errors** | **Boolean** | A boolean to indicate if a invoice 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] 
-**warnings** | [**Array<ValidationError>**](ValidationError.md) | Displays array of warning messages from the API | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Invoice.new(type: null,
-                                 contact: null,
-                                 line_items: null,
-                                 date: null,
-                                 due_date: null,
-                                 line_amount_types: null,
-                                 invoice_number: null,
-                                 reference: null,
-                                 branding_theme_id: null,
-                                 url: null,
-                                 currency_code: null,
-                                 currency_rate: null,
-                                 status: null,
-                                 sent_to_contact: null,
-                                 expected_payment_date: null,
-                                 planned_payment_date: null,
-                                 cis_deduction: null,
-                                 sub_total: null,
-                                 total_tax: null,
-                                 total: null,
-                                 total_discount: null,
-                                 invoice_id: null,
-                                 repeating_invoice_id: null,
-                                 has_attachments: false,
-                                 is_discounted: null,
-                                 payments: null,
-                                 prepayments: null,
-                                 overpayments: null,
-                                 amount_due: null,
-                                 amount_paid: null,
-                                 fully_paid_on_date: null,
-                                 amount_credited: null,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 credit_notes: null,
-                                 attachments: null,
-                                 has_errors: false,
-                                 status_attribute_string: null,
-                                 validation_errors: null,
-                                 warnings: null)
-```
-
-

data/docs/accounting/InvoiceReminder.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::InvoiceReminder
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**enabled** | **Boolean** | setting for on or off | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::InvoiceReminder.new(enabled: null)
-```
-
-

data/docs/accounting/InvoiceReminders.md

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

data/docs/accounting/Invoices.md

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

data/docs/accounting/Item.md

@@ -1,47 +0,0 @@
-# XeroRuby::Accounting::Item
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **String** | User defined item code (max length = 30) | 
-**inventory_asset_account_code** | **String** | The inventory asset account for the item. The account must be of type INVENTORY. The  COGSAccountCode in PurchaseDetails is also required to create a tracked item | [optional] 
-**name** | **String** | The name of the item (max length = 50) | [optional] 
-**is_sold** | **Boolean** | Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled. | [optional] 
-**is_purchased** | **Boolean** | Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled. | [optional] 
-**description** | **String** | The sales description of the item (max length = 4000) | [optional] 
-**purchase_description** | **String** | The purchase description of the item (max length = 4000) | [optional] 
-**purchase_details** | [**Purchase**](Purchase.md) |  | [optional] 
-**sales_details** | [**Purchase**](Purchase.md) |  | [optional] 
-**is_tracked_as_inventory** | **Boolean** | True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set. | [optional] 
-**total_cost_pool** | **BigDecimal** | The value of the item on hand. Calculated using average cost accounting. | [optional] 
-**quantity_on_hand** | **BigDecimal** | The quantity of the item on hand | [optional] 
-**updated_date_utc** | **DateTime** | Last modified date in UTC format | [optional] 
-**item_id** | **String** | The Xero identifier for an Item | [optional] 
-**status_attribute_string** | **String** | Status of object | [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::Item.new(code: null,
-                                 inventory_asset_account_code: null,
-                                 name: null,
-                                 is_sold: null,
-                                 is_purchased: null,
-                                 description: null,
-                                 purchase_description: null,
-                                 purchase_details: null,
-                                 sales_details: null,
-                                 is_tracked_as_inventory: null,
-                                 total_cost_pool: null,
-                                 quantity_on_hand: null,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 item_id: null,
-                                 status_attribute_string: null,
-                                 validation_errors: null)
-```
-
-

data/docs/accounting/Items.md

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