General.DocumentAmounts Entity

Namespace: General

Contains a specific instance of an additional amount for a specific document. Entity: Gen_Document_Amounts

Default Visualization

Default Display Text Format:
{DocumentAmountType.AmountTypeName:T}
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
Aggregate Root:
General.Documents

Attributes

Name	Type	Description
BaseAmount	Amount (14, 2) nullable	The calculated base amount (in documents currency) from the last document amount recalculation. The base amount is the base, over which the additional amounts are calculated. Null if the amount is not distributed yet. `Currency: LogisticsDocument.DocumentCurrency` `ReadOnly`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
InputAmount	Amount (14, 2) nullable	When not null, specifies directly the amount of the additional amount. `Currency: GetInputAmountCurrency()` `Filter(ge;le)`
InputPercent	decimal (7, 6) nullable	When not null, specifies that the amount for this document will be calculated as percent of the base amounts (which are defined in the amount type). `Filter(ge;le)`
InputUnitAmount	Amount (14, 5) nullable	Input unit amount for the calculation of the current amount. `Currency: GetInputAmountCurrency()` `Filter(eq;ge;le)`
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.
TotalDistributedAmount	Amount (14, 2) nullable	The total amount (in documents currency) which was distributed to the documents lines. Null if the amount is not distributed yet. `Currency: LogisticsDocument.DocumentCurrency` `ReadOnly`
UserCanChangeInput	boolean	True if the user, entering the document is allowed to change the default input percent. `Required` `Default(true)`

References

Name	Type	Description
Document	Documents	The to which this DocumentAmount belongs. `Required` `Filter(multi eq)` `Owner`
DocumentAmountType	DocumentAmountTypes	The type of the amount. `Required` `Filter(multi eq)`
InputAmountCurrency	Currencies (nullable)	When specifying the amount directly in Input Amount, this contains the currency of the amount. Used and required when Input Amount is not null. `Filter(multi eq)`
InputUnit	MeasurementUnits (nullable)	Measurement unit of the input unit amount. `Filter(multi eq)`

Child Collections

Name	Type	Description
ReferencedDocuments	DocumentAmountReferencedDocuments	List of `DocumentAmount<br />ReferencedDocument`(General.DocumentAmount ReferencedDocuments.md) child objects, based on the `General.DocumentAmount<br />ReferencedDocument.DocumentAmount`(General.DocumentAmount ReferencedDocuments.md#documentamount) back reference

Attribute Details

BaseAmount

The calculated base amount (in documents currency) from the last document amount recalculation. The base amount is the base, over which the additional amounts are calculated. Null if the amount is not distributed yet. Currency: LogisticsDocument.DocumentCurrency ReadOnly

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

Id

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

InputAmount

When not null, specifies directly the amount of the additional amount. Currency: GetInputAmountCurrency() Filter(ge;le)

Type: Amount (14, 2) nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Front-End Recalc Expressions:
IIF( obj.DocumentAmountType.AmountInputAllowed, obj.InputAmount, null)

InputPercent

When not null, specifies that the amount for this document will be calculated as percent of the base amounts (which are defined in the amount type). Filter(ge;le)

Type: decimal (7, 6) nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
obj.DocumentAmountType.DefaultPercent

Front-End Recalc Expressions:
obj.DocumentAmountType.DefaultPercent

InputUnitAmount

Input unit amount for the calculation of the current amount. Currency: GetInputAmountCurrency() Filter(eq;ge;le)

Type: Amount (14, 5) nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

Front-End Recalc Expressions:
IIF( obj.DocumentAmountType.UnitAmountInputAllowed, obj.InputUnitAmount, null)

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

TotalDistributedAmount

The total amount (in documents currency) which was distributed to the documents lines. Null if the amount is not distributed yet. Currency: LogisticsDocument.DocumentCurrency ReadOnly

Type: Amount (14, 2) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

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

Reference Details

Document

The to which this DocumentAmount 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 the amount. Required Filter(multi eq)

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

InputAmountCurrency

When specifying the amount directly in Input Amount, this contains the currency of the amount. Used and required when Input Amount is not null. Filter(multi eq)

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

Front-End Recalc Expressions:
IIF( obj.DocumentAmountType.AmountInputAllowed, obj.InputAmountCurrency, null)

InputUnit

Measurement unit of the input unit amount. Filter(multi eq)

Type: MeasurementUnits (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

Front-End Recalc Expressions:
IIF( obj.DocumentAmountType.UnitAmountInputAllowed, obj.InputUnit, null)

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