xero-ruby 2.5.0 → 2.7.0

data/docs/accounting/Accounts.md

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

data/docs/accounting/AccountsPayable.md

@@ -1,19 +0,0 @@
-# XeroRuby::Accounting::AccountsPayable
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**outstanding** | **BigDecimal** |  | [optional] 
-**overdue** | **BigDecimal** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::AccountsPayable.new(outstanding: null,
-                                 overdue: null)
-```
-
-

data/docs/accounting/AccountsReceivable.md

@@ -1,19 +0,0 @@
-# XeroRuby::Accounting::AccountsReceivable
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**outstanding** | **BigDecimal** |  | [optional] 
-**overdue** | **BigDecimal** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::AccountsReceivable.new(outstanding: null,
-                                 overdue: null)
-```
-
-

data/docs/accounting/Action.md

@@ -1,19 +0,0 @@
-# XeroRuby::Accounting::Action
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | Name of the actions for this organisation | [optional] 
-**status** | **String** | Status of the action for this organisation | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Action.new(name: UseMulticurrency,
-                                 status: null)
-```
-
-

data/docs/accounting/Actions.md

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

data/docs/accounting/Address.md

@@ -1,35 +0,0 @@
-# XeroRuby::Accounting::Address
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**address_type** | **String** | define the type of address | [optional] 
-**address_line1** | **String** | max length = 500 | [optional] 
-**address_line2** | **String** | max length = 500 | [optional] 
-**address_line3** | **String** | max length = 500 | [optional] 
-**address_line4** | **String** | max length = 500 | [optional] 
-**city** | **String** | max length = 255 | [optional] 
-**region** | **String** | max length = 255 | [optional] 
-**postal_code** | **String** | max length = 50 | [optional] 
-**country** | **String** | max length = 50, [A-Z], [a-z] only | [optional] 
-**attention_to** | **String** | max length = 255 | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Address.new(address_type: null,
-                                 address_line1: null,
-                                 address_line2: null,
-                                 address_line3: null,
-                                 address_line4: null,
-                                 city: null,
-                                 region: null,
-                                 postal_code: null,
-                                 country: null,
-                                 attention_to: null)
-```
-
-

data/docs/accounting/AddressForOrganisation.md

@@ -1,35 +0,0 @@
-# XeroRuby::Accounting::AddressForOrganisation
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**address_type** | **String** | define the type of address | [optional] 
-**address_line1** | **String** | max length = 500 | [optional] 
-**address_line2** | **String** | max length = 500 | [optional] 
-**address_line3** | **String** | max length = 500 | [optional] 
-**address_line4** | **String** | max length = 500 | [optional] 
-**city** | **String** | max length = 255 | [optional] 
-**region** | **String** | max length = 255 | [optional] 
-**postal_code** | **String** | max length = 50 | [optional] 
-**country** | **String** | max length = 50, [A-Z], [a-z] only | [optional] 
-**attention_to** | **String** | max length = 255 | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::AddressForOrganisation.new(address_type: null,
-                                 address_line1: null,
-                                 address_line2: null,
-                                 address_line3: null,
-                                 address_line4: null,
-                                 city: null,
-                                 region: null,
-                                 postal_code: null,
-                                 country: null,
-                                 attention_to: null)
-```
-
-

data/docs/accounting/Allocation.md

@@ -1,31 +0,0 @@
-# XeroRuby::Accounting::Allocation
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**invoice** | [**Invoice**](Invoice.md) |  | 
-**overpayment** | [**Overpayment**](Overpayment.md) |  | [optional] 
-**prepayment** | [**Prepayment**](Prepayment.md) |  | [optional] 
-**credit_note** | [**CreditNote**](CreditNote.md) |  | [optional] 
-**amount** | **BigDecimal** | the amount being applied to the invoice | 
-**date** | **Date** | the date the allocation is applied YYYY-MM-DD. | 
-**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::Allocation.new(invoice: null,
-                                 overpayment: null,
-                                 prepayment: null,
-                                 credit_note: null,
-                                 amount: null,
-                                 date: null,
-                                 status_attribute_string: null,
-                                 validation_errors: null)
-```
-
-

data/docs/accounting/Allocations.md

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

data/docs/accounting/Attachment.md

@@ -1,27 +0,0 @@
-# XeroRuby::Accounting::Attachment
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**attachment_id** | **String** | Unique ID for the file | [optional] 
-**file_name** | **String** | Name of the file | [optional] 
-**url** | **String** | URL to the file on xero.com | [optional] 
-**mime_type** | **String** | Type of file | [optional] 
-**content_length** | **Integer** | Length of the file content | [optional] 
-**include_online** | **Boolean** | Include the file with the online invoice | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Attachment.new(attachment_id: 00000000-0000-0000-0000-000000000000,
-                                 file_name: xero-dev.jpg,
-                                 url: https://api.xero.com/api.xro/2.0/Accounts/da962997-a8bd-4dff-9616-01cdc199283f/Attachments/sample5.jpg,
-                                 mime_type: image/jpg,
-                                 content_length: null,
-                                 include_online: null)
-```
-
-

data/docs/accounting/Attachments.md

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

data/docs/accounting/BalanceDetails.md

@@ -1,21 +0,0 @@
-# XeroRuby::Accounting::BalanceDetails
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**balance** | **Float** | The opening balances of the account. Debits are positive, credits are negative values | [optional] 
-**currency_code** | **String** | The currency of the balance (Not required for base currency) | [optional] 
-**currency_rate** | **BigDecimal** | (Optional) Exchange rate to base currency when money is spent or received. If not specified, XE rate for the day is applied | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::BalanceDetails.new(balance: null,
-                                 currency_code: null,
-                                 currency_rate: null)
-```
-
-

