Reduce net order total by refunded amount less tax and shipping refun…

…ds (woocommerce#1600) * Reduce net order total by refunded amount less tax and shipping refunds * Fix net_totals in tests with refunds
marcusquiroga · Feb 20, 2019 · 358473d · 358473d
1 parent 488bfa9
commit 358473d
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 9 deletions.
diff --git a/includes/data-stores/class-wc-admin-reports-orders-stats-data-store.php b/includes/data-stores/class-wc-admin-reports-orders-stats-data-store.php
@@ -401,7 +401,7 @@ public static function update( $order ) {
 			'refund_total'       => $order->get_total_refunded(),
 			'tax_total'          => $order->get_total_tax(),
 			'shipping_total'     => $order->get_shipping_total(),
-			'net_total'          => (float) $order->get_total() - (float) $order->get_total_tax() - (float) $order->get_shipping_total(),
+			'net_total'          => self::get_net_total( $order ),
 			'returning_customer' => self::is_returning_customer( $order ),
 			'status'             => self::normalize_order_status( $order->get_status() ),
 		);
@@ -507,6 +507,23 @@ protected static function get_num_items_sold( $order ) {
 		return $num_items;
 	}
 
+	/**
+	 * Get the net amount from an order without shipping, tax, or refunds.
+	 *
+	 * @param array $order WC_Order object.
+	 * @return float
+	 */
+	protected static function get_net_total( $order ) {
+		$net_total = $order->get_total() - $order->get_total_tax() - $order->get_shipping_total();
+
+		$refunds = $order->get_refunds();
+		foreach ( $refunds as $refund ) {
+			$net_total += $refund->get_total() - $refund->get_total_tax() - $refund->get_shipping_total();
+		}
+
+		return $net_total > 0 ? (float) $net_total : 0;
+	}
+
 	/**
 	 * Check to see if an order's customer has made previous orders or not
 	 *

diff --git a/tests/reports/class-wc-tests-reports-orders-stats.php b/tests/reports/class-wc-tests-reports-orders-stats.php
@@ -58,13 +58,13 @@ public function test_populate_and_query() {
 				'orders_count'            => 1,
 				'num_items_sold'          => 4,
 				'avg_items_per_order'     => 4,
-				'avg_order_value'         => 68,
+				'avg_order_value'         => 56,
 				'gross_revenue'           => 97,
 				'coupons'                 => 20,
 				'refunds'                 => 12,
 				'taxes'                   => 7,
 				'shipping'                => 10,
-				'net_revenue'             => 68,
+				'net_revenue'             => 56,
 				'num_returning_customers' => 0,
 				'num_new_customers'       => 1,
 				'products'                => 1,
@@ -79,15 +79,15 @@ public function test_populate_and_query() {
 					'date_end_gmt'   => $end_time,
 					'subtotals'      => array(
 						'gross_revenue'           => 97,
-						'net_revenue'             => 68,
+						'net_revenue'             => 56,
 						'coupons'                 => 20,
 						'shipping'                => 10,
 						'taxes'                   => 7,
 						'refunds'                 => 12,
 						'orders_count'            => 1,
 						'num_items_sold'          => 4,
 						'avg_items_per_order'     => 4,
-						'avg_order_value'         => 68,
+						'avg_order_value'         => 56,
 						'num_returning_customers' => 0,
 						'num_new_customers'       => 1,
 						'segments'                => array(),
@@ -106,8 +106,8 @@ public function test_populate_and_query() {
 		$query          = new WC_Admin_Reports_Orders_Stats_Query( $args );
 		$expected_stats = array(
 			'totals'    => array(
-				'net_revenue'             => 68,
-				'avg_order_value'         => 68,
+				'net_revenue'             => 56,
+				'avg_order_value'         => 56,
 				'orders_count'            => 1,
 				'avg_items_per_order'     => 4,
 				'num_items_sold'          => 4,
@@ -125,8 +125,8 @@ public function test_populate_and_query() {
 					'date_end'       => $end_time,
 					'date_end_gmt'   => $end_time,
 					'subtotals'      => array(
-						'net_revenue'             => 68,
-						'avg_order_value'         => 68,
+						'net_revenue'             => 56,
+						'avg_order_value'         => 56,
 						'orders_count'            => 1,
 						'avg_items_per_order'     => 4,
 						'num_items_sold'          => 4,