Table of Contents

General.Documents.DocumentLineAmounts Entity

Namespace: General.Documents

Specifies user-defined input percentages by lines for the document amounts. Entity: Gen_Document_Line_Amounts

Renames

Old name: General.DocumentLineAmounts
New name: General.Documents.DocumentLineAmounts
Version: 25.1.0.64
Case: 37169

Default Visualization

Default Display Text Format:
{Document.EntityName}
Default Search Members:
Document.EntityName
Name Data Member:
Document.EntityName
Category: Definitions
Show in UI: ShownByDefault

Aggregate

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

Aggregate Parent:
General.Documents.Documents
Aggregate Root:
General.Documents.Documents

Attributes

Name Type Description
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
DocumentLineId guid The line for which the distribution pattern is specified. Required Filter(multi eq)
Id guid
LinePercent decimal (14, 6) The percent of the additional amount which should be distributed over the current line. Required Default(0)
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.

References

Name Type Description
Document Documents The to which this DocumentLineAmount belongs. Required Filter(multi eq) Owner
DocumentAmountType DocumentAmountTypes The type of amount for which the distribution pattern is specified. Required Filter(multi eq)
Product Products The product for which the distribution is specified. It is also the product, specified in the document line, but is duplicated here for integrity purposes. Required Filter(multi eq)
ReferencedDocument Documents (nullable) When not null, specifies that this distribution is specified for a referenced document (not the document for which the amount is calculated). Filter(multi eq)

Attribute Details

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: ****
Show in UI: HiddenByDefault

DocumentLineId

The line for which the distribution pattern is specified. Required Filter(multi eq)

Type: guid
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

LinePercent

The percent of the additional amount which should be distributed over the current line. Required Default(0)

Type: decimal (14, 6)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

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: ****
Show in UI: HiddenByDefault

Reference Details

Document

The to which this DocumentLineAmount belongs. Required Filter(multi eq) Owner

Type: Documents
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: CannotBeShown

DocumentAmountType

The type of amount for which the distribution pattern is specified. Required Filter(multi eq)

Type: DocumentAmountTypes
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Product

The product for which the distribution is specified. It is also the product, specified in the document line, but is duplicated here for integrity purposes. Required Filter(multi eq)

Type: Products
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

ReferencedDocument

When not null, specifies that this distribution is specified for a referenced document (not the document for which the amount is calculated). Filter(multi eq)

Type: Documents (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

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

Create a notification immediately in a separate transaction, and send 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 notification 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

None

Front-End Business Rules

None

API

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

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