Show / Hide Table of Contents

    General.DocumentTypeAmounts Entity

    Namespace: General

    Specifies amount types, that should be automatically added to documents of a given type. Entity: Gen_Document_Type_Amounts

    Default Visualization

    Default Display Text Format:
    {DocumentType.EntityName}
    Default Search Members:
    DocumentType.EntityName
    Name Data Member:
    DocumentType.EntityName

    Aggregate

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

    Aggregate Parent:
    General.DocumentTypes
    Aggregate Root:
    General.DocumentTypes

    Attributes

    Name Type Description
    DefaultPercent decimal (7, 6) nullable Default input percent. Valid only for amount types, supporting percent and takes precedence over Default_Percent in the definition of the amount type.
    DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
    Id guid
    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.
    RequiredFromDate date nullable When not null, specifies a date, after which the amount becomes required for the current document type. The date is compared against the document date. Filter(ge;le)
    RequiredThruDate date nullable When not null, specifies a date, up to which the amount is required for the current document type. The date is compared against the document date. Filter(ge;le)
    UserCanChangeInput boolean True if the user, entering the document is allowed to change the default input percent. Required Default(true)

    References

    Name Type Description
    DocumentAmountType DocumentAmountTypes The amount type that should be automatically added to the documents of the specified type. Required Filter(multi eq)
    DocumentType DocumentTypes The document type for which the amount type is specified. Required Filter(multi eq) Owner

    Attribute Details

    DefaultPercent

    Default input percent. Valid only for amount types, supporting percent and takes precedence over Default_Percent in the definition of the amount type.

    Type: decimal (7, 6) nullable
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: 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: ****

    Id

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

    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: ****

    RequiredFromDate

    When not null, specifies a date, after which the amount becomes required for the current document type. The date is compared against the document date. Filter(ge;le)

    Type: date nullable
    Category: System
    Supported Filters: GreaterThanOrLessThan
    Supports Order By: False

    RequiredThruDate

    When not null, specifies a date, up to which the amount is required for the current document type. The date is compared against the document date. Filter(ge;le)

    Type: date nullable
    Category: System
    Supported Filters: GreaterThanOrLessThan
    Supports Order By: False

    UserCanChangeInput

    True if the user, entering the document is allowed to change the default input percent. Required Default(true)

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

    Reference Details

    DocumentAmountType

    The amount type that should be automatically added to the documents of the specified type. Required Filter(multi eq)

    Type: DocumentAmountTypes
    Category: System
    Supported Filters: Equals, EqualsIn

    DocumentType

    The document type for which the amount type is specified. Required Filter(multi eq) Owner

    Type: DocumentTypes
    Indexed: True
    Category: System
    Supported Filters: Equals, EqualsIn
    Filterable Reference: True

    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

    • R28869 DocumentTypeAmount - Only One Input Attribute May Have Default Value
    • R28870 DocumentTypeAmount - Default Currency Has Value Only For Input Amounts

    Front-End Business Rules

    None

    API

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

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

    • Improve this Doc
    Back to top Generated by DocFX