Merge pull request #382 from XeroAPI/18.1.0

Releasing 18.1.0 (OAS: 16.2.0)

Author: the-chris-mitchell

Gemfile.lock

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

docs/accounting/AccountingApi.md

@@ -2074,7 +2074,9 @@ opts = {
 
   unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
 
-  idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+  idempotency_key: 'KEY_VALUE', # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+
+  allow_backorders: true # Boolean | Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative
 }
 
 begin
@@ -2096,6 +2098,7 @@ Name | Type | Description  | Notes
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
  **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] 
  **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] 
+ **allow_backorders** | **Boolean**| Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative | [optional] 
 
 ### Return type
 
@@ -5905,7 +5908,9 @@ opts = {
 
   unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
 
-  page_size: 100 # Integer | Number of records to retrieve per page
+  page_size: 100, # Integer | Number of records to retrieve per page
+
+  references: ['&quot;Ref1&quot;, &quot;Ref2&quot;'] # Array<String> | Filter by a comma-separated list of References
 }
 
 begin
@@ -5929,6 +5934,7 @@ Name | Type | Description  | Notes
  **page** | **Integer**| Up to 100 bank transactions will be returned in a single API call with line items details | [optional] 
  **unitdp** | **Integer**| e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] 
  **page_size** | **Integer**| Number of records to retrieve per page | [optional] 
+ **references** | [**Array&lt;String&gt;**](String.md)| Filter by a comma-separated list of References | [optional] 
 
 ### Return type
 
@@ -10808,13 +10814,15 @@ opts = {
 
   order: 'Reference ASC', # String | Order by an any element
 
-  page: 1, # Integer | e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment
+  page: 1, # Integer | e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each prepayment
 
   unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
 
   page_size: 100, # Integer | Number of records to retrieve per page
 
-  invoice_numbers: ['&quot;INV-001&quot;, &quot;INV-002&quot;'] # Array<String> | Filter by a comma-separated list of InvoiceNumbers
+  invoice_numbers: ['&quot;INV-001&quot;, &quot;INV-002&quot;'], # Array<String> | Filter by a comma-separated list of InvoiceNumbers
+
+  references: ['&quot;Ref1&quot;, &quot;Ref2&quot;'] # Array<String> | Filter by a comma-separated list of References
 }
 
 begin
@@ -10835,10 +10843,11 @@ Name | Type | Description  | Notes
  **if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional] 
  **where** | **String**| Filter by an any element | [optional] 
  **order** | **String**| Order by an any element | [optional] 
- **page** | **Integer**| e.g. page&#x3D;1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment | [optional] 
+ **page** | **Integer**| e.g. page&#x3D;1 – Up to 100 prepayments will be returned in a single API call with line items shown for each prepayment | [optional] 
  **unitdp** | **Integer**| e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] 
  **page_size** | **Integer**| Number of records to retrieve per page | [optional] 
  **invoice_numbers** | [**Array&lt;String&gt;**](String.md)| Filter by a comma-separated list of InvoiceNumbers | [optional] 
+ **references** | [**Array&lt;String&gt;**](String.md)| Filter by a comma-separated list of References | [optional] 
 
 ### Return type
 
@@ -14799,7 +14808,9 @@ invoices = {"Invoices":[{"Reference":"May the force be with you","InvoiceID":"00
 opts = {
   unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
 
-  idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+  idempotency_key: 'KEY_VALUE', # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+
+  allow_backorders: true # Boolean | Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative
 }
 
 begin
@@ -14821,6 +14832,7 @@ Name | Type | Description  | Notes
  **invoices** | [**Invoices**](Invoices.md)|  | 
  **unitdp** | **Integer**| e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] 
  **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] 
+ **allow_backorders** | **Boolean**| Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative | [optional] 
 
 ### Return type
 
@@ -15458,7 +15470,9 @@ opts = {
 
   unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
 
-  idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+  idempotency_key: 'KEY_VALUE', # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+
+  allow_backorders: true # Boolean | Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative
 }
 
 begin
@@ -15480,6 +15494,7 @@ Name | Type | Description  | Notes
  **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
  **unitdp** | **Integer**| e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] 
  **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] 
+ **allow_backorders** | **Boolean**| Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative | [optional] 
 
 ### Return type
 

docs/accounting/Item.md

