ICustomerFamilyEntity Interface

CustomerFamily Entity

(Famille client/prospect)

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

Syntax

Copy

[GuidAttribute("6c5b131c-bc88-418a-87c8-2aa2c9a0f2da")]
public interface ICustomerFamilyEntity : IThirdFamilyEntityBase, 
	IThirdPartyFamilyEntityBase, IBusinessEntityBase, ISynchronizableEntityBase, IEntity, IApiEntity, 
	IDisposable, IEquatable<IProxy>

<GuidAttribute("6c5b131c-bc88-418a-87c8-2aa2c9a0f2da")>
Public Interface ICustomerFamilyEntity
	Inherits IThirdFamilyEntityBase, IThirdPartyFamilyEntityBase, IBusinessEntityBase, ISynchronizableEntityBase, 
	IEntity, IApiEntity, IDisposable, IEquatable(Of IProxy)

The ICustomerFamilyEntity type exposes the following members.

Properties

	Name	Description
	AnalyticAccounting	Gets the analytic accounting members (Inherited from IThirdFamilyEntityBase.)
	AutomaticStockBooking	Gets or sets the automatic stock booking. (Réservation de stock automatique)
	AutomaticStockBookingMember	Gets the automatic stock booking. (Réservation de stock automatique)
	Caption	Description of the ThirdParty's Family (Libellé) (Inherited from IThirdPartyFamilyEntityBase.)
	CaptionMember	Description of the ThirdParty's Family (Libellé) (Inherited from IThirdPartyFamilyEntityBase.)
	ColleagueFirstName	key lookup member on the first name column, used to update the description (Prénom) (Inherited from IThirdFamilyEntityBase.)
	ColleagueFirstNameMember	key lookup member on the first name column, used to update the description (Prénom) (Inherited from IThirdFamilyEntityBase.)
	ColleagueId	Colleague Id (Code commercial/collaborateur) (Inherited from IThirdFamilyEntityBase.)
	ColleagueIdMember	Colleague Id (Code commercial/collaborateur) (Inherited from IThirdFamilyEntityBase.)
	ColleagueLabel	Description (Inherited from IThirdFamilyEntityBase.)
	ColleagueLabelMember	Description (Inherited from IThirdFamilyEntityBase.)
	ColleagueLastName	key lookup member on the last name column, used to update the description (Nom) (Inherited from IThirdFamilyEntityBase.)
	ColleagueLastNameMember	key lookup member on the last name column, used to update the description (Nom) (Inherited from IThirdFamilyEntityBase.)
	CreatedDate	Gets the Created Date (Inherited from IEntity.)
	CreatedUser	Gets the Created User (Inherited from IEntity.)
	DepositPercentage	Gets or sets the deposit percentage (% acompte)
	DepositPercentageMember	Gets the deposit percentage (% acompte)
	DiscountRate	Gets or sets the discount to apply to thirds (% remise) (Inherited from IThirdFamilyEntityBase.)
	DiscountRateMember	Gets the discount to apply to thirds (% remise) (Inherited from IThirdFamilyEntityBase.)
	DocumentSerialId	Gets or sets the default document serial id to use when creating document (Série de documents) (Inherited from IThirdFamilyEntityBase.)
	DocumentSerialIdMember	Gets the default document serial id to use when creating document (Série de documents) (Inherited from IThirdFamilyEntityBase.)
	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.)
	FinancialDiscountRate	Gets or sets or set the financial discount rate (% escompte) (Inherited from IThirdFamilyEntityBase.)
	FinancialDiscountRateMember	Gets or set the financial discount rate (% escompte) (Inherited from IThirdFamilyEntityBase.)
	Id	Id of the ThirdParty's Family (Code famille tiers) (Inherited from IThirdPartyFamilyEntityBase.)
	IdMember	Id of the ThirdParty's Family (Code famille tiers) (Inherited from IThirdPartyFamilyEntityBase.)
	InvoicingChargesAmount	Invoicing Charges (Frais de facturation) (Inherited from IThirdFamilyEntityBase.)
	InvoicingChargesAmountMember	Invoicing Charges (Frais de facturation) (Inherited from IThirdFamilyEntityBase.)
	InvoicingChargesVatId	Invoicing Charges vat id (TVA Frais) (Inherited from IThirdFamilyEntityBase.)
	InvoicingChargesVatIdMember	Invoicing Charges vat id (TVA Frais) (Inherited from IThirdFamilyEntityBase.)
	InvoicingChargesVatRate	Gets the Invoicing Charges VAT rate (Taux de TVA) (Inherited from IThirdFamilyEntityBase.)
	InvoicingChargesVatRateMember	Gets the Invoicing Charges VAT rate (Taux de TVA) (Inherited from IThirdFamilyEntityBase.)
	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.)
	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.)
	PaymentDate	Payment date (Date de paiement) (Inherited from IThirdFamilyEntityBase.)
	PaymentDateMember	Payment date (Date de paiement) (Inherited from IThirdFamilyEntityBase.)
	PeriodicInvoicingSettings	Get the customer family periodic invoicings
	PriceListCategoryId	Gets or sets the PriceListCategory (Code de la catégorie tarifaire) (Inherited from IThirdFamilyEntityBase.)
	PriceListCategoryIdMember	Gets the PriceListCategory (Code de la catégorie tarifaire) (Inherited from IThirdFamilyEntityBase.)
	PriceListCollection	Gets the price list collection of the customer (Inherited from IThirdFamilyEntityBase.)
	PriceWithTaxBased	Default value for customer and customer familly (Facturation TTC)
	PriceWithTaxBasedMember	Default value for customer and customer familly (Facturation TTC)
	ReadOnly	Gets/Sets if the entity is in read only mode, to preserve from data changing (Inherited from IEntity.)
	RelatedPeriodicInvoicings	Get the related periodic invoicings
	SchedulerColor	Gets or sets the color in the scheduler (Couleur dans le planning) (Inherited from IThirdFamilyEntityBase.)
	SchedulerColorMember	Gets the color in the scheduler (Couleur dans le planning) (Inherited from IThirdFamilyEntityBase.)
	SecondDiscountRate	Gets or sets the SecondDiscountRate (% remise 2) (Inherited from IThirdFamilyEntityBase.)
	SecondDiscountRateMember	Get the SecondDiscountRate (% remise 2) (Inherited from IThirdFamilyEntityBase.)
	SecurityBondRate	Gets or sets the security bond rate (Taux de retenue de garantie)
	SecurityBondRateForGoodCompletedWork	Gets or sets the security bond rate for good completed work (Taux de retenue de garantie pour bonne fin de travaux)
	SecurityBondRateForGoodCompletedWorkMember	Gets the security bond rate for good completed work (Taux de retenue de garantie pour bonne fin de travaux)
	SecurityBondRateMember	Gets the security bond rate (Taux de retenue de garantie)
	SettlementModeCaptionInUserLanguage	Settlement mode caption in user language (Inherited from IThirdFamilyEntityBase.)
	SettlementModeCaptionInUserLanguageMember	Settlement mode caption in user language (Inherited from IThirdFamilyEntityBase.)
	SettlementModeId	Settlement Mode Id (Code mode de règlement) (Inherited from IThirdFamilyEntityBase.)
	SettlementModeIdMember	Settlement Mode Id (Code mode de règlement) (Inherited from IThirdFamilyEntityBase.)
	ShippingId	Gets or sets the ShippingId (Code frais de port) (Inherited from IThirdFamilyEntityBase.)
	ShippingIdMember	get the ShippingId (Code frais de port) (Inherited from IThirdFamilyEntityBase.)
	Silent	Get/Sets if the entity is in silent mode (Inherited from IEntity.)
	States	Gets the entity states (Inherited from IEntity.)
	SubjectToRe	Gets or sets SubjectToRE (Sujet au RE)
	SubjectToReMember	Gets SubjectToRE (Sujet au RE)
	TerritorialityId	Gets or sets the territoriality to apply to thirds List of authorized values (Ends with TerritorialityUniqueId) in IDatasHelper (Territorialité) (Inherited from IThirdFamilyEntityBase.)
	TerritorialityIdMember	Gets the territoriality to apply to thirds List of authorized values (Ends with TerritorialityUniqueId) in IDatasHelper (Territorialité) (Inherited from IThirdFamilyEntityBase.)
	ThirdCustomReports	Get the ThirdCustomReports (Inherited from IThirdFamilyEntityBase.)
	UniqueId	Gets or sets the unique Id (Inherited from ISynchronizableEntityBase.)
	UniqueIdMember	Gets the unique Id (Inherited from ISynchronizableEntityBase.)
	WebContactSendKind	Gets or sets IsWebCustomer List of authorized values in WebContactSendType (Type d'envoi des contacts sur le web)
	WebContactSendKindMember	Gets IsWebCustomer List of authorized values in WebContactSendType (Type d'envoi des contacts sur le web)

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.)
	TerritorialityChanged	Occurs when the territoriality changed (Inherited from IThirdFamilyEntityBase.)

Top

Remarks

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

Copy

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

Reference

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