Click or drag to resize

IShippingEntity Interface

represente the Shipping entity

(Frais de port)

Namespace:  EBP.Api.Interfaces.Invoicing.Module.Entities.Shipping
Assembly:  EBP.Api.XXX.Interfaces (in EBP.Api.XXX.Interfaces.dll) Version: 1.0.3.0
Syntax
[GuidAttribute("4626A67E-A25D-45c4-867D-06BE6004CA19")]
public interface IShippingEntity : IInvoicingEntityBase, 
	IBusinessEntityBase, ISynchronizableEntityBase, IEntity, IApiEntity, IDisposable, 
	IEquatable<IProxy>

The IShippingEntity type exposes the following members.

Properties
  NameDescription
Public propertyAccounts
get the Accounts
Public propertyApplyOnType

Gets or sets the type of the apply on.

List of authorized values in ShippingApplyOnType

(Applicable sur)

Public propertyApplyOnTypeMember

Gets the type of the apply on.

List of authorized values in ShippingApplyOnType

(Applicable sur)

Public propertyCalculationMode

Gets or sets the CalculationMode

List of authorized values in CalculationModeType

(Mode de calcul)

Public propertyCalculationModeMember

get the CalculationMode

List of authorized values in CalculationModeType

(Mode de calcul)

Public propertyCalculationValue

Gets or sets the CalculationValue

(Valeur)

Public propertyCalculationValueMember

get the CalculationValue

(Valeur)

Public propertyCaption

Gets or sets the Caption

(Libellé)

Public propertyCaptionMember

get the Caption

(Libellé)

Public propertyCarrierAddress
get the CarrierAddress
Public propertyCarrierContact
get the CarrierContact
Public propertyCreatedDate
Gets the Created Date
(Inherited from IEntity.)
Public propertyCreatedUser
Gets the Created User
(Inherited from IEntity.)
Public propertyEntityCaption
Gets the caption of the current entity, using the content
(Inherited from IEntity.)
Public propertyEntityLabel
Gets the entity Label
(Inherited from IEntity.)
Public propertyErrors
Gets the collection of errors
(Inherited from IEntity.)
Public propertyId

Gets or sets the Id

(Code)

Public propertyIdMember

get the Id

(Code)

Public propertyIntrastatTransportMode

Gets or sets the transport mode

(Mode de transport)

Public propertyIntrastatTransportModeMember

Gets the transport mode

(Mode de transport)

Public propertyIsDeleted
Gets if the mode matches a deleted mode
(Inherited from IEntity.)
Public propertyIsEmptyLine
Indicates if the entity is an empty line of an entity collection (created in auto following the entityCollection options)
(Inherited from IEntity.)
Public propertyLevels
get the Levels
Public propertyMembers
List of the members. It allows to acces to members with the name
(Inherited from IEntity.)
Public propertyMode
Gets the entity mode
(Inherited from IEntity.)
Public propertyModifiedDate
Gets the Modified Date
(Inherited from IEntity.)
Public propertyModifiedUser
Gets the Modified User
(Inherited from IEntity.)
Public propertyNotes

Gets or sets the notes in RTF format.

(Notes)

(Inherited from IBusinessEntityBase.)
Public propertyNotesClear

Gets or sets the notes in plain text format.

(Notes en texte brut)

(Inherited from IBusinessEntityBase.)
Public propertyNotesClearMember

Gets the notes in plain text format.

(Notes en texte brut)

(Inherited from IBusinessEntityBase.)
Public propertyNotesMember

Gets the notes in RTF format.

(Notes)

(Inherited from IBusinessEntityBase.)
Public propertyNotSubjectToFinancialDiscount

Gets or sets whether the shipping is used to calculate financial discount amount in documents

(Non soumis à escompte)

Public propertyNotSubjectToFinancialDiscountMember

Gets whether the shipping is used to calculate financial discount amount in documents

(Non soumis à escompte)

Public propertyOwnerEntity
Gets the main entity that own all this items/collection
(Inherited from IEntity.)
Public propertyParent
Gets the parent entity collection, that own this item
(Inherited from IEntity.)
Public propertyReadOnly
Gets/Sets if the entity is in read only mode, to preserve from data changing
(Inherited from IEntity.)
Public propertySilent
Get/Sets if the entity is in silent mode
(Inherited from IEntity.)
Public propertyStates
Gets the entity states
(Inherited from IEntity.)
Public propertyUniqueId
Gets or sets the unique Id
(Inherited from ISynchronizableEntityBase.)
Public propertyUniqueIdMember
Gets the unique Id
(Inherited from ISynchronizableEntityBase.)
Public propertyVatId

Gets or sets the VatId

(Code TVA)

Public propertyVatIdMember

get the VatId

(Code TVA)

Public propertyVatRate

Gets the VAT rate from VAT

(Taux de TVA)

Public propertyVatRateMember

Gets the VAT rate from VAT

(Taux de TVA)

Public propertyVatTerritorialityId

Gets the territorialité ID of the VAT

List of authorized values (Ends with TerritorialityUniqueId) in IDatasHelper

(Territorialité)

Public propertyVatTerritorialityIdMember

Gets the territorialité ID of the VAT

List of authorized values (Ends with TerritorialityUniqueId) in IDatasHelper

(Territorialité)

Top
Methods
  NameDescription
Public methodAppend
Method for add a new entity to the media. Update the entity to its default value.
(Inherited from IEntity.)
Public methodCancel
Cancel the edit mode without saving, and reload the entity
(Inherited from IEntity.)
Public methodCancelEdit
Cancel the edit mode without saving, without reload the entity
(Inherited from IEntity.)
Public methodCheckData
Check the data of the entity
(Inherited from IEntity.)
Public methodClear
Clear the entity content and reinitialize it to the default value
(Inherited from IEntity.)
Public methodClone
Clone an entity
(Inherited from IEntity.)
Public methodCopyTo(IEntity)
Copy the entity content to another entity
(Inherited from IEntity.)
Public methodCopyTo(IEntity, Boolean)
Copy the entity content to another entity
(Inherited from IEntity.)
Public methodDelete
Method for delete a existing entity from the media
(Inherited from IEntity.)
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodEdit
Method to pass in edit mode a existing entity in the media (for exemple, add a lock for database)
(Inherited from IEntity.)
Public methodGetExtension
Gets the extension.
(Inherited from IApiEntity.)
Public methodLoad
Method for loading the entity
(Inherited from IEntity.)
Public methodSave
Method for saving the entity to the media
(Inherited from IEntity.)
Public methodSetComplexMemberReadOnly
Set the read only property to a member
(Inherited from IEntity.)
Public methodShowMessage
Method to display a message. The message is displayed if the UI has connected to the ShowMessage event
(Inherited from IApiEntity.)
Top
Events
  NameDescription
Public eventModeChanged
Event raised on mode changed
(Inherited from IEntity.)
Top
Remarks
The IShippingEntity type can be instantiated with EBP.Api.Utils<TExtension>.GetInterface<T>
IShippingEntity instance = Utils<ExtensionType>.GetInterface<IShippingEntity>();
See Also