IDocumentSerialEntity Interface

Class representing a document serial entity (used to associate a serial to a trade document)

(Série de documents)

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

Syntax

Copy

[GuidAttribute("059EB391-8985-4B01-9F18-099736788D31")]
public interface IDocumentSerialEntity : IDocumentSerialEntityBase, 
	IBusinessEntityBase, ISynchronizableEntityBase, IEntity, IApiEntity, IDisposable, 
	IEquatable<IProxy>

<GuidAttribute("059EB391-8985-4B01-9F18-099736788D31")>
Public Interface IDocumentSerialEntity
	Inherits IDocumentSerialEntityBase, IBusinessEntityBase, ISynchronizableEntityBase, IEntity, 
	IApiEntity, IDisposable, IEquatable(Of IProxy)

The IDocumentSerialEntity type exposes the following members.

Properties

	Name	Description
	AddIdToDocumentNumber	Gets or sets whether the serial Id must be added at beggining of document number (Inclure la série dans la numérotation)
	AddIdToDocumentNumberMember	Gets whether the serial Id must be added at beggining of document number (Inclure la série dans la numérotation)
	ApplyToPurchase	Gets or sets whether serial can be used for purchase documents (Achat)
	ApplyToPurchaseMember	Gets whether serial can be used for purchase documents (Achat)
	ApplyToSale	Gets or sets whether serial can be used for sale documents (Vente)
	ApplyToSaleMember	Gets whether serial can be used for sale documents (Vente)
	ApplyToStock	Gets or sets whether serial can be use for stock documents (Stock)
	ApplyToStockMember	Gets whether serial can be use for stock documents (Stock)
	Caption	Gets or sets the serial caption (Libellé) (Inherited from IDocumentSerialEntityBase.)
	CaptionMember	Gets the serial caption (Libellé) (Inherited from IDocumentSerialEntityBase.)
	CorrectiveSerialId	Gets or sets the linked corrective serial id (Code série rectificative) (Inherited from IDocumentSerialEntityBase.)
	CorrectiveSerialIdMember	Gets the linked corrective serial id (Code série rectificative) (Inherited from IDocumentSerialEntityBase.)
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	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	Gets or sets the serial Id (Code série) (Inherited from IDocumentSerialEntityBase.)
	IdMember	Gets the serial Id (Code série) (Inherited from IDocumentSerialEntityBase.)
	IsDefault	Gets or sets whether is default serial to use (Série par défaut) (Inherited from IDocumentSerialEntityBase.)
	IsDefaultForPurchase	Gets or sets whether serial is default for purchases (Par défaut (achat))
	IsDefaultForPurchaseMember	Gets whether serial is default for purchases (Par défaut (achat))
	IsDefaultForSale	Gets or sets whether serial is default for sales (Par défaut (vente))
	IsDefaultForSaleMember	Gets whether serial is default for sales (Par défaut (vente))
	IsDefaultForStock	Gets or sets whether serial is default for stocks (Par défaut (stock))
	IsDefaultForStockMember	Gets whether serial is default for stocks (Par défaut (stock))
	IsDefaultMember	Gets whether is default serial to use (Série par défaut) (Inherited from IDocumentSerialEntityBase.)
	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.)
	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.)
	Notes	Gets or sets the notes in RTF format. (Notes) (Inherited from IBusinessEntityBase.)
	NotesClear	Gets or sets the notes in plain text format. (Notes en texte brut) (Inherited from IBusinessEntityBase.)
	NotesClearMember	Gets the notes in plain text format. (Notes en texte brut) (Inherited from IBusinessEntityBase.)
	NotesMember	Gets the notes in RTF format. (Notes) (Inherited from IBusinessEntityBase.)
	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.)
	PurchaseCreditMemoBook	Gets or sets the purchase credit memo Book (BE version) (Journal comptable notes de crédit achats)
	PurchaseCreditMemoBookMember	Gets the purchase credit memo Book (BE version) (Journal comptable notes de crédit achats)
	PurchaseDepositCreditMemoBook	Gets or sets the purchase deposit credit memo Book (BE version) (Journal comptable notes de crédit sur acompte achats)
	PurchaseDepositCreditMemoBookMember	Gets the purchase deposit credit memo Book (BE version) (Journal comptable notes de crédit sur acompte achats)
	PurchaseDepositInvoiceBook	Gets or sets the purchase deposit invoice Book (BE version) (Journal comptable factures d'acompte achats)
	PurchaseDepositInvoiceBookMember	Gets the purchase deposit invoice Book (BE version) (Journal comptable factures d'acompte achats)
	PurchasesAccountingBook	Gets or sets the purchases accounting book (Journal comptable achats)
	PurchasesAccountingBookMember	Gets the purchases accounting book (Journal comptable achats)
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	SaleCreditMemoBook	Gets or sets the sale credit memo Book (BE version) (Journal comptable notes de crédit ventes)
	SaleCreditMemoBookMember	Gets the sale credit memo Book (BE version) (Journal comptable notes de crédit ventes)
	SaleDepositCreditMemoBook	Gets or sets the sale deposit credit memo Book (BE version) (Journal comptable notes de crédit sur acompte ventes)
	SaleDepositCreditMemoBookMember	Gets the sale deposit credit memo Book (BE version) (Journal comptable notes de crédit sur acompte ventes)
	SaleDepositInvoiceBook	Gets or sets the sale deposit invoice Book (BE version) (Journal comptable factures d'acompte ventes)
	SaleDepositInvoiceBookMember	Gets the sale deposit invoice Book (BE version) (Journal comptable factures d'acompte ventes)
	SalesAccountingBook	Gets or sets the sales accounting book (Journal comptable ventes)
	SalesAccountingBookMember	Gets the sales accounting book (Journal comptable ventes)
	SerialToDisplay	Gets or sets IsMobile (Série à afficher)
	SerialToDisplayMember	Gets IsMobile (Série à afficher)
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	States	Gets the entity states (Inherited from IEntity.)
	StocksAccountingBook	Gets or sets the stocks accounting book (Journal comptable stocks)
	StocksAccountingBookMember	Gets the stocks accounting book (Journal comptable stocks)
	Type	Gets or sets the document serial type (Type de série) (Inherited from IDocumentSerialEntityBase.)
	TypeMember	Gets the document serial type (Type de série) (Inherited from IDocumentSerialEntityBase.)
	UniqueId	Gets or sets the unique Id (Inherited from ISynchronizableEntityBase.)
	UniqueIdMember	Gets the unique Id (Inherited from ISynchronizableEntityBase.)

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 IDocumentSerialEntity type can be instantiated with EBP.Api.Utils<TExtension>.GetInterface<T>

Copy

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

Reference

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