@@ -15,7 +15,9 @@ Name | Type | Description | Notes
 **sales_details** | [**Purchase**](Purchase.md) |  | [optional] 
 **is_tracked_as_inventory** | **Boolean** | True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set. | [optional] 
 **total_cost_pool** | **BigDecimal** | The value of the item on hand. Calculated using average cost accounting. | [optional] 
-**quantity_on_hand** | **BigDecimal** | The quantity of the item on hand | [optional] 
+**quantity_on_hand** | **BigDecimal** | The quantity of the item on hand. This will be 0 if `QuantityOnBackOrder` is greater than 0. | [optional] 
+**quantity_available** | **Float** | The quantity of the item available. This is equal to `QuantityOnHand` - `QuantityOnBackOrder`. This value will be negative if `QuantityOnBackOrder` is greater than 0. | [optional] 
+**quantity_on_back_order** | **Float** | The quantity of the item on backorder. This will be 0 if `QuantityOnHand` is greater than 0. | [optional] 
 **updated_date_utc** | **DateTime** | Last modified date in UTC format | [optional] 
 **item_id** | **String** | The Xero identifier for an Item | [optional] 
 **status_attribute_string** | **String** | Status of object | [optional] 
@@ -38,6 +40,8 @@ instance = XeroRuby::Accounting::Item.new(code: null,
                                  is_tracked_as_inventory: null,
                                  total_cost_pool: null,
                                  quantity_on_hand: null,
+                                 quantity_available: null,
+                                 quantity_on_back_order: null,
                                  updated_date_utc: /Date(1573755038314)/,
                                  item_id: null,
                                  status_attribute_string: null,

docs/accounting/index.html

@@ -3519,10 +3519,22 @@
     },
     "QuantityOnHand" : {
       "type" : "number",
-      "description" : "The quantity of the item on hand",
+      "description" : "The quantity of the item on hand. This will be 0 if `QuantityOnBackOrder` is greater than 0.",
       "format" : "double",
       "x-is-money" : true
     },
+    "QuantityAvailable" : {
+      "type" : "number",
+      "description" : "The quantity of the item available. This is equal to `QuantityOnHand` - `QuantityOnBackOrder`. This value will be negative if `QuantityOnBackOrder` is greater than 0.",
+      "format" : "double",
+      "readOnly" : true
+    },
+    "QuantityOnBackOrder" : {
+      "type" : "number",
+      "description" : "The quantity of the item on backorder. This will be 0 if `QuantityOnHand` is greater than 0.",
+      "format" : "double",
+      "readOnly" : true
+    },
     "UpdatedDateUTC" : {
       "type" : "string",
       "description" : "Last modified date in UTC format",
@@ -6494,7 +6506,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>18.0.0</li>
+              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>18.1.0</li>
               <li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
               <li data-group="Accounting" data-name="createAccount" class="">
                 <a href="#api-Accounting-createAccount">createAccount</a>
@@ -12087,6 +12099,7 @@ <h3>Usage and SDK Samples</h3>
 summarize_errors = true
 unitdp = 4
 idempotency_key = 'KEY_VALUE'
+allow_backorders = true
 date_value = 'YYYY-MM-DD'
 due_date_value = 'YYYY-MM-DD'
 
@@ -12126,7 +12139,7 @@ <h3>Usage and SDK Samples</h3>
 } 
 
 begin
-  response = xero_client.accounting_api.create_invoices(xero_tenant_id, invoices, summarize_errors, unitdp, idempotency_key)
+  response = xero_client.accounting_api.create_invoices(xero_tenant_id, invoices, summarize_errors, unitdp, idempotency_key, allow_backorders)
   return response
 rescue XeroRuby::ApiError => e
   puts "Exception when calling create_invoices: #{e}"
@@ -12294,6 +12307,26 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                    <tr><td style="width:150px;">allowBackorders</td>
+<td>
+
+
+    <div id="d2e199_createInvoices_allowBackorders">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    Boolean
+                </span>
+
+                    <div class="inner description marked">
+Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative
+                    </div>
+            </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                   </table>
@@ -21403,9 +21436,10 @@ <h3>Usage and SDK Samples</h3>
 page = 1
 unitdp = 4
 pageSize = 100
+references = [&quot;Ref1&quot;, &quot;Ref2&quot;]
 
 begin
-  response = xero_client.accounting_api.get_bank_transactions(xero_tenant_id, if_modified_since, where, order, page, unitdp, pageSize)
+  response = xero_client.accounting_api.get_bank_transactions(xero_tenant_id, if_modified_since, where, order, page, unitdp, pageSize, references)
   return response
 rescue XeroRuby::ApiError => e
   puts "Exception when calling get_bank_transactions: #{e}"
