IApproachChargeDocumentEntity Interface

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

(Document de ventilations 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("75B481DA-C3FF-4CC9-8299-DDB425414907")]
public interface IApproachChargeDocumentEntity : IEntity, 
	IApiEntity, IDisposable, IEquatable<IProxy>

<GuidAttribute("75B481DA-C3FF-4CC9-8299-DDB425414907")>
Public Interface IApproachChargeDocumentEntity
	Inherits IEntity, IApiEntity, IDisposable, IEquatable(Of IProxy)

The IApproachChargeDocumentEntity type exposes the following members.

Properties

	Name	Description
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	DistributionBaseAmount	sum of Distribution base amount of each line
	DistributionBaseAmountMember	sum of Distribution base amount of each line
	DocumentDate	Gets or sets the document date (Date)
	DocumentDateMember	Gets the document date (Date)
	DocumentNumber	Gets or sets the document number (Numéro du document)
	DocumentNumberMember	Gets the document number (Numéro du document)
	DocumentType	Document type : invoice, receipt order, etc List of authorized values in PurchaseDocumentSubTypes (Type de document)
	DocumentTypeMember	Document type : invoice, receipt order, etc List of authorized values in PurchaseDocumentSubTypes (Type de document)
	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.)
	GlobalDocumentOrder	Global document order (compulsory to have id since used in index GlobalDocumentOrderIndex) (Ordre de création du document)
	GlobalDocumentOrderMember	Global document order (compulsory to have id since used in index GlobalDocumentOrderIndex) (Ordre de création du document)
	Id	Document unique identifier (Code document)
	IdMember	Document unique identifier (Code 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
	Lines	Detail of the master : line of Approach Charge Document
	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.)
	NumberPrefix	Gets or sets the number prefix (compulsory to have id since used in index PrefixSuffixIndex) (Préfixe du numéro)
	NumberPrefixMember	Gets the number prefix (compulsory to have id since used in index PrefixSuffixIndex) (Préfixe du numéro)
	NumberSuffix	Gets or sets the number suffix (compulsory to have id since used in index PrefixSuffixIndex) (Suffixe du numéro)
	NumberSuffixMember	Gets the number suffix (compulsory to have id since used in index PrefixSuffixIndex) (Suffixe du numéro)
	OwnerEntity	Gets the main entity that own all this items/collection (Inherited from IEntity.)
	Parent	Gets the parent entity collection, that own this item (Inherited from IEntity.)
	PercentageDistribution	Gets or sets the percentage distribution
	PercentageDistributionMember	Gets the percentage distribution
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	SerialId	Serial Id (compulsory to have id since used in index PrefixSuffixIndex) (Série de documents)
	SerialIdMember	Serial Id (compulsory to have id since used in index PrefixSuffixIndex) (Série de documents)
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	States	Gets the entity states (Inherited from IEntity.)
	ThirdId	Gets or sets the third Id (Code fournisseur)
	ThirdIdMember	Gets the third Id (Code fournisseur)
	ThirdName	Gets or sets the third name (Nom du fournisseur)
	ThirdNameMember	Gets the third name (Nom du fournisseur)

Top

Methods

	Name	Description
	Append	Method for add a new entity to the media. Update the entity to its default value. (Inherited from IEntity.)
	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.)
	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 IApproachChargeDocumentEntity type can be instantiated with EBP.Api.Utils<TExtension>.GetInterface<T>

Copy

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

Reference

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