ICommitmentEntityBase Interface

Commitment entity

(Échéance)

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

Syntax

Copy

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

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

The ICommitmentEntityBase type exposes the following members.

Properties

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

Top

Events

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

Top

Reference

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