VAT calculation and rounding

Author: Markus Falk

src/Libraries/Nop.Core/Domain/Orders/Order.cs

@@ -26,9 +26,10 @@ public partial class Order : BaseEntity
 
         #region Utilities
 
-        protected virtual SortedDictionary<decimal, decimal> ParseTaxRates(string taxRatesStr)
+        protected virtual SortedDictionary<decimal, TaxRateRec> ParseTaxRates(string taxRatesStr)
         {
-            var taxRatesDictionary = new SortedDictionary<decimal, decimal>();
+            //var taxRatesDictionary = new SortedDictionary<decimal, decimal>();
+            var taxRatesDictionary = new SortedDictionary<decimal, TaxRateRec>();
             if (String.IsNullOrEmpty(taxRatesStr))
                 return taxRatesDictionary;
 
@@ -39,13 +40,20 @@ protected virtual SortedDictionary<decimal, decimal> ParseTaxRates(string taxRat
                     continue;
 
                 string[] taxes = line.Split(new [] { ':' });
-                if (taxes.Length == 2)
+                if (taxes.Length == 6)
                 {
                     try
                     {
-                        decimal taxRate = decimal.Parse(taxes[0].Trim(), CultureInfo.InvariantCulture);
-                        decimal taxValue = decimal.Parse(taxes[1].Trim(), CultureInfo.InvariantCulture);
-                        taxRatesDictionary.Add(taxRate, taxValue);
+                        decimal rate = decimal.Parse(taxes[0].Trim(), CultureInfo.InvariantCulture);
+                        taxRatesDictionary.Add(rate, new TaxRateRec()
+                        {
+                            VatRate = rate,
+                            Amount = decimal.Parse(taxes[1].Trim(), CultureInfo.InvariantCulture),
+                            DiscountAmount = decimal.Parse(taxes[2].Trim(), CultureInfo.InvariantCulture),
+                            BaseAmount = decimal.Parse(taxes[3].Trim(), CultureInfo.InvariantCulture),
+                            VatAmount = decimal.Parse(taxes[4].Trim(), CultureInfo.InvariantCulture),
+                            AmountIncludingVAT = decimal.Parse(taxes[5].Trim(), CultureInfo.InvariantCulture)
+                        });
                     }
                     catch (Exception exc)
                     {
@@ -56,7 +64,15 @@ protected virtual SortedDictionary<decimal, decimal> ParseTaxRates(string taxRat
 
             //add at least one tax rate (0%)
             if (!taxRatesDictionary.Any())
-                taxRatesDictionary.Add(decimal.Zero, decimal.Zero);
+                taxRatesDictionary.Add(decimal.Zero, new TaxRateRec()
+                {
+                    VatRate = decimal.Zero,
+                    Amount = decimal.Zero,
+                    DiscountAmount = decimal.Zero,
+                    BaseAmount = decimal.Zero,
+                    VatAmount = decimal.Zero,
+                    AmountIncludingVAT = decimal.Zero
+                });
 
             return taxRatesDictionary;
         }
@@ -196,7 +212,7 @@ protected virtual SortedDictionary<decimal, decimal> ParseTaxRates(string taxRat
         public decimal OrderDiscount { get; set; }
 
         /// <summary>
-        /// Gets or sets the order total
+        /// Gets or sets the order total to pay
         /// </summary>
         public decimal OrderTotal { get; set; }
 
@@ -209,7 +225,7 @@ protected virtual SortedDictionary<decimal, decimal> ParseTaxRates(string taxRat
         /// Gets or sets the reward points history entry identifier when reward points were earned (gained) for placing this order
         /// </summary>
         public int? RewardPointsHistoryEntryId { get; set; }
-        
+
         /// <summary>
         /// Gets or sets the checkout attribute description
         /// </summary>
@@ -309,7 +325,7 @@ protected virtual SortedDictionary<decimal, decimal> ParseTaxRates(string taxRat
         /// Gets or sets the paid date and time
         /// </summary>
         public DateTime? PaidDateUtc { get; set; }
-        
+
         /// <summary>
         /// Gets or sets the shipping method
         /// </summary>
@@ -335,6 +351,24 @@ protected virtual SortedDictionary<decimal, decimal> ParseTaxRates(string taxRat
         /// </summary>
         public DateTime CreatedOnUtc { get; set; }
 
+        /// <summary>
+        /// Gets or sets the invoice ID
+        /// </summary>
+        public string InvoiceId { get; set; }
+        /// <summary>
+        /// Gets or sets the invoice date UTC
+        /// </summary>
+        public DateTime? InvoiceDateUtc { get; set; }
+
+        /// <summary>
+        /// Gets or sets the order total base amount excl. tax
+        /// </summary>
+        public decimal OrderAmount { get; set; } //MF 09.12.16
+
+        /// <summary>
+        /// Gets or sets the order total amount incl. tax
+        /// </summary>
+        public decimal OrderAmountIncl { get; set; } //MF 09.12.16
         #endregion
 
         #region Navigation properties
@@ -476,14 +510,26 @@ public TaxDisplayType CustomerTaxDisplayType
         /// <summary>
         /// Gets the applied tax rates
         /// </summary>
-        public SortedDictionary<decimal, decimal> TaxRatesDictionary
+        public SortedDictionary<decimal, TaxRateRec> TaxRatesDictionary
         {
             get
             {
                 return ParseTaxRates(this.TaxRates);
             }
         }
-        
+
         #endregion
     }
+
+    #region Nested classes
+    public partial class TaxRateRec
+    {
+        public decimal VatRate { get; set; }
+        public decimal Amount { get; set; }
+        public decimal DiscountAmount { get; set; }
+        public decimal BaseAmount { get; set; }
+        public decimal VatAmount { get; set; }
+        public decimal AmountIncludingVAT { get; set; }
+    }
+    #endregion
 }

src/Libraries/Nop.Core/Domain/Orders/OrderItem.cs

@@ -75,7 +75,7 @@ public partial class OrderItem : BaseEntity
         /// Gets or sets the product attributes in XML format
         /// </summary>
         public string AttributesXml { get; set; }
-        
+
         /// <summary>
         /// Gets or sets the download count
         /// </summary>
@@ -125,5 +125,10 @@ public virtual ICollection<GiftCard> AssociatedGiftCards
             get { return _associatedGiftCards ?? (_associatedGiftCards = new List<GiftCard>()); }
             protected set { _associatedGiftCards = value; }
         }
+
+        /// <summary>
+        /// VAT% of product
+        /// </summary>
+        public decimal VatRate { get; set; } //MF 25.11.16
     }
 }

src/Libraries/Nop.Core/Domain/Orders/OrderSettings.cs

@@ -120,6 +120,13 @@ public class OrderSettings : ISettings
         /// Gets or sets a value indicating whether an order status should be set to "Complete" only when its shipping status is "Delivered". Otherwise, "Shipped" status will be enough.
         /// </summary>
         public bool CompleteOrderWhenDelivered { get; set; }
-        
+        /// <summary>
+        /// Last issued Invoice Id
+        /// </summary>
+        public int InvoiceIdent { get; set; }
+        /// <summary>
+        /// Last issued Invoice Date
+        /// </summary>
+        public int InvoiceYear { get; set; }
     }
 }

src/Libraries/Nop.Core/Domain/Orders/ShoppingCartItem.cs

@@ -43,7 +43,6 @@ public partial class ShoppingCartItem : BaseEntity
         /// Gets or sets the quantity
         /// </summary>
         public int Quantity { get; set; }
-
         /// <summary>
         /// Gets or sets the rental product start date (null if it's not a rental product)
         /// </summary>
@@ -63,7 +62,7 @@ public partial class ShoppingCartItem : BaseEntity
         /// Gets or sets the date and time of instance update
         /// </summary>
         public DateTime UpdatedOnUtc { get; set; }
-        
+
         /// <summary>
         /// Gets the log type
         /// </summary>
@@ -119,7 +118,7 @@ public bool IsShipEnabled
 
         /// <summary>
         /// Gets the additional shipping charge
-        /// </summary> 
+        /// </summary>
         public decimal AdditionalShippingCharge
         {
             get
@@ -145,5 +144,19 @@ public bool IsTaxExempt
                 return false;
             }
         }
