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

# clsPolicyPeriodPrepay

Represents prepaid premium data for a policy period; holds prepay amounts and schedule details for policies with prepaid billing arrangements. Consumed by prepay billing workflows.*

## Purpose
- Persists and retrieves prepaid premium amounts and schedule configuration for a policy period.*
- Consumed by prepay billing workflows that calculate or present the prepaid premium portion of a policy period.*

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

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| PolicyNumber | `Public ReadOnly Property PolicyNumber() As Decimal` | The numeric policy number identifying the policy to which this record belongs. |
| PolicyPeriodEffectiveDate | `Public ReadOnly Property PolicyPeriodEffectiveDate() As Date` | The effective date of the policy period to which this rating plan applies. |
| FrequencyCode | `Public ReadOnly Property FrequencyCode() As String` | Stores the Oracle code value that classifies this cls Policy Period Prepay. |
| DiscountAmount | `Public ReadOnly Property DiscountAmount() As Decimal` | Numeric discount amount value used by this type's rating, billing, or reporting logic.* |
| CreateDate | `Public ReadOnly Property CreateDate() As Date` | The timestamp at which this record was created in the Oracle database. |
| CreateUser | `Public ReadOnly Property CreateUser() As String` | The username of the account that created this record. |
| CancelDate | `Public ReadOnly Property CancelDate() As Date` | Business value exposed as cancel date for callers of this API.* |
| UpdateDate | `Public ReadOnly Property UpdateDate() As Date` | The timestamp of the most recent update to this record.* |
| UpdateUser | `Public ReadOnly Property UpdateUser() As String` | The username of the account that last modified this record.* |
| SetCancelDateNull | `Public Sub SetCancelDateNull()` | Clears `CancelDate`, marking it as null/unset so the column will be written as NULL on the next save.* |
| 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.* |
| IsCancelDateNull | `Public Function IsCancelDateNull() As Boolean` | Tests whether `CancelDate` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| 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.* |
| 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 clsPolicyPeriodPrepay) As Boolean` | Compares this instance with another `clsPolicyPeriodPrepay` instance for value equality.* |
| GetHashCode | `Public Overrides Function GetHashCode() As Integer` | Returns a hash code consistent with the value-equality implementation. |
| NewPolicyPeriodPrepay | `Public Shared Function NewPolicyPeriodPrepay(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNumber As Decimal, ByVal inPolicyPeriodEffectiveDate As Date) As clsPolicyPeriodPrepay` | Creates a new cls policy period prepay initialized from the supplied source values.* |
| GetPolicyPeriodPrepay | `Public Shared Function GetPolicyPeriodPrepay(ByVal inDataportal As IDataPortalInfo, ByVal inPolicyNumber As Decimal, ByVal inPolicyPeriodEffectiveDate As Date) As clsPolicyPeriodPrepay` | Loads a cls policy period prepay 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\clsPolicyPeriodPrepay.vb`.

## Constraints and usage notes
- Applicable only to policy periods with a prepay payment plan type.*


> **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\clsPolicyPeriodPrepay.vb`