data/docs/accounting/Balances.md

@@ -1,19 +0,0 @@
-# XeroRuby::Accounting::Balances
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accounts_receivable** | [**AccountsReceivable**](AccountsReceivable.md) |  | [optional] 
-**accounts_payable** | [**AccountsPayable**](AccountsPayable.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Balances.new(accounts_receivable: null,
-                                 accounts_payable: null)
-```
-
-

data/docs/accounting/BankTransaction.md

@@ -1,59 +0,0 @@
-# XeroRuby::Accounting::BankTransaction
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **String** | See Bank Transaction Types | 
-**contact** | [**Contact**](Contact.md) |  | [optional] 
-**line_items** | [**Array<LineItem>**](LineItem.md) | See LineItems | 
-**bank_account** | [**Account**](Account.md) |  | 
-**is_reconciled** | **Boolean** | Boolean to show if transaction is reconciled | [optional] 
-**date** | **Date** | Date of transaction – YYYY-MM-DD | [optional] 
-**reference** | **String** | Reference for the transaction. Only supported for SPEND and RECEIVE transactions. | [optional] 
-**currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
-**currency_rate** | **BigDecimal** | Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments. | [optional] 
-**url** | **String** | URL link to a source document – shown as “Go to App Name” | [optional] 
-**status** | **String** | See Bank Transaction Status Codes | [optional] 
-**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
-**sub_total** | **BigDecimal** | Total of bank transaction excluding taxes | [optional] 
-**total_tax** | **BigDecimal** | Total tax on bank transaction | [optional] 
-**total** | **BigDecimal** | Total of bank transaction tax inclusive | [optional] 
-**bank_transaction_id** | **String** | Xero generated unique identifier for bank transaction | [optional] 
-**prepayment_id** | **String** | Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT | [optional] 
-**overpayment_id** | **String** | Xero generated unique identifier for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT | [optional] 
-**updated_date_utc** | **DateTime** | Last modified date UTC format | [optional] 
-**has_attachments** | **Boolean** | Boolean to indicate if a bank transaction has an attachment | [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::BankTransaction.new(type: null,
-                                 contact: null,
-                                 line_items: null,
-                                 bank_account: null,
-                                 is_reconciled: null,
-                                 date: null,
-                                 reference: null,
-                                 currency_code: null,
-                                 currency_rate: null,
-                                 url: null,
-                                 status: null,
-                                 line_amount_types: null,
-                                 sub_total: null,
-                                 total_tax: null,
-                                 total: null,
-                                 bank_transaction_id: 00000000-0000-0000-0000-000000000000,
-                                 prepayment_id: 00000000-0000-0000-0000-000000000000,
-                                 overpayment_id: 00000000-0000-0000-0000-000000000000,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 has_attachments: false,
-                                 status_attribute_string: null,
-                                 validation_errors: null)
-```
-
-

data/docs/accounting/BankTransactions.md

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

data/docs/accounting/BankTransfer.md

@@ -1,37 +0,0 @@
-# XeroRuby::Accounting::BankTransfer
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**from_bank_account** | [**Account**](Account.md) |  | 
-**to_bank_account** | [**Account**](Account.md) |  | 
-**amount** | **BigDecimal** | amount of the transaction | 
-**date** | **Date** | The date of the Transfer YYYY-MM-DD | [optional] 
-**bank_transfer_id** | **String** | The identifier of the Bank Transfer | [optional] 
-**currency_rate** | **BigDecimal** | The currency rate | [optional] 
-**from_bank_transaction_id** | **String** | The Bank Transaction ID for the source account | [optional] 
-**to_bank_transaction_id** | **String** | The Bank Transaction ID for the destination account | [optional] 
-**has_attachments** | **Boolean** | Boolean to indicate if a Bank Transfer has an attachment | [optional] [default to false]
-**created_date_utc** | **DateTime** | UTC timestamp of creation date of bank transfer | [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::BankTransfer.new(from_bank_account: null,
-                                 to_bank_account: null,
-                                 amount: null,
-                                 date: null,
-                                 bank_transfer_id: null,
-                                 currency_rate: null,
-                                 from_bank_transaction_id: null,
-                                 to_bank_transaction_id: null,
-                                 has_attachments: false,
-                                 created_date_utc: /Date(1573755038314)/,
-                                 validation_errors: null)
-```
-
-

data/docs/accounting/BankTransfers.md

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