Table of Contents

General.Contacts.PartyBankAccounts Entity

Namespace: General.Contacts

The bank accounts of a party. Entity: Gen_Party_Bank_Accounts

Default Visualization

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

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:
General.Contacts.Parties
Aggregate Root:
General.Contacts.Parties

Attributes

Name Type Description
BankAccountCode string (50) The code of the account, usually the IBAN code. Required Filter(eq;like)
BankAddress MultilanguageString (254) nullable The address of the bank or the bank branch office. Required (not-null) only for own accounts for printing or exporting bank payments.
BankBranchName MultilanguageString (100) nullable The name of the branch office of the bank, where the account is located. Required (not-null) only for own accounts for printing or exporting bank payments.
BankCode string (30) nullable The code of the bank, usually the BIC code. Filter(eq)
BankName MultilanguageString (100) nullable The full name of the bank. Filter(like)
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
IsDefault boolean True if the this is the default account for the party. Only one default per party is allowed. Required Default(false) Filter(eq)
Notes string (254) nullable Notes for this PartyBankAccount.
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
Party Parties The to which this PartyBankAccount belongs. Required Filter(multi eq) Owner

Attribute Details

BankAccountCode

The code of the account, usually the IBAN code. Required Filter(eq;like)

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

BankAddress

The address of the bank or the bank branch office. Required (not-null) only for own accounts for printing or exporting bank payments.

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

BankBranchName

The name of the branch office of the bank, where the account is located. Required (not-null) only for own accounts for printing or exporting bank payments.

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

BankCode

The code of the bank, usually the BIC code. Filter(eq)

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

BankName

The full name of the bank. Filter(like)

Type: MultilanguageString (100) nullable
Category: System
Supported Filters: Like
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

IsDefault

True if the this is the default account for the party. Only one default per party is allowed. Required Default(false) Filter(eq)

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

Notes

Notes for this PartyBankAccount.

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

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

Party

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

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

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The notification subject.
    Type: string

  • priority
    The notification priority.
    Type: Systems.Core.NotificationsRepository.Priority
    Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
    Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

    Value Description
    Background Background value. Stored as 1.
    Model Value: 1
    Domain API Value: 'Background'
    Low Low value. Stored as 2.
    Model Value: 2
    Domain API Value: 'Low'
    Normal Normal value. Stored as 3.
    Model Value: 3
    Domain API Value: 'Normal'
    High High value. Stored as 4.
    Model Value: 4
    Domain API Value: 'High'
    Urgent Urgent value. Stored as 5.
    Model Value: 5
    Domain API Value: 'Urgent'

    Optional: True
    Default Value: Normal

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

Front-End Business Rules

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/General_Contacts_PartyBankAccounts?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#General_Contacts_PartyBankAccounts?$top=10

Suggest improvement to this page