ERP/TradeManageNew/APIClients/FedexApi/Models/RatesAndTransitTimes/ShipmentRateDetail.cs

namespace TradeManageNew.APIClients.FedexApi.Models.RatesAndTransitTimes
{
    /// <summary>
    /// This is shipment level rate data.
    /// </summary>
    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "14.1.0.0 (NJsonSchema v11.0.2.0 (Newtonsoft.Json v13.0.0.0))")]
    public partial class ShipmentRateDetail
    {
        [Newtonsoft.Json.JsonProperty("currencyExchangeRate", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public CurrencyExchangeRate CurrencyExchangeRate { get; set; }

        /// <summary>
        /// Indicates the currency associated with the amount.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("currency", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public string Currency { get; set; }

        /// <summary>
        /// Indicates the rate zone used.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("rateZone", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public string RateZone { get; set; }

        /// <summary>
        /// Allows clients to determine whether to add charges at the package level when Per Piece Rating details are returned.&lt;br&gt;&lt;ul&gt;&lt;li&gt;SHIPMENT_WEIGHT_BASED - Indicates shipment weight is used to calculate the rate.&lt;/li&gt;&lt;br&gt;&lt;li&gt;FLAT_RATE_PER_PAK - Indicates shipment is rated based on number of packs, weight would be considered for overweight surcharge but not for calculating shipment rate.&lt;/li&gt;&lt;br&gt;&lt;li&gt;PACK_WEIGHT_BASED - Indicates individual package weight would be rated and aggregated to get shipment rate weight.&lt;/li&gt;&lt;/ul&gt; Example : SHIPMENT_WEIGHT_BASED.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("ratingBasis", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        [Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]
        public ShipmentRateDetailRatingBasis? RatingBasis { get; set; }

        /// <summary>
        /// Indicates the type of pricing code.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("pricingCode", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public string PricingCode { get; set; }

        /// <summary>
        /// Indicates the total discounts used in the rate calculation. Example: 856.32
        /// </summary>
        [Newtonsoft.Json.JsonProperty("totalFreightDiscount", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public double? TotalFreightDiscount { get; set; }

        /// <summary>
        /// Indicates which special rating cases applied to this shipment.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("specialRatingApplied", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public System.Collections.Generic.ICollection<string> SpecialRatingApplied { get; set; }

        /// <summary>
        /// This is sum of all surcharges on the package. Example: 586.25
        /// </summary>
        [Newtonsoft.Json.JsonProperty("totalSurcharges", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public double? TotalSurcharges { get; set; }

        /// <summary>
        /// This is total discount used in the rate calculation.&lt;br&gt;&lt;a onclick='loadDocReference("discounts")'&gt;Click here to see Discounts&lt;/a&gt;
        /// </summary>
        [Newtonsoft.Json.JsonProperty("freightDiscount", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public System.Collections.Generic.ICollection<RateDiscount> FreightDiscount { get; set; }

        /// <summary>
        /// This is fuel surcharge percentage.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("fuelSurchargePercent", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public double? FuelSurchargePercent { get; set; }

        /// <summary>
        /// This is total of billing weight for the shipment.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("totalBillingWeight", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public Weight_1 TotalBillingWeight { get; set; }

        /// <summary>
        /// This is total of dimensional weight for the shipment.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("totalDimWeight", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public Weight_1 TotalDimWeight { get; set; }

        /// <summary>
        /// Identifies the type of divisor that was applied.&lt;br&gt; Example: 10
        /// </summary>
        [Newtonsoft.Json.JsonProperty("dimDivisor", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public int? DimDivisor { get; set; }

        /// <summary>
        /// Indicates the surcharges applied to this shipment.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("surCharges", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public System.Collections.Generic.ICollection<Surcharge> SurCharges { get; set; }

        /// <summary>
        /// List of taxes.
        /// </summary>
        [Newtonsoft.Json.JsonProperty("taxes", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public System.Collections.Generic.ICollection<Tax> Taxes { get; set; }

        private System.Collections.Generic.IDictionary<string, object> _additionalProperties;

        [Newtonsoft.Json.JsonExtensionData]
        public System.Collections.Generic.IDictionary<string, object> AdditionalProperties
        {
            get { return _additionalProperties ?? (_additionalProperties = new System.Collections.Generic.Dictionary<string, object>()); }
            set { _additionalProperties = value; }
        }

    }
}