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

# clsAwardPayeeInfo

`clsAwardPayeeInfo` packages benefit payee ID, update date, and update user for award payee information.*

## Purpose
- Packages benefit payee ID, update date, and update user for downstream consumers.*

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

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `BenefitPayeeID` | `Public ReadOnly Property BenefitPayeeID() As Decimal` | Returns benefit payee i d. |
| `UpdateDate` | `Public ReadOnly Property UpdateDate() As Date` | Returns update date. |
| `UpdateUser` | `Public ReadOnly Property UpdateUser() As String` | Returns update user. |
| `UpdateNumber` | `Public ReadOnly Property UpdateNumber() As Decimal` | Returns update number. |
| `CurrentBalanceDueAmount` | `Public Property CurrentBalanceDueAmount() As Decimal` | Gets or sets current balance due amount. |
| `NextCheckAmount` | `Public Property NextCheckAmount() As Decimal` | Gets or sets next check amount. |
| `NextRetroReserveAmount` | `Public Property NextRetroReserveAmount() As Decimal` | Gets or sets next retro reserve amount. |
| `SpecialHandlingCode` | `Public Property SpecialHandlingCode() As String` | Gets or sets special handling code. |
| `SetSpecialHandlingNull` | `Public Sub SetSpecialHandlingNull()` | Executes the `SetSpecialHandlingNull` operation. |
| `IsSpecialHandlingNull` | `Public ReadOnly Property IsSpecialHandlingNull() As Boolean` | Returns is special handling null. |
| `SetCurrentBalanceDueNull` | `Public Sub SetCurrentBalanceDueNull()` | Executes the `SetCurrentBalanceDueNull` operation. |
| `IsCurrentBalanceDueNull` | `Public ReadOnly Property IsCurrentBalanceDueNull() As Boolean` | Returns is current balance due null. |
| `Equals` | `Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean` | Exposes the public member. |
| `Equals` | `Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean` | Exposes the public member. |
| `Equals` | `Public Overloads Function Equals(ByVal inObject As clsAwardPayeeInfo) As Boolean` | Exposes the public member. |
| `GetHashCode` | `Public Overrides Function GetHashCode() As Integer` | Retrieves the `GetHashCode` operation. |
| `ToString` | `Public Overrides Function ToString() As String` | Exposes the public member. |
| `GetStateAwardMonthlyPayee` | `Public Shared Function GetStateAwardMonthlyPayee(ByVal inDataportal As IDataPortalInfo, ByVal inBenefitPayeeID As Decimal) As clsAwardPayeeInfo` | Retrieves the `GetStateAwardMonthlyPayee` operation. |
| `BenefitPayeeID` | `Public Property BenefitPayeeID() As Decimal` | Gets or sets benefit payee i d. |
| `New` | `Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo)` | Executes the `New` operation. |
| `New` | `Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inBenefitPayeeID 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\Payees\clsAwardPayeeInfo.vb`
- `Legacy\BusinessObjectFramework\clsBusinessBase.vb`