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

# clsBenefitPeriod

`clsBenefitPeriod` represents a benefit period and exposes benefit payment IDs, benefit period ID, and claim identifiers for claim payment processing.*

## Purpose
- Captures benefit payment IDs, benefit period ID, and claim identifiers for claim payment processing.*
- Provides retrieval or loading behavior related to that workflow.*

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

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `BenefitPaymentID` | `Public ReadOnly Property BenefitPaymentID() As Decimal` | Returns benefit payment i d. |
| `BenefitPeriodID` | `Public ReadOnly Property BenefitPeriodID() As Decimal` | Returns benefit period i d. |
| `ClaimID` | `Public ReadOnly Property ClaimID() As Decimal` | Returns claim i d. |
| `IsHalfShift` | `Public Property IsHalfShift() As Boolean` | Gets or sets is half shift. |
| `PaymentCategory` | `Public Property PaymentCategory() As PaymentCategories` | Gets or sets payment category. |
| `ProrateOffsetRate` | `Public Property ProrateOffsetRate() As Decimal` | Gets or sets prorate offset rate. |
| `RetroReserveAmount` | `Public Property RetroReserveAmount() As Decimal` | Gets or sets retro reserve amount. |
| `BenefitWithoutInterestAmount` | `Public ReadOnly Property BenefitWithoutInterestAmount() As Decimal` | Returns benefit without interest amount. |
| `OffsetAmountAdjusted` | `Public Property OffsetAmountAdjusted() As Decimal` | Gets or sets offset amount adjusted. |
| `InterestRate` | `Public Property InterestRate() As Decimal` | Gets or sets interest rate. |
| `TdDaysPaid` | `Public Property TdDaysPaid() As Decimal` | Gets or sets td days paid. |
| `TdPreviousDaysPaid` | `Public Property TdPreviousDaysPaid() As Decimal` | Gets or sets td previous days paid. |
| `PreviousPaidAmount` | `Public Property PreviousPaidAmount() As Decimal` | Gets or sets previous paid amount. |
| `BillPaymentID` | `Public Property BillPaymentID() As Decimal` | Gets or sets bill payment i d. |
| `LoadPreviousPaidProperites` | `Public Function LoadPreviousPaidProperites() As Boolean` | Exposes the public member. |
| `UpdateInfo` | `Public ReadOnly Property UpdateInfo() As clsUpdateInfo` | Returns update info. |
| `HasPreviouslyPaid3DW` | `Public ReadOnly Property HasPreviouslyPaid3DW(ByVal inClaimData As clsClaimData) As Boolean` | Returns has previously paid3 d w. |
| `Period` | `Public Property Period() As DateRange` | Gets or sets period. |
| `Amount` | `Public Property Amount() As Decimal` | Gets or sets amount. |
| `DaysPaid` | `Public Property DaysPaid() As Decimal` | Gets or sets days paid. |
| `New` | `Public Sub New()` | Executes the `New` operation. |
| `New` | `Public Sub New(ByVal inDateRange As DateRange, ByVal inAmount As Decimal, ByVal inDaysPaid As Decimal)` | Executes the `New` operation. |

## 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\Periods\clsBenefitPeriod.vb`
- `Legacy\BusinessObjectFramework\clsBusinessBase.vb`