+        //fields for restored cart
+        /// <summary>
+        /// VatRate for restored cart. Only used by UpdateOrderTotal and can be null
+        /// </summary>
+        public decimal? VatRate { get; set; }
+        /// <summary>
+        /// Subtotal of item with tax
+        /// </summary>
+        public decimal? SubTotalInclTax { get; set; }
+
+        /// <summary>
+        /// Subtotal of item without tax
+        /// </summary>
+        public decimal? SubTotalExclTax { get; set; }
     }
 }

src/Libraries/Nop.Data/Mapping/Orders/OrderItemMap.cs

@@ -17,6 +17,7 @@ public OrderItemMap()
             this.Property(orderItem => orderItem.DiscountAmountExclTax).HasPrecision(18, 4);
             this.Property(orderItem => orderItem.OriginalProductCost).HasPrecision(18, 4);
             this.Property(orderItem => orderItem.ItemWeight).HasPrecision(18, 4);
+            this.Property(orderItem => orderItem.VatRate).HasPrecision(18, 4); //MF 25.11.16
 
 
             this.HasRequired(orderItem => orderItem.Order)

src/Libraries/Nop.Data/Mapping/Orders/OrderMap.cs

@@ -19,6 +19,8 @@ public OrderMap()
             this.Property(o => o.PaymentMethodAdditionalFeeExclTax).HasPrecision(18, 4);
             this.Property(o => o.OrderTax).HasPrecision(18, 4);
             this.Property(o => o.OrderDiscount).HasPrecision(18, 4);
