General.Documents.DocumentDistributedAmounts Entity
Namespace: General.Documents
Contains the amounts which are distributed by the system over the document lines as a result of additional amount calculations. Entity: Gen_Document_Distributed_Amounts
Renames
Old name: General.DocumentDistributedAmounts
New name: General.Documents.DocumentDistributedAmounts
Version: 25.1.0.64
Case: 37169
Default Visualization
Default Display Text Format:
{DocumentAmountType} {DocumentLineId} {Amount}
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 |
---|---|---|
Amount | Amount (14, 2) | The amount which has beed distributed over the current line. The amount is in the currency of the document. Currency: GetDocumentCurrency() Required Filter(ge;le) |
BaseAmount | Amount (14, 2) nullable | The calculated base amount for the line in document currency. The base amount is the base, over which the additional amounts are calculated. Null if the base amount is not stored (for amounts distributed in older versions of the system). . Currency: GetDocumentCurrency() Introduced in version 22.1.4.44 |
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
DocumentLineId | guid nullable | The Id of the line over which the amount is distributed. Filter(multi eq) |
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. |
References
Name | Type | Description |
---|---|---|
Document | Documents | The Required Filter(multi eq) Owner |
DocumentAmountType | DocumentAmountTypes | The type of amount which is distributed. Required Filter(multi eq) |
ReferencedDocument | Documents (nullable) | In not null the Document_Line_Id is a line of the document with Referenced_Document_Id. Filter(multi eq) |
Attribute Details
Amount
The amount which has beed distributed over the current line. The amount is in the currency of the document. Currency: GetDocumentCurrency()
Required
Filter(ge;le)
Type: Amount (14, 2)
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault
BaseAmount
The calculated base amount for the line in document currency. The base amount is the base, over which the additional amounts are calculated. Null if the base amount is not stored (for amounts distributed in older versions of the system). . Currency: GetDocumentCurrency()
Introduced in version 22.1.4.44
Type: Amount (14, 2) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault
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 Id of the line over which the amount is distributed. Filter(multi eq)
Type: guid nullable
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown
Id
Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown
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 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 which is distributed. Required
Filter(multi eq)
Type: DocumentAmountTypes
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
ReferencedDocument
In not null the Document_Line_Id is a line of the document with Referenced_Document_Id. 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: stringsearch
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: nullexactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: FalseorderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: Falsetop
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10skip
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: UsersnotificationClass
The notification class.
Type: stringsubject
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_DocumentDistributedAmounts?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#General_Documents_DocumentDistributedAmounts?$top=10