Finance.Saft.ProfilePayments Entity

Namespace: Finance.Saft

Profile/settings used to generate the SAF-T Payments section. Defines how payments are classified and mapped to NRA accounts, direction, counterparty type, and debit/credit indicator. Entity: Saft_Profile_Payments (Introduced in version 26.2.0.80)

Default Visualization

Default Display Text Format:
{Profile.Name}
Default Search Members:
Profile.Name
Name Data Member:
Profile.Name
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:
Finance.Saft.Profiles
Aggregate Root:
Finance.Saft.Profiles

Attributes

Name	Type	Description
DebitCreditIndicator	DebitCreditIndicator	Debit/credit indicator for SAF-T payment lines. `Required` `Filter(eq)`
Direction	Direction	Payment direction. `Required` `Filter(eq)`
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.
PartyType	PartyType	Counterparty type to be populated in SAF-T: Supplier, Customer, None. `Required` `Filter(eq)`

References

Name	Type	Description
DocumentType	DocumentTypes (nullable)	ERP.net document type that is the source of the payment. `Filter(multi eq)`
PaymentAccount	Accounts	Description: Payment account – cash desk/bank account used for the payment. `Required` `Filter(multi eq)`
PaymentReason	PaymentReasons (nullable)	Payment reason/classification. `Filter(multi eq)`
Profile	Profiles	Identifier of the SAFT profile associated with this settings. `Required` `Filter(multi eq)` `Owner`
SaftAccountCodeEntry	CodeEntries	Selected SAF-T mapping entry to the NRA nomenclature (value for AccountID in PaymentLine). `Required` `Filter(multi eq)`

Attribute Details

DebitCreditIndicator

Debit/credit indicator for SAF-T payment lines. Required Filter(eq)

Type: DebitCreditIndicator
Category: System
Allowed values for the DebitCreditIndicator(Finance.Saft.ProfilePayments.md#debitcreditindicator) data attribute
Allowed Values (Finance.Saft.ProfilePaymentsRepository.DebitCreditIndicator Enum Members)

Value	Description
Debit	Debit. Stored as 'D'. Database Value: 'D' Model Value: 0 Domain API Value: 'Debit'
Credit	Credit . Stored as 'C'. Database Value: 'C' Model Value: 1 Domain API Value: 'Credit'

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

Direction

Payment direction. Required Filter(eq)

Type: Direction
Category: System
Allowed values for the Direction(Finance.Saft.ProfilePayments.md#direction) data attribute
Allowed Values (Finance.Saft.ProfilePaymentsRepository.Direction Enum Members)

Value	Description
Outgoing	Outgoing. Stored as 'O'. Database Value: 'O' Model Value: 0 Domain API Value: 'Outgoing'
Incoming	Incoming. Stored as 'I'. Database Value: 'I' Model Value: 1 Domain API Value: 'Incoming'

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

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

PartyType

Counterparty type to be populated in SAF-T: Supplier, Customer, None. Required Filter(eq)

Type: PartyType
Category: System
Allowed values for the PartyType(Finance.Saft.ProfilePayments.md#partytype) data attribute
Allowed Values (Finance.Saft.ProfilePaymentsRepository.PartyType Enum Members)

Value	Description
Supplier	Supplier. Stored as 'S'. Database Value: 'S' Model Value: 0 Domain API Value: 'Supplier'
Customer	Customer. Stored as 'C'. Database Value: 'C' Model Value: 1 Domain API Value: 'Customer'
None	None. Stored as 'N'. Database Value: 'N' Model Value: 2 Domain API Value: 'None'

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

Reference Details

DocumentType

ERP.net document type that is the source of the payment. Filter(multi eq)

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

PaymentAccount

Description: Payment account – cash desk/bank account used for the payment. Required Filter(multi eq)

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

PaymentReason

Payment reason/classification. Filter(multi eq)

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

Profile

Identifier of the SAFT profile associated with this settings. Required Filter(multi eq) Owner

Type: Profiles
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

SaftAccountCodeEntry

Selected SAF-T mapping entry to the NRA nomenclature (value for AccountID in PaymentLine). Required Filter(multi eq)

Type: CodeEntries
Indexed: True
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

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

None

Front-End Business Rules

None

API

Domain API Entity Set: Finance_Saft_ProfilePayments

Domain API Entity Type: Finance_Saft_ProfilePayment

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

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

Table of Contents

Finance.Saft.ProfilePayments Entity

Default Visualization

Track Changes

Aggregate

Attributes

References

Attribute Details

DebitCreditIndicator

Direction

DisplayText

Id

ObjectVersion

PartyType

Reference Details

DocumentType

PaymentAccount

PaymentReason

Profile

SaftAccountCodeEntry

API Methods

GetAllowedCustomPropertyValues

CreateNotification

CreateCopy

Business Rules

Front-End Business Rules

API