Finance.Payments.PaymentAccounts Entity

Namespace: Finance.Payments

Payment accounts are cash, bank and other accounts, which are used in payments. Payment accounts are frequently used as analytical dimensions (properties) for general ledger accounts. Entity: Cash_Payment_Accounts

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 2 - Track object 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 Tree

Finance.Payments.PaymentAccounts

Attributes

Name	Type	Description
Code	string (16)	The unique code of the PaymentAccount. `Required` `Filter(eq;like)` `ORD`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
IsActive	boolean	Indicates wheather the payment account is currently used (active). `Required` `Default(true)` `Filter(eq)`
Name	MultilanguageString (50)	The name of this PaymentAccount. `Required` `Filter(like)`
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
AccessKey	AccessKeys (nullable)	The access key, containing the user permissions for this PaymentAccount. Null means that all users have unlimited permissions. `Filter(multi eq)`
BankAccount	PartyBankAccounts (nullable)	The bank account, which is represented by this payment account. `Filter(multi eq)`
Currency	Currencies	The currency in which the movements for this payment account will be recorded. `Required` `Filter(multi eq)`
EnterpriseCompany	EnterpriseCompanies (nullable)	The Enterprise Company to which this PaymentAccount applies, or null if it is for all enterprise companies. `Filter(multi eq)`
EnterpriseCompanyLocation	CompanyLocations (nullable)	The Enterprise Company Location to which this PaymentAccount applies, or null if it is for all enterprise company locations. `Filter(multi eq)`
PaymentType	PaymentTypes (nullable)	Specifies the payment type used to pay, when using this payment account. null when the payment type is unknown or unspecified. `Filter(multi eq)`

Attribute Details

Code

The unique code of the PaymentAccount. Required Filter(eq;like) ORD

Type: string (16)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 16
Show in UI: ShownByDefault

Back-End Default Expression:
obj.IncMax( o => o.Code, null, "00000")

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

IsActive

Indicates wheather the payment account is currently used (active). Required Default(true) Filter(eq)

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

Name

The name of this PaymentAccount. Required Filter(like)

Type: MultilanguageString (50)
Category: System
Supported Filters: Like
Supports Order By: False
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

AccessKey

The access key, containing the user permissions for this PaymentAccount. Null means that all users have unlimited permissions. Filter(multi eq)

Type: AccessKeys (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown

Remarks
Supported permissions

Permission	Type
Update	-
Delete	-
Administer (manage security)	-
Release Payment Transactions	Permission1

BankAccount

The bank account, which is represented by this payment account. Filter(multi eq)

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

Currency

The currency in which the movements for this payment account will be recorded. Required Filter(multi eq)

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

EnterpriseCompany

The Enterprise Company to which this PaymentAccount applies, or null if it is for all enterprise companies. Filter(multi eq)

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

EnterpriseCompanyLocation

The Enterprise Company Location to which this PaymentAccount applies, or null if it is for all enterprise company locations. Filter(multi eq)

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

PaymentType

Specifies the payment type used to pay, when using this payment account. null when the payment type is unknown or unspecified. Filter(multi eq)

Type: PaymentTypes (nullable)
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: 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