Releasing 18.4.0 (OAS: 20.0.1)

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    xero-ruby (18.3.0)
+    xero-ruby (18.4.0)
       faraday (>= 2.0, < 3.0)
       json (~> 2.1, >= 2.1.0)
       json-jwt (~> 1.16, >= 1.16.3)

docs/account_data/Account.md

@@ -0,0 +1,27 @@
+# XeroRuby::AccountData::Account
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | [optional] 
+**name** | **String** |  | 
+**_class** | **String** |  | 
+**type** | **String** | Account type (e.g. `BANK`, `CURRENT`). Reported as `INVENTORY` for inventory asset accounts, regardless of the account's underlying type.  | 
+**status** | **String** |  | 
+**system_account_code** | **String** | System account code, or `NONE` if the account has no system account code. | 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::AccountData'
+
+instance = XeroRuby::AccountData::Account.new(code: null,
+                                 name: null,
+                                 _class: null,
+                                 type: null,
+                                 status: null,
+                                 system_account_code: null)
+```
+
+

docs/account_data/AccountBalance.md

@@ -0,0 +1,25 @@
+# XeroRuby::AccountData::AccountBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | The account this balance is for. | 
+**date** | **Date** | The date this balance applies to (YYYY-MM-DD). | 
+**balance** | [**LedgerDecimal**](LedgerDecimal.md) |  | 
+**signed_balance** | **Float** | Balance as a signed number (positive for debit, negative for credit). | 
+**account** | [**Account**](Account.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::AccountData'
+
+instance = XeroRuby::AccountData::AccountBalance.new(account_id: null,
+                                 date: null,
+                                 balance: null,
+                                 signed_balance: null,
+                                 account: null)
+```
+
+

docs/account_data/AccountBalancesResponse.md

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

docs/account_data/AccountMovement.md

