IDocumentEntityBase Interface

Document Entity

(Client/Prospect)

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

public interface IDocumentEntityBase : IInvoicingEntityBase, 
	IBusinessEntityBase, ISynchronizableEntityBase, IEntity, IApiEntity, IDisposable, 
	IEquatable<IProxy>

Public Interface IDocumentEntityBase
	Inherits IInvoicingEntityBase, IBusinessEntityBase, ISynchronizableEntityBase, IEntity, 
	IApiEntity, IDisposable, IEquatable(Of IProxy)

The IDocumentEntityBase type exposes the following members.

Properties

	Name	Description
	AllowNotReferencedItems	Gets whether the non referenced items are allowed in the document
	AllowSleepingItem	Gets whether sleeping items are allowed
	AssociatedFiles	Files associated to the document
	Behavior	Gets the document functionalities
	CanInsertNotReferencedItem	Gets whether the non referenced items are allowed in the document
	ConstructionSiteCaption	Gets or sets the construction site caption
	ConstructionSiteCaptionMember	Gets the construction site caption
	ConstructionSiteId	Gets or sets the construction site Id
	ConstructionSiteIdMember	Gets the construction site Id
	ConstructionSiteStorehouseId	Gets or sets the construction site storehouse Id
	ConstructionSiteStorehouseIdMember	Gets the construction site storehouse Id
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	DealCaption	Gets or sets the deal caption
	DealCaptionMember	Gets the deal caption
	DealId	Gets or sets the deal id
	DealIdMember	Gets the deal id
	DispatchedByStorehouse	Gets or sets if Document is dispatched on multiple Storehouses
	DispatchedByStorehouseMember	Gets if Document is dispatched on multiple Storehouses
	DocumentDate	Date of the document
	DocumentDateMember	Date of the document
	DocumentNumber	Id of the Items Family
	DocumentNumberMember	Id of the Items Family
	DocumentSerialId	Gets or sets the document serial id
	DocumentSerialIdMember	Gets the document serial id
	DocumentType	Type of the document (E:PutAway - S:Pick - F:Invoice - D:Quote) Sale document : List of authorized values in SaleDocumentSubTypes Purchase document : List of authorized values in PurchaseDocumentSubTypes Stock document : List of authorized values in StockDocumentSubTypes
	DocumentTypeMember	Type of the document (E:PutAway - S:Pick - F:Invoice - D:Quote) Sale document : List of authorized values in SaleDocumentSubTypes Purchase document : List of authorized values in PurchaseDocumentSubTypes Stock document : List of authorized values in StockDocumentSubTypes
	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 used for all kind of documents (stock, invoice ...)
	GlobalDocumentOrderMember	Global Document Order used for all kind of documents (stock, invoice ...)
	Hash	Gets the hash.
	HasNotReferencedItemRight	Gets whether the non referenced items are allowed in the document
	Id	internal Id for the document
	IdMember	internal Id for the document
	IncidentId	Gets or sets the incident Id
	IncidentIdMember	Gets the incident Id
	InternalNumberSuffix	Gets or sets the internal number suffix On opposition to the number suffix, its persisted in database to can order on document number
	InternalNumberSuffixMember	Gets the internal number suffix On opposition to the number suffix, its persisted in database to can order on document number
	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.)
	IsPartiallyBlockedItemAllowed	Allow the insertion of partially blocked item
	Lines	Document Lines collection
	MaintenanceContractId	Gets or sets the maintenance contract Id
	MaintenanceContractIdMember	Gets the maintenance contract Id
	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.)
	NumberPrefix	Gets or sets the number prefix
	NumberPrefixMember	Gets the number prefix
	NumberSuffix	Gets or sets the number suffix
	NumberSuffixMember	Gets the number suffix
	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.)
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	Reference	Gets or sets the document reference
	ReferenceMember	Gets the document reference
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	States	Gets the entity states (Inherited from IEntity.)
	StorehouseCaption	Gets or sets the document storehouse caption
	StorehouseCaptionMember	Gets the document storehouse caption
	StorehouseId	Reference Storehouse Id
	StorehouseIdMember	Reference Storehouse Id
	SubType	Gets the document sub type
	TotalVolume	Gets or sets the total volume
	TotalVolumeMember	Gets the total volume
	TotalWeight	Gets or sets the total weight
	TotalWeightMember	Gets the total weight
	Type	Gets the document type
	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.)
	CheckAllStock	Check the stock for all document lines
	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
	FooterCalculating	Occurs when footer is calculating
	ItemCreatedFromLine	Occurs when an item is created from a line
	ItemLoaded	Occurs when an item has been loaded
	ModeChanged	Event raised on mode changed (Inherited from IEntity.)

Top

Reference

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