Class Shipment

Represents a simplic shipment

Inheritance

System.Object

Shipment

Namespace: Simplic.PlugIn.Logistics.Disposition

Assembly: Simplic.PlugIn.Logistics.dll

Syntax

public class Shipment : IMultiTenantCompatible

Constructors

Shipment()

Initialize new shipment

Declaration

public Shipment()

Properties

ActiveTourId

Gets or sets the currently active tour id

Declaration

public Guid? ActiveTourId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

ActualFromLoadDate

Gets or sets the actual begin load date

Declaration

public DateTime? ActualFromLoadDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

ActualFromLoadTime

Gets or sets the begin load time

Declaration

public TimeSpan? ActualFromLoadTime { get; set; }

Property Value

Type	Description
System.Nullable<System.TimeSpan>

ActualFromUnloadDate

Gets or sets the actual unload date (start)

Declaration

public DateTime? ActualFromUnloadDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

ActualFromUnloadTime

Gets or sets the actual unload time (start)

Declaration

public TimeSpan? ActualFromUnloadTime { get; set; }

Property Value

Type	Description
System.Nullable<System.TimeSpan>

ActualToLoadDate

Gets or sets the load date

Declaration

public DateTime? ActualToLoadDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

ActualToLoadTime

Gets or sets the actual load date (to/end)

Declaration

public TimeSpan? ActualToLoadTime { get; set; }

Property Value

Type	Description
System.Nullable<System.TimeSpan>

ActualToUnloadDate

Gets or sets the actual unload date (end)

Declaration

public DateTime? ActualToUnloadDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

ActualToUnloadTime

Gets or sets the actual unload time (end)

Declaration

public TimeSpan? ActualToUnloadTime { get; set; }

Property Value

Type	Description
System.Nullable<System.TimeSpan>

CacheScope

Gets the cache scope

Declaration

[Browsable(false)]
public CacheScope CacheScope { get; }

Property Value

Type	Description
CacheScope

CalculatedCarrierValueSum

Declaration

public PreciseDecimal CalculatedCarrierValueSum { get; }

Property Value

Type	Description
PreciseDecimal

CalculatedCustomerValueSum

Declaration

public PreciseDecimal CalculatedCustomerValueSum { get; }

Property Value

Type	Description
PreciseDecimal

CalculatedSupplierValueSum

Add calculated supplier value sum

Declaration

public PreciseDecimal CalculatedSupplierValueSum { get; }

Property Value

Type	Description
PreciseDecimal

CalculateRoute

Gets or sets whether to calculuate route and toll information

Declaration

public bool CalculateRoute { get; set; }

Property Value

Type	Description
System.Boolean

CarrierAddress

Gets the carrier address based on the id and sets the carrier address

Declaration

public SAC.Contact.Contact CarrierAddress { get; set; }

Property Value

Type	Description
SAC.Contact.Contact

CarrierAddressId

Gets or sets the carrierAddressId

Declaration

public Guid? CarrierAddressId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

CarrierQuantitySum

Declaration

public PreciseDecimal CarrierQuantitySum { get; }

Property Value

Type	Description
PreciseDecimal

CarrierValueSum

Declaration

public PreciseDecimal CarrierValueSum { get; }

Property Value

Type	Description
PreciseDecimal

ConstructionSiteId

Gets or sets the construction site id.

Declaration

public Guid? ConstructionSiteId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

ContinuousNumber

Gets or sets a continuous number

Declaration

public long ContinuousNumber { get; set; }

Property Value

Type	Description
System.Int64

ContractId

Gets or sets the contract id.

Declaration

public Guid? ContractId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

ContractItemId

Gets or sets the contract item id.

Declaration

public Guid? ContractItemId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

CreateDateTime

Gets or sets the create date time

Declaration

public DateTime CreateDateTime { get; set; }

Property Value

Type	Description
System.DateTime

CreateUserId

Gets or sets the create user id

Declaration

public int CreateUserId { get; set; }

Property Value

Type	Description
System.Int32

CurrentPricing

Gets the current pricig configuration

Declaration

public PricingConfigurationInformation CurrentPricing { get; }

Property Value

Type	Description
PricingConfigurationInformation

CustomerLoadNumber

Gets or sets the customer load number

Declaration

public string CustomerLoadNumber { get; set; }

Property Value

Type	Description
System.String

CustomerQuantitySum

Declaration

public PreciseDecimal CustomerQuantitySum { get; }

Property Value

Type	Description
PreciseDecimal

CustomerUnloadNumber

Gets or sets the external customer unload number

Declaration

public string CustomerUnloadNumber { get; set; }

Property Value