@@ -0,0 +1,35 @@
+# XeroRuby::AccountData::AccountMovement
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | The account this movement is for. | 
+**date_range** | [**AccountingDateRange**](AccountingDateRange.md) |  | 
+**debits** | **Float** | Total debits posted to this account within the date range. | 
+**credits** | **Float** | Total credits posted to this account within the date range. | 
+**movement** | [**LedgerDecimal**](LedgerDecimal.md) |  | 
+**signed_movement** | **Float** | Movement as a signed number (positive for debit, negative for credit). | 
+**tax_debits** | **Float** | Total tax debits within the date range. Omitted from the response when tax values are not available. | [optional] 
+**tax_credits** | **Float** | Total tax credits within the date range. Omitted from the response when tax values are not available. | [optional] 
+**signed_tax_movement** | **Float** | Tax movement as a signed number (positive for debit, negative for credit). Omitted from the response when tax values are not available. | [optional] 
+**account** | [**Account**](Account.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::AccountData'
+
+instance = XeroRuby::AccountData::AccountMovement.new(account_id: null,
+                                 date_range: null,
+                                 debits: null,
+                                 credits: null,
+                                 movement: null,
+                                 signed_movement: null,
+                                 tax_debits: null,
+                                 tax_credits: null,
+                                 signed_tax_movement: null,
+                                 account: null)
+```
+
+

docs/account_data/AccountMovementsResponse.md

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

docs/account_data/AccountTransactionLine.md

@@ -0,0 +1,37 @@
+# XeroRuby::AccountData::AccountTransactionLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**journal_number** | **Integer** | Unique journal number for this transaction. | 
+**journal_date** | **Date** | Accounting date of the transaction (YYYY-MM-DD). | 
+**description** | **String** | Line description, falling back to the journal narration. Empty if neither is set. | 
+**account** | [**TransactionAccount**](TransactionAccount.md) |  | 
+**net_amount** | [**LedgerDecimal**](LedgerDecimal.md) |  | 
+**signed_net_amount** | **Float** | Net amount as a signed number (positive for debit, negative for credit). | [optional] 
+**tax_amount** | [**LedgerDecimal**](LedgerDecimal.md) |  | [optional] 
+**signed_tax_amount** | **Float** | Tax amount as a signed number (positive for debit, negative for credit). | [optional] 
+**source** | [**LineSource**](LineSource.md) |  | 
+**tax_rate** | [**LineTaxRate**](LineTaxRate.md) |  | 
+**tracking_categories** | [**Hash<String, TrackingItemDetails>**](TrackingItemDetails.md) | Present only when `include=trackingCategories` was requested, and omitted otherwise. Keys are tracking category IDs (UUIDs); values describe the selected tracking option. The object is empty when the line has no tracking.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::AccountData'
+
+instance = XeroRuby::AccountData::AccountTransactionLine.new(journal_number: null,
+                                 journal_date: null,
+                                 description: null,
+                                 account: null,
+                                 net_amount: null,
+                                 signed_net_amount: null,
+                                 tax_amount: null,
+                                 signed_tax_amount: null,
+                                 source: null,
+                                 tax_rate: null,
+                                 tracking_categories: null)
+```
+
+

docs/account_data/AccountTransactionsResponse.md

@@ -0,0 +1,23 @@
+# XeroRuby::AccountData::AccountTransactionsResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency_code** | **String** | Organisation's base currency code (ISO 4217). | 
+**max_journal_number** | **Integer** | Maximum journal number included in this result set. Captured at the first request and held constant across all pages for consistency.  | 
+**lines** | [**Array<AccountTransactionLine>**](AccountTransactionLine.md) | Transaction lines for this page (max 200). | 
+**pagination** | [**AccountTransactionsResponsePagination**](AccountTransactionsResponsePagination.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::AccountData'
+
+instance = XeroRuby::AccountData::AccountTransactionsResponse.new(currency_code: USD,
+                                 max_journal_number: 546,
+                                 lines: null,
+                                 pagination: null)
+```
+
+

docs/account_data/AccountTransactionsResponsePagination.md

@@ -0,0 +1,19 @@
+# XeroRuby::AccountData::AccountTransactionsResponsePagination
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page_size** | **Integer** |  | 
+**next_token** | **String** | Opaque continuation token for the next page. Send it as the `token` query parameter to retrieve the next page. | 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::AccountData'
+
+instance = XeroRuby::AccountData::AccountTransactionsResponsePagination.new(page_size: 200,
+                                 next_token: ZXhhbXBsZS1jb250aW51YXRpb24tdG9rZW4)
+```
+
+

docs/account_data/AccountingDateRange.md

@@ -0,0 +1,19 @@
+# XeroRuby::AccountData::AccountingDateRange
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_date** | **Date** |  | 
+**end_date** | **Date** |  | 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::AccountData'
+
+instance = XeroRuby::AccountData::AccountingDateRange.new(start_date: null,
+                                 end_date: null)
+```
+
+

docs/account_data/FieldProblem.md

@@ -0,0 +1,27 @@
+# XeroRuby::AccountData::FieldProblem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field_name** | **String** | The name of the offending parameter, or an empty string when the failure is not tied to one parameter. | [optional] 
+**type** | **String** |  | [optional] 
+**title** | **String** |  | [optional] 
+**status** | **Integer** |  | [optional] 
+**detail** | **String** |  | [optional] 
+**instance** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::AccountData'
+
+instance = XeroRuby::AccountData::FieldProblem.new(field_name: null,
+                                 type: null,
+                                 title: null,
+                                 status: null,
+                                 detail: null,
+                                 instance: null)
+```
+
+

docs/account_data/GatewayProblem.md

@@ -0,0 +1,27 @@
+# XeroRuby::AccountData::GatewayProblem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**title** | **String** |  | 
+**status** | **Integer** |  | 
+**detail** | **String** |  | [optional] 
+**instance** | **String** | The correlation ID of the request, also returned in the `Xero-Correlation-Id` header. | [optional] 
+**extensions** | **Hash<String, Object>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::AccountData'
+
+instance = XeroRuby::AccountData::GatewayProblem.new(type: null,
+                                 title: Unauthorized,
+                                 status: null,
+                                 detail: null,
+                                 instance: null,
+                                 extensions: null)
+```
+
+

docs/account_data/LedgerDecimal.md

@@ -0,0 +1,19 @@
+# XeroRuby::AccountData::LedgerDecimal
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Float** | Amount value (always positive). | 
+**type** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::AccountData'
+
+instance = XeroRuby::AccountData::LedgerDecimal.new(value: null,
+                                 type: null)
+```
+
+

docs/account_data/LineSource.md

@@ -0,0 +1,27 @@
+# XeroRuby::AccountData::LineSource
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document_id** | **String** |  | [optional] 
+**document_type** | **String** |  | [optional] 
+**event_type** | **String** |  | [optional] 
+**contact_id** | **String** |  | [optional] 
+**contact_name** | **String** |  | [optional] 
+**reference** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::AccountData'
+
+instance = XeroRuby::AccountData::LineSource.new(document_id: null,
+                                 document_type: null,
+                                 event_type: null,
+                                 contact_id: null,
+                                 contact_name: null,
+                                 reference: null)
+```
+
+

docs/account_data/LineTaxRate.md

@@ -0,0 +1,21 @@
+# XeroRuby::AccountData::LineTaxRate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**percentage** | **Float** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::AccountData'
+
+instance = XeroRuby::AccountData::LineTaxRate.new(code: null,
+                                 name: null,
+                                 percentage: null)
+```
+
+

docs/account_data/ProblemDetails.md

@@ -0,0 +1,25 @@
+# XeroRuby::AccountData::ProblemDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | URI reference identifying the problem type. | [optional] 
+**title** | **String** | Short, human-readable summary. | 
+**status** | **Integer** | HTTP status code. | 
+**detail** | **String** | Detailed explanation of the problem. | [optional] 
+**instance** | **String** | URI reference identifying the specific occurrence. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::AccountData'
+
+instance = XeroRuby::AccountData::ProblemDetails.new(type: null,
+                                 title: null,
+                                 status: null,
+                                 detail: null,
+                                 instance: null)
+```
+
+