IApproachChargeDocumentLineEntity Interface

Approach charge document line entity : contains such datas from purchase document which be used to calculate approach charges. Only used to load datas not to save.

(Ligne de document de ventilation de frais d'approche)

Namespace: EBP.Api.Interfaces.Invoicing.Module.Entities.ApproachCharge
Assembly: EBP.Api.XXX.Interfaces (in EBP.Api.XXX.Interfaces.dll) Version: 1.0.3.0

Syntax

Copy

[GuidAttribute("ACC25DBA-5EE9-474A-B8F0-34CAF68143A4")]
public interface IApproachChargeDocumentLineEntity : IEntity<IApproachChargeDocumentLineEntity>, 
	IEntityItemBase, IEntity, IApiEntity, IDisposable, IEquatable<IProxy>

<GuidAttribute("ACC25DBA-5EE9-474A-B8F0-34CAF68143A4")>
Public Interface IApproachChargeDocumentLineEntity
	Inherits IEntity(Of IApproachChargeDocumentLineEntity), IEntityItemBase, IEntity, 
	IApiEntity, IDisposable, IEquatable(Of IProxy)

The IApproachChargeDocumentLineEntity type exposes the following members.

Properties

	Name	Description
	Children	collection of children entity. The collection is hierarchical, so an entity item has its own children (Inherited from IEntityT.)
	CostAmount	Gets or sets the cost amount (Prix de revient)
	CostAmountMember	Gets the cost amount (Prix de revient)
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	DescriptionClear	Gets or sets the description without RTF formatting (Description commerciale en clair)
	DescriptionClearMember	Gets the description without RTF formatting (Description commerciale en clair)
	DistributionBaseAmount	Gets or sets the distribution base amount
	DistributionBaseAmountMember	Gets the distribution base amount
	EntityCaption	Gets the caption of the current entity, using the content (Inherited from IEntity.)
	EntityLabel	Gets the entity Label (Inherited from IEntity.)
	Errors	Gets the collection of errors (Inherited from IEntity.)
	Id	Unique identifier of the line (Code ligne de document)
	IdMember	Unique identifier of the line (Code ligne de document)
	IsDeleted	Gets if the mode matches a deleted mode (Inherited from IEntity.)
	IsEmptyLine	Indicates if the entity is an empty line of an entity collection (created in auto following the entityCollection options) (Inherited from IEntity.)
	IsSelected	Gets or sets whether the document is selected
	IsSelectedMember	Gets whether the document is selected
	ItemId	Gets or sets the item id (Code article)
	ItemIdMember	Gets the item id (Code article)
	LineType	Gets or sets the type line List of authorized values in DocumentLineType (Type de ligne)
	LineTypeMember	Gets the type line List of authorized values in DocumentLineType (Type de ligne)
	Members	List of the members. It allows to acces to members with the name (Inherited from IEntity.)
	Mode	Gets the entity mode (Inherited from IEntity.)
	ModifiedDate	Gets the Modified Date (Inherited from IEntity.)
	ModifiedUser	Gets the Modified User (Inherited from IEntity.)
	NomenclatureLevel	Gets or sets the Nomenclature Level (Niveau de nomenclature)
	NomenclatureLevelMember	Gets the Nomenclature Level (Niveau de nomenclature)
	OwnerEntity	Gets the main entity that own all this items/collection (Inherited from IEntity.)
	Parent	Parent entity collection, that own this item (Inherited from IEntityT.)
	ParentEntity	The entity item is in collection, this collection can be the children collection of an other entity (because the hierarchical possibility), returns this entity. Correspond to Parent.Parent (Inherited from IEntityT.)
	ParentLineId	Gets or sets the parent line ID (Code de la ligne parente)
	ParentLineIdMember	Gets the parent line ID (Code de la ligne parente)
	PercentageDistribution	Gets or sets the percentage distribution
	PercentageDistributionMember	Gets the percentage distribution
	PricesDecimalNumber	Gets/set the prices decimal number (Nombre de décimales des prix)
	PricesDecimalNumberMember	Gets/set the prices decimal number (Nombre de décimales des prix)
	Quantity	Gets or sets the quantity (Quantité)
	QuantityDecimalNumber	Gets or sets the quantity decimal number (Décimale)
	QuantityDecimalNumberMember	Gets the quantity decimal number (Décimale)
	QuantityMember	Gets the quantity (Quantité)
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	RealNetAmountVatExcludedWithDiscount	Gets or sets the net amount vat excluded with discount (Montant total Net HT remisé)
	RealNetAmountVatExcludedWithDiscountMember	Gets the net amount vat excluded with discount (Montant total Net HT remisé)
	RealQuantity	Gets or sets the real quantity function of the parent (Quantité totale)
	RealQuantityMember	Gets the real quantity function of the parent (Quantité totale)
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	States	Gets the entity states (Inherited from IEntity.)
	TotalChargeDistributedAmount	Gets or sets the total charge distributed amount
	TotalChargeDistributedAmountMember	Gets the total charge distributed amount
	TotalGrossWeight	Gets or sets the total gross weight (Poids Brut total (kg))
	TotalGrossWeightMember	Gets the total gross weight (Poids Brut total (kg))
	TotalNetWeight	Gets or sets the total net weight (Poids Net total)
	TotalNetWeightMember	Gets the total net weight (Poids Net total)
	TotalVolume	Gets or sets the total volume (m3) (Volume total (m3))
	TotalVolumeMember	Gets the total volume (m3) (Volume total (m3))
	UnitCostPrice	Gets or sets the unit cost price (Prix de revient unitaire)
	UnitCostPriceMember	Gets the unit cost price (Prix de revient unitaire)

Top

Methods

	Name	Description
	Append	Method for add a new entity to the media. Update the entity to its default value. (Inherited from IEntity.)
	CalculateDistributionBaseAmount	Calculate distribution base amount
	Cancel	Cancel the edit mode without saving, and reload the entity (Inherited from IEntity.)
	CancelEdit	Cancel the edit mode without saving, without reload the entity (Inherited from IEntity.)
	CheckData	Check the data of the entity (Inherited from IEntity.)
	Clear	Clear the entity content and reinitialize it to the default value (Inherited from IEntity.)
	Clone	Clone an entity (Inherited from IEntity.)
	CopyTo(IEntity)	Copy the entity content to another entity (Inherited from IEntity.)
	CopyTo(IEntity, Boolean)	Copy the entity content to another entity (Inherited from IEntity.)
	Delete	Method for delete a existing entity from the media (Inherited from IEntity.)
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
	Edit	Method to pass in edit mode a existing entity in the media (for exemple, add a lock for database) (Inherited from IEntity.)
	GetExtension	Gets the extension. (Inherited from IApiEntity.)
	GetIsFullDistributed	whether the line is already distributed by 3 other freight
	IsAlreadyFreightDistributed	Gets whether the freight has been distributed on line
	IsDistributable	Gets whether approach charges can be set on a line
	IsDocumentNomenclatureLine	Gets whether the line is a nomenclature line
	Load	Method for loading the entity (Inherited from IEntity.)
	Save	Method for saving the entity to the media (Inherited from IEntity.)
	SetComplexMemberReadOnly	Set the read only property to a member (Inherited from IEntity.)
	ShowMessage	Method to display a message. The message is displayed if the UI has connected to the ShowMessage event (Inherited from IApiEntity.)

Top

Events

	Name	Description
	ModeChanged	Event raised on mode changed (Inherited from IEntity.)

Top

Remarks

The IApproachChargeDocumentLineEntity type can be instantiated with EBP.Api.Utils<TExtension>.GetInterface<T>

Copy

IApproachChargeDocumentLineEntity instance = Utils<ExtensionType>.GetInterface<IApproachChargeDocumentLineEntity>();

Reference

EBP.Api.Interfaces.Invoicing.Module.Entities.ApproachCharge Namespace