---
title: clsPaymentPlanDefaultValues
summary: API reference for clsPaymentPlanDefaultValues.
status: draft
owner: Technical Writer
last_reviewed: 2026-07-31
library: SAIF.Business.Policy.Premium
reference_type: package
---

# clsPaymentPlanDefaultValues

Holds default parameter values for a specific payment plan type; used to populate new payment plan records with pre-configured defaults (e.g., installment counts, down payment amounts). Accessed via `clsPaymentPlanType.DefaultValues`.*

## Purpose
- Persists and retrieves the default parameter configuration for a payment plan type.*
- Consumed by payment plan creation workflows that apply default values based on the selected plan type.*

## Context
- Namespace: `SAIF.Business.Policy.Premium.Billing`
- Assembly/package: `SAIF.Business.Policy.Premium`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| PaymentPlanTypeCode | `Public Property PaymentPlanTypeCode() As String` | Stores the Oracle code value that classifies this cls Payment Plan Default Values. |
| AltScheduleOption | `Public Property AltScheduleOption() As String` | Business value exposed as alt schedule option for callers of this API.* |
| HighDays | `Public Property HighDays() As Decimal` | Business value exposed as high days for callers of this API.* |
| LowDays | `Public Property LowDays() As Decimal` | Business value exposed as low days for callers of this API.* |
| PaymentPlanDefaultCode | `Public Property PaymentPlanDefaultCode() As String` | Oracle code value used to classify this business object.* |
| Installments | `Public Property Installments() As Decimal` | Business value exposed as installments for callers of this API.* |
| PercentDown | `Public Property PercentDown() As Decimal` | Numeric percent down value used by this type's rating, billing, or reporting logic.* |
| PlanDescription | `Public Property PlanDescription() As String` | Human-readable description associated with the current plan.* |
| HighEAIP | `Public Property HighEAIP() As Decimal` | Business value exposed as high eaip for callers of this API.* |
| LowEAIP | `Public Property LowEAIP() As Decimal` | Business value exposed as low eaip for callers of this API.* |
| CreateDate | `Public Property CreateDate() As Date` | The timestamp at which this record was created in the Oracle database. |
| CreateUser | `Public Property CreateUser() As String` | The username of the account that created this record. |
| PayrollReportFrequencyCode | `Public Property PayrollReportFrequencyCode() As String` | Numeric payroll report frequency code value used by this type's rating, billing, or reporting logic.* |
| UpdateDate | `Public Property UpdateDate() As Date` | The timestamp of the most recent update to this record.* |
| UpdateUser | `Public Property UpdateUser() As String` | The username of the account that last modified this record.* |
| BillingFrequencyGroupCode | `Public Property BillingFrequencyGroupCode() As String` | Oracle code value used to classify this business object.* |
| BillingFrequency | `Public ReadOnly Property BillingFrequency() As String` | Business value exposed as billing frequency for callers of this API.* |
| BillingFrequencyCodes | `Public ReadOnly Property BillingFrequencyCodes() As clsCodeCollection` | Returns the associated billing frequency codes used by this type. |
| BillingSortNumber | `Public Property BillingSortNumber() As Decimal` | Business value exposed as billing sort number for callers of this API.* |
| IsNonStandardPlan | `Public ReadOnly Property IsNonStandardPlan() As Boolean` | Indicates whether non standard plan applies in this business object.* |
| PaymentPlanType | `Public ReadOnly Property PaymentPlanType As clsPaymentPlanType` | Lookup object that describes the current payment plan type.* |
| IsValid | `Public Overrides ReadOnly Property IsValid() As Boolean` | Returns True when all registered business rules pass; delegates to the framework rule engine. |
| IsDirty | `Public Overrides ReadOnly Property IsDirty() As Boolean` | Returns True when one or more tracked properties have been modified since the last save or MarkOld() call. |
| SetUpdateDateNull | `Public Sub SetUpdateDateNull()` | Clears `UpdateDate`, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetUpdateUserNull | `Public Sub SetUpdateUserNull()` | Clears `UpdateUser`, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetBillingFrequencyGroupCodeNull | `Public Sub SetBillingFrequencyGroupCodeNull()` | Clears `BillingFrequencyGroupCode`, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetBillingSortNumberNull | `Public Sub SetBillingSortNumberNull()` | Clears `BillingSortNumber`, marking it as null/unset so the column will be written as NULL on the next save.* |
| IsUpdateDateNull | `Public Function IsUpdateDateNull() As Boolean` | Tests whether `UpdateDate` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsUpdateUserNull | `Public Function IsUpdateUserNull() As Boolean` | Tests whether `UpdateUser` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsBillingFrequencyGroupCodeNull | `Public Function IsBillingFrequencyGroupCodeNull() As Boolean` | Tests whether `BillingFrequencyGroupCode` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsBillingSortNumberNull | `Public Function IsBillingSortNumberNull() As Boolean` | Tests whether `BillingSortNumber` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| Equals | `Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean` | Static overload: compares two Object references for equality using value-equality semantics.* |
| Equals | `Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean` | Compares this instance with another `Object` instance for value equality.* |
| Equals | `Public Overloads Function Equals(ByVal inObject As clsPaymentPlanDefaultValues) As Boolean` | Compares this instance with another `clsPaymentPlanDefaultValues` instance for value equality.* |
| GetHashCode | `Public Overrides Function GetHashCode() As Integer` | Returns a hash code consistent with the value-equality implementation. |
| ToString | `Public Overrides Function ToString() As String` | Returns a string representation of this instance, typically for diagnostics.* |
| GetPaymentPlanDefaultValues | `Public Shared Function GetPaymentPlanDefaultValues(ByVal inDataportal As IDataPortalInfo, ByVal inPaymentPlanTypeCode As String) As clsPaymentPlanDefaultValues` | Loads a cls payment plan default values that matches the supplied lookup criteria. |
## Inherited public members

| Member | Signature | Purpose | Origin |
| --- | --- | --- | --- |
| Rules | `Property Rules As clsRulesManager` | Framework rules manager used to register, evaluate, and surface broken rules on the object.† | `SAIF.Framework.Core — clsBusinessBase` |
| BeginEdit | `Sub BeginEdit()` | Starts an n-level edit session so callers can stage changes.† | `SAIF.Framework.Core — clsBusinessBase` |
| CancelEdit | `Sub CancelEdit()` | Rolls back the active edit session.† | `SAIF.Framework.Core — clsBusinessBase` |
| ApplyEdit | `Sub ApplyEdit()` | Commits the active edit session.† | `SAIF.Framework.Core — clsBusinessBase` |

## Behavioral notes
- Source file: `Business\SAIF.Business.Policy.Premium\Billing\clsPaymentPlanDefaultValues.vb`.

## Constraints and usage notes
- Each default values record is associated with a single `clsPaymentPlanType`; defaults apply to new payment plans and may be overridden by the caller.*


> **Note:** Statements marked with * were inferred from code structure, naming conventions, or
> contextual evidence where direct confirmation was not available in source artifacts. Statements
> marked with ** could not be confirmed; treat as unknown until verified.

## Sources
- `Business\SAIF.Business.Policy.Premium\Billing\clsPaymentPlanDefaultValues.vb`