xero-ruby 2.2.3 → 2.4.1

data/docs/accounting/Journal.md

@@ -1,31 +0,0 @@
-# XeroRuby::Accounting::Journal
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**journal_id** | **String** | Xero identifier | [optional] 
-**journal_date** | **Date** | Date the journal was posted | [optional] 
-**journal_number** | **Integer** | Xero generated journal number | [optional] 
-**created_date_utc** | **DateTime** | Created date UTC format | [optional] 
-**reference** | **String** | reference field for additional indetifying information | [optional] 
-**source_id** | **String** | The identifier for the source transaction (e.g. InvoiceID) | [optional] 
-**source_type** | **String** | The journal source type. The type of transaction that created the journal | [optional] 
-**journal_lines** | [**Array<JournalLine>**](JournalLine.md) | See JournalLines | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Journal.new(journal_id: null,
-                                 journal_date: null,
-                                 journal_number: null,
-                                 created_date_utc: /Date(1573755038314)/,
-                                 reference: null,
-                                 source_id: null,
-                                 source_type: null,
-                                 journal_lines: null)
-```
-
-

data/docs/accounting/JournalLine.md

@@ -1,39 +0,0 @@
-# XeroRuby::Accounting::JournalLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**journal_line_id** | **String** | Xero identifier for Journal | [optional] 
-**account_id** | **String** | See Accounts | [optional] 
-**account_code** | **String** | See Accounts | [optional] 
-**account_type** | [**AccountType**](AccountType.md) |  | [optional] 
-**account_name** | **String** | See AccountCodes | [optional] 
-**description** | **String** | The description from the source transaction line item. Only returned if populated. | [optional] 
-**net_amount** | **BigDecimal** | Net amount of journal line. This will be a positive value for a debit and negative for a credit | [optional] 
-**gross_amount** | **BigDecimal** | Gross amount of journal line (NetAmount + TaxAmount). | [optional] 
-**tax_amount** | **BigDecimal** | Total tax on a journal line | [optional] 
-**tax_type** | **String** | The tax type from TaxRates | [optional] 
-**tax_name** | **String** | see TaxRates | [optional] 
-**tracking_categories** | [**Array<TrackingCategory>**](TrackingCategory.md) | Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::JournalLine.new(journal_line_id: 7be9db36-3598-4755-ba5c-c2dbc8c4a7a2,
-                                 account_id: ceef66a5-a545-413b-9312-78a53caadbc4,
-                                 account_code: 90.0,
-                                 account_type: null,
-                                 account_name: Checking Account,
-                                 description: My business checking account,
-                                 net_amount: 4130.98,
-                                 gross_amount: 4130.98,
-                                 tax_amount: 0.0,
-                                 tax_type: null,
-                                 tax_name: Tax Exempt,
-                                 tracking_categories: null)
-```
-
-

data/docs/accounting/Journals.md

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

data/docs/accounting/LineAmountTypes.md

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

data/docs/accounting/LineItem.md