Type	Description
System.String

CustomerValueSum

Declaration

public PreciseDecimal CustomerValueSum { get; }

Property Value

Type	Description
PreciseDecimal

CustomPricingConfigurationId

Gets or sets the custom pricing configuration id

Declaration

public Guid? CustomPricingConfigurationId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

DeliveryAddress

Gets the delivery address contact based on the id and sets the delivery address contact

Declaration

public SAC.Contact.Contact DeliveryAddress { get; set; }

Property Value

Type	Description
SAC.Contact.Contact

DeliveryAddressId

Gets or sets the unique delivery address

Declaration

public Guid DeliveryAddressId { get; set; }

Property Value

Type	Description
System.Guid

DeliveryAddressLatitude

Gets or sets the latitude of the delivery address

Declaration

public double? DeliveryAddressLatitude { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

DeliveryAddressLongitude

Gets or sets the longitude of the delivery address

Declaration

public double? DeliveryAddressLongitude { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

DeliveryTelematicWorkflow

Gets or sest the DeliveryTelematicWorkflow

Declaration

public TelematicWorkflow DeliveryTelematicWorkflow { get; set; }

Property Value

Type	Description
TelematicWorkflow

DeliveryTelematicWorkflowId

Gets or sets the DeliveryTelematicWorkflowId

Declaration

public Guid DeliveryTelematicWorkflowId { get; set; }

Property Value

Type	Description
System.Guid

DistanceToDeliveryAddress

Gets or sets the distance from the current position to the delivery address in meter

Declaration

public int DistanceToDeliveryAddress { get; set; }

Property Value

Type	Description
System.Int32

Documents

Gets or sets a list of documents

Declaration

public StatefulCollection<ShipmentDocument> Documents { get; set; }

Property Value

Type	Description
StatefulCollection<ShipmentDocument>

DurationInMinutes

Gets or sets the time in minutes which is required for the shipment

Declaration

public int DurationInMinutes { get; set; }

Property Value

Type	Description
System.Int32

ExtShipmentNr

Gets or sets the external shipment number

Declaration

public string ExtShipmentNr { get; set; }

Property Value

Type	Description
System.String

ForwarderAddress

Gets or sets the ForwarderAddress

Declaration

public SAC.Contact.Contact ForwarderAddress { get; set; }

Property Value

Type	Description
SAC.Contact.Contact

ForwarderAddressId

Gets or sets the ForwarderAddressId

Declaration

public Guid? ForwarderAddressId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

FreightPayerAddress

Gets or sets the FreightPayer

Declaration

public SAC.Contact.Contact FreightPayerAddress { get; set; }

Property Value

Type	Description
SAC.Contact.Contact

FreightPayerAddressId

Gets or sets the FreightPayerId

Declaration

public Guid? FreightPayerAddressId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

FromLoadDate

Gets or set the first possible load date

Declaration

public DateTime FromLoadDate { get; set; }

Property Value

Type	Description
System.DateTime

FromLoadDateTime

Gets the from load date and time

Declaration

public DateTime FromLoadDateTime { get; }

Property Value

Type	Description
System.DateTime

FromLoadTime

Gets or sets the first possibble load time

Declaration

public TimeSpan FromLoadTime { get; set; }

Property Value

Type	Description
System.TimeSpan

FromUnloadDate

Gets or sets the first possible unload date

Declaration

public DateTime FromUnloadDate { get; set; }

Property Value

Type	Description
System.DateTime

FromUnloadDateTime

Gets the from unload date and time

Declaration

public DateTime FromUnloadDateTime { get; }

Property Value

Type	Description
System.DateTime

FromUnloadTime

Gets or sets the first possible unload time

Declaration

public TimeSpan FromUnloadTime { get; set; }

Property Value

Type	Description
System.TimeSpan

GlobalShipmentId

Gets or sets a global shipment it

Declaration

public Guid? GlobalShipmentId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

HasBillableShipmentCarrier

Gets or sets whether any item with carrierstatus open exists

Declaration

public bool HasBillableShipmentCarrier { get; }

Property Value

Type	Description
System.Boolean

HasBillableShipmentCustomer

Gets or sets whether any item with status open exists

Declaration

public bool HasBillableShipmentCustomer { get; }

Property Value

Type	Description
System.Boolean

HasLoadingTimeSlot

Gets or sets whether a loading slot exists

Declaration

public bool HasLoadingTimeSlot { get; set; }

Property Value

Type	Description
System.Boolean

HasUnloadingTimeSlot

Gets or sets whether a unloading slot exists

Declaration

public bool HasUnloadingTimeSlot { get; set; }

Property Value

Type	Description
System.Boolean

Id

Gets/sets guid

Declaration

public Guid Id { get; set; }

Property Value

Type	Description
System.Guid

IsDeleted

Gets or sets whether the shipment is deleted

Declaration

public bool IsDeleted { get; set; }

Property Value

Type	Description
System.Boolean

IsFinished

Gets or sets whether the shipment is finished

Declaration

public bool IsFinished { get; set; }

Property Value

Type	Description
System.Boolean

IsSplitted

Gets or sets whether the item is splitted

Declaration

public bool IsSplitted { get; set; }

Property Value

Type	Description
System.Boolean

IsStarted

Gets or sets whether the shipment is started yet

Declaration

public bool IsStarted { get; set; }

Property Value

Type	Description
System.Boolean

IsTemplate

Gets or sets whether the current shipment is a template

Declaration

public bool IsTemplate { get; set; }

Property Value

Type	Description
System.Boolean

Items

Gets a stateful collection of positions

Declaration

public StatefulCollection<ShipmentItem> Items { get; }

Property Value

Type	Description
StatefulCollection<ShipmentItem>

LoadAddress

Gets the load address contact based on the id and sets the load address contact

Declaration

public SAC.Contact.Contact LoadAddress { get; set; }

Property Value

Type	Description
SAC.Contact.Contact

LoadAddressId

Gets or sets the unique load address

Declaration

public Guid LoadAddressId { get; set; }

Property Value

Type	Description
System.Guid

LoadAddressLatitude

Gets or sets the latitude of the load address

Declaration

public double? LoadAddressLatitude { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

LoadAddressLongitude

Gets or sets the longitude of the load address

Declaration

public double? LoadAddressLongitude { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

LoadDeliveryAddressChanged

Declaration

public bool LoadDeliveryAddressChanged { get; set; }

Property Value

Type	Description
System.Boolean

LoadingMetersSum

Declaration

public PreciseDecimal LoadingMetersSum { get; }

Property Value

Type	Description
PreciseDecimal

LoadTelematicWorkflow

Declaration

public TelematicWorkflow LoadTelematicWorkflow { get; }

Property Value

Type	Description
TelematicWorkflow

LoadTelematicWorkflowId

Declaration

public Guid LoadTelematicWorkflowId { get; set; }

Property Value

Type	Description
System.Guid

Notes

Gets or sets a notes field

Declaration

public string Notes { get; set; }

Property Value

Type	Description
System.String

OrderDate

Gets or sets the order date

Declaration

public DateTime OrderDate { get; set; }

Property Value

Type	Description
System.DateTime

PitchesSum

Declaration

public PreciseDecimal PitchesSum { get; }

Property Value

Type	Description
PreciseDecimal

ReceiverAddress

Gets or sets the ReceiverAddress

Declaration

public SAC.Contact.Contact ReceiverAddress { get; set; }

Property Value

Type	Description
SAC.Contact.Contact

ReceiverAddressId

Gets or sets the ReceiverAddressId

Declaration

public Guid? ReceiverAddressId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

RecipientAddress

Gets the recipient address contact based on the id and sets the recipient address contact

Declaration

public SAC.Contact.Contact RecipientAddress { get; set; }

Property Value

Type	Description
SAC.Contact.Contact

RecipientAddressId

Gets or sets the unique recipient address (Where the unload is done)

Declaration

public Guid? RecipientAddressId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

RequiredTimeInMinutes

Gets or sets the time that is required to finish this tour

Declaration

public int RequiredTimeInMinutes { get; set; }

Property Value

Type	Description
System.Int32

ScheduledFromLoadDate

Gets or sets the actual begin scheduled date

Declaration

public DateTime? ScheduledFromLoadDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

ScheduledFromLoadTime

Gets or sets the begin scheduled time

Declaration

public TimeSpan? ScheduledFromLoadTime { get; set; }

Property Value

Type	Description
System.Nullable<System.TimeSpan>

ScheduledFromUnloadDate

Gets or sets the scheduled unload date (start)

Declaration

public DateTime? ScheduledFromUnloadDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

ScheduledFromUnloadTime

Gets or sets the scheduled unload time (start)

Declaration

public TimeSpan? ScheduledFromUnloadTime { get; set; }

Property Value

Type	Description
System.Nullable<System.TimeSpan>

ScheduledToLoadDate

Gets or sets the scheduled date

Declaration

public DateTime? ScheduledToLoadDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

ScheduledToLoadTime

Gets or sets the scheduled load date (to/end)

Declaration

public TimeSpan? ScheduledToLoadTime { get; set; }

Property Value

Type	Description
System.Nullable<System.TimeSpan>

ScheduledToUnloadDate

Gets or sets the scheduled unload date (end)

Declaration

public DateTime? ScheduledToUnloadDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

ScheduledToUnloadTime

Gets or sets the scheduled unload time (end)

Declaration

public TimeSpan? ScheduledToUnloadTime { get; set; }

Property Value

Type	Description
System.Nullable<System.TimeSpan>

SelectedTenant

Gets or sets the currently selected tenant

Declaration

public OrganizationTenant SelectedTenant { get; set; }

Property Value

Type	Description
OrganizationTenant

SenderAddress

Gets the sender address contact based on the id and sets the sender address contact

Declaration

public SAC.Contact.Contact SenderAddress { get; set; }

Property Value

Type	Description
SAC.Contact.Contact

SenderAddressId

Gets or sets the unique sender address

Declaration

public Guid? SenderAddressId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

ShipmentNr

Gets or sets the internal shipment number

Declaration

public string ShipmentNr { get; set; }

Property Value

Type	Description
System.String

ShipName

Gets or sets the ShipName

Declaration

public string ShipName { get; set; }

Property Value

Type	Description
System.String

SplitParentId

Gets or sets the id of a splitted shipment

Declaration

public Guid? SplitParentId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

Status

gets or sets the status

Declaration

public ShipmentStatus Status { get; set; }

Property Value

Type	Description
ShipmentStatus

StatusCarrier

Gets or sets the billing status for the freight carrier

Declaration

public Guid StatusCarrier { get; set; }

Property Value

Type	Description
System.Guid

StatusCustomer

Gets or sets the billing status for the customer

Declaration

public Guid StatusCustomer { get; set; }

Property Value

Type	Description
System.Guid

StatusId

gets or sets the Status Id

Declaration

public Guid StatusId { get; set; }

Property Value

Type	Description
System.Guid

StatusSupplier

Gets or sets the billing status for the supplier

Declaration

public Guid StatusSupplier { get; set; }

Property Value

Type	Description
System.Guid

Tags

Gets or sets the tags

Declaration

public StatefulCollection<ShipmentTag> Tags { get; set; }

Property Value

Type	Description
StatefulCollection<ShipmentTag>

TemplateName

Gets or sets the TemplateName

Declaration

public string TemplateName { get; set; }

Property Value

Type	Description
System.String

TenantId

Gets or sets the currently selected tenants

Declaration

public Guid TenantId { get; set; }

Property Value

Type	Description
System.Guid

Tenants

Gets or sets all organization tenants

Declaration

public ObservableCollection<OrganizationTenant> Tenants { get; set; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<OrganizationTenant>

Toll

Declaration

public PreciseDecimal Toll { get; set; }

Property Value

Type	Description
PreciseDecimal

TollDistance

Declaration

public int TollDistance { get; set; }

Property Value

Type	Description
System.Int32

TollFactor

Declaration

public PreciseDecimal TollFactor { get; set; }

Property Value

Type	Description
PreciseDecimal

ToLoadDate

Gets or sets the last possible load date

Declaration

public DateTime ToLoadDate { get; set; }

Property Value

Type	Description
System.DateTime

ToLoadDateTime

Gets the to load date and time

Declaration

public DateTime ToLoadDateTime { get; }

Property Value

Type	Description
System.DateTime

ToLoadTime

Gets or sets the last possible load time

Declaration

public TimeSpan ToLoadTime { get; set; }

Property Value

Type	Description
System.TimeSpan

ToUnloadDate

Gets or sets the last possible unload date

Declaration

public DateTime ToUnloadDate { get; set; }

Property Value

Type	Description
System.DateTime

ToUnloadDateTime

Gets the to unload date and time

Declaration

public DateTime ToUnloadDateTime { get; }

Property Value

Type	Description
System.DateTime

ToUnloadTime

Gets or sets the last possible unload time

Declaration

public TimeSpan ToUnloadTime { get; set; }

Property Value

Type	Description
System.TimeSpan

Tours

Gets or sets a list of tours which are connected to the shipment

Declaration

public StatefulCollection<Tour> Tours { get; set; }

Property Value

Type	Description
StatefulCollection<Tour>

TradingUnitSum

Gets or sets the trading unit

Declaration

public PreciseDecimal TradingUnitSum { get; }

Property Value

Type	Description
PreciseDecimal

TranshipPartialShipments

Gets or sets a collection of observable collections

Declaration

public StatefulCollection<TranshipPartialShipment> TranshipPartialShipments { get; set; }

Property Value

Type	Description
StatefulCollection<TranshipPartialShipment>

TransportOrder

Gets or sets the current transport order

Declaration

public TransportOrder TransportOrder { get; set; }

Property Value

Type	Description
TransportOrder

TransportOrderId

Gets or sets the TransporOrder id

Declaration

public Guid? TransportOrderId { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

TransportOrderReservation

Declaration

public bool TransportOrderReservation { get; set; }

Property Value

Type	Description
System.Boolean

TransportOrderReservationDateTime

Declaration

public DateTime? TransportOrderReservationDateTime { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

TransportOrderReservationUserId

Declaration

public int? TransportOrderReservationUserId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

UpdateDateTime

Gets or sets the update date time

Declaration

public DateTime UpdateDateTime { get; set; }

Property Value

Type	Description
System.DateTime

UpdateUserId

Gets or sets the update user id

Declaration

public int UpdateUserId { get; set; }

Property Value

Type	Description
System.Int32

WeightSum

Declaration

public PreciseDecimal WeightSum { get; }

Property Value

Type	Description
PreciseDecimal

Methods

CalculateTranships()

Calculates and recalculates the Tranship information

Declaration

public void CalculateTranships()

DeepCopy(Boolean)

Create a deep copy from the current shipment

Declaration

public Shipment DeepCopy(bool newId)

Parameters

Type	Name	Description
System.Boolean	newId	True if a new id should be generated

Returns

Type	Description
Shipment	New shipment instance

ExecutePricingConnfigurationCustomer(Guid)

Executes the pricing configuration for th ecurrent shipment

Declaration

public async Task ExecutePricingConnfigurationCustomer(Guid pricingConfigurationId)

Parameters

Type	Name	Description
System.Guid	pricingConfigurationId

Returns

Type	Description
System.Threading.Tasks.Task

LoadDocuments()

Load shipment documents

Declaration

public StatefulCollection<ShipmentDocument> LoadDocuments()

Returns

Type	Description
StatefulCollection<ShipmentDocument>

LoadItems()

Loads a collection of positions

Declaration

public StatefulCollection<ShipmentItem> LoadItems()

Returns

Type	Description
StatefulCollection<ShipmentItem>	Collection of positions

LoadItemsAsync()

Declaration

public async Task<StatefulCollection<ShipmentItem>> LoadItemsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<StatefulCollection<ShipmentItem>>

LoadTags()

Loads the tags for this shipment

Declaration

public StatefulCollection<ShipmentTag> LoadTags()

Returns

Type	Description
StatefulCollection<ShipmentTag>

LoadTours()

Load all tours that are connected with this shipment

Declaration

public ICollection<Tour> LoadTours()

Returns

Type	Description
System.Collections.Generic.ICollection<Tour>	Collection of tours

LoadTranshipPartialShipments()

Declaration

public StatefulCollection<TranshipPartialShipment> LoadTranshipPartialShipments()

Returns

Type	Description
StatefulCollection<TranshipPartialShipment>

Merge(Shipment, Shipment)

Undo a split process and merge shipments

Declaration

protected void Merge(Shipment source, Shipment target)

Parameters

Type	Name	Description
Shipment	source
Shipment	target

RefreshLatitudeLongitude()

Refresh latitude and longitude for load and delivery address

Declaration

public void RefreshLatitudeLongitude()

RefreshPricing()

Function to call whenever a freight payer is refrehsed (freight payer or sender)

Declaration

public async Task RefreshPricing()

Returns

Type	Description
System.Threading.Tasks.Task

Split(IList<ShipmentItemSplit>)

Split the current shipment into a new shipment and merge items

Declaration

public Shipment Split(IList<ShipmentItemSplit> items)

Parameters

Type	Name	Description
System.Collections.Generic.IList<ShipmentItemSplit>	items	Splitting information

Returns

Type	Description
Shipment	List of new splitted items

UndoSplit(Boolean, IList<Shipment>)

Undo a split process and merge shipments

Declaration

public IList<Shipment> UndoSplit(bool mergeIntoParent, IList<Shipment> preLoadedShipments = null)

Parameters

Type	Name	Description
System.Boolean	mergeIntoParent	If set to true, the current shipment will be merged into its parent too
System.Collections.Generic.IList<Shipment>	preLoadedShipments	List of already loaded shipment objects. This will be used for merging if required. Missing shipments will be loaded automatically

Returns

Type	Description
System.Collections.Generic.IList<Shipment>	List of changed shipments

Events

UndoSplitNotAllowed

Declaration

public event Shipment.UndoSplitNotAllowedEventHandler UndoSplitNotAllowed

Event Type

Type	Description
Shipment.UndoSplitNotAllowedEventHandler