ISettlementEntityBase Interface

Settlement entity base

(Règlement)

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

Syntax

Copy

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

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

The ISettlementEntityBase type exposes the following members.

Properties

	Name	Description
	AcceptationId	Gets or sets the acceptation code used by CFONB file transfer (Code acceptation)
	AcceptationIdMember	Gets the acceptation code used by CFONB file transfer (Code acceptation)
	AccountingExchangeGroupId	Gets or sets Accounting exchange group Id (Identifiant du lot comptable)
	AccountingExchangeGroupIdMember	Gets Accounting exchange group Id (Identifiant du lot comptable)
	AccountingTransferMode	Gets or sets the accounting transfer mode List of authorized values in SettlementAccountingTransferType (Comptabilisation)
	AccountingTransferModeMember	Gets the accounting transfer mode List of authorized values in SettlementAccountingTransferType (Comptabilisation)
	Amount	Gets or sets the amount (Montant)
	AmountMember	Gets the amount (Montant)
	AssociatedDeliveryId	Gets or sets the associated delivery document Id (Numéro de réception)
	AssociatedDeliveryIdMember	Gets the associated delivery document Id (Numéro de réception)
	AssociatedDeliveryNumber	Gets the associated delivery number (Numéro du document)
	AssociatedDeliveryNumberMember	Gets the associated delivery number (Numéro du document)
	AssociatedInvoiceId	Gets or sets the associated invoice document Id (Code de la facture associée)
	AssociatedInvoiceIdMember	Gets the associated invoice document Id (Code de la facture associée)
	AssociatedInvoiceNumber	Gets the associated invoice number (Numéro du document)
	AssociatedInvoiceNumberMember	Gets the associated invoice number (Numéro du document)
	AssociatedOrderId	Gets or sets the associated order document Id (Code de la commande associée)
	AssociatedOrderIdMember	Gets the associated order document Id (Code de la commande associée)
	AssociatedOrderNumber	Get the associated order number (Numéro du document)
	AssociatedOrderNumberMember	Get the associated order number (Numéro du document)
	AssociatedQuoteId	Gets or sets the associated quote document Id (Code du devis lié)
	AssociatedQuoteIdMember	Gets the associated quote document Id (Code du devis lié)
	AssociatedQuoteNumber	Get the associated quote number (Numéro du document)
	AssociatedQuoteNumberMember	Get the associated quote number (Numéro du document)
	BankCountryId	Gets the bank country Id (Code Pays)
	BankCountryIdMember	Gets the bank country Id (Code Pays)
	BankCurrencyId	Gets the currency id of settlement's bank (Code ISO devise)
	BankCurrencyIdMember	Gets the currency id of settlement's bank (Code ISO devise)
	BankId	Gets or sets the bankId (Banque)
	BankIdMember	Gets the bankId (Banque)
	BankRemittanceId	Gets or sets whether settlement is linked to bank remittance (Code du décaissement)
	BankRemittanceIdMember	Gets whether settlement is linked to bank remittance (Code du décaissement)
	BankRemittanceOperationDate	Gets or sets the bank remittance operation date (Date d'exécution)
	BankRemittanceOperationDateMember	Gets the bank remittance operation date (Date d'exécution)
	BankRemittancePlannedDate	Gets or sets the bank remittance planned date (Date de décaissement prévue)
	BankRemittancePlannedDateMember	Gets the bank remittance planned date (Date de décaissement prévue)
	BillOfExchangeCommitmentId	Gets or sets Id used to create a commitment corresponding to a settlement of bill of exchange type (default 413/403) (Identifiant d'échéance de l'effet)
	BillOfExchangeCommitmentIdMember	Gets Id used to create a commitment corresponding to a settlement of bill of exchange type (default 413/403) (Identifiant d'échéance de l'effet)
	BillOfExchangePointingId	Gets or sets Id used to create a pointing between bill of exchange account entries (default 413/403) (Identifiant de pointage de l'effet)
	BillOfExchangePointingIdMember	Gets Id used to create a pointing between bill of exchange account entries (default 413/403) (Identifiant de pointage de l'effet)
	CommitmentCurrencyTotalAmount	Gets or sets the currency total amount of commitment
	CommitmentCurrencyTotalAmountMember	Get the currency total amount of commitment
	CommitmentCurrencyTotalBalanceDue	Gets or sets the currency total amount of balance due of commitment
	CommitmentCurrencyTotalBalanceDueMember	Get the currency total amount of balance due of commitment
	CommitmentIdToPoint	Gets or sets or set the commitment Id to point
	CommitmentIdToPointMember	Gets or set the commitment Id to point
	Commitments	Gets the collection of corresponding commitment
	CommitmentTotalAmount	Gets or sets the total amount of commitment
	CommitmentTotalAmountMember	Get the total amount of commitment
	CommitmentTotalBalanceDue	Gets or sets the total amount of balance due of commitment
	CommitmentTotalBalanceDueMember	Get the total amount of balance due of commitment
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	CurrencyAmount	Gets or sets the currency amount (Montant en devise)
	CurrencyAmountMember	Get the currency amount (Montant en devise)
	CurrencyConversionRate	Gets or sets the currency conversion rate (Cours de la devise)
	CurrencyConversionRateMember	Get the currency conversion rate (Cours de la devise)
	CurrencyDecimalCountLookup	Get the CurrencyDecimalCountLookup (Nombre de décimales)
	CurrencyDecimalCountLookupMember	Get the CurrencyDecimalCountLookup (Nombre de décimales)
	CurrencyExchangeDifference	Gets or sets the currency exchange difference (Écart de change (Perte))
	CurrencyExchangeDifferenceMember	Get the currency exchange difference (Écart de change (Perte))
	CurrencyFinancialDiscountAmount	Gets or sets the currency financial discount amount (Montant de l'escompte en devise)
	CurrencyFinancialDiscountAmountMember	Gets the currency financial discount amount (Montant de l'escompte en devise)
	CurrencyId	Gets or sets the linked currency id (Code ISO devise)
	CurrencyIdMember	Get the linked currency id (Code ISO devise)
	CurrencyRemainingAmount	Gets or sets the currency assigned amount (Restant à affecter en devise)
	CurrencyRemainingAmountMember	Gets the currency assigned amount (Restant à affecter en devise)
	DepositCommitmentAssociatedDeliveryId	Gets or sets the delivery id Associated to the deposit for a credit memo deposit commitment used for pointings
	DepositCommitmentAssociatedDeliveryIdMember	Gets the delivery id Associated to the deposit for a credit memo deposit commitment used for pointings
	DepositCommitmentAssociatedInvoiceId	Gets or sets the invoice id Associated to the deposit for a credit memo deposit commitment used for pointings
	DepositCommitmentAssociatedInvoiceIdMember	Gets the invoice id Associated to the deposit for a credit memo deposit commitment used for pointings
	DepositCommitmentAssociatedOrderId	Gets or sets the order id Associated to the deposit for a credit memo deposit commitment used for pointings
	DepositCommitmentAssociatedOrderIdMember	Gets the order id Associated to the deposit for a credit memo deposit commitment used for pointings
	DocumentDate	Document date
	DocumentDateMember	Document date
	DocumentId	Gets the document Id
	DocumentIdMember	Gets the document Id
	DocumentNumber	Document number
	DocumentNumberMember	Document number
	DocumentSubType	Gets the credit memo sub type (use to point invoices commitments)
	DocumentSubTypeMember	Gets the credit memo sub type (use to point invoices commitments)
	DocumentThirdName	Document third name
	DocumentThirdNameMember	Document third name
	DocumentValidationState	Document validation state
	DocumentValidationStateMember	Document validation state
	DraweeReference	Gets or sets the drawee reference (Référence tiré)
	DraweeReferenceMember	Gets the drawee reference (Référence tiré)
	EconomicReasonId	Gets or sets the economic reason id (Code motif économique)
	EconomicReasonIdMember	Gets the economic reason id (Code motif économique)
	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.)
	FinancialDiscountAmount	Gets or sets the financial discount amount (Montant de l'escompte)
	FinancialDiscountAmountMember	Gets the financial discount amount (Montant de l'escompte)
	FinancialDiscountId	Gets or sets the id used to identify financial discount's accounting entry (Identifiant escompte)
	FinancialDiscountIdMember	Gets the id used to identify financial discount's accounting entry (Identifiant escompte)
	Id	Gets or sets the id of the settlement (Code règlement)
	IdMember	Gets the id of the settlement (Code règlement)
	IsDeleted	Gets if the mode matches a deleted mode (Inherited from IEntity.)
	IsDeposit	Gets or sets whether the settlement is deposit (Règlement d'acompte)
	IsDepositMember	Gets whether the settlement is deposit (Règlement d'acompte)
	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 settlement is liquidated (Écart de règlement)
	IsLiquidatedMember	Gets if the settlement is liquidated (Écart de règlement)
	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é")
	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.)
	PaymentTypeId	Gets or sets the payment type id (Code moyen de paiement)
	PaymentTypeIdMember	Gets the payment type id (Code moyen de paiement)
	PaymentTypeNature	Gets the payment type nature List of authorized values in PaymentTypeNature (Nature)
	PaymentTypeNatureMember	Gets the payment type nature List of authorized values in PaymentTypeNature (Nature)
	PaymentTypeTransferAtCommitmentDate	Gets whether settlement must be transfered at commitment date (Transférer à la date d'échéance dans le journal de banque)
	PaymentTypeTransferAtCommitmentDateMember	Gets whether settlement must be transfered at commitment date (Transférer à la date d'échéance dans le journal de banque)
	PreviousBankCurrencyId	Gets or sets the previous value of currency id from settlement's bank (lookup member doesn't call ApplyChangedMember method)
	PreviousBankCurrencyIdMember	Gets the previous value of currency id from settlement's bank (lookup member doesn't call ApplyChangedMember method)
	PreviousLiquidationType	Gets or sets the previous liquidation type List of authorized values in LiquidationType (Type d'écart précédent)
	PreviousLiquidationTypeMember	Gets 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	Gets or sets the reference (Libellé/Référence)
	ReferenceMember	Gets the reference (Libellé/Référence)
	RemainingAmount	Gets or sets the assigned amount (Restant à affecter)
	RemainingAmountMember	Gets the assigned amount (Restant à affecter)
	SettlementDate	Gets or sets the date of settlement (Date)
	SettlementDateMember	Gets the date of settlement (Date)
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	States	Gets the entity states (Inherited from IEntity.)
	ThirdBankAccountCaption	Gets the third bank account caption (Libellé)
	ThirdBankAccountCaptionMember	Gets the third bank account caption (Libellé)
	ThirdBankAccountIBAN	Gets the third bank account iban (IBAN)
	ThirdBankAccountIBANMember	Gets the third bank account iban (IBAN)
	ThirdBankAccountId	Gets or sets the third bank account id (Coordonnées bancaires (tiers))
	ThirdBankAccountIdMember	Gets the third bank account id (Coordonnées bancaires (tiers))
	ThirdId	Gets or sets the thirdId (Code (tiers))
	ThirdIdMember	Gets the thirdId (Code (tiers))
	ThirdName	Gets customer name (Nom)
	ThirdNameMember	Gets customer name (Nom)
	TransferedLiquidationAmount	transfered liquidation amount to accounting (Montant d'écart de règlement transféré)
	TransferedLiquidationAmountMember	transfered liquidation amount to accounting (Montant d'écart de règlement transféré)
	TransferedLiquidationCurrencyAmount	transfered liquidation currency amount to accounting (Montant d'écart de règlement en devise transféré)
	TransferedLiquidationCurrencyAmountMember	transfered liquidation currency amount to accounting (Montant d'écart de règlement en devise transféré)
	TransferedLiquidationStateChangeDate	Transfered Liquidate state change date (Date de changement de l'état "soldé" transféré)
	TransferedLiquidationStateChangeDateMember	Transfered Liquidate state 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.)
	ValidationState	Gets or sets if the settlement has been transfered to accountant List of authorized values in SettlementValidationState (État de validation)
	ValidationStateMember	Gets if the settlement has been transfered to accountant List of authorized values in SettlementValidationState (État de validation)

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

Reference

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