Show / Hide Table of Contents

    General.DocumentTypes Entity

    Namespace: General

    List of user-defined document types. Each type has associated system entity (object class). Entity: Gen_Document_Types

    Default Visualization

    Default Display Text Format:
    {TypeName:T}
    Default Search Members:
    Code; TypeName
    Code Data Member:
    Code
    Name Data Member:
    TypeName

    Aggregate

    An aggregate is a cluster of domain objects that can be treated as a single unit.

    Aggregate Tree

    • General.DocumentTypes
      • Crm.Invoicing.InvoicesOptions
      • Crm.Presales.OffersOptions
      • Crm.Sales.DefaultSalesOrderDocumentProperties
      • Crm.Sales.DefaultSalesOrderPaymentPlans
      • Crm.Sales.DocumentTypePaymentOptions
      • Crm.Sales.SalesOrdersOptions
      • General.DocumentTypeAmounts
      • General.DocumentTypeEnterpriseCompanies
      • General.DocumentTypeNotifications
      • General.DocumentTypeProperties
      • General.DocumentTypeSecurityConditions
      • General.DocumentTypeUserStatuses
      • General.Printouts
      • Logistics.Inventory.CostCorrectionsOptions
      • Logistics.Inventory.TransferOrdersOptions
      • Production.WorkOrderDocumentTypesOptions
      • Logistics.Procurement.PurchaseInvoicesOptions
      • Systems.Workflow.Routes
        • Finance.Accounting.TemplateRouteLinks
        • Finance.Accounting.Templates
          • Finance.Accounting.TemplateLines
            • Finance.Accounting.TemplateLineProperties
        • Finance.Payments.PaymentSlipPaymentTransactionsTemplates
        • Crm.Sales.SalesOrderPaymentOrdersTemplates
        • Applications.Rental.TransactionTemplates

    Attributes

    Name Type Description
    Code string (16) Unique descriptive code of the document type. Required Filter(eq;like) ORD
    CreateFulfillments
    OnCompletion
    boolean When document state is changed to Completed, creates completed document fulfillments for the parent document. Used only for logistic documents. Required Default(false)
    CreateManully boolean False if documents with this document type only can be generated; true - the user can create documents with this type. Required Default(true) Filter(eq)
    Description MultilanguageString (max) nullable The description of this DocumentType.
    DisallowOpposite
    ValuesGeneration
    boolean Disallow the generation of decreasing scalar values (values with opposite directions than the original values determined by the parent document) through this document type. Required Default(false)
    DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
    EntityName string (64) System entity, which contains the documents. Required Filter(multi eq) ORD
    GenerateSingleDocument boolean Create maximum one document when documents from this type are generated by parent documents (usually from another document type). Required Default(false)
    Id guid
    Notes string (254) nullable Notes for this DocumentType.
    ObjectVersion int32 The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
    SchemaXML string (max) nullable Obsolete. Not used.
    TransitionalDocument boolean If checked determines that the documents from this type are automatically managed by the system and don't require management from the users. Required Default(false)
    TypeName MultilanguageString (254) Description of the document type. Required Filter(like) ORD

    References

    Name Type Description
    AccessKey AccessKeys (nullable) The access key, containing the user permissions for this DocumentType. Null means that all users have unlimited permissions. Filter(multi eq)
    Sequence Sequences (nullable) The sequence that will be used to give new numbers to the documents of this type. Filter(multi eq)

    Child Collections

    Name Type Description
    Amounts DocumentTypeAmounts List of DocumentTypeAmount(General.DocumentTypeAmounts.md) child objects, based on the General.DocumentTypeAmount.DocumentType(General.DocumentTypeAmounts.md#documenttype) back reference
    CostCorrectionsOptions CostCorrectionsOptions List of CostCorrectionsOption(Logistics.Inventory.CostCorrectionsOptions.md) child objects, based on the Logistics.Inventory.CostCorrectionsOption.DocumentType(Logistics.Inventory.CostCorrectionsOptions.md#documenttype) back reference
    DefaultSalesOrder
    DocumentProperties
    DefaultSalesOrderDocumentProperties List of DefaultSalesOrder<br />DocumentProperty(Crm.Sales.DefaultSalesOrder
    DocumentProperties.md) child objects, based on the Crm.Sales.DefaultSalesOrder<br />DocumentProperty.DocumentType(Crm.Sales.DefaultSalesOrder
    DocumentProperties.md#documenttype) back reference
    DefaultSalesOrder
    PaymentPlans
    DefaultSalesOrderPaymentPlans List of DefaultSalesOrder<br />PaymentPlan(Crm.Sales.DefaultSalesOrder
    PaymentPlans.md) child objects, based on the Crm.Sales.DefaultSalesOrder<br />PaymentPlan.DocumentType(Crm.Sales.DefaultSalesOrder
    PaymentPlans.md#documenttype) back reference
    DocumentTypeProperties DocumentTypeProperties List of DocumentTypeProperty(General.DocumentTypeProperties.md) child objects, based on the General.DocumentTypeProperty.DocumentType(General.DocumentTypeProperties.md#documenttype) back reference
    EnterpriseCompanies DocumentTypeEnterpriseCompanies List of DocumentTypeEnterprise<br />Company(General.DocumentTypeEnterprise
    Companies.md) child objects, based on the General.DocumentTypeEnterprise<br />Company.DocumentType(General.DocumentTypeEnterprise
    Companies.md#documenttype) back reference
    InvoicesOptions InvoicesOptions List of InvoicesOption(Crm.Invoicing.InvoicesOptions.md) child objects, based on the Crm.Invoicing.InvoicesOption.DocumentType(Crm.Invoicing.InvoicesOptions.md#documenttype) back reference
    Notifications DocumentTypeNotifications List of DocumentTypeNotification(General.DocumentTypeNotifications.md) child objects, based on the General.DocumentTypeNotification.DocumentType(General.DocumentTypeNotifications.md#documenttype) back reference
    OffersOptions OffersOptions List of OffersOption(Crm.Presales.OffersOptions.md) child objects, based on the Crm.Presales.OffersOption.DocumentType(Crm.Presales.OffersOptions.md#documenttype) back reference
    PaymentOptions DocumentTypePaymentOptions List of DocumentTypePayment<br />Option(Crm.Sales.DocumentTypePaymentOptions.md) child objects, based on the Crm.Sales.DocumentTypePaymentOption.DocumentType(Crm.Sales.DocumentTypePaymentOptions.md#documenttype) back reference
    Printouts Printouts List of Printout(General.Printouts.md) child objects, based on the General.Printout.DocumentType(General.Printouts.md#documenttype) back reference
    PurchaseInvoicesOptions PurchaseInvoicesOptions List of PurchaseInvoicesOption(Logistics.Procurement.PurchaseInvoicesOptions.md) child objects, based on the Logistics.Procurement.PurchaseInvoicesOption.DocumentType(Logistics.Procurement.PurchaseInvoicesOptions.md#documenttype) back reference
    Routes Routes List of Route(Systems.Workflow.Routes.md) child objects, based on the Systems.Workflow.Route.DocumentType(Systems.Workflow.Routes.md#documenttype) back reference
    SalesOrdersOptions SalesOrdersOptions List of SalesOrdersOption(Crm.Sales.SalesOrdersOptions.md) child objects, based on the Crm.Sales.SalesOrdersOption.DocumentType(Crm.Sales.SalesOrdersOptions.md#documenttype) back reference
    SecurityConditions DocumentTypeSecurityConditions List of DocumentTypeSecurity<br />Condition(General.DocumentTypeSecurity
    Conditions.md) child objects, based on the General.DocumentTypeSecurity<br />Condition.DocumentType(General.DocumentTypeSecurity
    Conditions.md#documenttype) back reference
    TransferOrdersOptions TransferOrdersOptions List of TransferOrdersOption(Logistics.Inventory.TransferOrdersOptions.md) child objects, based on the Logistics.Inventory.TransferOrdersOption.DocumentType(Logistics.Inventory.TransferOrdersOptions.md#documenttype) back reference
    UserStatuses DocumentTypeUserStatuses List of DocumentTypeUserStatus(General.DocumentTypeUserStatuses.md) child objects, based on the General.DocumentTypeUserStatus.DocumentType(General.DocumentTypeUserStatuses.md#documenttype) back reference
    WorkOrderDocument
    TypesOptions
    WorkOrderDocumentTypesOptions List of WorkOrderDocument<br />TypesOption(Production.WorkOrderDocument
    TypesOptions.md) child objects, based on the Production.WorkOrderDocument<br />TypesOption.DocumentType(Production.WorkOrderDocument
    TypesOptions.md#documenttype) back reference

    Attribute Details

    Code

    Unique descriptive code of the document type. Required Filter(eq;like) ORD

    Type: string (16)
    Indexed: True
    Category: System
    Supported Filters: Equals, Like
    Supports Order By: True
    Maximum Length: 16

    CreateFulfillmentsOnCompletion

    When document state is changed to Completed, creates completed document fulfillments for the parent document. Used only for logistic documents. Required Default(false)

    Type: boolean
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Default Value: False

    CreateManully

    False if documents with this document type only can be generated; true - the user can create documents with this type. Required Default(true) Filter(eq)

    Type: boolean
    Category: System
    Supported Filters: Equals
    Supports Order By: False
    Default Value: True

    Front-End Recalc Expressions:
    IIF( obj.TransitionalDocument, False, obj.CreateManully)

    Description

    The description of this DocumentType.

    Type: MultilanguageString (max) nullable
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False

    DisallowOppositeValuesGeneration

    Disallow the generation of decreasing scalar values (values with opposite directions than the original values determined by the parent document) through this document type. Required Default(false)

    Type: boolean
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Default Value: False

    DisplayText

    Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

    Type: string
    Category: Calculated Attributes
    Supported Filters: NotFilterable
    Supports Order By: ****

    EntityName

    System entity, which contains the documents. Required Filter(multi eq) ORD

    Type: string (64)
    Indexed: True
    Category: System
    Supported Filters: Equals, EqualsIn
    Supports Order By: True
    Maximum Length: 64

    GenerateSingleDocument

    Create maximum one document when documents from this type are generated by parent documents (usually from another document type). Required Default(false)

    Type: boolean
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Default Value: False

    Id

    Type: guid
    Indexed: True
    Category: System
    Supported Filters: Equals, EqualsIn
    Default Value: NewGuid

    Notes

    Notes for this DocumentType.

    Type: string (254) nullable
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Maximum Length: 254

    ObjectVersion

    The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

    Type: int32
    Category: Extensible Data Object
    Supported Filters: NotFilterable
    Supports Order By: ****

    SchemaXML

    Obsolete. Not used.

    Type: string (max) nullable
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Maximum Length: 2147483647

    TransitionalDocument

    If checked determines that the documents from this type are automatically managed by the system and don't require management from the users. Required Default(false)

    Type: boolean
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Default Value: False

    Front-End Recalc Expressions:
    IIF( obj.CreateManully, False, obj.TransitionalDocument)

    TypeName

    Description of the document type. Required Filter(like) ORD

    Type: MultilanguageString (254)
    Indexed: True
    Category: System
    Supported Filters: Like
    Supports Order By: True

    Reference Details

    AccessKey

    The access key, containing the user permissions for this DocumentType. Null means that all users have unlimited permissions. Filter(multi eq)

    Type: AccessKeys (nullable)
    Category: System
    Supported Filters: Equals, EqualsIn

    Sequence

    The sequence that will be used to give new numbers to the documents of this type. Filter(multi eq)

    Type: Sequences (nullable)
    Category: System
    Supported Filters: Equals, EqualsIn

    API Methods

    Methods that can be invoked in public APIs.

    GetAllowedCustomPropertyValues

    Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
    Return Type: Collection Of CustomPropertyValue
    Declaring Type: EntityObject
    Domain API Request: GET

    Parameters

    • customPropertyCode
      The code of the custom property
      Type: string

    • search
      The search text - searches by value or description. Can contain wildcard character %.
      Type: string
      Optional: True
      Default Value: null

    • exactMatch
      If true the search text should be equal to the property value
      Type: boolean
      Optional: True
      Default Value: False

    • orderByDescription
      If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
      Type: boolean
      Optional: True
      Default Value: False

    • top
      The top clause - default is 10
      Type: int32
      Optional: True
      Default Value: 10

    • skip
      The skip clause - default is 0
      Type: int32
      Optional: True
      Default Value: 0

    CreateNotification

    Creates a notification a sends a real time event to the user.
    Return Type: void
    Declaring Type: EntityObject
    Domain API Request: POST

    Parameters

    • user
      The user.
      Type: Users

    • notificationClass
      The notification class.
      Type: string

    • subject
      The subject.
      Type: string

    CreateCopy

    Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
    Return Type: EntityObject
    Declaring Type: EntityObject
    Domain API Request: POST

    Business Rules

    • R29337 DocumentType - No User Statuses If Transitional

    Front-End Business Rules

    • R31485-1 Document Type - Set Create Manully (Recalc)
    • R31485-2 Document Type - Set Transitional Document (Recalc)

    API

    Domain API Query: https://demodb.my.erp.net/api/domain/odata/General_DocumentTypes?$top=10

    Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#General_DocumentTypes?$top=10

    • Improve this Doc
    Back to top Generated by DocFX