@@ -1,41 +0,0 @@
-# XeroRuby::Accounting::LineItem
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**line_item_id** | **String** | LineItem unique ID | [optional] 
-**description** | **String** | Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character | [optional] 
-**quantity** | **BigDecimal** | LineItem Quantity | [optional] 
-**unit_amount** | **BigDecimal** | LineItem Unit Amount | [optional] 
-**item_code** | **String** | See Items | [optional] 
-**account_code** | **String** | See Accounts | [optional] 
-**tax_type** | **String** | The tax type from TaxRates | [optional] 
-**tax_amount** | **BigDecimal** | The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct. | [optional] 
-**line_amount** | **BigDecimal** | If you wish to omit either of the <Quantity> or <UnitAmount> you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100) | [optional] 
-**tracking** | [**Array<LineItemTracking>**](LineItemTracking.md) | Optional Tracking Category – see Tracking.  Any LineItem can have a  maximum of 2 <TrackingCategory> elements. | [optional] 
-**discount_rate** | **BigDecimal** | Percentage discount being applied to a line item (only supported on  ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts | [optional] 
-**discount_amount** | **BigDecimal** | Discount amount being applied to a line item. Only supported on ACCREC invoices - ACCPAY invoices and credit notes in Xero do not support discounts. | [optional] 
-**repeating_invoice_id** | **String** | The Xero identifier for a Repeating Invoice | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::LineItem.new(line_item_id: 00000000-0000-0000-0000-000000000000,
-                                 description: null,
-                                 quantity: null,
-                                 unit_amount: null,
-                                 item_code: null,
-                                 account_code: null,
-                                 tax_type: null,
-                                 tax_amount: null,
-                                 line_amount: null,
-                                 tracking: null,
-                                 discount_rate: null,
-                                 discount_amount: null,
-                                 repeating_invoice_id: 00000000-0000-0000-0000-000000000000)
-```
-
-

data/docs/accounting/LineItemTracking.md

@@ -1,23 +0,0 @@
-# XeroRuby::Accounting::LineItemTracking
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**tracking_category_id** | **String** | The Xero identifier for a tracking category | [optional] 
-**tracking_option_id** | **String** | The Xero identifier for a tracking category option | [optional] 
-**name** | **String** | The name of the tracking category | [optional] 
-**option** | **String** | See Tracking Options | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::LineItemTracking.new(tracking_category_id: 00000000-0000-0000-0000-000000000000,
-                                 tracking_option_id: 00000000-0000-0000-0000-000000000000,
-                                 name: Region,
-                                 option: North)
-```
-
-

data/docs/accounting/LinkedTransaction.md

@@ -1,37 +0,0 @@
-# XeroRuby::Accounting::LinkedTransaction
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**source_transaction_id** | **String** | Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice | [optional] 
-**source_line_item_id** | **String** | The line item identifier from the source transaction. | [optional] 
-**contact_id** | **String** | Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED. | [optional] 
-**target_transaction_id** | **String** | Filter by the TargetTransactionID. Get all the linked transactions  allocated to a particular ACCREC invoice | [optional] 
-**target_line_item_id** | **String** | The line item identifier from the target transaction. It is possible  to link multiple billable expenses to the same TargetLineItemID. | [optional] 
-**linked_transaction_id** | **String** | The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional] 
-**status** | **String** | Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED. | [optional] 
-**type** | **String** | This will always be BILLABLEEXPENSE. More types may be added in future. | [optional] 
-**updated_date_utc** | **DateTime** | The last modified date in UTC format | [optional] 
-**source_transaction_type_code** | **String** | The Type of the source tranasction. This will be ACCPAY if the linked transaction was created from an invoice and SPEND if it was created from a bank transaction. | [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::LinkedTransaction.new(source_transaction_id: null,
-                                 source_line_item_id: null,
-                                 contact_id: null,
-                                 target_transaction_id: null,
-                                 target_line_item_id: null,
-                                 linked_transaction_id: null,
-                                 status: null,
-                                 type: null,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 source_transaction_type_code: null,
-                                 validation_errors: null)
-```
-
-

data/docs/accounting/LinkedTransactions.md

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

data/docs/accounting/ManualJournal.md

@@ -1,43 +0,0 @@
-# XeroRuby::Accounting::ManualJournal
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**narration** | **String** | Description of journal being posted | 
-**journal_lines** | [**Array<ManualJournalLine>**](ManualJournalLine.md) | See JournalLines | [optional] 
-**date** | **Date** | Date journal was posted – YYYY-MM-DD | [optional] 
-**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
-**status** | **String** | See Manual Journal Status Codes | [optional] 
-**url** | **String** | Url link to a source document – shown as “Go to [appName]” in the Xero app | [optional] 
-**show_on_cash_basis_reports** | **Boolean** | Boolean – default is true if not specified | [optional] 
-**has_attachments** | **Boolean** | Boolean to indicate if a manual journal has an attachment | [optional] [default to false]
-**updated_date_utc** | **DateTime** | Last modified date UTC format | [optional] 
-**manual_journal_id** | **String** | The Xero identifier for a Manual Journal | [optional] 
-**status_attribute_string** | **String** | A string to indicate if a invoice status | [optional] 
-**warnings** | [**Array<ValidationError>**](ValidationError.md) | Displays array of warning messages from the API | [optional] 
-**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional] 
-**attachments** | [**Array<Attachment>**](Attachment.md) | Displays array of attachments from the API | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::ManualJournal.new(narration: null,
-                                 journal_lines: null,
-                                 date: null,
-                                 line_amount_types: null,
-                                 status: null,
-                                 url: null,
-                                 show_on_cash_basis_reports: null,
-                                 has_attachments: false,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 manual_journal_id: null,
-                                 status_attribute_string: ERROR,
-                                 warnings: null,
-                                 validation_errors: null,
-                                 attachments: null)
-```
-
-

data/docs/accounting/ManualJournalLine.md

@@ -1,31 +0,0 @@
-# XeroRuby::Accounting::ManualJournalLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**line_amount** | **BigDecimal** | total for line. Debits are positive, credits are negative value | [optional] 
-**account_code** | **String** | See Accounts | [optional] 
-**account_id** | **String** | See Accounts | [optional] 
-**description** | **String** | Description for journal line | [optional] 
-**tax_type** | **String** | The tax type from TaxRates | [optional] 
-**tracking** | [**Array<TrackingCategory>**](TrackingCategory.md) | Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements. | [optional] 
-**tax_amount** | **BigDecimal** | The calculated tax amount based on the TaxType and LineAmount | [optional] 
-**is_blank** | **Boolean** | is the line blank | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::ManualJournalLine.new(line_amount: -2569.0,
-                                 account_code: 720,
-                                 account_id: null,
-                                 description: Coded incorrectly Office Equipment should be Computer Equipment,
-                                 tax_type: null,
-                                 tracking: null,
-                                 tax_amount: 0.0,
-                                 is_blank: false)
-```
-
-

data/docs/accounting/ManualJournals.md

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

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)
-```
-
-