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

# clsPayeeBase

`clsPayeeBase` is the shared base for payee, centralizing claim context, benefit payee ID, and benefit payment IDs for derived types.*

## Purpose
- Centralizes claim context, benefit payee ID, and benefit payment IDs for derived types.*
- Provides shared lifecycle checks used before derived objects are saved or retrieved.*

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

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `BenefitPayeeID` | `Public ReadOnly Property BenefitPayeeID() As Decimal Implements IPayee.PayeeID` | Returns benefit payee i d. |
| `BenefitPaymentID` | `Public ReadOnly Property BenefitPaymentID() As Decimal` | Returns benefit payment i d. |
| `ClaimData` | `Public ReadOnly Property ClaimData() As clsClaimData` | Returns claim data. |
| `PaymentAmount` | `Public Property PaymentAmount() As Decimal Implements IPayee.PaymentAmount` | Gets or sets payment amount. |
| `PaymentAmountMin` | `Public Property PaymentAmountMin() As Decimal` | Gets or sets payment amount min. |
| `PaymentAmountMax` | `Public Property PaymentAmountMax() As Decimal` | Gets or sets payment amount max. |
| `PaymentPercentage` | `Public Property PaymentPercentage() As Decimal` | Gets or sets payment percentage. |
| `SpecialHandlingCode` | `Public Property SpecialHandlingCode() As String` | Gets or sets special handling code. |
| `IsDenialFinalLanguage` | `Public Property IsDenialFinalLanguage() As Boolean` | Gets or sets is denial final language. |
| `PayeeDescription` | `Public ReadOnly Property PayeeDescription() As String` | Returns payee description. |
| `PayeeType` | `Public Property PayeeType() As PayeeTypes Implements IPayee.PayeeType` | Gets or sets payee type. |
| `PayeeTypeCode` | `Public Property PayeeTypeCode As String` | Gets or sets payee type code. |
| `RetroReserveAmount` | `Public Property RetroReserveAmount() As Decimal Implements IPayee.RetroReserveAmount` | Gets or sets retro reserve amount. |
| `PaymentText` | `Public Property PaymentText() As String` | Gets or sets payment text. |
| `CashCardID` | `Public Property CashCardID() As Decimal Implements IPayee.CashCardID` | Gets or sets cash card i d. |
| `HasCashCard` | `Public ReadOnly Property HasCashCard() As Boolean` | Returns has cash card. |
| `UpdateInfo` | `Public ReadOnly Property UpdateInfo() As clsUpdateInfo` | Returns update info. |
| `BenefitRemark` | `Public ReadOnly Property BenefitRemark() As clsBenefitRemark` | Returns benefit remark. |
| `MonthlyAwardInfo` | `Public ReadOnly Property MonthlyAwardInfo() As clsAwardPayeeInfo Implements IPayee.MonthlyAwardInfo` | Returns monthly award info. |
| `MonthlyPaymentAmount` | `Public ReadOnly Property MonthlyPaymentAmount() As Decimal` | Returns monthly payment amount. |
| `MonthlyRetroReserveAmount` | `Public ReadOnly Property MonthlyRetroReserveAmount() As Decimal` | Returns monthly retro reserve amount. |
| `TotalMonthlyPaymentAmount` | `Public ReadOnly Property TotalMonthlyPaymentAmount() As Decimal` | Returns total monthly payment amount. |
| `TotalImmediatePaymentAmount` | `Public ReadOnly Property TotalImmediatePaymentAmount() As Decimal` | Returns total immediate payment amount. |
| `TotalPaymentAmount` | `Public ReadOnly Property TotalPaymentAmount() As Decimal` | Returns total payment amount. |
| `IsSpecialHandlingNull` | `Public ReadOnly Property IsSpecialHandlingNull() As Boolean` | Returns is special handling null. |
| `SetSpecialHandlingNull` | `Public Sub SetSpecialHandlingNull()` | Executes the `SetSpecialHandlingNull` operation. |
| `IsPaymentTextNull` | `Public ReadOnly Property IsPaymentTextNull() As Boolean` | Returns is payment text null. |
| `SetPaymentTextNull` | `Public Sub SetPaymentTextNull()` | Executes the `SetPaymentTextNull` operation. |
| `IsCashCardIDNull` | `Public ReadOnly Property IsCashCardIDNull() As Boolean` | Returns is cash card i d null. |
| `SetCashCardIDNull` | `Public Sub SetCashCardIDNull()` | Executes the `SetCashCardIDNull` operation. |
| `IsDirty` | `Public Overrides ReadOnly Property IsDirty() As Boolean` | Returns is dirty. |
| `IsValid` | `Public Overrides ReadOnly Property IsValid() As Boolean` | Returns is valid. |
| `PaymentAddress` | `Public MustOverride ReadOnly Property PaymentAddress() As clsAddress Implements IPayee.PayeeAddress` | Returns payment address. |
| `PayeeName` | `Public MustOverride ReadOnly Property PayeeName() As String Implements IPayee.PayeeName` | Returns payee name. |
| `GetReadonlyPayee` | `Public Shared Function GetReadonlyPayee(ByVal inPayeeType As PayeeTypes, ByVal inDPI As IDataPortalInfo, ByVal inClaimData As clsClaimData) As clsPayeeBase` | Retrieves the `GetReadonlyPayee` operation. |
| `Save` | `Public Overrides Function Save() As Boolean` | Executes the `Save` operation. |
| `PayeeTypeMap` | `Public ReadOnly Property PayeeTypeMap() As clsPayeeTypeMap` | Returns payee type map. |
| `GetPayeeTypeMap` | `Public Shared Function GetPayeeTypeMap(ByVal inDPI As IDataPortalInfo, Optional ByVal RefreshPayeeTypes As Boolean = False) As clsPayeeTypeMap` | Retrieves the `GetPayeeTypeMap` operation. |
| `GetSpecialHandlingCodes` | `Public Shared Function GetSpecialHandlingCodes(ByVal inDPI As IDataPortalInfo, Optional ByVal RefreshCodes As Boolean = False) As SpecialHandlingCodes` | Retrieves the `GetSpecialHandlingCodes` operation. |
| `New` | `Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo)` | 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` |
| `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\Payees\clsPayeeBase.vb`
- `Legacy\BusinessObjectFramework\clsBusinessBase.vb`