xero-ruby 0.1.1

data/docs/Journals.md

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

data/docs/LineAmountTypes.md

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

data/docs/LineItem.md

@@ -0,0 +1,41 @@
+# XeroRuby::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** | **Float** | LineItem Quantity | [optional] 
+**unit_amount** | **Float** | 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** | **Float** | 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** | **Float** | 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** | **String** | 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** | **Float** | 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 Invoicee.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby'
+
+instance = XeroRuby::LineItem.new(line_item_id: null,
+                                 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: null)
+```
+
+

data/docs/LineItemTracking.md

@@ -0,0 +1,21 @@
+# XeroRuby::LineItemTracking
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tracking_category_id** | **String** | The Xero identifier for a tracking category | [optional] 
+**name** | **String** | The name of the tracking category | [optional] 
+**option** | **String** | See Tracking Options | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby'
+
+instance = XeroRuby::LineItemTracking.new(tracking_category_id: 297c2dc5-cc47-4afd-8ec8-74990b8761e9,
+                                 name: Region,
+                                 option: North)
+```
+
+

data/docs/LinkedTransaction.md

@@ -0,0 +1,37 @@
+# XeroRuby::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. | 
+**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'
+
+instance = XeroRuby::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: null,
+                                 source_transaction_type_code: null,
+                                 validation_errors: null)
+```
+
+

data/docs/LinkedTransactions.md

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

data/docs/ManualJournal.md

@@ -0,0 +1,41 @@
+# XeroRuby::ManualJournal
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**narration** | **String** | Description of journal being posted | 
+**journal_lines** | [**Array<ManualJournalLine>**](ManualJournalLine.md) | See JournalLines | 
+**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] 
+**updated_date_utc** | **DateTime** | Last modified date UTC format | [optional] 
+**manual_journal_id** | **String** | The Xero identifier for a Manual Journal | [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'
+
+instance = XeroRuby::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: null,
+                                 updated_date_utc: null,
+                                 manual_journal_id: null,
+                                 warnings: null,
+                                 validation_errors: null,
+                                 attachments: null)
+```
+
+

data/docs/ManualJournalLine.md

@@ -0,0 +1,29 @@
+# XeroRuby::ManualJournalLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**line_amount** | **Float** | total for line. Debits are positive, credits are negative value | [optional] 
+**account_code** | **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** | **Float** | The calculated tax amount based on the TaxType and LineAmount | [optional] 
+**is_blank** | **Boolean** | is the line blank | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby'
+
+instance = XeroRuby::ManualJournalLine.new(line_amount: -2569.0,
+                                 account_code: 720,
+                                 description: Coded incorrectly Office Equipment should be Computer Equipment,
+                                 tax_type: null,
+                                 tracking: null,
+                                 tax_amount: 0.0,
+                                 is_blank: false)
+```
+
+

data/docs/ManualJournals.md

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

data/docs/OnlineInvoice.md

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

data/docs/OnlineInvoices.md

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

data/docs/Organisation.md

@@ -0,0 +1,79 @@
+# XeroRuby::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] 
+**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 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'
+
+instance = XeroRuby::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,
+                                 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: null,
+                                 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/Organisations.md

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

data/docs/Overpayment.md

@@ -0,0 +1,51 @@
+# XeroRuby::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** | **Float** | The subtotal of the overpayment excluding taxes | [optional] 
+**total_tax** | **Float** | The total tax on the overpayment | [optional] 
+**total** | **Float** | 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** | **Float** | The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used | [optional] 
+**remaining_credit** | **Float** | The remaining credit balance on the overpayment | [optional] 
+**allocations** | [**Array<Allocation>**](Allocation.md) | See Allocations | [optional] 
+**payments** | [**Array<Payment>**](Payment.md) | See Payments | [optional] 
+**has_attachments** | **Boolean** | boolean to indicate if a overpayment has an attachment | [optional] 
+**attachments** | [**Array<Attachment>**](Attachment.md) | See Attachments | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby'
+
+instance = XeroRuby::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: null,
+                                 currency_code: null,
+                                 overpayment_id: null,
+                                 currency_rate: null,
+                                 remaining_credit: null,
+                                 allocations: null,
+                                 payments: null,
+                                 has_attachments: null,
+                                 attachments: null)
+```
+
+

data/docs/Overpayments.md

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