+            this.Property(o => o.OrderAmount).HasPrecision(18, 4); //MF 09.12.16
+            this.Property(o => o.OrderAmountIncl).HasPrecision(18, 4); //MF 09.12.16
             this.Property(o => o.OrderTotal).HasPrecision(18, 4);
             this.Property(o => o.RefundedAmount).HasPrecision(18, 4);
 
@@ -27,11 +29,11 @@ public OrderMap()
             this.Ignore(o => o.ShippingStatus);
             this.Ignore(o => o.CustomerTaxDisplayType);
             this.Ignore(o => o.TaxRatesDictionary);
-            
+
             this.HasRequired(o => o.Customer)
                 .WithMany()
                 .HasForeignKey(o => o.CustomerId);
-            
+
             //code below is commented because it causes some issues on big databases - http://www.nopcommerce.com/boards/t/11126/bug-version-20-command-confirm-takes-several-minutes-using-big-databases.aspx
             //this.HasRequired(o => o.BillingAddress).WithOptional().Map(x => x.MapKey("BillingAddressId")).WillCascadeOnDelete(false);
             //this.HasOptional(o => o.ShippingAddress).WithOptionalDependent().Map(x => x.MapKey("ShippingAddressId")).WillCascadeOnDelete(false);

src/Libraries/Nop.Data/Mapping/Orders/ShoppingCartItemMap.cs

@@ -16,6 +16,9 @@ public ShoppingCartItemMap()
             this.Ignore(sci => sci.IsShipEnabled);
             this.Ignore(sci => sci.AdditionalShippingCharge);
             this.Ignore(sci => sci.IsTaxExempt);
+            this.Ignore(sci => sci.VatRate);
+            this.Ignore(sci => sci.SubTotalExclTax);
+            this.Ignore(sci => sci.SubTotalInclTax);
 
             this.HasRequired(sci => sci.Customer)
                 .WithMany(c => c.ShoppingCartItems)

src/Libraries/Nop.Services/Catalog/IPriceFormatter.cs

@@ -43,7 +43,7 @@ public partial interface IPriceFormatter
         /// <param name="showTax">A value indicating whether to show tax suffix</param>
         /// <param name="language">Language</param>
         /// <returns>Price</returns>
