 | IDealSaleDocumentEntity Interface |
DealSaleDocument entity
(Document de vente d'affaire/projet)
Namespace: EBP.Api.Interfaces.Invoicing.Module.Entities.Deal
Assembly: EBP.Api.XXX.Interfaces (in EBP.Api.XXX.Interfaces.dll) Version: 1.0.3.0
SyntaxThe IDealSaleDocumentEntity type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AchievedDuration | Gets or sets the total achieved duration of all events linked to document (for orders). (Durée totale réalisée) |
| AchievedDurationMember | Gets the total achieved duration of all events linked to document (for orders). (Durée totale réalisée) |
| AmountVatExcluded | Gets or Sets the net amount vat excluded from lines (Montant HT) |
| AmountVatExcludedMember | Gets or Sets the net amount vat excluded from lines (Montant HT) |
| ColleagueId | Gets or Sets the Colleague id (Code commercial/collaborateur) |
| ColleagueIdMember | Gets or Sets the Colleague id (Code commercial/collaborateur) |
| ConstructionSiteId | Gets or sets the construction site Id (Code du projet) |
| ConstructionSiteIdMember | Gets the construction site Id (Code du projet) |
| CreatedDate |
Gets the Created Date
(Inherited from IEntity.) |
| CreatedUser |
Gets the Created User
(Inherited from IEntity.) |
| DealId | Gets or sets the deal id (Code Affaire) |
| DealIdMember | Gets the deal id (Code Affaire) |
| DocumentDate | Gets or Sets the document date (Inherited from IDealDocumentEntity.) |
| DocumentDateMember | Gets or Sets the document date (Inherited from IDealDocumentEntity.) |
| DocumentId | Gets or Sets the document id (Inherited from IDealDocumentEntity.) |
| DocumentIdMember | Gets or Sets the document id (Inherited from IDealDocumentEntity.) |
| DocumentNumber | Gets or Sets the document number (Inherited from IDealDocumentEntity.) |
| DocumentNumberMember | Gets or Sets the document number (Inherited from IDealDocumentEntity.) |
| DocumentState | Gets or Sets the state (only Quote) Sale document : List of authorized values (StateX) in ISaleQuoteComplexEntityMember which can be found in IReadOnlyInvoicingOptionsEntity Purchase document : List of authorized values (StateX) in IPurchaseQuoteComplexEntityMember which can be found in IReadOnlyInvoicingOptionsEntity (État) |
| DocumentStateMember | Gets or Sets the state (only Quote) Sale document : List of authorized values (StateX) in ISaleQuoteComplexEntityMember which can be found in IReadOnlyInvoicingOptionsEntity Purchase document : List of authorized values (StateX) in IPurchaseQuoteComplexEntityMember which can be found in IReadOnlyInvoicingOptionsEntity (État) |
| DocumentTotalAmountVatIncludedWithDiscount | Gets or sets the DocumentTotalAmountVatIncludedWithDiscount (to dispatch settlement amount) (Montant total HT remisé du document) |
| DocumentTotalAmountVatIncludedWithDiscountMember | Gets the DocumentTotalAmountVatIncludedWithDiscount (to dispatch settlement amount) (Montant total HT remisé du document) |
| DocumentType | Gets or sets the type of the document (Invoice - pick...) Sale document : List of authorized values in SaleDocumentSubTypes Purchase document : List of authorized values in PurchaseDocumentSubTypes Stock document : List of authorized values in StockDocumentSubTypes (Type de document) |
| DocumentTypeMember | Gets the type of the document (Invoice - pick...) Sale document : List of authorized values in SaleDocumentSubTypes Purchase document : List of authorized values in PurchaseDocumentSubTypes Stock document : List of authorized values in StockDocumentSubTypes (Type de document) |
| 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.) |
| ExpectedDuration | Gets or sets the total expected duration of all events linked to document (for orders). (Durée totale planifiée) |
| ExpectedDurationMember | Gets the total expected duration of all events linked to document (for orders). (Durée totale planifiée) |
| GlobalDocumentOrder | GlobaldocumentOrder (Inherited from IDealDocumentEntity.) |
| GlobalDocumentOrderMember | GlobaldocumentOrder (Inherited from IDealDocumentEntity.) |
| GlobalDocumentState | Gets or sets the document state for all the document types (État du document) |
| GlobalDocumentStateMember | Gets the document state for all the document types (État du document) |
| GrossInterestAmount | Gets or Sets the total gross interest amount from lines (Marge brute totale) |
| GrossInterestAmountMember | Gets or Sets the total gross interest amount from lines (Marge brute totale) |
| Id | Gets or Sets the id (Code) |
| IdMember | Gets or Sets the id (Code) |
| InterestAmount | Gets or sets the total interest amount from lines (Marge HT) |
| InterestAmountMember | Gets or sets the total interest amount from lines (Marge HT) |
| InvoicableAchievedDuration | Gets or sets the total invoicable achieved duration of all events linked to document (for orders). (Durée réalisée (facturable)) |
| InvoicableAchievedDurationMember | Gets the total invoicable achieved duration of all events linked to document (for orders). (Durée réalisée (facturable)) |
| InvoicableExpectedDuration | Gets or sets the total invoicable expected duration of all events linked to document (for orders). (Durée planifiée (facturable)) |
| InvoicableExpectedDurationMember | Gets the total invoicable expected duration of all events linked to document (for orders). (Durée planifiée (facturable)) |
| InvoicableToScheduleDuration | Gets or sets the total invoicable expected duration of all events in 'ToSchedule' state linked to document (for orders). (Durée à planifier (facturable)) |
| InvoicableToScheduleDurationMember | Gets the total invoicable expected duration of all events in 'ToSchedule' state linked to document (for orders). (Durée à planifier (facturable)) |
| InvoiceCorrectionType | Gets or sets the type of the invoice correction. List of authorized values in InvoiceCorrectionType (Type de rectification) |
| InvoiceCorrectionTypeMember | Gets the type of the invoice correction. List of authorized values in InvoiceCorrectionType (Type de rectification) |
| 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.) |
| LastTransferedDocumentSubType | Gets the last transfered document sub type Sale document : List of authorized values in SaleDocumentSubTypes Purchase document : List of authorized values in PurchaseDocumentSubTypes (Type de document) |
| LastTransferedDocumentSubTypeMember | Gets the last transfered document sub type Sale document : List of authorized values in SaleDocumentSubTypes Purchase document : List of authorized values in PurchaseDocumentSubTypes (Type de document) |
| Lines | Gets or Sets the lines (Inherited from IDealDocumentEntity.) |
| 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.) |
| NetAmountVatExcludedWithDiscount | Gets or Sets the net amount vat excluded with discount from lines (Montant Net HT remisé) |
| NetAmountVatExcludedWithDiscountMember | Gets or Sets the net amount vat excluded with discount from lines (Montant Net HT remisé) |
| NetAmountVatIncludedWithDiscountAndEcotax | Gets or sets the net amount vat included with discount It is used to dispatch settlement amount (Montant Net TTC remisé) |
| NetAmountVatIncludedWithDiscountAndEcotaxMember | Gets the net amount vat included with discount It is used to dispatch settlement amount (Montant Net TTC remisé) |
| NetInterestAmount | Gets or Sets the total net interest amount from lines (Marge nette HT ) |
| NetInterestAmountMember | Gets or Sets the total net interest amount from lines (Marge nette HT ) |
| 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.) |
| PreviousDocuments | Gets or Sets the previous documents (document history) (Inherited from IDealDocumentEntity.) |
| ReadOnly |
Gets/Sets if the entity is in read only mode, to preserve from data changing
(Inherited from IEntity.) |
| 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 the third id (Code client) |
| ThirdIdMember | Gets or Sets the third id (Code client) |
| ThirdName | Gets or Sets the third name (Nom du client) |
| ThirdNameMember | Gets or Sets the third name (Nom du client) |
| ToScheduleDuration | Gets or sets the total expected duration of all events in 'ToSchedule' state linked to document (for orders). (Durée totale à planifier) |
| ToScheduleDurationMember | Gets the total expected duration of all events in 'ToSchedule' state linked to document (for orders). (Durée totale à planifier) |
| TransferedDocumentId | Gets or Sets the transfered document id (Inherited from IDealDocumentEntity.) |
| TransferedDocumentIdMember | Gets or Sets the transfered document id (Inherited from IDealDocumentEntity.) |
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.) |
Events| Name | Description | |
|---|---|---|
 | ModeChanged |
Event raised on mode changed
(Inherited from IEntity.) |
RemarksIDealSaleDocumentEntity instance = Utils<ExtensionType>.GetInterface<IDealSaleDocumentEntity>();
See Also