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

# clsAwardPayment

`clsAwardPayment` represents the shared base for award payments and exposes payees, award payee, and reductions for state award processing.*

## Purpose
- Captures payees, award payee, and reductions for state award processing.*
- Organizes how the award amount is distributed across payees or reductions.*

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

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `AwardPayee` | `Public MustOverride ReadOnly Property AwardPayee() As IPayee Implements IAwardPayment.AwardPayee` | Returns award payee. |
| `PaymentReleased` | `Public Shadows ReadOnly Property PaymentReleased() As Boolean Implements IAwardPayment.PaymentReleased` | Returns payment released. |
| `ErrorMessages` | `Public Shadows ReadOnly Property ErrorMessages() As String() Implements IAwardPayment.PaymentErrors` | Returns error messages. |
| `BenefitPaymentId` | `Public Shadows ReadOnly Property BenefitPaymentId() As Decimal Implements IAwardPayment.PaymentID` | Returns benefit payment id. |
| `AwardNumber` | `Public Property AwardNumber() As Decimal` | Gets or sets award number. |
| `LastCalculationDate` | `Public Property LastCalculationDate() As Date Implements IAwardPayment.LastCalculationDate` | Gets or sets last calculation date. |
| `MonthlyBenefitFromDate` | `Public ReadOnly Property MonthlyBenefitFromDate() As Date Implements IAwardPayment.MonthlyBenefitFromDate` | Returns monthly benefit from date. |
| `MonthlyBenefitThruDate` | `Public ReadOnly Property MonthlyBenefitThruDate() As Date Implements IAwardPayment.MonthlyBenefitThruDate` | Returns monthly benefit thru date. |
| `MonthlyNextIssueDate` | `Public ReadOnly Property MonthlyNextIssueDate() As Date Implements IAwardPayment.MonthlyNextIssueDate` | Returns monthly next issue date. |
| `MonthlyBenefitAmount` | `Public Property MonthlyBenefitAmount() As Decimal Implements IAwardPayment.MonthlyBenefitAmount` | Gets or sets monthly benefit amount. |
| `ImmediatePaymentFromDate` | `Public Property ImmediatePaymentFromDate() As Date` | Gets or sets immediate payment from date. |
| `ImmediatePaymentThruDate` | `Public Property ImmediatePaymentThruDate() As Date` | Gets or sets immediate payment thru date. |
| `ImmediatePaymentIssueDate` | `Public Property ImmediatePaymentIssueDate() As Date` | Gets or sets immediate payment issue date. |
| `Payees` | `Public Shadows ReadOnly Property Payees() As clsPayeeCollection Implements IAwardPayment.Payees` | Returns payees. |
| `Reductions` | `Public ReadOnly Property Reductions() As Generic.List(Of clsPayeeBase)` | Returns reductions. |
| `AwardReductions` | `Public ReadOnly Property AwardReductions() As IEnumerable(Of IPayee) Implements IAwardPayment.AwardReductions` | Returns award reductions. |
| `AwardPayeeTypes` | `Public Overridable ReadOnly Property AwardPayeeTypes() As List(Of CTB.ExtendedCodeInfo(Of String, clsPayeeBase.PayeeTypes))` | Returns award payee types. |
| `NextIssueDateUpdated` | `Public ReadOnly Property NextIssueDateUpdated() As Boolean` | Returns next issue date updated. |
| `TotalPayeeBalance` | `Public ReadOnly Property TotalPayeeBalance() As Decimal` | Returns total payee balance. |
| `TotalMonthlyImmediatePaymentAmount` | `Public ReadOnly Property TotalMonthlyImmediatePaymentAmount() As Decimal` | Returns total monthly immediate payment amount. |
| `TotalPaymentAmountExcludingRecovery` | `Public ReadOnly Property TotalPaymentAmountExcludingRecovery() As Decimal` | Returns total payment amount excluding recovery. |
| `TotalImmediatePaymentAmount` | `Public ReadOnly Property TotalImmediatePaymentAmount() As Decimal` | Returns total immediate payment amount. |
| `TotalImmediatePaymentAmountExcludingRecovery` | `Public ReadOnly Property TotalImmediatePaymentAmountExcludingRecovery() As Decimal` | Returns total immediate payment amount excluding recovery. |
| `TotalMonthlyPaymentAmount` | `Public ReadOnly Property TotalMonthlyPaymentAmount() As Decimal` | Returns total monthly payment amount. |
| `TotalMonthlyPaymentAmountExcludingRecovery` | `Public ReadOnly Property TotalMonthlyPaymentAmountExcludingRecovery() As Decimal` | Returns total monthly payment amount excluding recovery. |
| `TotalMonthlyReductionAmount` | `Public ReadOnly Property TotalMonthlyReductionAmount() As Decimal` | Returns total monthly reduction amount. |
| `TotalImmediateReductionAmount` | `Public ReadOnly Property TotalImmediateReductionAmount() As Decimal` | Returns total immediate reduction amount. |
| `TotalMonthlySupportAmount` | `Public ReadOnly Property TotalMonthlySupportAmount() As Decimal` | Returns total monthly support amount. |
| `TotalImmediateSupportAmount` | `Public ReadOnly Property TotalImmediateSupportAmount() As Decimal` | Returns total immediate support amount. |
| `TotalImmediateRetroReserveAmount` | `Public ReadOnly Property TotalImmediateRetroReserveAmount() As Decimal` | Returns total immediate retro reserve amount. |
| `TotalMonthlyRetroReserveAmount` | `Public ReadOnly Property TotalMonthlyRetroReserveAmount() As Decimal` | Returns total monthly retro reserve amount. |
| `IsValid` | `Public Overrides ReadOnly Property IsValid() As Boolean` | Returns is valid. |
| `IsImmediatePaymentFromDateNull` | `Public ReadOnly Property IsImmediatePaymentFromDateNull() As Boolean` | Returns is immediate payment from date null. |
| `IsImmediatePaymentThruDateNull` | `Public ReadOnly Property IsImmediatePaymentThruDateNull() As Boolean` | Returns is immediate payment thru date null. |
| `SetImmediatePaymentFromDateNull` | `Public Sub SetImmediatePaymentFromDateNull()` | Executes the `SetImmediatePaymentFromDateNull` operation. |
| `SetImmediatePaymentThruDateNull` | `Public Sub SetImmediatePaymentThruDateNull()` | Executes the `SetImmediatePaymentThruDateNull` operation. |
| `SetMonthlyBenefitDatesNull` | `Public Sub SetMonthlyBenefitDatesNull() Implements IAwardPayment.SetMonthlyBenefitDatesNull` | Executes the `SetMonthlyBenefitDatesNull` operation. |
| `IsMonthlyIssueDateNull` | `Public ReadOnly Property IsMonthlyIssueDateNull() As Boolean Implements IAwardPayment.IsMonthlyIssueDateNull` | Returns is monthly issue date null. |
| `GetPayee` | `Public Function GetPayee(ByVal inPayeeID As Decimal) As IPayee Implements IAwardPayment.GetPayee` | Retrieves the `GetPayee` operation. |
| `SetMonthlyBenefitDates` | `Public Sub SetMonthlyBenefitDates(ByVal inMonthlyNextIssueDate As Date, ByVal inMonthlyBenefitFromDate As Date, ByVal inMonthlyBenefitThruDate As Date) Implements IAwardPayment.SetMonthlyBenefitDates` | Executes the `SetMonthlyBenefitDates` operation. |

