Finance.Payments.PaymentTransactionLines Entity

Namespace: Finance.Payments

Contains the distibution of the payments' amounts among the source payment orders. Entity: Cash_Payment_Transaction_Lines

Default Visualization

Default Display Text Format:
{Id}. {PaymentTransaction.DocumentNo} {PaymentTransaction.DocumentType.TypeName:T}
Default Search Members:
PaymentTransaction.DocumentNo
Name Data Member:
PaymentTransaction.EntityName
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

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

Aggregate Parent:
Finance.Payments.PaymentTransactions
Aggregate Root:
Finance.Payments.PaymentTransactions

Attributes

Name	Type	Description
AllowOverpayment	boolean	True-Allows overpayment for the payment order; false=Does not allow (default). `Required` `Default(false)`
Amount	Amount (10, 2)	The part of the total payed amount by the transaction, that is distributed to the specified payment order. `Currency: PaymentTransaction.TotalAmountCurrency` `Required` `Default(0)`
CoveredOrderAmount	Amount (10, 2)	The part of the original payment order amount, that is covered by this transaction line. `Currency: PaymentOrder.TotalAmountCurrency` `Required` `Default(0)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
Notes	string (254) nullable	Notes for this PaymentTransactionLine.
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	PaymentTransactions	The <see cref="PaymentTransaction"/ > to which this PaymentTransactionLine belongs. `Required` `Filter(multi eq)`
PaymentOrder	PaymentOrders	The payment order, that is covered by this transaction amount distribution (tr.line). `Required` `Filter(multi eq)`
PaymentTransaction	PaymentTransactions	The <see cref="PaymentTransaction"/ > to which this PaymentTransactionLine belongs. `Required` `Filter(multi eq)` `Owner`

Attribute Details

AllowOverpayment

True-Allows overpayment for the payment order; false=Does not allow (default). Required Default(false)

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

Amount

The part of the total payed amount by the transaction, that is distributed to the specified payment order. Currency: PaymentTransaction.TotalAmountCurrency Required Default(0)

Type: Amount (10, 2)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

Front-End Recalc Expressions:
obj.CoveredOrderAmount.ConvertTo( obj.PaymentTransaction.TotalAmountCurrency, obj.PaymentTransaction.CurrencyDirectory)

CoveredOrderAmount

The part of the original payment order amount, that is covered by this transaction line. Currency: PaymentOrder.TotalAmountCurrency Required Default(0)

Type: Amount (10, 2)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

Front-End Recalc Expressions:
obj.Amount.ConvertTo( obj.PaymentOrder.TotalAmountCurrency, obj.PaymentTransaction.CurrencyDirectory)

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

Notes

Notes for this PaymentTransactionLine.

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
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 PaymentTransactionLine belongs. Required Filter(multi eq)

Type: PaymentTransactions
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

PaymentOrder

The payment order, that is covered by this transaction amount distribution (tr.line). Required Filter(multi eq)

Type: PaymentOrders
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

PaymentTransaction

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

Type: PaymentTransactions
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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