 | ITradeDocumentEntityBase Interface |
Class representing trade document entity base
(Client/Prospect)
Namespace: EBP.Api.Interfaces.Invoicing.Module.Entities.TradeDocument
Assembly: EBP.Api.XXX.Interfaces (in EBP.Api.XXX.Interfaces.dll) Version: 1.0.3.0
SyntaxThe ITradeDocumentEntityBase type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AllowNotReferencedItems | Gets whether the non referenced items are allowed in the document (Inherited from IDocumentEntityBase.) |
| AllowSleepingItem | Gets whether sleeping items are allowed (Inherited from IDocumentEntityBase.) |
| AmountVatExcluded | Gets or sets the amount VAT excluded |
| AmountVatExcludedMember | Gets the amount VAT excluded |
| AmountVatExcludedWithDiscount | Gets or sets the amount VAT excluded with discount |
| AmountVatExcludedWithDiscountAndShipping | Amount Vat Excluded With Discount, Shipping and invoicing charges |
| AmountVatExcludedWithDiscountAndShippingMember | Amount Vat Excluded With Discount, Shipping and invoicing charges |
| AmountVatExcludedWithDiscountAndShippingWithoutEcotax | Amount Vat Excluded With Discount, Shipping and invoicing charges Without Ecotax |
| AmountVatExcludedWithDiscountAndShippingWithoutEcotaxMember | Amount Vat Excluded With Discount, Shipping and invoicing charges Without Ecotax |
| AmountVatExcludedWithDiscountMember | Gets the amount VAT excluded with discount |
| AmountVatIncluded | Gets or sets the amount VAT included |
| AmountVatIncludedMember | Gets the amount VAT included |
| AmountWithFinancialDiscount | Gets or sets the amount whith discount, shipping and invoicing charges, financial discount deducted |
| AmountWithFinancialDiscountMember | Gets the amount whith discount, shipping and invoicing charges, financial discount deducted |
| AssociatedFiles | Files associated to the document (Inherited from IDocumentEntityBase.) |
| BaseAmountVatExcluded | Gets or sets the amount VAT excluded
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseAmountVatExcludedMember | Gets the amount VAT excluded
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseAmountVatExcludedWithDiscount | Gets or sets the amount VAT excluded with discount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseAmountVatExcludedWithDiscountAndShipping | Gets or sets the amount VAT excluded with discount and shipping
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseAmountVatExcludedWithDiscountAndShippingMember | Gets the amount VAT excluded with discount and shipping
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseAmountVatExcludedWithDiscountAndShippingWithoutEcotax | Gets or sets the amount VAT excluded with discount and shipping without ecotax
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseAmountVatExcludedWithDiscountAndShippingWithoutEcotaxMember | Gets the amount VAT excluded with discount and shipping without ecotax
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseAmountVatExcludedWithDiscountMember | Gets the amount VAT excluded with discount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseAmountVatIncluded | Gets or sets the amount VAT included
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseAmountVatIncludedMember | Gets the amount VAT included
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseAmountWithFinancialDiscount | Gets or sets the amount with financial discount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseAmountWithFinancialDiscountMember | Gets the amount with financial discount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseDiscountAmount | Gets or sets the Discount Amount |
| BaseDiscountAmountMember | Gets the Discount Amount |
| BaseEcotaxAmountVatExcluded | Gets or sets the ecotax amount VAT excluded
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxAmountVatExcludedMember | Gets the ecotax amount VAT excluded
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxAmountVatIncluded | Gets or sets the ecotax amount VAT included
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxAmountVatIncludedMember | Gets the ecotax amount VAT included
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxFurnitureAmountIncludedToDueAmount | Gets or sets the base ecotax furniture amount included to due amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxFurnitureAmountIncludedToDueAmountMember | Gets the base ecotax furniture amount included to due amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxFurnitureAmountVatExcluded | Gets or sets the ecotax furniture amount vat excluded
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxFurnitureAmountVatExcludedIncludedToDueAmount | Gets or sets the ecotax furniture amount vat excluded that is included in document due amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxFurnitureAmountVatExcludedIncludedToDueAmountMember | Gets the ecotax furniture amount vat excluded that is included in document due amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxFurnitureAmountVatExcludedMember | Gets the ecotax furniture amount vat excluded
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxFurnitureAmountVatIncluded | Gets or sets the ecotax furniture amount vat included
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxFurnitureAmountVatIncludedMember | Gets the ecotax furniture amount vat included
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxFurnitureVatAmount | Gets or sets the ecotax furniture vat amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxFurnitureVatAmountIncludedToDueAmount | Gets or sets the ecotax furniture vat amount that is included in document due amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxFurnitureVatAmountIncludedToDueAmountMember | Gets the ecotax furniture vat amount that is included in document due amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxFurnitureVatAmountMember | Gets the ecotax furniture vat amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxVatAmount | Gets or sets the ecotax VAT amoung
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseEcotaxVatAmountMember | Gets the ecotax VAT amoung
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseFinancialDiscountAmount | Gets or sets the financial discount amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseFinancialDiscountAmountMember | Gets the financial discount amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseInvoicingChargesAmountVatExcluded | Gets or sets the invoicing charges amount VAT excluded
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseInvoicingChargesAmountVatExcludedMember | Gets the invoicing charges amount VAT excluded
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseOtherTaxAmount | Gets or sets the other tax amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseOtherTaxAmountMember | Gets the other tax amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseShippingAmountVatExcluded | Gets or sets the shipping amount vat excluded
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseShippingAmountVatExcludedMember | Gets the shipping amount vat excluded
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseTotalDueAmount | Gets or sets the amount total due amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseTotalDueAmountMember | Gets the amount total due amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseVatAmount | Gets or sets the VAT amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseVatAmountMember | Gets the VAT amount
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseVatAmountWithoutEcotax | Gets or sets the VAT amount without ecotax
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| BaseVatAmountWithoutEcotaxMember | Gets the VAT amount without ecotax
(currency amount if the currency is applied on all the document, otherwise classic amount) |
| Behavior | Gets the document functionalities (Inherited from IDocumentEntityBase.) |
| CanContinueOnExceededAmount | Gets or sets whether the user has chosen to continue after the exceeded amount warning has been shown |
| CanContinueOnExceededAmountMember | Gets whether the user has chosen to continue after the exceeded amount warning has been shown |
| CanInsertNotReferencedItem | Gets whether the non referenced items are allowed in the document (Inherited from IDocumentEntityBase.) |
| ColleagueDocumentSerialId | Gets or sets the colleague document serial identifier. |
| ColleagueDocumentSerialIdMember | Gets the colleague document serial identifier. |
| ColleagueFirstName | Gets the colleague first name |
| ColleagueFirstNameMember | Gets the colleague first name |
| ColleagueId | Gets or sets the colleague Id |
| ColleagueIdMember | Gets the colleague Id |
| ColleagueLabel | Gets or sets the colleague label |
| ColleagueLabelMember | Gets the colleague label |
| ColleagueLastName | Gets the colleague last name |
| ColleagueLastNameMember | Gets the colleague last name |
| CommitmentDate | Gets or sets the commitment date |
| CommitmentDateMember | Gets the commitment date |
| CompanyBankId | Gets or sets the bank account id |
| CompanyBankIdMember | Gets the bank account id |
| ComplementaryDiscounts | Complementary discounts collection |
| ConstructionSiteCaption | Gets or sets the construction site caption (Inherited from IDocumentEntityBase.) |
| ConstructionSiteCaptionMember | Gets the construction site caption (Inherited from IDocumentEntityBase.) |
| ConstructionSiteId | Gets or sets the construction site Id (Inherited from IDocumentEntityBase.) |
| ConstructionSiteIdMember | Gets the construction site Id (Inherited from IDocumentEntityBase.) |
| ConstructionSiteManagementStockType | Gets or sets the management stock type of the construction site |
| ConstructionSiteManagementStockTypeMember | Gets the management stock type of the construction site |
| ConstructionSiteStorehouseId | Gets or sets the construction site storehouse Id (Inherited from IDocumentEntityBase.) |
| ConstructionSiteStorehouseIdMember | Gets the construction site storehouse Id (Inherited from IDocumentEntityBase.) |
| ContainsNomenclatureLevelSuperiorTo1 | Gets or sets whether there is a nomenclature which level is >1 |
| ContainsNomenclatureLevelSuperiorTo1Member | Gets whether there is a nomenclature which level is >1 |
| CostPrice | Gets or sets the cost price |
| CostPriceMember | Gets the cost price |
| CreatedDate |
Gets the Created Date
(Inherited from IEntity.) |
| CreatedUser |
Gets the Created User
(Inherited from IEntity.) |
| CurrencyAmountVatExcluded | Gets or sets the currency amount VAT excluded |
| CurrencyAmountVatExcludedMember | Gets the currency amount VAT excluded |
| CurrencyAmountVatExcludedWithDiscount | Gets or sets the currency amount VAT excluded with discount |
| CurrencyAmountVatExcludedWithDiscountAndShipping | Gets or sets the currency amount VAT excluded with discount and shipping |
| CurrencyAmountVatExcludedWithDiscountAndShippingMember | Gets the currency amount VAT excluded with discount and shipping |
| CurrencyAmountVatExcludedWithDiscountAndShippingWithoutEcotax | Gets or sets the currency amount VAT excluded with discount and shipping without ecotax |
| CurrencyAmountVatExcludedWithDiscountAndShippingWithoutEcotaxMember | Gets the currency amount VAT excluded with discount and shipping without ecotax |
| CurrencyAmountVatExcludedWithDiscountMember | Gets the currency amount VAT excluded with discount |
| CurrencyAmountVatIncluded | Gets or sets the currency amount VAT included |
| CurrencyAmountVatIncludedMember | Get the currency amount VAT included |
| CurrencyAmountWithFinancialDiscount | Gets or sets the amount whith discount and shipping, financial discount deducted |
| CurrencyAmountWithFinancialDiscountMember | Gets the amount whith discount and shipping, financial discount deducted |
| CurrencyApplicationType | Gets or sets the currency aplication type
List of authorized values in CurrencyApplicationTypes |
| CurrencyApplicationTypeMember | Gets the currency aplication type
List of authorized values in CurrencyApplicationTypes |
| CurrencyConversionRate | Gets or sets the currency conversion rate |
| CurrencyConversionRateMember | Get the currency conversion rate |
| CurrencyDecimalCountLookup | Get the current decimal count |
| CurrencyDecimalCountLookupMember | Get the current decimal count |
| CurrencyDiscountAmount | Gets or sets the currency discount amount |
| CurrencyDiscountAmountMember | Gets the currency discount amount |
| CurrencyEcotaxAmountVatExcluded | Gets or sets the currency ecotax amount VAT excluded |
| CurrencyEcotaxAmountVatExcludedMember | Gets the currency ecotax amount VAT excluded |
| CurrencyEcotaxAmountVatIncluded | Gets or sets the currency ecotax amount VAT included |
| CurrencyEcotaxAmountVatIncludedMember | Gets the currency ecotax amount VAT included |
| CurrencyEcotaxFurnitureAmountIncludedToDueAmount | Gets or sets the ecotax furniture currency amount included to due amount |
| CurrencyEcotaxFurnitureAmountIncludedToDueAmountMember | Gets the ecotax furniture currency amount included to due amount |
| CurrencyEcotaxFurnitureAmountVatExcluded | Gets or sets the ecotax furniture currency amount vat excluded |
| CurrencyEcotaxFurnitureAmountVatExcludedIncludedToDueAmount | Gets or sets the ecotax furniture currency amount vat excluded that is included in document due amount |
| CurrencyEcotaxFurnitureAmountVatExcludedIncludedToDueAmountMember | Gets the ecotax furniture currency amount vat excluded that is included in document due amount |
| CurrencyEcotaxFurnitureAmountVatExcludedMember | Gets the ecotax furniture currency amount vat excluded |
| CurrencyEcotaxFurnitureAmountVatIncluded | Gets or sets the ecotax furniture currency amount vat included |
| CurrencyEcotaxFurnitureAmountVatIncludedMember | Gets the ecotax furniture currency amount vat included |
| CurrencyEcotaxFurnitureVatAmount | Gets or sets the ecotax furniture vat currency amount |
| CurrencyEcotaxFurnitureVatAmountIncludedToDueAmount | Gets or sets the ecotax furniture vat currency amount that is included in document due amount |
| CurrencyEcotaxFurnitureVatAmountIncludedToDueAmountMember | Gets the ecotax furniture vat currency amount that is included in document due amount |
| CurrencyEcotaxFurnitureVatAmountMember | Gets the ecotax furniture vat currency amount |
| CurrencyEcotaxVatAmount | Gets or sets the currency ecotax VAT amount |
| CurrencyEcotaxVatAmountMember | Gets the currency ecotax VAT amount |
| CurrencyFinancialDiscountAmount | Gets or sets the currency financial discout amount |
| CurrencyFinancialDiscountAmountMember | Gets the currency financial discout amount |
| CurrencyId | Gets or sets the linked currency id |
| CurrencyIdMember | Get the linked currency id |
| CurrencyInvoicingChargesAmountVatExcluded | Gets or sets the currency invoicing charges amount VAT excluded |
| CurrencyInvoicingChargesAmountVatExcludedMember | Gets the currency invoicing charges amount VAT excluded |
| CurrencyOtherTaxAmount | Gets or sets the currency other tax amount |
| CurrencyOtherTaxAmountMember | Gets the currency other tax amount |
| CurrencyOtherTaxAmountNotSubjectToVat | Gets or sets the currency other tax amount not subject to VAT |
| CurrencyOtherTaxAmountNotSubjectToVatMember | Get the currency other tax amount not subject to VAT |
| CurrencyShippingAmountVatExcluded | Gets or sets the currency shipping amount VAT excluded |
| CurrencyShippingAmountVatExcludedMember | Gets the currency shipping amount VAT excluded |
| CurrencySymbol | Gets or sets the currencr symbol |
| CurrencySymbolMember | Gets the currencr symbol |
| CurrencyTotalDueAmount | Gets or sets the currency total due amount |
| CurrencyTotalDueAmountMember | Get the currency total due amount |
| CurrencyVatAmount | Gets or sets the currency VAT amount |
| CurrencyVatAmountMember | Gets the currency VAT amount |
| CurrencyVatAmountWithoutEcotax | Gets the currency VAT amount without ecotax |
| CurrencyVatAmountWithoutEcotaxMember | Gets the currency VAT amount without ecotax |
| DealCaption | Gets or sets the deal caption (Inherited from IDocumentEntityBase.) |
| DealCaptionMember | Gets the deal caption (Inherited from IDocumentEntityBase.) |
| DealId | Gets or sets the deal id (Inherited from IDocumentEntityBase.) |
| DealIdMember | Gets the deal id (Inherited from IDocumentEntityBase.) |
| DeliveryAddress | Gets the delivery address |
| DeliveryAddressCountryCaptionInUserLanguage | Delivery adress country caption in user language |
| DeliveryAddressCountryCaptionInUserLanguageMember | Delivery adress country caption in user language |
| DeliveryAddressId | Gets or sets the delivery address Id |
| DeliveryAddressIdMember | Gets the delivery address Id |
| DeliveryContact | Gets the delivery contact |
| DeliveryContactId | Gets or sets the delivery contact Id |
| DeliveryContactIdMember | Gets the delivery contact Id |
| DiscountAmount | Gets or sets the discount amount |
| DiscountAmountMember | Gets the discount amount |
| DiscountRate | Gets or sets the discount rate |
| DiscountRateMember | Gets the discount rate |
| DispatchedByStorehouse | Gets or sets if Document is dispatched on multiple Storehouses (Inherited from IDocumentEntityBase.) |
| DispatchedByStorehouseMember | Gets if Document is dispatched on multiple Storehouses (Inherited from IDocumentEntityBase.) |
| DocumentDate | Date of the document (Inherited from IDocumentEntityBase.) |
| DocumentDateMember | Date of the document (Inherited from IDocumentEntityBase.) |
| DocumentLanguage | Document language (iso code) : language of item label and description |
| DocumentLanguageMember | Document language (iso code) : language of item label and description |
| DocumentNumber | Id of the Items Family (Inherited from IDocumentEntityBase.) |
| DocumentNumberMember | Id of the Items Family (Inherited from IDocumentEntityBase.) |
| DocumentSerialId | Gets or sets the document serial id (Inherited from IDocumentEntityBase.) |
| DocumentSerialIdMember | Gets the document serial id (Inherited from IDocumentEntityBase.) |
| DocumentType | Type of the document (E:PutAway - S:Pick - F:Invoice - D:Quote)
(Inherited from IDocumentEntityBase.)Sale document : List of authorized values in SaleDocumentSubTypes Purchase document : List of authorized values in PurchaseDocumentSubTypes Stock document : List of authorized values in StockDocumentSubTypes |
| DocumentTypeMember | Type of the document (E:PutAway - S:Pick - F:Invoice - D:Quote)
(Inherited from IDocumentEntityBase.)Sale document : List of authorized values in SaleDocumentSubTypes Purchase document : List of authorized values in PurchaseDocumentSubTypes Stock document : List of authorized values in StockDocumentSubTypes |
| DoNotCreateMovement | Gets or sets whether the line must be delivered |
| DoNotCreateMovementMember | Gets whether the line must be delivered |
| DoNotShowMessageOnAmountExceeded | Gets or sets whether amount exceeded message must not be shown |
| DoNotShowMessageOnAmountExceededMember | Gets whether amount exceeded message must not be shown |
| EcotaxAmountVatExcluded | Gets or sets the ecotax amount vat excluded |
| EcotaxAmountVatExcludedMember | Gets the ecotax amount vat excluded |
| EcotaxAmountVatIncluded | Gets or sets the ecotax amount vat included |
| EcotaxAmountVatIncludedMember | Gets the ecotax amount vat included |
| EcotaxFurnitureAmountIncludedToDueAmount | Gets or sets the ecotax furniture amount included to due amount |
| EcotaxFurnitureAmountIncludedToDueAmountMember | Gets the ecotax furniture amount included to due amount |
| EcotaxFurnitureAmountVatExcluded | Gets or sets the ecotax furniture amount vat excluded |
| EcotaxFurnitureAmountVatExcludedIncludedToDueAmount | Gets or sets the ecotax furniture amount vat excluded that is included in document due amount |
| EcotaxFurnitureAmountVatExcludedIncludedToDueAmountMember | Gets the ecotax furniture amount vat excluded that is included in document due amount |
| EcotaxFurnitureAmountVatExcludedMember | Gets the ecotax furniture amount vat excluded |
| EcotaxFurnitureAmountVatIncluded | Gets or sets the ecotax furniture amount vat included |
| EcotaxFurnitureAmountVatIncludedMember | Gets the ecotax furniture amount vat included |
| EcotaxFurnitureVatAmount | Gets or sets the ecotax furniture vat amount |
| EcotaxFurnitureVatAmountIncludedToDueAmount | Gets or sets the ecotax furniture vat amount that is included in document due amount |
| EcotaxFurnitureVatAmountIncludedToDueAmountMember | Gets the ecotax furniture vat amount that is included in document due amount |
| EcotaxFurnitureVatAmountMember | Gets the ecotax furniture vat amount |
| EcotaxVatAmount | Gets or sets the ecotax vat amount |
| EcotaxVatAmountMember | Gets the ecotax vat amount |
| 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 |
| FinancialDiscountAmountMember | Gets the financial discount amount |
| FinancialDiscountRate | Gets or sets or set the financial discount rate |
| FinancialDiscountRateMember | Gets or set the financial discount rate |
| FinancialDiscountType | Gets or sets or set the financial discount type
List of authorized values in FinancialDiscountType |
| FinancialDiscountTypeMember | Gets or set the financial discount type
List of authorized values in FinancialDiscountType |
| FixedShippingAmount | Gets or sets whether shipping amount is fixed by previous document |
| FixedShippingAmountMember | Gets whether shipping amount is fixed by previous document |
| GlobalDocumentOrder | Global Document Order used for all kind of documents (stock, invoice ...) (Inherited from IDocumentEntityBase.) |
| GlobalDocumentOrderMember | Global Document Order used for all kind of documents (stock, invoice ...) (Inherited from IDocumentEntityBase.) |
| Hash | Gets the hash. (Inherited from IDocumentEntityBase.) |
| HasNotReferencedItemRight | Gets whether the non referenced items are allowed in the document (Inherited from IDocumentEntityBase.) |
| Id | internal Id for the document (Inherited from IDocumentEntityBase.) |
| IdentificationType | Gets or sets the identification type |
| IdentificationTypeMember | Gets the identification type |
| IdEx | Gets or sets the extended document id. Used by Framework to automatically query the extended table |
| IdExMember | Gets the extended document id. Used by Framework to automatically query the extended table |
| IdMember | internal Id for the document (Inherited from IDocumentEntityBase.) |
| IncidentId | Gets or sets the incident Id (Inherited from IDocumentEntityBase.) |
| IncidentIdMember | Gets the incident Id (Inherited from IDocumentEntityBase.) |
| InternalNumberSuffix | Gets or sets the internal number suffix
On opposition to the number suffix, its persisted in database to can order on document number (Inherited from IDocumentEntityBase.) |
| InternalNumberSuffixMember | Gets the internal number suffix
On opposition to the number suffix, its persisted in database to can order on document number (Inherited from IDocumentEntityBase.) |
| IntrastatIncoterm | Gets or sets the incoterm |
| IntrastatIncotermMember | Gets the incoterm |
| IntrastatTransactionNature | Gets or sets the transaction nature |
| IntrastatTransactionNatureMember | Gets the transaction nature |
| IntrastatTransportMode | Gets or sets the transport mode |
| IntrastatTransportModeMember | Gets the transport mode |
| InvoicingAddress | Gets the invoicing address |
| InvoicingAddressCountryCaptionInUserLanguage | Invoicing adress country caption in user language |
| InvoicingAddressCountryCaptionInUserLanguageMember | Invoicing adress country caption in user language |
| InvoicingAddressId | Gets or sets the invoicing address Id |
| InvoicingAddressIdMember | Gets the invoicing address Id |
| InvoicingChargesAmountVatExcluded | Gets or sets the invoicing charges amount VAT excluded |
| InvoicingChargesAmountVatExcludedMember | Gets the invoicing charges amount VAT excluded |
| InvoicingChargesNotSubjectToFinancialDiscount | Gets or sets the InvoicingChargesNotSubjectToFinancialDiscount |
| InvoicingChargesNotSubjectToFinancialDiscountMember | Gets the InvoicingChargesNotSubjectToFinancialDiscount |
| InvoicingChargesVatId | Gets or sets the invoicing charges VAT Id |
| InvoicingChargesVatIdMember | Gets the invoicing charges VAT Id |
| InvoicingChargesVatRate | Gets the invoicing charges VAT rate |
| InvoicingChargesVatRateMember | Gets the invoicing charges VAT rate |
| InvoicingChargesVatReRate | Gets or sets the invoicing charges VAT RE rate (for spain version only) |
| InvoicingChargesVatReRateMember | Gets the invoicing charges VAT RE rate (for spain version only) |
| InvoicingContact | Gets the invoicing contact |
| InvoicingContactId | Gets or sets the invoicing contact Id |
| InvoicingContactIdMember | Gets the invoicing contact Id |
| InvoicingThirdId | Gets or sets the invoicing third id |
| InvoicingThirdIdMember | Gets the invoicing third id |
| InvoicingThirdName | Gets or sets the invoicing third name |
| InvoicingThirdNameMember | Gets the invoicing third name |
| IrpfAmount | Gets or sets the IRPF amount |
| IrpfAmountMember | Gets the IRPF amount |
| IrpfRate | Gets or sets the IRPF rate |
| IrpfRateMember | Gets the IRPF rate |
| IsCustomNumberOfPackage | Gets or sets whether the numberOfPackage is set by user |
| IsCustomNumberOfPackageMember | Gets whether the numberOfPackage is set by user |
| IsDeleted |
Gets if the mode matches a deleted mode
(Inherited from IEntity.) |
| IsEcotaxAmountIncludedToDueAmount | Gets or sets whether the ecotax amount is included into the due amount |
| IsEcotaxAmountIncludedToDueAmountMember | Gets whether the ecotax amount is included into the due amount |
| IsEmptyLine |
Indicates if the entity is an empty line of an entity collection (created in auto
following the entityCollection options)
(Inherited from IEntity.) |
| IsMessageShownOnThresholdReached | Gets or sets whether a message has been shown when threshold has been shown |
| IsMessageShownOnThresholdReachedMember | Gets whether a message has been shown when threshold has been shown |
| IsPartiallyBlockedItemAllowed | Allow the insertion of partially blocked item (Inherited from IDocumentEntityBase.) |
| IsShippingNprVat | Gets or sets whether the shipping musn't include the VAT |
| IsShippingNprVatMember | Gets whether the shipping musn't include the VAT |
| LastTransferedDocumentSubType | Gets or sets the last transfered document sub type
Sale document : List of authorized values in SaleDocumentSubTypes Purchase document : List of authorized values in PurchaseDocumentSubTypes |
| LastTransferedDocumentSubTypeMember | Gets the last transfered document sub type
Sale document : List of authorized values in SaleDocumentSubTypes Purchase document : List of authorized values in PurchaseDocumentSubTypes |
| Lines | Gets the document lines |
| LoadFabricationComponentsMode | Gets or sets the load fabrication components mode.
List of authorized values in LoadFabricationComponentsModeType |
| LoadFabricationComponentsModeMember | Gets the load fabrication components mode.
List of authorized values in LoadFabricationComponentsModeType |
| MaintenanceContractId | Gets or sets the maintenance contract Id (Inherited from IDocumentEntityBase.) |
| MaintenanceContractIdMember | Gets the maintenance contract Id (Inherited from IDocumentEntityBase.) |
| 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) |
| NotesClear | Gets or sets the notes in plain text format. (Notes en texte brut) |
| NotesClearMember | Gets the notes in plain text format. (Notes en texte brut) |
| NotesMember | Gets the notes in RTF format. (Notes) |
| NumberOfCopies | Gets or sets the number of copies |
| NumberOfCopiesMember | Gets the number of copies |
| NumberOfPackage | Gets or sets the number of package |
| NumberOfPackageMember | Gets the number of package |
| NumberPrefix | Gets or sets the number prefix (Inherited from IDocumentEntityBase.) |
| NumberPrefixMember | Gets the number prefix (Inherited from IDocumentEntityBase.) |
| NumberSuffix | Gets or sets the number suffix (Inherited from IDocumentEntityBase.) |
| NumberSuffixMember | Gets the number suffix (Inherited from IDocumentEntityBase.) |
| OrderThirdId | Gets or sets the third id of origin order |
| OrderThirdIdMember | Gets the third id of origin order |
| OrderThirdName | Gets or sets the third name of origin order |
| OrderThirdNameMember | Gets the third name of origin order |
| OriginDocumentType | Gets or sets the origin document type
Sale document : List of authorized values in SaleDocumentSubTypes Purchase document : List of authorized values in PurchaseDocumentSubTypes |
| OriginDocumentTypeMember | Gets the origin document type
Sale document : List of authorized values in SaleDocumentSubTypes Purchase document : List of authorized values in PurchaseDocumentSubTypes |
| OriginOrderLines | Gets the origin order lines associated to the document |
| OtherTaxAmount | Gets or sets the other tax amount |
| OtherTaxAmountMember | Gets the other tax amount |
| OtherTaxAmountNotSubjectToVat | Gets or sets the other tax amount |
| OtherTaxAmountNotSubjectToVatMember | Gets the other tax amount |
| 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.) |
| PaymentThirdId | Gets or sets the payment third id |
| PaymentThirdIdMember | Gets the payment third id |
| PriceListCategoryId | Gets or sets the price list category Id |
| PriceListCategoryIdMember | Gets the price list category Id |
| PriceListCollection | Gets the PriceListCollection |
| PriceWithTaxBased | Gets or sets a value representing whether the calculation method is vat included or vat excluded |
| PriceWithTaxBasedMember | Gets a value representing whether the calculation method is vat included or vat excluded |
| Printed | Gets or sets a value indicating whether the document was printed. |
| PrintedMember | Gets a value indicating whether the document was printed. |
| ReadOnly |
Gets/Sets if the entity is in read only mode, to preserve from data changing
(Inherited from IEntity.) |
| ReAmount | Gets or sets the RE amount (For spain version only) |
| ReAmountMember | Gets the RE amount (For spain version only) |
| Reference | Gets or sets the document reference (Inherited from IDocumentEntityBase.) |
| ReferenceMember | Gets the document reference (Inherited from IDocumentEntityBase.) |
| ReportId | Gets or sets the report id |
| ReportIdMember | Gets the report id |
| ReportName | Gets or sets the report name |
| ReportNameMember | Gets the report name |
| RequiredAmountVatExcludedWithDiscountAndShipping | Gets or sets the RequiredAmountVatExcludedWithDiscountAndShipping |
| RequiredAmountVatExcludedWithDiscountAndShippingMember | Gets the RequiredAmountVatExcludedWithDiscountAndShipping |
| ReverseChargeMention | Gets or sets the reverse charge mention to print on documents |
| ReverseChargeMentionMember | Gets the reverse charge mention to print on documents |
| RoundLinesNetPriceVatExcluded | Gets or sets the round lines net price vat excluded. |
| RoundLinesNetPriceVatExcludedMember | Gets the round lines net price vat excluded. |
| SendedByMail | Gets or sets whether the document was sended by mail |
| SendedByMailMember | Gets whether the document was sended by mail |
| SettlementModeCaptionInUserLanguage | Settlement mode caption in user language : only used if multi language is activated
and if user language is different from default business language : null otherwise |
| SettlementModeCaptionInUserLanguageMember | Settlement mode caption in user language : only used if multi language is activated
and if user language is different from default business language : null otherwise |
| ShippingAmountInclusionType | Use to recalculate trade document currency in tranfert |
| ShippingAmountInclusionTypeMember | Use to recalculate trade document currency in tranfert |
| ShippingAmountVatExcluded | Gets or sets the shipping amount VAT excluded |
| ShippingAmountVatExcludedMember | Gets the shipping amount VAT excluded |
| ShippingCalculationMode | Gets or sets the shipping calculation mode |
| ShippingCalculationModeMember | Gets the shipping calculation mode |
| ShippingId | Gets or sets the shipping Id |
| ShippingIdMember | Gets the shipping Id |
| ShippingNotSubjectToFinancialDiscount | Gets or sets the ShippingNotSubjectToFinancialDiscount |
| ShippingNotSubjectToFinancialDiscountMember | Gets the ShippingNotSubjectToFinancialDiscount |
| ShippingVatId | Gets or sets the shipping VAT Id |
| ShippingVatIdMember | Gets the shipping VAT Id |
| ShippingVatRate | Gets or sets the shipping VAT rate |
| ShippingVatRateMember | Gets the shipping VAT rate |
| ShippingVatReRate | Gets or sets the shipping VAT RE Rate (For spain version only) |
| ShippingVatReRateMember | Gets the shipping VAT RE Rate (For spain version only) |
| Silent |
Get/Sets if the entity is in silent mode
(Inherited from IEntity.) |
| SimulationLoyaltyCardTypeId | Gets or sets the loyalty card type identifier used in price list simulation to check
price list based on loyalty card type. |
| SimulationLoyaltyCardTypeIdMember | Gets the loyalty card type identifier used in price list simulation to check
price list based on loyalty card type. |
| States |
Gets the entity states
(Inherited from IEntity.) |
| StorehouseCaption | Gets or sets the document storehouse caption (Inherited from IDocumentEntityBase.) |
| StorehouseCaptionMember | Gets the document storehouse caption (Inherited from IDocumentEntityBase.) |
| StorehouseCaptionToDeliver | Gets or sets the storehouse caption to deliver (used only for delivering process) |
| StorehouseCaptionToDeliverMember | Gets the storehouse caption to deliver (used only for delivering process) |
| StorehouseId | Reference Storehouse Id (Inherited from IDocumentEntityBase.) |
| StorehouseIdMember | Reference Storehouse Id (Inherited from IDocumentEntityBase.) |
| StorehouseIdToDeliver | Gets or sets the storehouse Id to deliver (used only for delivering process) |
| StorehouseIdToDeliverMember | Gets the storehouse Id to deliver (used only for delivering process) |
| SubjectToRe | Gets Subject to RE (for spain version only) |
| SubjectToReMember | Gets Subject to RE (for spain version only) |
| SubType | Gets the document sub type (Inherited from IDocumentEntityBase.) |
| TaxAmountList | Gets the tax amount list |
| TerritorialityId | Gets or sets the territoriality Id |
| TerritorialityIdMember | Gets the territoriality Id |
| ThirdActiveState | Gets or sets the third active state, with third entity load if necessary
List of authorized values in ThirdActiveState |
| ThirdActiveStateMember | Gets the third active state, with third entity load if necessary
List of authorized values in ThirdActiveState |
| ThirdBankAccountId | Gets or sets the third bank account id |
| ThirdBankAccountIdMember | Gets the third bank account id |
| ThirdCivility | Gets or sets the third civility |
| ThirdCivilityMember | Gets the third civility |
| ThirdFamilyId | Gets or sets the third family Id |
| ThirdFamilyIdMember | Gets the third family Id |
| ThirdId | Gets or sets the third Id |
| ThirdIdMember | Gets the third Id |
| ThirdIntracommunityVatNumber | Gets or sets the third intra community VAT number |
| ThirdIntracommunityVatNumberMember | Gets the third intra community VAT number |
| ThirdLanguage | Third language (isoCode) |
| ThirdLanguageMember | Third language (isoCode) |
| ThirdName | Gets or sets the third name |
| ThirdNameMember | Gets the third name |
| ThirdSubFamilyId | Gets or sets the third sub family Id |
| ThirdSubFamilyIdMember | Gets the third sub family Id |
| TotalDueAmount | Gets or sets the total due amount |
| TotalDueAmountMember | Gets the total due amount |
| TotalGoodAmount | Gets or sets the total good amount |
| TotalGoodAmountMember | Gets the total good amount |
| TotalNetWeight | Gets or sets the total net weight |
| TotalNetWeightMember | Gets the total net weight |
| TotalServiceAmount | Gets or sets the total service amount |
| TotalServiceAmountMember | Gets the total service amount |
| TotalVolume | Gets or sets the total volume (Inherited from IDocumentEntityBase.) |
| TotalVolumeMember | Gets the total volume (Inherited from IDocumentEntityBase.) |
| TotalWeight | Gets or sets the total weight (Inherited from IDocumentEntityBase.) |
| TotalWeightMember | Gets the total weight (Inherited from IDocumentEntityBase.) |
| TransferedDocumentId | Gets or sets the transfered document id |
| TransferedDocumentIdMember | Gets the transfered document id |
| Type | Gets the document type (Inherited from IDocumentEntityBase.) |
| UniqueId | Gets or sets the unique Id (Inherited from ISynchronizableEntityBase.) |
| UniqueIdMember | Gets the unique Id (Inherited from ISynchronizableEntityBase.) |
| UseInvoicingAddressAsDeliveryAddress | true if invoicing address is the same as delivery address |
| UseInvoicingAddressAsDeliveryAddressMember | true if invoicing address is the same as delivery address |
| UseInvoicingContactAsDeliveryContact | true if invoicing contact is the same as delivery contact |
| UseInvoicingContactAsDeliveryContactMember | true if invoicing contact is the same as delivery contact |
| VatAmount | Gets or sets the VAT amount |
| VatAmountList | Gets the VAT amount list |
| VatAmountMember | Gets the VAT amount |
| VatAmountWithoutEcotax | Gets or sets the VAT amount without ecotax |
| VatAmountWithoutEcotaxMember | Gets the VAT amount without ecotax |
| VatId | Gets or sets the VAT Id |
| VatIdMember | Gets the VAT Id |
| VatMode | Gets or sets the vat mode
List of authorized values in VatModeType |
| VatModeMember | Gets the vat mode
List of authorized values in VatModeType |
| VatTerritorialityId | Gets or sets the VAT territoriality Id
List of authorized values (Ends with TerritorialityUniqueId) in IDatasHelper |
| VatTerritorialityIdMember | Gets the VAT territoriality Id
List of authorized values (Ends with TerritorialityUniqueId) in IDatasHelper |
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.) |
| CheckAllStock | Check the stock for all document lines (Inherited from IDocumentEntityBase.) |
| 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 | |
|---|---|---|
 | FooterCalculating | Occurs when footer is calculating (Inherited from IDocumentEntityBase.) |
| ItemCreatedFromLine | Occurs when an item is created from a line (Inherited from IDocumentEntityBase.) |
| ItemLoaded | Occurs when an item has been loaded (Inherited from IDocumentEntityBase.) |
| ModeChanged |
Event raised on mode changed
(Inherited from IEntity.) |
See Also