IDealPurchaseCommitmentEntity Interface

Deal purchase commitment entity

(Échéance)

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

Syntax

Copy

[GuidAttribute("68080D5E-42EB-4A4C-8384-BAE01D4CA16E")]
public interface IDealPurchaseCommitmentEntity : IPurchaseCommitmentEntity, 
	ICommitmentEntityBase, IInvoicingEntityBase, IBusinessEntityBase, ISynchronizableEntityBase, IEntity, 
	IApiEntity, IDisposable, IEquatable<IProxy>

<GuidAttribute("68080D5E-42EB-4A4C-8384-BAE01D4CA16E")>
Public Interface IDealPurchaseCommitmentEntity
	Inherits IPurchaseCommitmentEntity, ICommitmentEntityBase, IInvoicingEntityBase, IBusinessEntityBase, 
	ISynchronizableEntityBase, IEntity, IApiEntity, IDisposable, IEquatable(Of IProxy)

The IDealPurchaseCommitmentEntity type exposes the following members.

Properties

	Name	Description
	AccountingExchangeGroupId	Gets or sets Accounting exchange group Id (Identifiant du lot comptable) (Inherited from ICommitmentEntityBase.)
	AccountingExchangeGroupIdMember	Gets Accounting exchange group Id (Identifiant du lot comptable) (Inherited from ICommitmentEntityBase.)
	AccountingMonth	Gets or sets if the commitment is calculate with accounting month (Mois comptable) (Inherited from ICommitmentEntityBase.)
	AccountingMonthMember	Gets if the commitment is calculate with accounting month (Mois comptable) (Inherited from ICommitmentEntityBase.)
	AccountingTransferStatus	Gets or sets if the commitment has been transfered to accountant List of authorized values in AccountingTransferState (Transféré en comptabilité) (Inherited from ICommitmentEntityBase.)
	AccountingTransferStatusMember	Gets if the commitment has been transfered to accountant List of authorized values in AccountingTransferState (Transféré en comptabilité) (Inherited from ICommitmentEntityBase.)
	Amount	Gets or sets amount (Montant) (Inherited from ICommitmentEntityBase.)
	AmountMember	Gets amount (Montant) (Inherited from ICommitmentEntityBase.)
	AssignedAmount	Gets or sets the assigned amount (this data doesn't save in commitment table) (Inherited from ICommitmentEntityBase.)
	AssignedAmountMember	Gets the assigned amount (this data doesn't save in commitment table) (Inherited from ICommitmentEntityBase.)
	Associations	Gets the collection of assocationsEntity (Inherited from ICommitmentEntityBase.)
	BalanceDue	Gets or sets balance due (Solde dû) (Inherited from ICommitmentEntityBase.)
	BalanceDueMember	Gets balance due (Solde dû) (Inherited from ICommitmentEntityBase.)
	CommitmentType	Gets or sets the type of commitment (net, net on, etc.) (Type d'échéance) (Inherited from ICommitmentEntityBase.)
	CommitmentTypeMember	Get the type of commitment (net, net on, etc.) (Type d'échéance) (Inherited from ICommitmentEntityBase.)
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	CurrencyAmount	Gets or sets the CurrencyAmount (Montant en devise) (Inherited from ICommitmentEntityBase.)
	CurrencyAmountMember	Get the CurrencyAmount (Montant en devise) (Inherited from ICommitmentEntityBase.)
	CurrencyAssignedAmount	Gets or sets the currency assigned amount (this data doesn't save in commitment table) (Inherited from ICommitmentEntityBase.)
	CurrencyAssignedAmountMember	Gets the currency assigned amount (this data doesn't save in commitment table) (Inherited from ICommitmentEntityBase.)
	CurrencyBalanceDue	Gets or sets the CurrencyBalanceDue (Solde dû en devise) (Inherited from ICommitmentEntityBase.)
	CurrencyBalanceDueMember	Get the CurrencyBalanceDue (Solde dû en devise) (Inherited from ICommitmentEntityBase.)
	CurrencyDecimalCountLookup	Get the CurrencyDecimalCountLookup (Nombre de décimales) (Inherited from ICommitmentEntityBase.)
	CurrencyDecimalCountLookupMember	Get the CurrencyDecimalCountLookup (Nombre de décimales) (Inherited from ICommitmentEntityBase.)
	CurrencyId	Gets or sets the DocumentCurrencyId (Code ISO devise) (Inherited from ICommitmentEntityBase.)
	CurrencyIdMember	Get the DocumentCurrencyId (Code ISO devise) (Inherited from ICommitmentEntityBase.)
	DayOfMonth	Gets or sets the day of payment (Le jour) (Inherited from ICommitmentEntityBase.)
	DayOfMonthMember	Gets the day of payment (Le jour) (Inherited from ICommitmentEntityBase.)
	DaysNumber	Gets or sets the number of day to pay (Nombre de jours) (Inherited from ICommitmentEntityBase.)
	DaysNumberMember	Gets the number of day to pay (Nombre de jours) (Inherited from ICommitmentEntityBase.)
	DepositAssociatedDeliveryId	Gets the delivery id Associated to the deposit for a deposit commitment (Code de la réception associée) (Inherited from ICommitmentEntityBase.)
	DepositAssociatedDeliveryIdMember	Gets the delivery id Associated to the deposit for a deposit commitment (Code de la réception associée) (Inherited from ICommitmentEntityBase.)
	DepositAssociatedInvoiceId	Gets the invoice id Associated to the deposit for a deposit commitment (Code de la facture associée) (Inherited from ICommitmentEntityBase.)
	DepositAssociatedInvoiceIdMember	Gets the invoice id Associated to the deposit for a deposit commitment (Code de la facture associée) (Inherited from ICommitmentEntityBase.)
	DepositAssociatedOrderId	Gets the order id Associated to the deposit for a deposit commitment (Code de la commande associée) (Inherited from ICommitmentEntityBase.)
	DepositAssociatedOrderIdMember	Gets the order id Associated to the deposit for a deposit commitment (Code de la commande associée) (Inherited from ICommitmentEntityBase.)
	DocumentCurrencyApplicationType	Get the document's currency application type List of authorized values in CurrencyApplicationTypes (Devise appliquée dans les documents) (Inherited from ICommitmentEntityBase.)
	DocumentCurrencyApplicationTypeMember	Get the document's currency application type List of authorized values in CurrencyApplicationTypes (Devise appliquée dans les documents) (Inherited from ICommitmentEntityBase.)
	DocumentCurrencyConversionRate	Get the DocumentCurrencyConversionRate (Cours de la devise) (Inherited from ICommitmentEntityBase.)
	DocumentCurrencyConversionRateMember	Get the DocumentCurrencyConversionRate (Cours de la devise) (Inherited from ICommitmentEntityBase.)
	DocumentDate	Gets the date of document (this field is not saved) (Date) (Inherited from ICommitmentEntityBase.)
	DocumentDateMember	Gets the date of document (this field is not saved) (Date) (Inherited from ICommitmentEntityBase.)
	DocumentId	Gets or sets id of document (Code document) (Inherited from ICommitmentEntityBase.)
	DocumentIdMember	Gets id of document (Code document) (Inherited from ICommitmentEntityBase.)
	DocumentIsStructuredSepaCommunication	Document is structured sepa communication (Structurée) (Inherited from ICommitmentEntityBase.)
	DocumentIsStructuredSepaCommunicationMember	Document is structured sepa communication (Structurée) (Inherited from ICommitmentEntityBase.)
	DocumentNumber	Gets the numbering id of the document, this field doesn't save (Numéro du document) (Inherited from ICommitmentEntityBase.)
	DocumentNumberMember	Gets the numbering id of the document, this field doesn't save (Numéro du document) (Inherited from ICommitmentEntityBase.)
	DocumentSepaCommunication	Document Sepa communication (Communication) (Inherited from ICommitmentEntityBase.)
	DocumentSepaCommunicationMember	Document Sepa communication (Communication) (Inherited from ICommitmentEntityBase.)
	DocumentSubType	Gets or sets subtype of document Sale commitment : List of authorized values in SaleDocumentSubTypes Purchase commitment : List of authorized values in PurchaseDocumentSubTypes (Sous type de document) (Inherited from ICommitmentEntityBase.)
	DocumentSubTypeMember	Gets subtype of document Sale commitment : List of authorized values in SaleDocumentSubTypes Purchase commitment : List of authorized values in PurchaseDocumentSubTypes (Sous type de document) (Inherited from ICommitmentEntityBase.)
	DocumentType	Gets or sets type of document (sale or purchase) List of authorized values in DocumentTypes (Type de document) (Inherited from ICommitmentEntityBase.)
	DocumentTypeMember	Gets type of document (sale or purchase) List of authorized values in DocumentTypes (Type de document) (Inherited from ICommitmentEntityBase.)
	DueDate	Gets or sets due date (Date échéance) (Inherited from ICommitmentEntityBase.)
	DueDateMember	Gets due date (Date échéance) (Inherited from ICommitmentEntityBase.)
	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.)
	ExternalDocumentId	external document Id from linked application (Référence externe) (Inherited from ICommitmentEntityBase.)
	ExternalDocumentIdMember	external document Id from linked application (Référence externe) (Inherited from ICommitmentEntityBase.)
	GenerateSettlement	Generate Settlement (Générer le règlement) (Inherited from ICommitmentEntityBase.)
	GenerateSettlementMember	Generate Settlement (Générer le règlement) (Inherited from ICommitmentEntityBase.)
	GiftVoucherId	Gets or sets the gift voucher id (Inherited from ICommitmentEntityBase.)
	GiftVoucherIdMember	Gets the gift voucher id (Inherited from ICommitmentEntityBase.)
	Id	Gets or sets id (Code échéance) (Inherited from ICommitmentEntityBase.)
	IdMember	Gets id (Code échéance) (Inherited from ICommitmentEntityBase.)
	IsAssigned	Gets or sets if the commitment isAssigned (this data doesn't save in commitment table) (Inherited from ICommitmentEntityBase.)
	IsAssignedMember	Gets if the commitment isAssigned (this data doesn't save in commitment table) (Inherited from ICommitmentEntityBase.)
	IsAssociationsModified	Check if associations collection has been modified (Inherited from ICommitmentEntityBase.)
	IsCorrected	Gets or sets whether commitment has been corrected (invoice or corrected invoice) (Rectifiée) (Inherited from ICommitmentEntityBase.)
	IsCorrectedMember	Gets whether commitment has been corrected (invoice or corrected invoice) (Rectifiée) (Inherited from ICommitmentEntityBase.)
	IsDeleted	Gets if the mode matches a deleted mode (Inherited from IEntity.)
	IsDeposit	Gets or sets if there is an account (Acompte) (Inherited from ICommitmentEntityBase.)
	IsDepositMember	Gets if there is an account (Acompte) (Inherited from ICommitmentEntityBase.)
	IsDocumentOrCommitmentSentOrTransferedToAccounting	True if document or commitment are in sentToAccounting state or TransferedToAccounting state (Inherited from ICommitmentEntityBase.)
	IsEmptyLine	Indicates if the entity is an empty line of an entity collection (created in auto following the entityCollection options) (Inherited from IEntity.)
	IsLiquidated	Gets or sets if the commitment is liquidated (Soldée) (Inherited from ICommitmentEntityBase.)
	IsLiquidatedMember	Gets if the commitment is liquidated (Soldée) (Inherited from ICommitmentEntityBase.)
	IsMarkable	Get whether commitment is able to associated with settlement (Inherited from ICommitmentEntityBase.)
	IsOneCommitmentPointingByAccounting	Gets whether one of commitment in collection is pointing by accounting (Inherited from ICommitmentEntityBase.)
	IsPointingByAccounting	Get whether commitment has been pointing by accounting application (Inherited from ICommitmentEntityBase.)
	IsSettledOrLiquidated	commitment settled or liquidated (Inherited from ICommitmentEntityBase.)
	IsUnmarkable	Gets whether commitment is able to un-associated from settlement (Inherited from ICommitmentEntityBase.)
	LiquidationAccountingExchangeGroupId	liquidation accounting exchange group id (Identifiant du lot comptable de l'écart de règlement) (Inherited from ICommitmentEntityBase.)
	LiquidationAccountingExchangeGroupIdMember	liquidation accounting exchange group id (Identifiant du lot comptable de l'écart de règlement) (Inherited from ICommitmentEntityBase.)
	LiquidationAccountingTransferStatus	Is liquidation amount transfered to accounting List of authorized values in AccountingTransferState (Écart de règlement transféré en comptabilité) (Inherited from ICommitmentEntityBase.)
	LiquidationAccountingTransferStatusMember	Is liquidation amount transfered to accounting List of authorized values in AccountingTransferState (Écart de règlement transféré en comptabilité) (Inherited from ICommitmentEntityBase.)
	LiquidationAmount	liquidation amount transfered to accounting (Montant d'écart de règlement) (Inherited from ICommitmentEntityBase.)
	LiquidationAmountMember	liquidation amount transfered to accounting (Montant d'écart de règlement) (Inherited from ICommitmentEntityBase.)
	LiquidationCurrencyAmount	liquidation currency amount transfered to accounting (Montant d'écart de règlement en devise) (Inherited from ICommitmentEntityBase.)
	LiquidationCurrencyAmountMember	liquidation currency amount transfered to accounting (Montant d'écart de règlement en devise) (Inherited from ICommitmentEntityBase.)
	LiquidationStateChangeDate	Liquidate state change date (Date de changement de l'état "soldé") (Inherited from ICommitmentEntityBase.)
	LiquidationStateChangeDateMember	Liquidate state change date (Date de changement de l'état "soldé") (Inherited from ICommitmentEntityBase.)
	LiquidationType	Gets or sets the liquidation type List of authorized values in LiquidationType (Type d'écart) (Inherited from ICommitmentEntityBase.)
	LiquidationTypeMember	Get the liquidation type List of authorized values in LiquidationType (Type d'écart) (Inherited from ICommitmentEntityBase.)
	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.)
	PaymentNature	Gets the payment nature. List of authorized values in PaymentTypeNature (Nature) (Inherited from ICommitmentEntityBase.)
	PaymentNatureMember	Gets the payment nature. List of authorized values in PaymentTypeNature (Nature) (Inherited from ICommitmentEntityBase.)
	PaymentThirdId	Gets or sets the payment third id (Code tiers encaisseur) (Inherited from ICommitmentEntityBase.)
	PaymentThirdIdFromThird	Gets the payment third id linked to third (Code tiers encaisseur) (Inherited from ICommitmentEntityBase.)
	PaymentThirdIdFromThirdMember	Gets the payment third id linked to third (Code tiers encaisseur) (Inherited from ICommitmentEntityBase.)
	PaymentThirdIdMember	Gets the payment third id (Code tiers encaisseur) (Inherited from ICommitmentEntityBase.)
	PaymentTypeCaptionInUserLanguage	Payment type caption in user languages (Inherited from ICommitmentEntityBase.)
	PaymentTypeCaptionInUserLanguageMember	Payment type caption in user languages (Inherited from ICommitmentEntityBase.)
	PaymentTypeDefaultBank	Gets the default bank defined on payment type (Banque) (Inherited from ICommitmentEntityBase.)
	PaymentTypeDefaultBankMember	Gets the default bank defined on payment type (Banque) (Inherited from ICommitmentEntityBase.)
	PaymentTypeId	Gets or sets type of settlement mode (Moyen de paiement) (Inherited from ICommitmentEntityBase.)
	PaymentTypeIdMember	Gets type of settlement mode (Moyen de paiement) (Inherited from ICommitmentEntityBase.)
	PercentageDistribution	Gets or sets the percentage of due amount for this commitment (Pourcentage de répartition) (Inherited from ICommitmentEntityBase.)
	PercentageDistributionMember	Gets the percentage of due amount for this commitment (Pourcentage de répartition) (Inherited from ICommitmentEntityBase.)
	PreviousLiquidationType	Gets or sets the previous liquidation type List of authorized values in LiquidationType (Type d'écart précédent) (Inherited from ICommitmentEntityBase.)
	PreviousLiquidationTypeMember	Get the previous liquidation type List of authorized values in LiquidationType (Type d'écart précédent) (Inherited from ICommitmentEntityBase.)
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	Reference	Reference used for SEPA transfer (this data doesn't save in commitment table) (Inherited from ICommitmentEntityBase.)
	ReferenceMember	Reference used for SEPA transfer (this data doesn't save in commitment table) (Inherited from ICommitmentEntityBase.)
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	States	Gets the entity states (Inherited from IEntity.)
	SupplierType	Gets the type of the supplier. (Type)
	SupplierTypeMember	Gets the type of the supplier. (Type)
	ThirdId	Gets or sets third Id (Code tiers) (Inherited from ICommitmentEntityBase.)
	ThirdIdMember	Gets third Id (Code tiers) (Inherited from ICommitmentEntityBase.)
	TransferedLiquidationAmount	Transfered liquidation amount transfered to accounting (Montant d'écart de règlement transféré) (Inherited from ICommitmentEntityBase.)
	TransferedLiquidationAmountMember	Transfered liquidation amount transfered to accounting (Montant d'écart de règlement transféré) (Inherited from ICommitmentEntityBase.)
	TransferedLiquidationCurrencyAmount	Transfered liquidation currency amount transfered to accounting (Montant d'écart de règlement en devise transféré) (Inherited from ICommitmentEntityBase.)
	TransferedLiquidationCurrencyAmountMember	Transfered liquidation currency amount transfered to accounting (Montant d'écart de règlement en devise transféré) (Inherited from ICommitmentEntityBase.)
	TransferedLiquidationStateChangeDate	Transfered Liquidation change date (Date de changement de l'état "soldé" transféré) (Inherited from ICommitmentEntityBase.)
	TransferedLiquidationStateChangeDateMember	Transfered Liquidation change date (Date de changement de l'état "soldé" transféré) (Inherited from ICommitmentEntityBase.)
	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.)
	CancelLiquidateCommitement	Cancel liquidated manually the commitment (Inherited from ICommitmentEntityBase.)
	CanLiquidateForExchangeDifference	Return true if this commitment can liquidate for exchange difference indicate has currency exchange loss (Inherited from ICommitmentEntityBase.)
	CanMarkOffCommitment	Determines whether can mark off commitment (Inherited from ICommitmentEntityBase.)
	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.)
	LiquidatedCommitment	Liquidate manually the commitment (Inherited from ICommitmentEntityBase.)
	Load	Method for loading the entity (Inherited from IEntity.)
	MarkOffCommitment	Mark off the commitment Only works for commitment of settlement (Inherited from ICommitmentEntityBase.)
	Save	Method for saving the entity to the media (Inherited from IEntity.)
	SetAmount	Set amount of the commitment (Inherited from ICommitmentEntityBase.)
	SetComplexMemberReadOnly	Set the read only property to a member (Inherited from IEntity.)
	SetCurrencyAmount	Set the currency amount of the commitment (Inherited from ICommitmentEntityBase.)
	ShowMessage	Method to display a message. The message is displayed if the UI has connected to the ShowMessage event (Inherited from IApiEntity.)
	UnmarkOffCommitment	Unmark off the commitment Only works for commitment of settlement (Inherited from ICommitmentEntityBase.)

Top

Events

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

Top

Remarks

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

Copy

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

Reference

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