xero-ruby 2.4.1 → 2.5.0

data/docs/accounting/RepeatingInvoice.md

@@ -0,0 +1,47 @@
+# XeroRuby::Accounting::RepeatingInvoice
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | See Invoice Types | [optional] 
+**contact** | [**Contact**](Contact.md) |  | [optional] 
+**schedule** | [**Schedule**](Schedule.md) |  | [optional] 
+**line_items** | [**Array<LineItem>**](LineItem.md) | See LineItems | [optional] 
+**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
+**reference** | **String** | ACCREC only – additional reference number | [optional] 
+**branding_theme_id** | **String** | See BrandingThemes | [optional] 
+**currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
+**status** | **String** | One of the following - DRAFT or AUTHORISED – See Invoice Status Codes | [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) | [optional] 
+**repeating_invoice_id** | **String** | Xero generated unique identifier for repeating invoice template | [optional] 
+**id** | **String** | Xero generated unique identifier for repeating invoice template | [optional] 
+**has_attachments** | **Boolean** | boolean to indicate if an invoice has an attachment | [optional] [default to false]
+**attachments** | [**Array<Attachment>**](Attachment.md) | Displays array of attachments from the API | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::RepeatingInvoice.new(type: null,
+                                 contact: null,
+                                 schedule: null,
+                                 line_items: null,
+                                 line_amount_types: null,
+                                 reference: null,
+                                 branding_theme_id: null,
+                                 currency_code: null,
+                                 status: null,
+                                 sub_total: null,
+                                 total_tax: null,
+                                 total: null,
+                                 repeating_invoice_id: null,
+                                 id: null,
+                                 has_attachments: false,
+                                 attachments: null)
+```
+
+

data/docs/accounting/RepeatingInvoices.md

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

data/docs/accounting/Report.md

@@ -0,0 +1,29 @@
+# XeroRuby::Accounting::Report
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**report_id** | **String** | See Prepayment Types | [optional] 
+**report_name** | **String** | See Prepayment Types | [optional] 
+**report_type** | **String** | See Prepayment Types | [optional] 
+**report_title** | **String** | See Prepayment Types | [optional] 
+**report_date** | **String** | Date of report | [optional] 
+**updated_date_utc** | **DateTime** | Updated Date | [optional] 
+**contacts** | [**Array<TenNinetyNineContact>**](TenNinetyNineContact.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::Report.new(report_id: null,
+                                 report_name: null,
+                                 report_type: null,
+                                 report_title: null,
+                                 report_date: null,
+                                 updated_date_utc: /Date(1573755038314)/,
+                                 contacts: null)
+```
+
+

data/docs/accounting/ReportAttribute.md

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

data/docs/accounting/ReportCell.md

@@ -0,0 +1,19 @@
+# XeroRuby::Accounting::ReportCell
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** |  | [optional] 
+**attributes** | [**Array<ReportAttribute>**](ReportAttribute.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ReportCell.new(value: null,
+                                 attributes: null)
+```
+
+

data/docs/accounting/ReportFields.md

@@ -0,0 +1,21 @@
+# XeroRuby::Accounting::ReportFields
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field_id** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ReportFields.new(field_id: null,
+                                 description: null,
+                                 value: null)
+```
+
+

data/docs/accounting/ReportRow.md

@@ -0,0 +1,21 @@
+# XeroRuby::Accounting::ReportRow
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**row_type** | [**RowType**](RowType.md) |  | [optional] 
+**title** | **String** |  | [optional] 
+**cells** | [**Array<ReportCell>**](ReportCell.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ReportRow.new(row_type: null,
+                                 title: null,
+                                 cells: null)
+```
+
+

data/docs/accounting/ReportRows.md

@@ -0,0 +1,23 @@
+# XeroRuby::Accounting::ReportRows
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**row_type** | [**RowType**](RowType.md) |  | [optional] 
+**title** | **String** |  | [optional] 
+**cells** | [**Array<ReportCell>**](ReportCell.md) |  | [optional] 
+**rows** | [**Array<ReportRow>**](ReportRow.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ReportRows.new(row_type: null,
+                                 title: null,
+                                 cells: null,
+                                 rows: null)
+```
+
+

data/docs/accounting/ReportWithRow.md

@@ -0,0 +1,33 @@
+# XeroRuby::Accounting::ReportWithRow
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**report_id** | **String** | Report id | [optional] 
+**report_name** | **String** | Name of the report | [optional] 
+**report_title** | **String** | Title of the report | [optional] 
+**report_type** | **String** | The type of report (BalanceSheet,ProfitLoss, etc) | [optional] 
+**report_titles** | **Array<String>** | Report titles array (3 to 4 strings with the report name, orgnisation name and time frame of report) | [optional] 
+**report_date** | **String** | Date of report | [optional] 
+**rows** | [**Array<ReportRows>**](ReportRows.md) |  | [optional] 
+**updated_date_utc** | **DateTime** | Updated Date | [optional] 
+**fields** | [**Array<ReportFields>**](ReportFields.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ReportWithRow.new(report_id: null,
+                                 report_name: null,
+                                 report_title: null,
+                                 report_type: null,
+                                 report_titles: null,
+                                 report_date: null,
+                                 rows: null,
+                                 updated_date_utc: /Date(1573755038314)/,
+                                 fields: null)
+```
+
+

data/docs/accounting/ReportWithRows.md

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

data/docs/accounting/Reports.md

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

data/docs/accounting/RequestEmpty.md

@@ -0,0 +1,17 @@
+# XeroRuby::Accounting::RequestEmpty
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | Need at least one field to create an empty JSON payload | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::RequestEmpty.new(status: null)
+```
+
+

data/docs/accounting/RowType.md

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

data/docs/accounting/SalesTrackingCategory.md

@@ -0,0 +1,19 @@
+# XeroRuby::Accounting::SalesTrackingCategory
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tracking_category_name** | **String** | The default sales tracking category name for contacts | [optional] 
+**tracking_option_name** | **String** | The default purchase tracking category name for contacts | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::SalesTrackingCategory.new(tracking_category_name: null,
+                                 tracking_option_name: null)
+```
+
+

data/docs/accounting/Schedule.md

@@ -0,0 +1,29 @@
+# XeroRuby::Accounting::Schedule
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**period** | **Integer** | Integer used with the unit e.g. 1 (every 1 week), 2 (every 2 months) | [optional] 
+**unit** | **String** | One of the following - WEEKLY or MONTHLY | [optional] 
+**due_date** | **Integer** | Integer used with due date type e.g 20 (of following month), 31 (of current month) | [optional] 
+**due_date_type** | **String** | the payment terms | [optional] 
+**start_date** | **Date** | Date the first invoice of the current version of the repeating schedule was generated (changes when repeating invoice is edited) | [optional] 
+**next_scheduled_date** | **Date** | The calendar date of the next invoice in the schedule to be generated | [optional] 
+**end_date** | **Date** | Invoice end date – only returned if the template has an end date set | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::Schedule.new(period: null,
+                                 unit: null,
+                                 due_date: null,
+                                 due_date_type: null,
+                                 start_date: null,
+                                 next_scheduled_date: null,
+                                 end_date: null)
+```
+
+

data/docs/accounting/Setup.md

@@ -0,0 +1,21 @@
+# XeroRuby::Accounting::Setup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversion_date** | [**ConversionDate**](ConversionDate.md) |  | [optional] 
+**conversion_balances** | [**Array<ConversionBalances>**](ConversionBalances.md) | Balance supplied for each account that has a value as at the conversion date. | [optional] 
+**accounts** | [**Array<Account>**](Account.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::Setup.new(conversion_date: null,
+                                 conversion_balances: null,
+                                 accounts: null)
+```
+
+

data/docs/accounting/TaxComponent.md

@@ -0,0 +1,23 @@
+# XeroRuby::Accounting::TaxComponent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of Tax Component | [optional] 
+**rate** | **BigDecimal** | Tax Rate (up to 4dp) | [optional] 
+**is_compound** | **Boolean** | Boolean to describe if Tax rate is compounded. | [optional] 
+**is_non_recoverable** | **Boolean** | Boolean to describe if tax rate is non-recoverable. Non-recoverable rates are only applicable to Canadian organisations | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::TaxComponent.new(name: null,
+                                 rate: null,
+                                 is_compound: null,
+                                 is_non_recoverable: null)
+```
+
+

data/docs/accounting/TaxRate.md

@@ -0,0 +1,39 @@
+# XeroRuby::Accounting::TaxRate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of tax rate | [optional] 
+**tax_type** | **String** | The tax type | [optional] 
+**tax_components** | [**Array<TaxComponent>**](TaxComponent.md) | See TaxComponents | [optional] 
+**status** | **String** | See Status Codes | [optional] 
+**report_tax_type** | **String** | See ReportTaxTypes | [optional] 
+**can_apply_to_assets** | **Boolean** | Boolean to describe if tax rate can be used for asset accounts i.e.  true,false | [optional] 
+**can_apply_to_equity** | **Boolean** | Boolean to describe if tax rate can be used for equity accounts i.e true,false | [optional] 
+**can_apply_to_expenses** | **Boolean** | Boolean to describe if tax rate can be used for expense accounts  i.e. true,false | [optional] 
+**can_apply_to_liabilities** | **Boolean** | Boolean to describe if tax rate can be used for liability accounts  i.e. true,false | [optional] 
+**can_apply_to_revenue** | **Boolean** | Boolean to describe if tax rate can be used for revenue accounts i.e. true,false | [optional] 
+**display_tax_rate** | **BigDecimal** | Tax Rate (decimal to 4dp) e.g 12.5000 | [optional] 
+**effective_rate** | **BigDecimal** | Effective Tax Rate (decimal to 4dp) e.g 12.5000 | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::TaxRate.new(name: null,
+                                 tax_type: null,
+                                 tax_components: null,
+                                 status: null,
+                                 report_tax_type: null,
+                                 can_apply_to_assets: null,
+                                 can_apply_to_equity: null,
+                                 can_apply_to_expenses: null,
+                                 can_apply_to_liabilities: null,
+                                 can_apply_to_revenue: null,
+                                 display_tax_rate: null,
+                                 effective_rate: null)
+```
+
+