---
title: clsBenefitSchedule
summary: API reference for clsBenefitSchedule.
status: draft
owner: SAIF Doc Gen
last_reviewed: 2026-07-28
library: SAIF.Business.Claim.Payment
reference_type: package
---

# clsBenefitSchedule

`clsBenefitSchedule` represents benefit schedule and exposes max future payments, start date, and stop date for time-loss payment processing.*

## Purpose
- Captures max future payments, start date, and stop date for time-loss payment processing.*

## Context
- Namespace: `SAIF.Business.Claim.Payment`
- Assembly/package: `SAIF.Business.Claim.Payment`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `MaxFuturePayments` | `Public ReadOnly Property MaxFuturePayments() As Decimal` | Returns max future payments. |
| `StartDate` | `Public ReadOnly Property StartDate() As Date` | Returns start date. |
| `StopDate` | `Public ReadOnly Property StopDate() As Date` | Returns stop date. |
| `IsEmpty` | `Public ReadOnly Property IsEmpty() As Boolean` | Returns is empty. |
| `PaymentProjections` | `Public ReadOnly Property PaymentProjections() As List(Of PaymentProjection)` | Returns payment projections. |
| `IssueDate` | `Public Property IssueDate() As Date` | Gets or sets issue date. |
| `FromDate` | `Public Property FromDate() As Date` | Gets or sets from date. |
| `ThruDate` | `Public Property ThruDate() As Date` | Gets or sets thru date. |

## Inherited public members

| Member | Signature | Purpose | Origin |
| --- | --- | --- | --- |
| `MyGuid` | `Public ReadOnly Property MyGuid() As String` | Returns the object's generated GUID identifier.† | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `IsNew` | `Public ReadOnly Property IsNew() As Boolean` | Indicates whether the object represents unsaved data.† | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `IsDeleted` | `Public ReadOnly Property IsDeleted() As Boolean` | Indicates whether the object has been marked for deletion.† | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `SetValueOnChange` | `Public Function SetValueOnChange(Of T)(ByRef inFieldValue As T, ByVal inSetValue As T, Optional ByVal inMarkDirty As Boolean = True) As Boolean` | Assigns a new field value only when it differs and optionally marks the object dirty.† | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `Rules` | `Public ReadOnly Property Rules() As clsRulesManager` | Exposes the BOF rules manager for validation and messages.† | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `Save` | `Public Overridable Function Save() As Boolean` | Persists the object through the BOF save pipeline.† | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `SaveChild` | `Public Overridable Function SaveChild() As Boolean` | Persists the object as a BOF child object.† | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |
| `ToXml` | `Public Function ToXml() As String` | Returns the object's XML representation using the configured default tag name.† | `Legacy\BusinessObjectFramework` — `clsBusinessBase` |

## Behavioral notes
- This type is documented from its source declaration.
- The type participates in the `clsBusinessBase` inheritance path used by `SAIF.Business.Claim.Payment`.

## Constraints and usage notes
- Consumers should rely on the public members and BOF lifecycle patterns visible in the source file.

> **Note:** Statements marked with `†` are derived from dependency library documentation via the Legends CLI.

## Sources
- `Business\SAIF.Business.Claim.Payment\Payments\TimelossPayments\clsBenefitSchedule.vb`
- `Legacy\BusinessObjectFramework\clsBusinessBase.vb`