@@ -21585,6 +21619,26 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                    <tr><td style="width:150px;">References</td>
+<td>
+
+
+    <div id="d2e199_getBankTransactions_references">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    array[String]
+                </span>
+
+                    <div class="inner description marked">
+Filter by a comma-separated list of References
+                    </div>
+            </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                   </table>
@@ -31679,9 +31733,10 @@ <h3>Usage and SDK Samples</h3>
 unitdp = 4
 pageSize = 100
 invoice_numbers = [&quot;INV-001&quot;, &quot;INV-002&quot;]
+references = [&quot;Ref1&quot;, &quot;Ref2&quot;]
 
 begin
-  response = xero_client.accounting_api.get_prepayments(xero_tenant_id, if_modified_since, where, order, page, unitdp, pageSize, invoice_numbers)
+  response = xero_client.accounting_api.get_prepayments(xero_tenant_id, if_modified_since, where, order, page, unitdp, pageSize, invoice_numbers, references)
   return response
 rescue XeroRuby::ApiError => e
   puts "Exception when calling get_prepayments: #{e}"
@@ -31815,7 +31870,7 @@ <h2>Parameters</h2>
                 </span>
 
                     <div class="inner description marked">
-e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment
+e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each prepayment
                     </div>
             </div>
         </div>
@@ -31881,6 +31936,26 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                    <tr><td style="width:150px;">References</td>
+<td>
+
+
+    <div id="d2e199_getPrepayments_references">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    array[String]
+                </span>
+
+                    <div class="inner description marked">
+Filter by a comma-separated list of References
+                    </div>
+            </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                   </table>
@@ -40920,6 +40995,7 @@ <h3>Usage and SDK Samples</h3>
 invoice_id = '00000000-0000-0000-0000-000000000000'
 unitdp = 4
 idempotency_key = 'KEY_VALUE'
+allow_backorders = true
 
 invoice = { 
   reference: "I am Iron man"
@@ -40930,7 +41006,7 @@ <h3>Usage and SDK Samples</h3>
 } 
 
 begin
-  response = xero_client.accounting_api.update_invoice(xero_tenant_id, invoice_id, invoices, unitdp, idempotency_key)
+  response = xero_client.accounting_api.update_invoice(xero_tenant_id, invoice_id, invoices, unitdp, idempotency_key, allow_backorders)
   return response
 rescue XeroRuby::ApiError => e
   puts "Exception when calling update_invoice: #{e}"
@@ -41099,6 +41175,26 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                    <tr><td style="width:150px;">allowBackorders</td>
+<td>
+
+
+    <div id="d2e199_updateInvoice_allowBackorders">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    Boolean
+                </span>
+
+                    <div class="inner description marked">
+Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative
+                    </div>
+            </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                   </table>
@@ -42779,6 +42875,7 @@ <h3>Usage and SDK Samples</h3>
 summarize_errors = true
 unitdp = 4
 idempotency_key = 'KEY_VALUE'
+allow_backorders = true
 date_value = 'YYYY-MM-DD'
 due_date_value = 'YYYY-MM-DD'
 
@@ -42810,7 +42907,7 @@ <h3>Usage and SDK Samples</h3>
 } 
 
 begin
-  response = xero_client.accounting_api.update_or_create_invoices(xero_tenant_id, invoices, summarize_errors, unitdp, idempotency_key)
+  response = xero_client.accounting_api.update_or_create_invoices(xero_tenant_id, invoices, summarize_errors, unitdp, idempotency_key, allow_backorders)
   return response
 rescue XeroRuby::ApiError => e
   puts "Exception when calling update_or_create_invoices: #{e}"
@@ -42977,6 +43074,26 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                    <tr><td style="width:150px;">allowBackorders</td>
+<td>
+
+
+    <div id="d2e199_updateOrCreateInvoices_allowBackorders">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    Boolean
+                </span>
+
+                    <div class="inner description marked">
+Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative
+                    </div>
+            </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                   </table>

docs/app_store/index.html

@@ -1242,7 +1242,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>18.0.0</li>
+              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>18.1.0</li>
               <li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
               <li data-group="AppStore" data-name="getSubscription" class="">
                 <a href="#api-AppStore-getSubscription">getSubscription</a>