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

# clsFatalAward

`clsFatalAward` represents a fatal award and exposes award type, award payments, and beneficiaries for state award processing.*

## Purpose
- Captures award type, award payments, and beneficiaries for state award processing.*
- Participates in the award payment workflow through validation, approval, or save steps.*

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

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `AwardType` | `Public Overrides ReadOnly Property AwardType() As clsAward.AwardTypes` | Returns award type. |
| `AwardPayments` | `Public Overrides ReadOnly Property AwardPayments() As IEnumerable(Of IAwardPayment)` | Returns award payments. |
| `Beneficiaries` | `Public ReadOnly Property Beneficiaries() As clsFatalBeneficiaryList` | Returns beneficiaries. |
| `IsAdvance` | `Public ReadOnly Property IsAdvance() As Boolean` | Returns is advance. |
| `AwardPayeeTypes` | `Public ReadOnly Property AwardPayeeTypes() As List(Of CTB.ExtendedCodeInfo(Of String, clsPayeeBase.PayeeTypes))` | Returns award payee types. |
| `AddPayee` | `Public Function AddPayee(ByVal inPayeeType As clsPayeeBase.PayeeTypes, ByVal inBeneficiaryID As Decimal) As clsPayeeBase` | Executes the `AddPayee` operation. |
| `ChangePayeeType` | `Public Overridable Function ChangePayeeType(ByVal inPayee As clsPayeeBase, ByVal inpayeetype As clsPayeeBase.PayeeTypes, ByVal inBeneficiaryID As Decimal) As clsPayeeBase` | Exposes the public member. |
| `NewAward` | `Public Shared Function NewAward(ByVal inDPI As IDataPortalInfo, ByVal inClaimID As Decimal) As clsFatalAward` | Executes the `NewAward` operation. |
| `NewAward` | `Public Shared Function NewAward(ByVal inDPI As IDataPortalInfo, ByVal inClaimData As clsClaimData) As clsFatalAward` | Executes the `NewAward` operation. |
| `GetAward` | `Public Shared Function GetAward(ByVal inDPI As IDataPortalInfo, ByVal inClaimData As clsClaimData, Optional ByVal ViewOnly As Boolean = False) As clsFatalAward` | Retrieves the `GetAward` operation. |
| `GetAward` | `Public Shared Function GetAward(ByVal inDPI As IDataPortalInfo, ByVal inClaimID As Decimal, Optional ByVal ViewOnly As Boolean = False) As clsFatalAward` | Retrieves the `GetAward` operation. |
| `PreviouslyPaidPayees` | `Public ReadOnly Property PreviouslyPaidPayees() As List(Of IPayee)` | Returns previously paid payees. |
| `Approve` | `Public Overrides Function Approve() As clsPaymentBase.ApprovalErrors` | Exposes the public member. |
| `DisApprove` | `Public Overrides Sub DisApprove()` | Exposes the public member. |

## Inherited public members