## Inherited public members

| Member | Signature | Purpose | Origin |
| --- | --- | --- | --- |
| `BenefitPaymentID` | `Public Property BenefitPaymentID() As Decimal` | Gets or sets benefit payment i d. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `ClaimData` | `Public ReadOnly Property ClaimData() As clsClaimData` | Returns claim data. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `IsPaymentTransactionType` | `Public Property IsPaymentTransactionType() As Boolean` | Gets or sets is payment transaction type. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `IsInBatchMode` | `Public ReadOnly Property IsInBatchMode() As Boolean` | Returns is in batch mode. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `IssueDate` | `Public Property IssueDate() As Date` | Gets or sets issue date. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `MaxFutureIssueDays` | `Public Property MaxFutureIssueDays() As Integer` | Gets or sets max future issue days. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `MaxIssueDate` | `Public ReadOnly Property MaxIssueDate() As Date` | Returns max issue date. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `InitiatorUser` | `Public Property InitiatorUser() As String` | Gets or sets initiator user. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `ApproverUser` | `Public Property ApproverUser() As String` | Gets or sets approver user. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `CurrentUser` | `Public ReadOnly Property CurrentUser() As clsPaymentUser` | Returns current user. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `IsAdditionToComp` | `Public Property IsAdditionToComp() As Boolean` | Gets or sets is addition to comp. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `IsChargeable` | `Public Property IsChargeable() As Boolean` | Gets or sets is chargeable. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `IsRevolvingFund` | `Public Property IsRevolvingFund() As Boolean` | Gets or sets is revolving fund. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `IsRushCheck` | `Public Property IsRushCheck() As Boolean` | Gets or sets is rush check. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `IsApproved` | `Public ReadOnly Property IsApproved() As Boolean` | Returns is approved. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `IsAwaitingApproval` | `Public ReadOnly Property IsAwaitingApproval() As Boolean` | Returns is awaiting approval. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `IsInProgress` | `Public ReadOnly Property IsInProgress() As Boolean` | Returns is in progress. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `PaymentAmountMin` | `Public Property PaymentAmountMin() As Decimal` | Gets or sets payment amount min. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `PaymentAmountMax` | `Public Property PaymentAmountMax() As Decimal` | Gets or sets payment amount max. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `UpdateInfo` | `Public ReadOnly Property UpdateInfo() As clsUpdateInfo` | Returns update info. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `TotalPaymentAmount` | `Public Overridable ReadOnly Property TotalPaymentAmount() As Decimal` | Returns total payment amount. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `TotalPaymentPercentage` | `Public ReadOnly Property TotalPaymentPercentage() As Decimal` | Returns total payment percentage. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `PaymentBusinessFunction` | `Public ReadOnly Property PaymentBusinessFunction() As PaymentBusinessFunctions` | Returns payment business function. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `PaymentTransactionTypeMap` | `Public ReadOnly Property PaymentTransactionTypeMap() As clsPaymentTransactionTypeMap` | Returns payment transaction type map. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `PaymentTransactionType` | `Public ReadOnly Property PaymentTransactionType() As PaymentTransactionTypes` | Returns payment transaction type. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `BenefitTypeMap` | `Public ReadOnly Property BenefitTypeMap() As clsBenefitTypeMap` | Returns benefit type map. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `PaymentCategoryMap` | `Public ReadOnly Property PaymentCategoryMap() As clsPaymentCategoryMap` | Returns payment category map. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `IsDirty` | `Public Overrides ReadOnly Property IsDirty() As Boolean` | Returns is dirty. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `Save` | `Public Overrides Function Save() As Boolean` | Executes the `Save` operation. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `Disapprove` | `Public Sub Disapprove()` | Exposes the public member. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `Approve` | `Public Overridable Function Approve() As ApprovalErrors` | Exposes the public member. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `GetNextIssueDate` | `Public Shared Function GetNextIssueDate(ByVal inDPI As IDataPortalInfo, _` | Retrieves the `GetNextIssueDate` operation. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `GetNextIssueDate` | `Public Function GetNextIssueDate(ByVal inPaymentTransactionType As PaymentTransactionTypes) As Date` | Retrieves the `GetNextIssueDate` operation. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `GetNextIssueDate` | `Public Function GetNextIssueDate() As Date` | Retrieves the `GetNextIssueDate` operation. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `UpdateIssueDate` | `Public Function UpdateIssueDate() As Boolean` | Executes the `UpdateIssueDate` operation. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `MaxTotalMonthlyAmount` | `Public ReadOnly Property MaxTotalMonthlyAmount() As Decimal` | Returns max total monthly amount. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `HasCurrentSupportOrder` | `Public ReadOnly Property HasCurrentSupportOrder() As Boolean` | Returns has current support order. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `HasDelinquentSupportOrder` | `Public ReadOnly Property HasDelinquentSupportOrder() As Boolean` | Returns has delinquent support order. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `HasSupportOrder` | `Public ReadOnly Property HasSupportOrder() As Boolean` | Returns has support order. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `HasArrearage` | `Public ReadOnly Property HasArrearage As Boolean` | Returns has arrearage. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `PreviousPaidAmount` | `Public ReadOnly Property PreviousPaidAmount(ByVal inIssueDate As Date) As Decimal` | Returns previous paid amount. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `GetTotalSupportAmount` | `Public Function GetTotalSupportAmount(ByVal inPayees As clsPayeeCollection) As Decimal` | Retrieves the `GetTotalSupportAmount` operation. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `New` | `Public Sub New(ByVal inDPI As IDataPortalInfo, ByVal inClaimData As clsClaimData)` | Executes the `New` operation. | `SAIF.Business.Claim.Payment` — `clsPaymentBase` |
| `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 `clsPaymentBase` 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\StateAwardPayments\clsAwardPayment.vb`
- `Legacy\BusinessObjectFramework\clsBusinessBase.vb`