[SerializableAttribute]
public class InvoiceLineItem : CommonLineItem

<SerializableAttribute> _
Public Class InvoiceLineItem _
	Inherits CommonLineItem

[SerializableAttribute]
public ref class InvoiceLineItem : public CommonLineItem

This class represents an invoice line item.

Each invoice line item has a line item type, indicated by the LineItemType property, and some properties of the InvoiceLineItem class are only applicable to certain line item types. The following chart indicates which of these properties are applicable for the different CicaBargeEventStatusType values:

Status Type

Properties

Assist

BreakTow

Clean

CoverHandling

Delay

Fleeting

Load

MakeTow

MidstreamIn

MidstreamOut

Other

Pump

Repair

Shift

Unload

CargoCustomerName CargoCustomerIdentifier

CargoTransferStatus

CleanType

CommodityQuantity CommodityQuantityUnitCode

CoverHandlingType

DelayType

LineBoatName LineBoatMappedName LineBoatCoastGuardNumber

LoadStatus

PrimaryTransactionIdentifier PrimaryTransactionRevision

PumpType

RepairType

ToLocationName ToLocationMappedName ToLocationCode ToLocationShipName ToLocationMappedShipName ToLocationShipImoNumber

WaterwayName WaterwayMappedName WaterwayCode WaterwayMile WaterwayDirection WaterwayLatitude WaterwayLongitude

The following example creates an instance of the InvoiceLineItem class and sets its common properties.

CopyVisual Basic

' Create a new BargeEx InvoiceLineItem object
Dim InvoiceLineItem As New BargeEx.InvoiceLineItem()

' Update the InvoiceLineItems properties
With InvoiceLineItem

    ' Set the LineItem Details properties
    .LineItemNumber = 1
    .Description = "InvoiceLineItem test description."
    .LineItemAmount = 1000
    .Note = "InvoiceLineItem test note."

    ' Set the EventStatusType
    .LineItemType = BargeEx.CicaBargeEventStatusType.Assist

    ' Set the start and end date times
    .StartDateTime = DateTime.Parse("01/01/2008 16:00")
    .EndDateTime = DateTime.Parse("01/01/2008 16:00")

    ' Set Locaiton properties
    .LocationName = "Coal Dock #1"

    ' Set Waterway properties
    .WaterwayName = "Ohio River"
    .WaterwayMile = 123
    .WaterwayDirection = BargeEx.CicaWaterwayDirection.North

    ' Set LineBoat properties
    .LineBoatName = "Jerry K."

    ' Set Commodity properties
    .CommodityName = "Coal"

    ' Set Order Document Reference properties
    .OrderDocumentNumber = "XYZ123"

    ' Set the Status Document Reference properties
    .RelatedTransactionIdentifier = "ABC123"

    ' For the available RateInformation properties
    With .RateInformation

        ' Set the rate type to FixedRate
        .RateType = BargeEx.CicaRateType.FixedRate

        ' Set the rate information properties
        .FixedRateAmount = 200

        ' Add incidentals
        .Incidentals.Add(New BargeEx.Incidental(BargeEx.CicaIncidentalCode.Fuel, 100, 2))
        .Incidentals.Add(New BargeEx.Incidental(BargeEx.CicaIncidentalCode.HighWater, 50))

    End With ' .RateInformation


    ' Add equipment to the list
    ' Add Barges
    .Barges.Add(New BargeEx.Barge("CSG123"))
    .Barges.Add(New BargeEx.Barge("CSG456"))

    ' Add a Boat
    .Boats.Add(New BargeEx.Boat("Henry B."))

    ' Add other Equipment
    .OtherEquipmentItems.Add("Crane #1")

End With ' InvoiceLineItem

CopyC#

// Create a new BargeEx InvoiceLineItem object
BargeEx.InvoiceLineItem InvoiceLineItem = new BargeEx.InvoiceLineItem();

// Update the InvoiceLineItems properties
// Set the LineItem Details properties
InvoiceLineItem.LineItemNumber = 1;
InvoiceLineItem.Description = "InvoiceLineItem test description.";
InvoiceLineItem.LineItemAmount = 1000;
InvoiceLineItem.Note = "InvoiceLineItem test note.";

// Set the EventStatusType
InvoiceLineItem.LineItemType = BargeEx.CicaBargeEventStatusType.Assist;

// Set the start and end date times
InvoiceLineItem.StartDateTime = DateTime.Parse("01/01/2008 16:00");

InvoiceLineItem.EndDateTime = DateTime.Parse("01/01/2008 16:00");

// Set Locaiton properties
InvoiceLineItem.LocationName = "Coal Dock #1";

// Set Waterway properties
InvoiceLineItem.WaterwayName = "Ohio River";
InvoiceLineItem.WaterwayMile = 123;
InvoiceLineItem.WaterwayDirection = BargeEx.CicaWaterwayDirection.North;

// Set LineBoat properties
InvoiceLineItem.LineBoatName = "Jerry K.";

// Set Commodity properties
InvoiceLineItem.CommodityName = "Coal";

// Set Order Document Reference properties
InvoiceLineItem.OrderDocumentNumber = "XYZ123";

// Set the Status Document Reference properties
InvoiceLineItem.RelatedTransactionIdentifier = "ABC123";

// For the available RateInformation properties

// Set the rate type to FixedRate
InvoiceLineItem.RateInformation.RateType = BargeEx.CicaRateType.FixedRate;

// Set the rate information properties
InvoiceLineItem.RateInformation.FixedRateAmount = 200;

// Add incidentals
InvoiceLineItem.RateInformation.Incidentals.Add(new BargeEx.Incidental(BargeEx.CicaIncidentalCode.Fuel, 100, 2));
InvoiceLineItem.RateInformation.Incidentals.Add(new BargeEx.Incidental(BargeEx.CicaIncidentalCode.HighWater, 50));

// Add equipment to the list
// Add Barges
InvoiceLineItem.Barges.Add(new BargeEx.Barge("CSG123"));
InvoiceLineItem.Barges.Add(new BargeEx.Barge("CSG456"));

// Add a Boat
InvoiceLineItem.Boats.Add(new BargeEx.Boat("Henry B."));

// Add other Equipment
InvoiceLineItem.OtherEquipmentItems.Add("Crane #1");

System..::.Object
  BargeEx.Internal..::.SerializableBase
    BargeEx.Internal..::.CommonLineItem
      BargeEx..::.InvoiceLineItem