PaymentPlan

: Public <<TMF_BusinessEntity>> Business Entity

Created:	1/10/2022 12:02:22 PM
Modified:	4/15/2022 10:31:34 AM

Project:
Author:	Giu Platania
Version:	22.0
Phase:	prop
Status:	Implemented
Complexity:	Easy
Difficulty:
Priority:
Multiplicity:
Advanced:
UUID:	{C65AF53D-8432-4d02-B08A-AF84712A9910}
Appears In:	Figure Pr.40a - Payment Method and Plan, Figure C.27 - Customer Billing Account Balance, Part 3, Figure C.17 - Customer Payment Scope, Figure C.19 - Payment Method and Plan, Figure PAY.01 - Payment Method and Payment Plan, Figure CI.03 - CommunicationInteraction UseCase and Result, Figure BPA.01 - Business Partner Payment, UNUSED Figure P.24 - Party Payment Scope

PaymentPlan defines the plan for payment via its associations to the PaymentMethod and PaymentAccount.

Attributes
Associations To
Associations From
Tagged Values
Advanced

Attribute

Public String
ID

Details:

Alias:
Initial:
Stereotype:	<<required>>
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

Unique identifier

Public Money
maxAmount

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

The maximum amount of the Payment when at least one PaymentMethod is declared so that the company generates each Payment. For example, with a due debt of $250, and a maxPaymentAmount of $100, 2 payments of $100 will be generated and the last one will be $50.

Public Integer
maxTrialTimes

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

Maximum number of trial to submit a payment if it has been rejected.

Public Integer
paymentDay

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

The day chosen by the party for generating the payments

Public Duration
paymentPeriod

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

The period of time between two payments.

Public Integer
priority

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

The priority of the PaymentPlan amongst all the PaymentPlans agreed with the same PartyRole.

Public String
status

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

A PayemntPlan might be initialized, validated,in progress or closed.

Public Money
totalAmount

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

The total amount that the PaymentPlan has to recover through payments.

Public String
type

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

A grouping of PaymentPlans that have strongly marked and readily defined similarities.

Public TimePeriod
validFor

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

Valid period for the PaymentPlan.

Element	Source Role	Target Role
«TMF_BusinessEntity» CustomerBillingAccount Business Entity	Name: paymentPlan	Name: _CustomerBillingAccount
Details:
«TMF_BusinessEntity» PartyPayment Business Entity	Name: _paymentPlan	Name: _partyPayment
Details:
«TMF_BusinessEntity» PaymentMethod Business Entity	Name: _paymentPlan	Name: _paymentMethod
Details:
«TMF_ABE» Party Payment ABE ABE «TMF_ABEIsComposedByEntity»	Name:	Name:
Details:
«TMF_BusinessEntity» PaymentPlanPaymentMethod Business Entity	Name: paymentPlan	Name: paymentPlanPaymentMethod
Details:

Element	Source Role	Target Role
«TMF_BusinessEntity» BusinessPartnerAccount Business Entity	Name: partyAccount	Name: _paymentPlan
Details:

Tag	Value
IsCoreEntity	False
Details: Values: true,false Default: False
rsa_guid	_aifwl04cEeO_XpEXs37Qew
Details:

Property	Value
isActive:	0
isFinalSpecialization:	0