Show / Hide Table of Contents

    Finance.Payments.PaymentTypes Entity

    Namespace: Finance.Payments

    Describes the way of payment. For example: in cash, by bank transfer, with credit card, etc. Entity: Cash_Payment_Types

    Default Visualization

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

    Aggregate

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

    Aggregate Tree

    • Finance.Payments.PaymentTypes

    Attributes

    Name Type Description
    Code string (16) The payment type unique code. 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 type is active and usable for choosing in new documents. Required Default(true) Filter(eq) Introduced in version 19.1
    Name MultilanguageString (254) The name of this PaymentType. 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.
    SystemType SystemType nullable Not null only when this is one of the system payment types. CS=Cash; CD=By Card; BT=Bank Transfer.

    References

    Name Type Description
    DefaultPaymentAccount PaymentAccounts (nullable) When not null specifies the default payment account to use associated with this payment type. Filter(multi eq)
    EnterpriseCompany EnterpriseCompanies (nullable) The Enterprise Company to which this PaymentType applies, or null if it is for all enterprise companies. Filter(multi eq)

    Attribute Details

    Code

    The payment type unique code. 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

    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 type is active and usable for choosing in new documents. Required Default(true) Filter(eq) Introduced in version 19.1

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

    Name

    The name of this PaymentType. Required Filter(like)

    Type: MultilanguageString (254)
    Indexed: True
    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

    SystemType

    Not null only when this is one of the system payment types. CS=Cash; CD=By Card; BT=Bank Transfer.

    Type: SystemType nullable
    Category: System
    Allowed values for the SystemType(Finance.Payments.PaymentTypes.md#systemtype) data attribute
    Allowed Values (Finance.Payments.PaymentTypesRepository.SystemType Enum Members)

    Value Description
    Cash Cash value. Stored as 'CH'.
    Database Value: 'CH'
    Model Value: 0
    Domain API Value: 'Cash'
    ByCard ByCard value. Stored as 'CD'.
    Database Value: 'CD'
    Model Value: 1
    Domain API Value: 'ByCard'
    BankTransfer BankTransfer value. Stored as 'BT'.
    Database Value: 'BT'
    Model Value: 2
    Domain API Value: 'BankTransfer'
    Coupons Coupons value. Stored as 'TK'.
    Database Value: 'TK'
    Model Value: 3
    Domain API Value: 'Coupons'
    Check Check value. Stored as 'CK'.
    Database Value: 'CK'
    Model Value: 4
    Domain API Value: 'Check'
    UserDefined1 UserDefined1 value. Stored as 'U1'.
    Database Value: 'U1'
    Model Value: 5
    Domain API Value: 'UserDefined1'
    UserDefined2 UserDefined2 value. Stored as 'U2'.
    Database Value: 'U2'
    Model Value: 6
    Domain API Value: 'UserDefined2'
    Vouchers Vouchers value. Stored as 'U3'.
    Database Value: 'U3'
    Model Value: 7
    Domain API Value: 'Vouchers'
    Packaging Packaging value. Stored as 'PK'.
    Database Value: 'PK'
    Model Value: 8
    Domain API Value: 'Packaging'
    InternalUsage InternalUsage value. Stored as 'IU'.
    Database Value: 'IU'
    Model Value: 9
    Domain API Value: 'InternalUsage'
    Damage Damage value. Stored as 'DG'.
    Database Value: 'DG'
    Model Value: 10
    Domain API Value: 'Damage'
    Other Other value. Stored as 'OT'.
    Database Value: 'OT'
    Model Value: 11
    Domain API Value: 'Other'

    Supported Filters: NotFilterable
    Supports Order By: False
    Show in UI: ShownByDefault

    Reference Details

    DefaultPaymentAccount

    When not null specifies the default payment account to use associated with this payment type. Filter(multi eq)

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

    EnterpriseCompany

    The Enterprise Company to which this PaymentType 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

    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

    Creates a notification and sends 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 subject.
      Type: string

    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

    • R30146 PaymentType - Requires Fiscal Receipt (DEPRECATED)
    • R30982 PaymentType - System Type Update Not Allowed

    Front-End Business Rules

    None

    API

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

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

    • Improve this Doc
    Back to top Generated by DocFX