xero-ruby 2.2.4 → 2.5.0

data/docs/accounting/Action.md

@@ -0,0 +1,19 @@
+# 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

@@ -0,0 +1,17 @@
+# 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/AddressForOrganisation.md

@@ -0,0 +1,35 @@
+# 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/BalanceDetails.md

@@ -0,0 +1,21 @@
+# 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/CISOrgSetting.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **cis_contractor_enabled** | **Boolean** | true or false - Boolean that describes if the organisation is a CIS Contractor | [optional] 
 **cis_sub_contractor_enabled** | **Boolean** | true or false - Boolean that describes if the organisation is a CIS SubContractor | [optional] 
-**rate** | **Integer** | CIS Deduction rate for the organisation | [optional] 
+**rate** | **BigDecimal** | CIS Deduction rate for the organisation | [optional] 
 
 ## Code Sample
 

data/docs/accounting/CISSetting.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **cis_enabled** | **Boolean** | Boolean that describes if the contact is a CIS Subcontractor | [optional] 
-**rate** | **Integer** | CIS Deduction rate for the contact if he is a subcontractor. If the contact is not CISEnabled, then the rate is not returned | [optional] 
+**rate** | **BigDecimal** | CIS Deduction rate for the contact if he is a subcontractor. If the contact is not CISEnabled, then the rate is not returned | [optional] 
 
 ## Code Sample
 

data/docs/accounting/ConversionBalances.md

@@ -0,0 +1,21 @@
+# XeroRuby::Accounting::ConversionBalances
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_code** | **String** | The account code for a account | [optional] 
+**balance** | **Float** | The opening balances of the account. Debits are positive, credits are negative values | [optional] 
+**balance_details** | [**Array<BalanceDetails>**](BalanceDetails.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ConversionBalances.new(account_code: null,
+                                 balance: null,
+                                 balance_details: null)
+```
+
+

data/docs/accounting/ConversionDate.md

@@ -0,0 +1,19 @@
+# XeroRuby::Accounting::ConversionDate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**month** | **Integer** | The month the organisation starts using Xero. Value is an integer between 1 and 12 | [optional] 
+**year** | **Integer** | The year the organisation starts using Xero. Value is an integer greater than 2006 | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ConversionDate.new(month: 1,
+                                 year: 2020)
+```
+
+

data/docs/accounting/CreditNote.md

@@ -7,12 +7,15 @@ Name | Type | Description | Notes
 **type** | **String** | See Credit Note Types | [optional] 
 **contact** | [**Contact**](Contact.md) |  | [optional] 
 **date** | **Date** | The date the credit note is issued YYYY-MM-DD. If the Date element is not specified then 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] 
 **status** | **String** | See Credit Note Status Codes | [optional] 
 **line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
 **line_items** | [**Array<LineItem>**](LineItem.md) | See Invoice Line Items | [optional] 
 **sub_total** | **BigDecimal** | The subtotal of the credit note excluding taxes | [optional] 
 **total_tax** | **BigDecimal** | The total tax on the credit note | [optional] 
 **total** | **BigDecimal** | The total of the Credit Note(subtotal + total tax) | [optional] 
+**cis_deduction** | **BigDecimal** | CIS deduction for UK contractors | [optional] 
+**cis_rate** | **BigDecimal** | CIS Deduction rate for the organisation | [optional] 
 **updated_date_utc** | **DateTime** | UTC timestamp of last update to the credit note | [optional] 
 **currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
 **fully_paid_on_date** | **Date** | Date when credit note was fully paid(UTC format) | [optional] 
@@ -39,12 +42,15 @@ require 'XeroRuby::Accounting'
 instance = XeroRuby::Accounting::CreditNote.new(type: null,
                                  contact: null,
                                  date: null,
+                                 due_date: null,
                                  status: null,
                                  line_amount_types: null,
                                  line_items: null,
                                  sub_total: null,
                                  total_tax: null,
                                  total: null,
+                                 cis_deduction: null,
+                                 cis_rate: null,
                                  updated_date_utc: /Date(1573755038314)/,
                                  currency_code: null,
                                  fully_paid_on_date: null,

data/docs/accounting/ExpenseClaim.md

@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 **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] 
+**receipt_id** | **String** | The Xero identifier for the Receipt e.g. e59a2c7f-1306-4078-a0f3-73537afcbba9 | [optional] 
 
 ## Code Sample
 

data/docs/accounting/ImportSummary.md

@@ -0,0 +1,19 @@
+# XeroRuby::Accounting::ImportSummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accounts** | [**ImportSummaryAccounts**](ImportSummaryAccounts.md) |  | [optional] 
+**organisation** | [**ImportSummaryOrganisation**](ImportSummaryOrganisation.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ImportSummary.new(accounts: null,
+                                 organisation: null)
+```
+
+

data/docs/accounting/ImportSummaryAccounts.md

@@ -0,0 +1,33 @@
+# XeroRuby::Accounting::ImportSummaryAccounts
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Float** | The total number of accounts in the org | [optional] 
+**new** | **Float** | The number of new accounts created | [optional] 
+**updated** | **Float** | The number of accounts updated | [optional] 
+**deleted** | **Float** | The number of accounts deleted | [optional] 
+**locked** | **Float** | The number of locked accounts | [optional] 
+**system** | **Float** | The number of system accounts | [optional] 
+**errored** | **Float** | The number of accounts that had an error | [optional] 
+**present** | **Boolean** |  | [optional] 
+**new_or_updated** | **Float** | The number of new or updated accounts | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ImportSummaryAccounts.new(total: null,
+                                 new: null,
+                                 updated: null,
+                                 deleted: null,
+                                 locked: null,
+                                 system: null,
+                                 errored: null,
+                                 present: null,
+                                 new_or_updated: null)
+```
+
+

data/docs/accounting/ImportSummaryObject.md

@@ -0,0 +1,17 @@
+# XeroRuby::Accounting::ImportSummaryObject
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**import_summary** | [**ImportSummary**](ImportSummary.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ImportSummaryObject.new(import_summary: null)
+```
+
+

data/docs/accounting/ImportSummaryOrganisation.md

@@ -0,0 +1,17 @@
+# XeroRuby::Accounting::ImportSummaryOrganisation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**present** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ImportSummaryOrganisation.new(present: null)
+```
+
+

data/docs/accounting/Invoice.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **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] 
+**reference** | **String** | ACCREC only – additional reference number | [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] 
@@ -21,6 +21,7 @@ Name | Type | Description | Notes
 **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] 
