Provides details about an incidental (e.g. additional fee).
Namespace:
BargeExAssembly: BargeEx (in BargeEx.dll)
Version: 3.0.400.140 (3.0.400.140)
Syntax
C# |
---|
[SerializableAttribute] public class Incidental : SerializableBase |
Visual Basic (Declaration) |
---|
<SerializableAttribute> _ Public Class Incidental _ Inherits SerializableBase |
Visual C++ |
---|
[SerializableAttribute] public ref class Incidental : public SerializableBase |
Remarks
This class represents an incidental or additional fee that was charged in addition to the standard fee for a product or service. This class includes billing rate information for the incidental or additional fee.
The following types of billing rates can be represented: flat fee or fixed rate (FixedRate), a unit and quantity rate (UnitRate), or a percentage rate (PercentageRate). The RateType property indicates what type of rate is represented by this class instance:
- If RateType is set to NotProvided, the FixedRateAmount, UnitRateUnitAmount, UnitRateQuantity, UnitRateQuantityUnitCode, PercentageRateBaseAmount, and PercentageRatePercentage properties should be disregarded.
-
If RateType
is set to FixedRate, the
FixedRateAmount
property will contain the rate. The
UnitRateUnitAmount,
UnitRateQuantity,
UnitRateQuantityUnitCode,
PercentageRateBaseAmount, and
PercentageRatePercentage
properties should be disregarded.
Cost = FixedRateAmount
-
If RateType
is set to UnitRate, the
UnitRateUnitAmount,
UnitRateQuantity, and
UnitRateQuantityUnitCode
properties should be set. The
FixedRateAmount,
PercentageRateBaseAmount, and
PercentageRatePercentage
properties should be disregarded.
Cost = UnitRateUnitAmount * UnitRateQuantity
- If RateType is set to PercentageRate, the PercentageRateBaseAmount and PercentageRatePercentage properties should be set. The FixedRateAmount, UnitRateUnitAmount, UnitRateQuantity, and UnitRateQuantityUnitCode properties should be disregarded.
Examples
The following example creates an instance of the
Incidental class
and sets its common properties.
CopyVisual Basic
' Create an Incidental object Dim Incidental As New BargeEx.Incidental ' Set the Incidental properties With Incidental .Code = BargeEx.CicaIncidentalCode.Fuel .Description = "Charging for extra fuel due to high water." ' Set the specified RateType to UnitRate .RateType = BargeEx.CicaRateType.UnitRate ' Set the associated unit rate properties .UnitRateUnitAmount = 50 .UnitRateQuantity = 5 .UnitRateQuantityUnitCode = BargeEx.CicaUnitRateQuantityUnitCode.Hour End With ' Incidental
CopyC#
// Create an Incidental object BargeEx.Incidental Incidental = new BargeEx.Incidental(); // Set the Incidental properties Incidental.Code = BargeEx.CicaIncidentalCode.Fuel; Incidental.Description = "Charging for extra fuel due to high water."; // Set the specified RateType to UnitRate Incidental.RateType = BargeEx.CicaRateType.UnitRate; // Set the associated unit rate properties Incidental.UnitRateUnitAmount = 50; Incidental.UnitRateQuantity = 5; Incidental.UnitRateQuantityUnitCode = BargeEx.CicaUnitRateQuantityUnitCode.Hour;