Finance.Payments.PaymentSlipLines Entity

Namespace: Finance.Payments

Mass payment line, which is distribution of an amount among payment orders. Each record generates one payment transaction line. Entity: Cash_Payment_Slip_Lines

Default Visualization

Default Display Text Format:
{PaymentSlipAmount.PartyName:T}
Default Search Members:
PaymentSlipAmount.PartyName
Name Data Member:
PaymentSlipAmount.PartyName
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.PaymentSlipAmounts
Aggregate Root:
Finance.Payments.PaymentSlips

Attributes

Name	Type	Description
Amount	Amount (10, 2)	The part of the total amount in the payment slip amount, that is distributed to the specified payment order. `Currency: PaymentSlipAmount.PaymentSlip.DocumentCurrency` `Required` `Default(0)`
CoveredOrderAmount	Amount (10, 2)	The part of the original payment order amount, that is covered by this payment slip 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
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
PaymentOrder	PaymentOrders	The payment order, that is covered by this payment slip line. `Required` `Filter(multi eq)`
PaymentSlipAmount	PaymentSlipAmounts	The to which this PaymentSlipLine belongs. `Required` `Filter(multi eq)` `ReadOnly` `Owner`

Attribute Details

Amount

The part of the total amount in the payment slip amount, that is distributed to the specified payment order. Currency: PaymentSlipAmount.PaymentSlip.DocumentCurrency 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.PaymentSlipAmount.PaymentSlip.DocumentCurrency, obj.PaymentSlipAmount.PaymentSlip.CurrencyDirectory)

CoveredOrderAmount

The part of the original payment order amount, that is covered by this payment slip 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.PaymentSlipAmount.PaymentSlip.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

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

PaymentOrder

The payment order, that is covered by this payment slip line. Required Filter(multi eq)

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

PaymentSlipAmount

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

Type: PaymentSlipAmounts
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