Issue #3254168: Support taxIncluded in AvaTax response

src/Plugin/Commerce/TaxType/Avatax.php

@@ -110,42 +110,50 @@ class Avatax extends RemoteTaxTypeBase {
     foreach ($response_body['lines'] as $tax_adjustment) {
       $label = isset($tax_adjustment['details'][0]['taxName']) ? Html::escape($tax_adjustment['details'][0]['taxName']) : $this->t('Sales tax');
       $adjustments[$tax_adjustment['lineNumber']] = [
-        'amount' => $tax_adjustment['tax'],
+        'type' => 'tax',
         'label' => $label,
+        'amount' => new Price ((string) $tax_adjustment['tax'], $currency_code),
+        'source_id' => $this->pluginId . '|' . $this->parentEntity->id(),
+        'included' => !empty($tax_adjustment['taxIncluded']),
       ];
     }
 
     // Add tax adjustments to order items.
     foreach ($order->getItems() as $order_item) {
-      if (!isset($adjustments[$order_item->uuid()])) {
+      $adjustment = $adjustments[$order_item->uuid()] ?? NULL;
+      if (!$adjustment) {
         continue;
       }
-      $order_item->addAdjustment(new Adjustment([
-        'type' => 'tax',
-        'label' => $adjustments[$order_item->uuid()]['label'],
-        'amount' => new Price((string) $adjustments[$order_item->uuid()]['amount'], $currency_code),
-        'source_id' => $this->pluginId . '|' . $this->parentEntity->id(),
-      ]));
+      $order_item->addAdjustment(new Adjustment($adjustment));
       $applied_adjustments[$order_item->uuid()] = $order_item->uuid();
     }
 
-    // If we still have Tax adjustments to apply, add a single one to the order.
+    // If we still have Tax adjustments to apply, add it/them to the order.
     $remaining_adjustments = array_diff_key($adjustments, $applied_adjustments);
     if (!$remaining_adjustments) {
       return;
     }
-    $tax_adjustment_total = NULL;
-    // Calculate the total Tax adjustment to add.
-    foreach ($remaining_adjustments as $remaining_adjustment) {
-      $adjustment_amount = new Price((string) $remaining_adjustment['amount'], $currency_code);
-      $tax_adjustment_total = $tax_adjustment_total ? $tax_adjustment_total->add($adjustment_amount) : $adjustment_amount;
+
+    // Combine remaining adjustments being careful not to mix inclusive with
+    // non-inclusive.
+    // @todo This could potentially be handled by creating Adjustment objects
+    //   and using the adjustment transformer, but it currently doesn't handle
+    //   a mixture of included and non-included adjustments.
+    // @see https://www.drupal.org/project/commerce/issues/3285502
+    foreach ($remaining_adjustments as $adjustment) {
+      $index = $adjustment['included'] ? 1 : 0;
+      if (isset($combined[$index])) {
+        $combined[$index]['amount']->add($adjustment['amount']);
+      }
+      else {
+        $combined[$index] = $adjustment;
+      }
+    }
+    foreach ($combined as $adjustment) {
+      $order->addAdjustment(new Adjustment([
+        'label' => $this->t('Sales tax'),
+      ] + $adjustment));
     }
-    $order->addAdjustment(new Adjustment([
-      'type' => 'tax',
-      'label' => $this->t('Sales tax'),
-      'amount' => $tax_adjustment_total,
-      'source_id' => $this->pluginId . '|' . $this->parentEntity->id(),
-    ]));
   }
 
 }