-        string FormatPrice(decimal price, bool showCurrency, 
+        string FormatPrice(decimal price, bool showCurrency,
             string currencyCode, bool showTax, Language language);
 
         /// <summary>
@@ -67,7 +67,7 @@ string FormatPrice(decimal price, bool showCurrency,
         /// <param name="language">Language</param>
         /// <param name="priceIncludesTax">A value indicating whether price includes tax</param>
         /// <returns>Price</returns>
-        string FormatPrice(decimal price, bool showCurrency, 
+        string FormatPrice(decimal price, bool showCurrency,
             Currency targetCurrency, Language language, bool priceIncludesTax);
 
         /// <summary>
@@ -80,7 +80,7 @@ string FormatPrice(decimal price, bool showCurrency,
         /// <param name="priceIncludesTax">A value indicating whether price includes tax</param>
         /// <param name="showTax">A value indicating whether to show tax suffix</param>
         /// <returns>Price</returns>
-        string FormatPrice(decimal price, bool showCurrency, 
+        string FormatPrice(decimal price, bool showCurrency,
             Currency targetCurrency, Language language, bool priceIncludesTax, bool showTax);
 
         /// <summary>
@@ -110,7 +110,7 @@ string FormatPrice(decimal price, bool showCurrency,
         /// <param name="language">Language</param>
         /// <param name="priceIncludesTax">A value indicating whether price includes tax</param>
         /// <returns>Price</returns>
-        string FormatShippingPrice(decimal price, bool showCurrency, 
+        string FormatShippingPrice(decimal price, bool showCurrency,
             Currency targetCurrency, Language language, bool priceIncludesTax);
         /// <summary>
         /// Formats the shipping price
@@ -122,9 +122,9 @@ string FormatShippingPrice(decimal price, bool showCurrency,
         /// <param name="priceIncludesTax">A value indicating whether price includes tax</param>
         /// <param name="showTax">A value indicating whether to show tax suffix</param>
         /// <returns>Price</returns>
-        string FormatShippingPrice(decimal price, bool showCurrency, 
+        string FormatShippingPrice(decimal price, bool showCurrency,
             Currency targetCurrency, Language language, bool priceIncludesTax, bool showTax);
-        
+
         /// <summary>
         /// Formats the shipping price
         /// </summary>
@@ -134,7 +134,7 @@ string FormatShippingPrice(decimal price, bool showCurrency,
         /// <param name="language">Language</param>
         /// <param name="priceIncludesTax">A value indicating whether price includes tax</param>
         /// <returns>Price</returns>
-        string FormatShippingPrice(decimal price, bool showCurrency, 
+        string FormatShippingPrice(decimal price, bool showCurrency,
             string currencyCode, Language language, bool priceIncludesTax);
 
 
@@ -169,7 +169,7 @@ string FormatPaymentMethodAdditionalFee(decimal price, bool showCurrency,
         /// <param name="priceIncludesTax">A value indicating whether price includes tax</param>
         /// <param name="showTax">A value indicating whether to show tax suffix</param>
         /// <returns>Price</returns>
-        string FormatPaymentMethodAdditionalFee(decimal price, bool showCurrency, 
+        string FormatPaymentMethodAdditionalFee(decimal price, bool showCurrency,
             Currency targetCurrency, Language language, bool priceIncludesTax, bool showTax);
 
         /// <summary>
@@ -181,7 +181,7 @@ string FormatPaymentMethodAdditionalFee(decimal price, bool showCurrency,
         /// <param name="language">Language</param>
         /// <param name="priceIncludesTax">A value indicating whether price includes tax</param>
         /// <returns>Price</returns>
-        string FormatPaymentMethodAdditionalFee(decimal price, bool showCurrency, 
+        string FormatPaymentMethodAdditionalFee(decimal price, bool showCurrency,
             string currencyCode, Language language, bool priceIncludesTax);
 
 
@@ -192,5 +192,24 @@ string FormatPaymentMethodAdditionalFee(decimal price, bool showCurrency,
         /// <param name="taxRate">Tax rate</param>
         /// <returns>Formatted tax rate</returns>
         string FormatTaxRate(decimal taxRate);
+
+        /// <summary>
+        /// Adds tax suffix to text
+        /// </summary>
+        /// <param name="text">Text to format</param>
+        /// <param name="language">Language</param>
+        /// <param name="priceIncludesTax">A value indicating whether price includes tax</param>
+        /// <returns></returns>
+        string FormatTaxString(string text, Language language, bool priceIncludesTax);
+
+        /// <summary>
+        /// Adds tax suffix to text
+        /// </summary>
+        /// <param name="text">Text to format</param>
+        /// <param name="language">Language</param>
+        /// <param name="priceIncludesTax">A value indicating whether price includes tax</param>
+        /// <param name="showTax">Optional. A value indicating whether to show tax suffix.</param>
+        /// <returns></returns>
+        string FormatTaxString(string text, Language language, bool priceIncludesTax, bool showTax);
     }
 }