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

Attributes
PartyPayment	_partyPayment
PaymentMethod	_paymentMethod
CustomerAccount	customerAccount
String	ID	Unique identifier
«baseType» Money	maxAmount	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.
Integer	maxTrialTimes	Maximum number of trial to submit a payment if it has been rejected.
BusinessPartnerAccount	partyAccount
Integer	paymentDay	The day chosen by the party for generating the payments
«baseType» Duration	paymentPeriod	The period of time between two payments.
PaymentPlanPaymentMethod	paymentPlanPaymentMethod
Integer	priority	The priority of the PaymentPlan amongst all the PaymentPlans agreed with the same PartyRole.
String	status	A PayemntPlan might be initialized, validated,in progress or closed.
«baseType» Money	totalAmount	The total amount that the PaymentPlan has to recover through payments.
String	type
«baseType» TimePeriod	validFor	Valid period for the PaymentPlan.

 _partyPayment

Public PartyPayment _partyPayment

Constraints:

Properties:

Aggregation	None
Alias
Association	PaymentMadeAccordingTo
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	_partyPayment
Name Expression
Namespace	PaymentPlan
Opposite	_paymentPlan
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::_partyPayment
Stereotype
Template Parameter
Type	PartyPayment
Upper	*
Upper Value	(*)
Visibility	Public

 _paymentMethod

Public PaymentMethod _paymentMethod

Constraints:

Properties:

Aggregation	None
Alias
Association	PaymentPlanUsePaymentMethod
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	_paymentMethod
Name Expression
Namespace	PaymentPlan
Opposite	_paymentPlan
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::_paymentMethod
Stereotype
Template Parameter
Type	PaymentMethod
Upper	*
Upper Value	(*)
Visibility	Public

 customerAccount

Public CustomerAccount customerAccount

Constraints:

Properties:

Aggregation	None
Alias
Association	PaymentPlanAppliedToCustomerAccount
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	customerAccount
Name Expression
Namespace	PaymentPlan
Opposite	paymentPlan
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::customerAccount
Stereotype
Template Parameter
Type	CustomerAccount
Upper	*
Upper Value	(*)
Visibility	Public

 ID

Public String ID

Unique identifier

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	ID
Name Expression
Namespace	PaymentPlan
Opposite
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::ID
Stereotype	required
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

 maxAmount

Public «baseType» Money maxAmount

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.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	maxAmount
Name Expression
Namespace	PaymentPlan
Opposite
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::maxAmount
Stereotype
Template Parameter
Type	«baseType» Money
Upper	1
Upper Value
Visibility	Public

 maxTrialTimes

Public Integer maxTrialTimes

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

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	maxTrialTimes
Name Expression
Namespace	PaymentPlan
Opposite
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::maxTrialTimes
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value
Visibility	Public

 partyAccount

Public BusinessPartnerAccount partyAccount

Constraints:

Properties:

Aggregation	None
Alias
Association	PaymentPlanAppliedToPartyAccount
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	partyAccount
Name Expression
Namespace	PaymentPlan
Opposite	_paymentPlan
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::partyAccount
Stereotype
Template Parameter
Type	BusinessPartnerAccount
Upper	*
Upper Value	(*)
Visibility	Public

 paymentDay

Public Integer paymentDay

The day chosen by the party for generating the payments

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	paymentDay
Name Expression
Namespace	PaymentPlan
Opposite
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::paymentDay
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value
Visibility	Public

 paymentPeriod

Public «baseType» Duration paymentPeriod

The period of time between two payments.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	paymentPeriod
Name Expression
Namespace	PaymentPlan
Opposite
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::paymentPeriod
Stereotype
Template Parameter
Type	«baseType» Duration
Upper	1
Upper Value
Visibility	Public

 paymentPlanPaymentMethod

Public PaymentPlanPaymentMethod paymentPlanPaymentMethod

Constraints:

Properties:

Aggregation	None
Alias
Association	PaymentPlanUsesForAutoPay
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	paymentPlanPaymentMethod
Name Expression
Namespace	PaymentPlan
Opposite	paymentPlan
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::paymentPlanPaymentMethod
Stereotype
Template Parameter
Type	PaymentPlanPaymentMethod
Upper	*
Upper Value	(*)
Visibility	Public

 priority

Public Integer priority

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

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	priority
Name Expression
Namespace	PaymentPlan
Opposite
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::priority
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value
Visibility	Public

 status

Public String status

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

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	status
Name Expression
Namespace	PaymentPlan
Opposite
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::status
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

 totalAmount

Public «baseType» Money totalAmount

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

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	totalAmount
Name Expression
Namespace	PaymentPlan
Opposite
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::totalAmount
Stereotype
Template Parameter
Type	«baseType» Money
Upper	1
Upper Value
Visibility	Public

 type

Public String type

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	type
Name Expression
Namespace	PaymentPlan
Opposite
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::type
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

 validFor

Public «baseType» TimePeriod validFor

Valid period for the PaymentPlan.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PaymentPlan
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	validFor
Name Expression
Namespace	PaymentPlan
Opposite
Owner	PaymentPlan
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Party Payment ABE::PaymentPlan::validFor
Stereotype
Template Parameter
Type	«baseType» TimePeriod
Upper	1
Upper Value
Visibility	Public