xero-ruby 2.2.2 → 2.4.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/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/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,6 +7,7 @@ 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] 
@@ -39,6 +40,7 @@ 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,

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

@@ -26,6 +26,7 @@ Name | Type | Description | Notes
 **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] 
 **total_discount** | **BigDecimal** | Total of discounts applied on the invoice line items | [optional] 
 **invoice_id** | **String** | Xero generated unique identifier for invoice | [optional] 
+**repeating_invoice_id** | **String** | Xero generated unique identifier for repeating invoices | [optional] 
 **has_attachments** | **Boolean** | boolean to indicate if an invoice has an attachment | [optional] [default to false]
 **is_discounted** | **Boolean** | boolean to indicate if an invoice has a discount | [optional] 
 **payments** | [**Array<Payment>**](Payment.md) | See Payments | [optional] 
@@ -70,6 +71,7 @@ instance = XeroRuby::Accounting::Invoice.new(type: null,
                                  total: null,
                                  total_discount: null,
                                  invoice_id: null,
+                                 repeating_invoice_id: null,
                                  has_attachments: false,
                                  is_discounted: null,
                                  payments: 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/TrackingOption.md

@@ -4,10 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**tracking_option_id** | **String** | The Xero identifier for a tracking optione.g. ae777a87-5ef3-4fa0-a4f0-d10e1f13073a | [optional] 
-**name** | **String** | The name of the tracking option e.g. Marketing, East (max length = 50) | [optional] 
+**tracking_option_id** | **String** | The Xero identifier for a tracking option e.g. ae777a87-5ef3-4fa0-a4f0-d10e1f13073a | [optional] 
+**name** | **String** | The name of the tracking option e.g. Marketing, East (max length = 100) | [optional] 
 **status** | **String** | The status of a tracking option | [optional] 
-**tracking_category_id** | **String** | Filter by a tracking categorye.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional] 
+**tracking_category_id** | **String** | Filter by a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional] 
 
 ## Code Sample
 

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

data/docs/files/Association.md

@@ -0,0 +1,23 @@
+# XeroRuby::Files::Association
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file_id** | **String** | The unique identifier of the file | [optional] 
+**object_id** | **String** | The identifier of the object that the file is being associated with (e.g. InvoiceID, BankTransactionID, ContactID) | [optional] 
+**object_group** | [**ObjectGroup**](ObjectGroup.md) |  | [optional] 
+**object_type** | [**ObjectType**](ObjectType.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Files'
+
+instance = XeroRuby::Files::Association.new(file_id: null,
+                                 object_id: null,
+                                 object_group: null,
+                                 object_type: null)
+```
+
+

data/docs/files/FileObject.md

@@ -0,0 +1,31 @@
+# XeroRuby::Files::FileObject
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | File Name | [optional] 
+**mime_type** | **String** | MimeType of the file (image/png, image/jpeg, application/pdf, etc..) | [optional] 
+**size** | **Integer** | Numeric value in bytes | [optional] 
+**created_date_utc** | **String** | Created date in UTC | [optional] 
+**updated_date_utc** | **String** | Updated date in UTC | [optional] 
+**user** | [**User**](User.md) |  | [optional] 
+**id** | **String** | File object's UUID | [optional] 
+**folder_id** | **String** | Folder relation object's UUID | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Files'
+
+instance = XeroRuby::Files::FileObject.new(name: File2.jpg,
+                                 mime_type: image/jpeg,
+                                 size: 3615,
+                                 created_date_utc: 2020-12-03T19:04:58.6970000,
+                                 updated_date_utc: 2020-12-03T19:04:58.6970000,
+                                 user: null,
+                                 id: d290f1ee-6c54-4b01-90e6-d701748f0851,
+                                 folder_id: 0f8ccf21-7267-4268-9167-a1e2c40c84c8)
+```
+
+