| Member | Signature | Purpose | Origin |
| --- | --- | --- | --- |
| `AwardTypeMap` | `Public ReadOnly Property AwardTypeMap() As clsAwardTypeMap` | Returns award type map. | `StateAwards` — `clsAward` |
| `GetAwardTypeMap` | `Public Shared Function GetAwardTypeMap(Optional ByVal RefreshAwardTypes As Boolean = False) _` | Retrieves the `GetAwardTypeMap` operation. | `StateAwards` — `clsAward` |
| `AwardStatusMap` | `Public ReadOnly Property AwardStatusMap() As clsAwardStatusMap` | Returns award status map. | `StateAwards` — `clsAward` |
| `GetAwardStatusMap` | `Public Shared Function GetAwardStatusMap(ByVal inDPI As IDataPortalInfo, Optional ByVal RefreshAwardTypes As Boolean = False) _` | Retrieves the `GetAwardStatusMap` operation. | `StateAwards` — `clsAward` |
| `FinancialTransactionMode` | `Public Property FinancialTransactionMode() As AwardMode` | Gets or sets financial transaction mode. | `StateAwards` — `clsAward` |
| `AwardApprovalErrors` | `Public ReadOnly Property AwardApprovalErrors() As clsPaymentBase.ApprovalErrors()` | Returns award approval errors. | `StateAwards` — `clsAward` |
| `Disapprove` | `Public Overridable Sub Disapprove()` | Exposes the public member. | `StateAwards` — `clsAward` |
| `GetAwardType` | `Public Shared Function GetAwardType(ByVal inDPI As IDataPortalInfo, ByVal inAwardNumber As Decimal) As AwardTypes` | Retrieves the `GetAwardType` operation. | `StateAwards` — `clsAward` |
| `GetSpecificAward` | `Public Shared Function GetSpecificAward(ByVal inDPI As IDataPortalInfo, ByVal inAwardNumber As Decimal) As IAward` | Retrieves the `GetSpecificAward` operation. | `StateAwards` — `clsAward` |
| `GetAwardCount` | `Public Shared Function GetAwardCount(ByVal inDPI As IDataPortalInfo, ByVal inClaimID As Decimal, Optional ByVal inStatus As AwardStatus = AwardStatus.Active) As Decimal` | Retrieves the `GetAwardCount` operation. | `StateAwards` — `clsAward` |
| `GetPayment` | `Public Function GetPayment(ByVal inPaymentID As Decimal) As IAwardPayment Implements IAward.GetPayment` | Retrieves the `GetPayment` operation. | `StateAwards` — `clsAward` |
| `IsApproved` | `Public ReadOnly Property IsApproved() As Boolean` | Returns is approved. | `StateAwards` — `clsAward` |
| `IsInProgress` | `Public ReadOnly Property IsInProgress() As Boolean` | Returns is in progress. | `StateAwards` — `clsAward` |
| `IsAwaitingApproval` | `Public ReadOnly Property IsAwaitingApproval() As Boolean` | Returns is awaiting approval. | `StateAwards` — `clsAward` |
| `InitiatorUser` | `Public Property InitiatorUser() As String` | Gets or sets initiator user. | `StateAwards` — `clsAward` |
| `ApproverUser` | `Public Property ApproverUser() As String` | Gets or sets approver user. | `StateAwards` — `clsAward` |
| `PercentLimitChangeDate` | `Public ReadOnly Property PercentLimitChangeDate() As Date` | Returns percent limit change date. | `StateAwards` — `clsAward` |
| `AwardNumber` | `Public ReadOnly Property AwardNumber() As Decimal Implements IAward.AwardNumber` | Returns award number. | `StateAwards` — `clsAward` |
| `ClaimID` | `Public ReadOnly Property ClaimID() As Decimal Implements IAward.ClaimID` | Returns claim i d. | `StateAwards` — `clsAward` |
| `Status` | `Public Property Status() As AwardStatus Implements IAward.Status` | Gets or sets status. | `StateAwards` — `clsAward` |
| `OrderID` | `Public ReadOnly Property OrderID() As Decimal Implements IAward.OrderID` | Returns order i d. | `StateAwards` — `clsAward` |
| `ClosureID` | `Public ReadOnly Property ClosureID() As Decimal Implements IAward.ClosureID` | Returns closure i d. | `StateAwards` — `clsAward` |
| `EffectiveDate` | `Public Property EffectiveDate() As Date Implements IAward.EffectiveDate` | Gets or sets effective date. | `StateAwards` — `clsAward` |
| `NextIssueDate` | `Public Property NextIssueDate() As Date` | Gets or sets next issue date. | `StateAwards` — `clsAward` |
| `IsAutoRecalc` | `Public Property IsAutoRecalc() As Boolean Implements IAward.IsAutoRecalc` | Gets or sets is auto recalc. | `StateAwards` — `clsAward` |
| `TotalPayeeBalance` | `Public ReadOnly Property TotalPayeeBalance() As Decimal` | Returns total payee balance. | `StateAwards` — `clsAward` |
| `TotalPaymentAmount` | `Public ReadOnly Property TotalPaymentAmount() As Decimal` | Returns total payment amount. | `StateAwards` — `clsAward` |
| `TotalPaymentAmountExcludingRecovery` | `Public ReadOnly Property TotalPaymentAmountExcludingRecovery() As Decimal` | Returns total payment amount excluding recovery. | `StateAwards` — `clsAward` |
| `TotalImmediatePaymentAmount` | `Public ReadOnly Property TotalImmediatePaymentAmount() As Decimal` | Returns total immediate payment amount. | `StateAwards` — `clsAward` |
| `TotalImmediatePaymentAmountExcludingRecovery` | `Public ReadOnly Property TotalImmediatePaymentAmountExcludingRecovery() As Decimal` | Returns total immediate payment amount excluding recovery. | `StateAwards` — `clsAward` |
| `TotalMonthlyPaymentAmount` | `Public ReadOnly Property TotalMonthlyPaymentAmount() As Decimal` | Returns total monthly payment amount. | `StateAwards` — `clsAward` |
| `TotalMonthlyPaymentAmountExcludingRecovery` | `Public ReadOnly Property TotalMonthlyPaymentAmountExcludingRecovery() As Decimal` | Returns total monthly payment amount excluding recovery. | `StateAwards` — `clsAward` |
| `TotalMonthlyReductionAmount` | `Public ReadOnly Property TotalMonthlyReductionAmount() As Decimal` | Returns total monthly reduction amount. | `StateAwards` — `clsAward` |
| `TotalImmediateReductionAmount` | `Public ReadOnly Property TotalImmediateReductionAmount() As Decimal` | Returns total immediate reduction amount. | `StateAwards` — `clsAward` |
| `TotalMonthlySupportAmount` | `Public ReadOnly Property TotalMonthlySupportAmount() As Decimal` | Returns total monthly support amount. | `StateAwards` — `clsAward` |
| `TotaltImmediateSupportAmount` | `Public ReadOnly Property TotaltImmediateSupportAmount() As Decimal` | Returns totalt immediate support amount. | `StateAwards` — `clsAward` |
| `TotalImmediateRetroReserveAmount` | `Public ReadOnly Property TotalImmediateRetroReserveAmount() As Decimal` | Returns total immediate retro reserve amount. | `StateAwards` — `clsAward` |
| `TotalMonthlyRetroReserveAmount` | `Public ReadOnly Property TotalMonthlyRetroReserveAmount() As Decimal` | Returns total monthly retro reserve amount. | `StateAwards` — `clsAward` |
| `Claim` | `Public ReadOnly Property Claim() As clsClaimData Implements IAward.Claim` | Returns claim. | `StateAwards` — `clsAward` |
| `CurrentUser` | `Public ReadOnly Property CurrentUser() As clsPaymentUser` | Returns current user. | `StateAwards` — `clsAward` |
| `IsExistingAward` | `Public Property IsExistingAward() As Boolean` | Gets or sets is existing award. | `StateAwards` — `clsAward` |
| `UpdateNumber` | `Public ReadOnly Property UpdateNumber() As Decimal` | Returns update number. | `StateAwards` — `clsAward` |
| `UpdateDate` | `Public ReadOnly Property UpdateDate() As Date` | Returns update date. | `StateAwards` — `clsAward` |
| `UpdateUser` | `Public ReadOnly Property UpdateUser() As String` | Returns update user. | `StateAwards` — `clsAward` |
| `UpdateInfo` | `Public ReadOnly Property UpdateInfo() As clsUpdateInfo` | Returns update info. | `StateAwards` — `clsAward` |
| `GetMonthlyNextIssueDate` | `Public Function GetMonthlyNextIssueDate() As Date` | Retrieves the `GetMonthlyNextIssueDate` operation. | `StateAwards` — `clsAward` |
| `GetDailyNextIssueDate` | `Public Function GetDailyNextIssueDate() As Date` | Retrieves the `GetDailyNextIssueDate` operation. | `StateAwards` — `clsAward` |
| `HasPaymentsInProgress` | `Public ReadOnly Property HasPaymentsInProgress() As Boolean` | Returns has payments in progress. | `StateAwards` — `clsAward` |
| `HasPayments` | `Public ReadOnly Property HasPayments() As Boolean` | Returns has payments. | `StateAwards` — `clsAward` |
| `PaymentReleased` | `Public ReadOnly Property PaymentReleased() As Boolean` | Returns payment released. | `StateAwards` — `clsAward` |
| `GenerateFinancialTransactions` | `Public Function GenerateFinancialTransactions(ByVal inIssueDate As Date) As Boolean Implements IAward.GenerateFinancialTransactions` | Exposes the public member. | `StateAwards` — `clsAward` |
| `IsValid` | `Public Overrides ReadOnly Property IsValid() As Boolean` | Returns is valid. | `StateAwards` — `clsAward` |
| `IsDirty` | `Public Overrides ReadOnly Property IsDirty() As Boolean` | Returns is dirty. | `StateAwards` — `clsAward` |
| `Save` | `Public Shadows Function Save() As Boolean Implements IAward.Save` | Executes the `Save` operation. | `StateAwards` — `clsAward` |
| `SetClosureOrderNull` | `Public Sub SetClosureOrderNull()` | Executes the `SetClosureOrderNull` operation. | `StateAwards` — `clsAward` |
| `SetClosureOrder` | `Public Sub SetClosureOrder(ByVal inClosureID As Decimal, ByVal inOrderID As Decimal)` | Executes the `SetClosureOrder` operation. | `StateAwards` — `clsAward` |
| `IsClosureOrderAssociated` | `Public Function IsClosureOrderAssociated() As Boolean` | Exposes the public member. | `StateAwards` — `clsAward` |
| `SetAwardEffectiveDateNull` | `Public Sub SetAwardEffectiveDateNull()` | Executes the `SetAwardEffectiveDateNull` operation. | `StateAwards` — `clsAward` |
| `SetNextIssueDateNull` | `Public Sub SetNextIssueDateNull()` | Executes the `SetNextIssueDateNull` operation. | `StateAwards` — `clsAward` |
| `IsAwardEffectiveDateNull` | `Public Function IsAwardEffectiveDateNull() As Boolean` | Exposes the public member. | `StateAwards` — `clsAward` |
| `IsNextIssueDateNull` | `Public Function IsNextIssueDateNull() As Boolean` | Exposes the public member. | `StateAwards` — `clsAward` |
| `Equals` | `Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean` | Exposes the public member. | `StateAwards` — `clsAward` |
| `Equals` | `Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean` | Exposes the public member. | `StateAwards` — `clsAward` |
| `Equals` | `Public Overloads Function Equals(ByVal inObject As clsAward) As Boolean` | Exposes the public member. | `StateAwards` — `clsAward` |
| `GetHashCode` | `Public Overrides Function GetHashCode() As Integer` | Retrieves the `GetHashCode` operation. | `StateAwards` — `clsAward` |
| `ToString` | `Public Overrides Function ToString() As String` | Exposes the public member. | `StateAwards` — `clsAward` |
| `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 `clsAward` 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\clsFatalAward.vb`
- `Legacy\BusinessObjectFramework\clsBusinessBase.vb`