IDepositEntity Interface

Deposit entity

(Acompte)

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

Syntax

Copy

[GuidAttribute("607497E5-78F4-482c-B028-D19592BBA60A")]
public interface IDepositEntity : IEntity, 
	IApiEntity, IDisposable, IEquatable<IProxy>

<GuidAttribute("607497E5-78F4-482c-B028-D19592BBA60A")>
Public Interface IDepositEntity
	Inherits IEntity, IApiEntity, IDisposable, IEquatable(Of IProxy)

The IDepositEntity type exposes the following members.

Properties

	Name	Description
	AmountVatExcluded	Gets or sets the amount VAT excluded
	AmountVatExcludedMember	Gets the amount VAT excluded
	AmountVatIncluded	Gets or sets the amount VAT included
	AmountVatIncludedMember	Gets the amount VAT included
	AssociatedDeliveryOrderNumber	Gets or sets the associated delivery order document number
	AssociatedDeliveryOrderNumberMember	Gets the associated delivery order document number
	AssociatedExecutionQuoteNumber	Gets or sets the associated execution quote document number
	AssociatedExecutionQuoteNumberMember	Gets the associated execution quote document number
	AssociatedInvoiceNumber	Gets or sets the associated invoice document number
	AssociatedInvoiceNumberMember	Gets the associated invoice document number
	AssociatedOrderNumber	Gets or sets the associated sale order document number
	AssociatedOrderNumberMember	Gets the associated sale order document number
	AssociatedProgressStateNumber	Gets or sets the associated progress state document number
	AssociatedProgressStateNumberMember	Gets the associated progress state document number
	AssociatedQuoteNumber	Gets or sets the associated quote document number
	AssociatedQuoteNumberMember	Gets the associated quote document number
	BaseAmountVatExcluded	Gets or sets the vat amount depending of the currency type
	BaseAmountVatExcludedMember	Gets the vat amount depending of the currency type
	BaseAmountVatIncluded	Gets or sets the vat amount depending of the currency type
	BaseAmountVatIncludedMember	Gets the vat amount depending of the currency type
	BaseVatAmount	Gets or sets the vat amount depending of the currency type
	BaseVatAmountMember	Gets the vat amount depending of the currency type
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	CurrencyAmountVatExcluded	Gets or sets the currency amount VAT excluded
	CurrencyAmountVatExcludedMember	Gets the currency amount VAT excluded
	CurrencyAmountVatIncluded	Gets or sets the currency amount VAT included
	CurrencyAmountVatIncludedMember	Gets the currency amount VAT included
	CurrencyId	Gets or sets the currency Id
	CurrencyIdMember	Gets the currency Id
	CurrencyVatAmount	Gets or sets the vat amount of the deposit
	CurrencyVatAmountMember	Gets the vat amount of the deposit
	Date	Gets or sets the deposit Date
	DateMember	Gets the deposit Date
	DealId	Gets or sets the deal id
	DealIdMember	Gets the deal id
	DocumentSubType	Document sub type
	DocumentSubTypeMember	Document sub type
	DocumentType	Document type
	DocumentTypeMember	Document type
	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 deposit ID
	IdMember	Gets the deposit ID
	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.)
	IsPosDeposit	Gets or sets a value indicating whether this instance is point of sales deposit.
	IsPosDepositMember	Gets or sets a value indicating whether this instance is point of sales deposit.
	KeepDepositVatAmount	Gets or sets whether the deposit vat amount have to be kept
	KeepDepositVatAmountMember	Gets whether the deposit vat amount have to be kept
	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.)
	Number	Gets or sets the deposit number
	NumberMember	Gets the deposit number
	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.)
	PosAmountVatIncluded	Gets or sets the point of sales amount vat included.
	PosAmountVatIncludedMember	Gets the point of sales amount vat included.
	PosAmountWithReturningChangeAmount	Gets or sets the POS amount with returning change amount.
	PosAmountWithReturningChangeAmountMember	Gets the POS amount with returning change amount.
	PosPaymentNature	Gets or sets the point of sales payment nature.
	PosPaymentNatureMember	Gets the point of sales payment nature.
	PosPaymentTypeCaption	Gets or sets the point of sales payment caption.
	PosPaymentTypeCaptionMember	Gets the point of sales payment caption.
	PosPaymentTypeId	Gets or sets the point of sales payment type identifier.
	PosPaymentTypeIdMember	Gets the point of sales payment type identifier.
	PosReturningChangeAmount	Gets or sets the point of sales returning change amount.
	PosReturningChangeAmountMember	Gets the point of sales returning change amount.
	PosSettlellingAppliedGap	Gets or sets the point of sale settlelling applied gap (used in share and divide mode).
	PosSettlellingAppliedGapMember	Gets the point of sale settlelling applied gap (used in share and divide mode).
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	ReAmount	Gets or sets the vat amount of the deposit
	ReAmountMember	Gets the vat amount of the deposit
	SettlementId	Gets or sets the settlement id
	SettlementIdMember	Gets the settlement id
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	SmoothingHistory	Gets the smoothing history
	States	Gets the entity states (Inherited from IEntity.)
	VatAmount	Gets or sets the vat amount of the deposit
	VatAmountMember	Gets the vat amount of the deposit
	VatId	Gets or sets the vat Id
	VatIdMember	Gets the vat Id
	VatMode	Gets or sets the deposit vat mode List of authorized values in VatModeType
	VatModeMember	Gets the deposit vat mode List of authorized values in VatModeType
	VatRate	Gets or sets the vat Rate
	VatRateMember	Gets the vat Rate

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

Not persisted

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

Copy

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

Reference

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