Finance.Payments.BulkPaymentOrderLines Entity

Bulk payment order document line. Each line usually creates one payment order. Entity: Cash_Bulk_Payment_Order_Lines

Default Visualization

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

Attributes

Name	Type	Description
BillTo	BillTo nullable	If filled indicates which party is billed for the total amount. Possible values: 'C' = Company (means the Party_Id), 'L' = Company location (the Location_Party_Id), null = unidentified.
Direction	Direction	I for Payment issue, R for payment receipt. `Required` `Default("I")` `Filter(eq)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
DueDate	datetime nullable	The due date of the payment. null means there is no due date. `Filter(ge;le)`
Id	guid
InstallmentNumber	int32 nullable	Consequtive installment number. Used for identifying the payment when using payment plans. null means that the payment is not part of a payment plan.
InvoiceAmount	Amount (18, 2) nullable	The specified invoice amount. (the invoice amount converted to the Total_Amount_Currency_Id must be equal to the Total_Amount). `Currency: InvoiceAmountCurrency`
IsAmountWithVAT	boolean	Is_Amount_With_VAT=true if the requested amount includes VAT. `Required` `Default(true)` `Filter(eq)`
Notes	string (254) nullable	Notes for this BulkPaymentOrderLine.
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.
RefDocumentDate	datetime nullable	The date of the base document. null means that it is unknown. `Filter(ge;le)`
RefDocumentNo	string (20)	The number of the document which is the basis for the payment. `Required`
RefInvoiceApplyDate	datetime nullable	The apply date of the related invoice. Not specified when the payment order isn't related to any invoice or the apply date is unknown. `Filter(ge;le)`
RefInvoiceDocumentDate	datetime nullable	The date of the related invoice. null means that the payment order isn't related to any invoice or the date is unknown. `Filter(ge;le)`
RefInvoiceDocumentNo	string (20) nullable	The number of the invoice which is related and is the basis for the payment. null means that the payment order isn't created or related to any invoice.
TotalAmount	Amount (18, 2)	Total amount that should be payed. `Currency: TotalAmountCurrency` `Required` `Default(0)`

References

Name	Type	Description
BulkPaymentOrder	BulkPaymentOrders	The to which this BulkPaymentOrderLine belongs. `Required` `Filter(multi eq)` `Owner`
InvoiceAmountCurrency	Currencies (nullable)	The currency of Invoice Amount. `Filter(multi eq)`
LocationParty	Parties (nullable)	Location or sub-party of the Party_Id. `Filter(multi eq)`
Party	Parties	The party which is to pay or receive the amount. `Required` `Filter(multi eq)`
PaymentAccount	PaymentAccounts (nullable)	When not null, specifies the payment account that is expected or will be used by the payment transaction. `Filter(multi eq)`
PaymentType	PaymentTypes (nullable)	Expected payment type. When null, there is no expectation for payment type. `Filter(multi eq)`
RefDocumentType	DocumentTypes	The type of the document which is the basis for the payment. `Required` `Filter(multi eq)`
RefInvoiceDocumentType	DocumentTypes (nullable)	The document type of the invoice which is related and is the basis for the payment. null means that the payment order isn't created or related to any invoice. `Filter(multi eq)`
TotalAmountCurrency	Currencies	The currency of Total Amount. `Required` `Filter(multi eq)`

Attribute Details

BillTo

If filled indicates which party is billed for the total amount. Possible values: 'C' = Company (means the Party_Id), 'L' = Company location (the Location_Party_Id), null = unidentified.

Type: BillTo nullable
Category: System
Allowed values for the BillTo(Finance.Payments.BulkPaymentOrderLines.md#billto) data attribute
Allowed Values (Finance.Payments.BulkPaymentOrderLinesRepository.BillTo Enum Members)

Value	Description
Company	Company value. Stored as 'C'. Database Value: 'C' Model Value: 0 Domain API Value: 'Company'
CompanyLocation	CompanyLocation value. Stored as 'L'. Database Value: 'L' Model Value: 1 Domain API Value: 'CompanyLocation'

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

Direction

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

Type: Direction
Category: System
Allowed values for the Direction(Finance.Payments.BulkPaymentOrderLines.md#direction) data attribute
Allowed Values (Finance.Payments.BulkPaymentOrderLinesRepository.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
Default Value: Expense
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

DueDate

The due date of the payment. null means there is no due date. Filter(ge;le)

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

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

InstallmentNumber

Consequtive installment number. Used for identifying the payment when using payment plans. null means that the payment is not part of a payment plan.

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

InvoiceAmount

The specified invoice amount. (the invoice amount converted to the Total_Amount_Currency_Id must be equal to the Total_Amount). Currency: InvoiceAmountCurrency

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

IsAmountWithVAT

Is_Amount_With_VAT=true if the requested amount includes VAT. Required Default(true) Filter(eq)

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

Notes

Notes for this BulkPaymentOrderLine.

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

RefDocumentDate

The date of the base document. null means that it is unknown. Filter(ge;le)

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

RefDocumentNo

The number of the document which is the basis for the payment. Required

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

RefInvoiceApplyDate

The apply date of the related invoice. Not specified when the payment order isn't related to any invoice or the apply date is unknown. Filter(ge;le)

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

RefInvoiceDocumentDate

The date of the related invoice. null means that the payment order isn't related to any invoice or the date is unknown. Filter(ge;le)

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

RefInvoiceDocumentNo

The number of the invoice which is related and is the basis for the payment. null means that the payment order isn't created or related to any invoice.

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

TotalAmount

Total amount that should be payed. Currency: TotalAmountCurrency Required Default(0)

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

Reference Details

BulkPaymentOrder

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

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

InvoiceAmountCurrency

The currency of Invoice Amount. Filter(multi eq)

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

LocationParty

Location or sub-party of the Party_Id. Filter(multi eq)

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

Party

The party which is to pay or receive the amount. Required Filter(multi eq)

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

Front-End Recalc Expressions:
obj.LocationParty.ParentParty

PaymentAccount

When not null, specifies the payment account that is expected or will be used by the payment transaction. Filter(multi eq)

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

Front-End Recalc Expressions:
obj.PaymentType.GetDefaultPaymentAccount( ).IfNullThen( obj.PaymentAccount)

PaymentType

Expected payment type. When null, there is no expectation for payment type. Filter(multi eq)

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

RefDocumentType

The type of the document which is the basis for the payment. Required Filter(multi eq)

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

RefInvoiceDocumentType

The document type of the invoice which is related and is the basis for the payment. null means that the payment order isn't created or related to any invoice. Filter(multi eq)

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

TotalAmountCurrency

The currency of Total Amount. Required Filter(multi eq)

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

Front-End Recalc Expressions:
obj.PaymentAccount.Currency

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

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

API

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

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

Table of Contents

Finance.Payments.BulkPaymentOrderLines Entity

Default Visualization

Track Changes

Aggregate

Attributes

References

Attribute Details

BillTo

Direction

DisplayText

DueDate

Id

InstallmentNumber

InvoiceAmount

IsAmountWithVAT

Notes

ObjectVersion

RefDocumentDate

RefDocumentNo

RefInvoiceApplyDate

RefInvoiceDocumentDate

RefInvoiceDocumentNo

TotalAmount

Reference Details

BulkPaymentOrder

InvoiceAmountCurrency

LocationParty

Party

PaymentAccount

PaymentType

RefDocumentType

RefInvoiceDocumentType

TotalAmountCurrency

API Methods

GetAllowedCustomPropertyValues

CreateNotification

CreateCopy

Business Rules

Front-End Business Rules

API