Finance.Payments.PaymentSlipAmounts Entity

Mass payment amount. Each record generates one payment transaction. Entity: Cash_Payment_Slip_Amounts

Default Visualization

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

Attributes

Name	Type	Description
Description	string (254) nullable	Description of the payed amount. The numbers of the documents which are payed for example.
Direction	Direction	'I' for Payment issue, 'R' for payment receipt. `Required` `Filter(eq)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
IsPartyPayment	boolean	Indicates whether the amount is payed or received by party or not (i.e. the amount is for fee, tax, etc.). `Required` `Default(true)`
LineNo	int32	The number of the line within the payment. `Required`
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.
PartyName	MultilanguageString (254) nullable	The name of the party that is paying or receiving the money. The column can be left blank if there is no party involved (e.g. the amount is fee).
PaymentDate	datetime	The date on which the payment is done. `Required` `Filter(ge;le)`
TotalAmount	Amount (18, 2) nullable	The total amount payed. The distribution of the amount amongst the payment orders for this party is specified with payment slip lines. If null the total amount is calculated as sum of the amounts in the payment slip lines. `Currency: PaymentSlip.DocumentCurrency`

References

Name	Type	Description
Party	Parties (nullable)	The party that is paying or receiving the money. The column can be left blank if there is no party involved (e.g. the amount is fee) or the party isn't present in the database yet. `Filter(multi eq)`
PaymentReason	PaymentReasons (nullable)	The reason for the payment, as defined in Payment Reasons. `Filter(multi eq)`
PaymentSlip	PaymentSlips	The to which this PaymentSlipAmount belongs. `Required` `Filter(multi eq)` `Owner`

Child Collections

Name	Type	Description
PaymentSlipLines	PaymentSlipLines	List of `PaymentSlipLine`(Finance.Payments.PaymentSlipLines.md) child objects, based on the `Finance.Payments.PaymentSlipLine.PaymentSlipAmount`(Finance.Payments.PaymentSlipLines.md#paymentslipamount) back reference

Attribute Details

Description

Description of the payed amount. The numbers of the documents which are payed for example.

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

Direction

'I' for Payment issue, 'R' for payment receipt. Required Filter(eq)

Type: Direction
Category: System
Allowed values for the Direction(Finance.Payments.PaymentOrders.md#direction) data attribute
Allowed Values (Finance.Payments.PaymentOrdersRepository.Direction Enum Members)

Value	Description
Expense	Expense value. Stored as 'I'. Database Value: 'I' Model Value: 0 Domain API Value: 'Expense'
Income	Income value. Stored as 'R'. Database Value: 'R' Model Value: 1 Domain API Value: 'Income'

Supported Filters: Equals
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

IsPartyPayment

Indicates whether the amount is payed or received by party or not (i.e. the amount is for fee, tax, etc.). Required Default(true)

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

LineNo

The number of the line within the payment. Required

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.PaymentSlip.Amounts.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 1)

Front-End Recalc Expressions:
( obj.PaymentSlip.Amounts.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 1)

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

PartyName

The name of the party that is paying or receiving the money. The column can be left blank if there is no party involved (e.g. the amount is fee).

Type: MultilanguageString (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

Front-End Recalc Expressions:
obj.Party.ObtainPartyName( )

PaymentDate

The date on which the payment is done. Required Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Front-End Recalc Expressions:
obj.PaymentSlip.DocumentDate

TotalAmount

The total amount payed. The distribution of the amount amongst the payment orders for this party is specified with payment slip lines. If null the total amount is calculated as sum of the amounts in the payment slip lines. Currency: PaymentSlip.DocumentCurrency

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

Reference Details

Party

The party that is paying or receiving the money. The column can be left blank if there is no party involved (e.g. the amount is fee) or the party isn't present in the database yet. Filter(multi eq)

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

PaymentReason

The reason for the payment, as defined in Payment Reasons. Filter(multi eq)

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

PaymentSlip

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

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