IPeriodicInvoicingEntity Interface

Periodic invoicing entity

(Facturation périodique)

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

Syntax

Copy

[GuidAttribute("4D986521-3ED8-4F4A-B3A1-A240F1062D91")]
public interface IPeriodicInvoicingEntity : IInvoicingEntityBase, 
	IBusinessEntityBase, ISynchronizableEntityBase, IEntity, IApiEntity, IDisposable, 
	IEquatable<IProxy>

<GuidAttribute("4D986521-3ED8-4F4A-B3A1-A240F1062D91")>
Public Interface IPeriodicInvoicingEntity
	Inherits IInvoicingEntityBase, IBusinessEntityBase, ISynchronizableEntityBase, IEntity, 
	IApiEntity, IDisposable, IEquatable(Of IProxy)

The IPeriodicInvoicingEntity type exposes the following members.

Properties

	Name	Description
	ApplyCustomerDiscount	Gets or sets wether to apply customer discount (used for reference document) (Appliquer les remises et escomptes du client)
	ApplyCustomerDiscountMember	Get wether to apply customer discount (used for reference document) (Appliquer les remises et escomptes du client)
	ApplyPriceList	Gets or sets wether to apply price list (used for reference document) (Appliquer les tarifs et promotions)
	ApplyPriceListMember	Get wether to apply price list (used for reference document) (Appliquer les tarifs et promotions)
	AssortCurrencyCalculationMethod	Gets or sets the assort currency calculation method List of authorized values in CurrencyCalculationMethodType
	AssortCurrencyCalculationMethodMember	Get the assort currency calculation method List of authorized values in CurrencyCalculationMethodType
	AssortItemLines	Gets or sets wether to assort item lines (used for assorting) (Regrouper les lignes Article)
	AssortItemLinesMember	Get wether to assort item lines (used for assorting) (Regrouper les lignes Article)
	AssortSettlementModeId	Gets or sets the AssortSettlementModeId
	AssortSettlementModeIdMember	Get the AssortSettlementModeId
	AssortUseCustomSettlementMode	Gets or sets the AssortUseCustomSettlementMode
	AssortUseCustomSettlementModeMember	Get the AssortUseCustomSettlementMode
	Caption	Gets or sets the periofdic invoicing caption (Libellé)
	CaptionMember	Get the periofdic invoicing caption (Libellé)
	CopyTextLines	Gets or sets wether to copy text lines from (used for assorting) (Copier les lignes Texte)
	CopyTextLinesMember	Get wether to copy text lines from (used for assorting) (Copier les lignes Texte)
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	CreateSubTotal	Gets or sets wether to create a sub total for each assorted document (used for assorting) (Générer un sous-total par document)
	CreateSubTotalMember	Get wether to create a sub total for each assorted document (used for assorting) (Générer un sous-total par document)
	CurrencyCalculationMethod	Gets or sets the currency calculation method List of authorized values in CurrencyCalculationMethodType (Mode de calcul de la devise)
	CurrencyCalculationMethodMember	Get the currency calculation method List of authorized values in CurrencyCalculationMethodType (Mode de calcul de la devise)
	CustomerFamilies	Get the related customer families
	Customers	Get the related customers
	DelayBeforeAssortEnabled	Gets or sets the delay to filter deliveries (used for assorting) (Ancienneté minimum des bons de livraison)
	DelayBeforeAssortEnabledMember	Get the delay to filter deliveries (used for assorting) (Ancienneté minimum des bons de livraison)
	DoNotAddOriginDocumentInformationLine	Gets or sets whether the origin document information line must be added (Ne pas ajouter les informations des documents d'origine)
	DoNotAddOriginDocumentInformationLineMember	Gets whether the origin document information line must be added (Ne pas ajouter les informations des documents d'origine)
	DoNotSetLastAssortDebitSepaToLast	Gets or sets whether do not force the sepa debit of the last invoice grouping to last
	DoNotSetLastAssortDebitSepaToLastMember	Gets whether do not force the sepa debit of the last invoice grouping to last
	DoNotSetLastDebitSepaToLast	Gets or sets whether do not force the sepa debit of the last invoice to last, stored in DB (Ne pas générer le séquencement Final sur le dernier prélèvement)
	DoNotSetLastDebitSepaToLastMember	Gets whether do not force the sepa debit of the last invoice to last, stored in DB (Ne pas générer le séquencement Final sur le dernier prélèvement)
	DoNotSetLastInvoiceDebitSepaToLast	Gets or sets whether do not force the sepa debit of the last invoice to last
	DoNotSetLastInvoiceDebitSepaToLastMember	Gets whether do not force the sepa debit of the last invoice to last
	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 Periodic invoicing id (Code)
	IdMember	Get the Periodic invoicing id (Code)
	IgnoreCheckAddress	Gets or sets wehter to ignore customer address checking (used for assorting) (Ignorer la vérification de l’adresse)
	IgnoreCheckAddressMember	Get wehter to ignore customer address checking (used for assorting) (Ignorer la vérification de l’adresse)
	IgnoreCheckUserDefinedFields	Gets or sets whether the User Defined Fields checking have to be ignored (Ignorer la vérification des champs personnalisés)
	IgnoreCheckUserDefinedFieldsMember	Gets whether the User Defined Fields checking have to be ignored (Ignorer la vérification des champs personnalisés)
	InvoiceCurrencyCalculationMethod	Gets or sets the invoice currency calculation method List of authorized values in CurrencyCalculationMethodType
	InvoiceCurrencyCalculationMethodMember	Get the invoice currency calculation method List of authorized values in CurrencyCalculationMethodType
	InvoiceSettlementModeId	Gets or sets the InvoiceSettlementModeId
	InvoiceSettlementModeIdMember	Get the InvoiceSettlementModeId
	InvoiceUseCustomSettlementMode	Gets or sets the InvoiceUseCustomSettlementMode
	InvoiceUseCustomSettlementModeMember	Get the InvoiceUseCustomSettlementMode
	InvoicingMode	Gets or sets the periodic invoicing Mode List of authorized values in PeriodicInvoicingModeTypes (Mode)
	InvoicingModeMember	Get the periodic invoicing Mode List of authorized values in PeriodicInvoicingModeTypes (Mode)
	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.)
	KeepBillOfQuantitiesProgramActive	Gets or sets whether to keep bill of quantities program active on generated invoice (Conserver le calcul de quantité actif)
	KeepBillOfQuantitiesProgramActiveMember	Gets whether to keep bill of quantities program active on generated invoice (Conserver le calcul de quantité actif)
	KeepUnitPriceProgramActive	Gets or sets whether to keep unit price program active on generated invoice (Conserver le calcul de PV HT actif)
	KeepUnitPriceProgramActiveMember	Gets whether to keep unit price program active on generated invoice (Conserver le calcul de PV HT actif)
	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.)
	Periodicity	Get the periodicity settings
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	ReferenceDocumentCurrencyId	Get the reference document related currency id (Code ISO devise)
	ReferenceDocumentCurrencyIdMember	Get the reference document related currency id (Code ISO devise)
	ReferenceDocumentCustomerId	Get the reference document related customer id (Code client)
	ReferenceDocumentCustomerIdMember	Get the reference document related customer id (Code client)
	ReferenceDocumentId	Gets or sets the reference document id (Code document)
	ReferenceDocumentIdMember	Get the reference document id (Code document)
	ReferenceDocumentNumber	Get the reference document number (Numéro du document)
	ReferenceDocumentNumberMember	Get the reference document number (Numéro du document)
	ReferenceDocumentType	Get the reference document type List of authorized values in SaleDocumentSubTypes (Type de document)
	ReferenceDocumentTypeMember	Get the reference document type List of authorized values in SaleDocumentSubTypes (Type de document)
	RetrieveCustomerInformations	Gets or sets wether must retrieve customer informations (used for reference document) (Récupérer les données de la fiche client)
	RetrieveCustomerInformationsMember	Get wether must retrieve customer informations (used for reference document) (Récupérer les données de la fiche client)
	SettlementModeId	Gets or sets the SettlementModeId (Code mode de règlement)
	SettlementModeIdMember	Get the SettlementModeId (Code mode de règlement)
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	States	Gets the entity states (Inherited from IEntity.)
	UniqueId	Gets or sets the unique Id (Inherited from ISynchronizableEntityBase.)
	UniqueIdMember	Gets the unique Id (Inherited from ISynchronizableEntityBase.)
	UpdatePrices	Gets or sets wether must update prices from item for each invoicing (used for reference document) (Actualiser les prix de vente de la pièce)
	UpdatePricesMember	Get wether must update prices from item for each invoicing (used for reference document) (Actualiser les prix de vente de la pièce)
	UpdatePurchaseAndCostPrice	Gets or sets whether must update purchase and cost price. (Actualiser les prix d'achat et de revient)
	UpdatePurchaseAndCostPriceMember	Gets whether must update purchase and cost price. (Actualiser les prix d'achat et de revient)
	UseCustomSettlementMode	Gets or sets the UseCustomSettlementMode (Utiliser un mode de règlement personnalisé)
	UseCustomSettlementModeMember	Get the UseCustomSettlementMode (Utiliser un mode de règlement personnalisé)

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

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

Copy

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

Reference

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