+**cis_rate** | **BigDecimal** | CIS Deduction rate for the organisation | [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] 
@@ -66,6 +67,7 @@ instance = XeroRuby::Accounting::Invoice.new(type: null,
                                  expected_payment_date: null,
                                  planned_payment_date: null,
                                  cis_deduction: null,
+                                 cis_rate: null,
                                  sub_total: null,
                                  total_tax: null,
                                  total: null,

data/docs/accounting/Organisation.md

@@ -33,7 +33,7 @@ Name | Type | Description | Notes
 **_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] 
+**addresses** | [**Array<AddressForOrganisation>**](AddressForOrganisation.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] 

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/assets/Asset.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **asset_number** | **String** | Must be unique. | [optional] 
 **purchase_date** | **Date** | The date the asset was purchased YYYY-MM-DD | [optional] 
 **purchase_price** | **BigDecimal** | The purchase price of the asset | [optional] 
+**disposal_date** | **Date** | The date the asset was disposed | [optional] 
 **disposal_price** | **BigDecimal** | The price the asset was disposed at | [optional] 
 **asset_status** | [**AssetStatus**](AssetStatus.md) |  | [optional] 
 **warranty_expiry_date** | **String** | The date the asset’s warranty expires (if needed) YYYY-MM-DD | [optional] 
@@ -31,6 +32,7 @@ instance = XeroRuby::Assets::Asset.new(asset_id: 3b5b3a38-5649-495f-87a1-14a4e59
                                  asset_number: FA-0013,
                                  purchase_date: null,
                                  purchase_price: 1000.0000,
+                                 disposal_date: null,
                                  disposal_price: 1.0000,
                                  asset_status: null,
                                  warranty_expiry_date: ca4c6b39-4f4f-43e8-98da-5e1f350a6694,

data/docs/assets/AssetApi.md

@@ -39,13 +39,11 @@ token_set = fetch_valid_token_set(user) # example
 
 xero_client.refresh_token_set(token_set)
 
-# depending on the methods you need to use
-# accounting_api
-api_instance = xero_client.accounting_api
-# :assets_api
-api_instance = xero_client.asset_api
-# :projects_api
-api_instance = xero_client.projects_api
+# You need to namespace your api method call to one of the following api sets
+# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
+
+api_instance = xero_client.<api_set>
+
 
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
@@ -107,13 +105,11 @@ token_set = fetch_valid_token_set(user) # example
 
 xero_client.refresh_token_set(token_set)
 
-# depending on the methods you need to use
-# accounting_api
-api_instance = xero_client.accounting_api
-# :assets_api
-api_instance = xero_client.asset_api
-# :projects_api
-api_instance = xero_client.projects_api
+# You need to namespace your api method call to one of the following api sets
+# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
+
+api_instance = xero_client.<api_set>
+
 
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
@@ -178,13 +174,11 @@ token_set = fetch_valid_token_set(user) # example
 
 xero_client.refresh_token_set(token_set)
 
-# depending on the methods you need to use
-# accounting_api
-api_instance = xero_client.accounting_api
-# :assets_api
-api_instance = xero_client.asset_api
-# :projects_api
-api_instance = xero_client.projects_api
+# You need to namespace your api method call to one of the following api sets
+# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
+
+api_instance = xero_client.<api_set>
+
 
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
@@ -246,13 +240,11 @@ token_set = fetch_valid_token_set(user) # example
 
 xero_client.refresh_token_set(token_set)
 
-# depending on the methods you need to use
-# accounting_api
-api_instance = xero_client.accounting_api
-# :assets_api
-api_instance = xero_client.asset_api
-# :projects_api
-api_instance = xero_client.projects_api
+# You need to namespace your api method call to one of the following api sets
+# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
+
+api_instance = xero_client.<api_set>
+
 
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
@@ -312,13 +304,11 @@ token_set = fetch_valid_token_set(user) # example
 
 xero_client.refresh_token_set(token_set)
 
-# depending on the methods you need to use
-# accounting_api
-api_instance = xero_client.accounting_api
-# :assets_api
-api_instance = xero_client.asset_api
-# :projects_api
-api_instance = xero_client.projects_api
+# You need to namespace your api method call to one of the following api sets
+# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
+
+api_instance = xero_client.<api_set>
+
 
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
@@ -378,13 +368,11 @@ token_set = fetch_valid_token_set(user) # example
 
 xero_client.refresh_token_set(token_set)
 
-# depending on the methods you need to use
-# accounting_api
-api_instance = xero_client.accounting_api
-# :assets_api
-api_instance = xero_client.asset_api
-# :projects_api
-api_instance = xero_client.projects_api
+# You need to namespace your api method call to one of the following api sets
+# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
+
+api_instance = xero_client.<api_set>
+
 
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant