---

title: clsAwardBenefitPayment
summary: API reference for clsAwardBenefitPayment.
status: draft
owner: Technical Writer
last_reviewed: 2026-07-28
library: SAIF.Business.Claim
reference_type: package
---



# clsAwardBenefitPayment



clsAwardBenefitPayment supports business object — award benefit payment in `SAIF.Business.Claim`.*



## Purpose

- Business object — award benefit payment



## Context

- Namespace: `SAIF.Business.Claim`
- Assembly/package: `SAIF.Business.Claim`



## Public members

| Member | Signature | Purpose |
| --- | --- | --- |
| BenefitPaymentSeqNum | `ReadOnly Property BenefitPaymentSeqNum() As Decimal` | Exposes the BenefitPaymentSeqNum value on the type.* |
| BenefitTypeCode | `ReadOnly Property BenefitTypeCode() As String` | Exposes the BenefitTypeCode value on the type.* |
| ClaimID | `ReadOnly Property ClaimID() As Decimal` | Exposes the ClaimID value on the type.* |
| InitiatorUser | `ReadOnly Property InitiatorUser() As String` | Exposes the InitiatorUser value on the type.* |
| RevolvingFundFlag | `ReadOnly Property RevolvingFundFlag() As String` | Exposes the RevolvingFundFlag value on the type.* |
| SettlementTotalAmt | `ReadOnly Property SettlementTotalAmt() As Decimal` | Exposes the SettlementTotalAmt value on the type.* |
| UpdateDate | `ReadOnly Property UpdateDate() As Date` | Exposes the UpdateDate value on the type.* |
| UpdateNum | `ReadOnly Property UpdateNum() As Decimal` | Exposes the UpdateNum value on the type.* |
| UpdateUser | `ReadOnly Property UpdateUser() As String` | Exposes the UpdateUser value on the type.* |
| BenefitStatusCode | `Property BenefitStatusCode() As String` | Exposes the BenefitStatusCode value on the type.* |
| ApproverUser | `Property ApproverUser() As String` | Exposes the ApproverUser value on the type.* |
| IssueDate | `ReadOnly Property IssueDate() As Date` | Exposes the IssueDate value on the type.* |
| AwardNum | `ReadOnly Property AwardNum() As Decimal` | Exposes the AwardNum value on the type.* |
| IsValid | `Overrides ReadOnly Property IsValid() As Boolean` | Exposes the IsValid value on the type.* |
| IsDirty | `Overrides ReadOnly Property IsDirty() As Boolean` | Exposes the IsDirty value on the type.* |
| Save | `Overrides Function Save() As Boolean` | Executes the Save operation and returns the requested result.* |
| SetApproverUserNull | `Sub SetApproverUserNull()` | Performs the SetApproverUserNull operation for the current instance.* |
| SetIssueDateNull | `Sub SetIssueDateNull()` | Performs the SetIssueDateNull operation for the current instance.* |
| SetAwardNumNull | `Sub SetAwardNumNull()` | Performs the SetAwardNumNull operation for the current instance.* |
| IsApproverUserNull | `Function IsApproverUserNull() As Boolean` | Executes the IsApproverUserNull operation and returns the requested result.* |
| IsIssueDateNull | `Function IsIssueDateNull() As Boolean` | Executes the IsIssueDateNull operation and returns the requested result.* |
| IsAwardNumNull | `Function IsAwardNumNull() As Boolean` | Executes the IsAwardNumNull operation and returns the requested result.* |
| Equals | `Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean` | Executes the Equals operation and returns the requested result.* |
| Equals | `Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean` | Executes the Equals operation and returns the requested result.* |
| Equals | `Overloads Function Equals(ByVal inObject As clsAwardBenefitPayment) As Boolean` | Executes the Equals operation and returns the requested result.* |
| GetHashCode | `Overrides Function GetHashCode() As Integer` | Executes the GetHashCode operation and returns the requested result.* |
| ToString | `Overrides Function ToString() As String` | Executes the ToString operation and returns the requested result.* |
| NewAwardBenefitPayment | `Shared Function NewAwardBenefitPayment(ByVal inDataportal As IDataPortalInfo, ByVal inAwardNum As Decimal) As clsAwardBenefitPayment` | Executes the NewAwardBenefitPayment operation and returns the requested result.* |
| GetAwardBenefitPayment | `Shared Function GetAwardBenefitPayment(ByVal inDataportal As IDataPortalInfo, ByVal inAwardNum As Decimal) As clsAwardBenefitPayment` | Executes the GetAwardBenefitPayment operation and returns the requested result.* |
| GetAwardBenefitPaymentBySeq | `Shared Function GetAwardBenefitPaymentBySeq(ByVal inDataportal As IDataPortalInfo, ByVal inClaimID As Decimal, ByVal inSeqNum As Decimal) As clsAwardBenefitPayment` | Executes the GetAwardBenefitPaymentBySeq operation and returns the requested result.* |
| AwardNum | `Property AwardNum() As Decimal` | Exposes the AwardNum value on the type.* |
| ClaimID | `Property ClaimID() As Decimal` | Exposes the ClaimID value on the type.* |
| SeqNum | `Property SeqNum() As Decimal` | Exposes the SeqNum value on the type.* |
| New | `Sub New(ByVal inDataPortalInfo As IDataPortalInfo)` | Initializes the type instance.* |
| New | `Sub New(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inAwardNum As Decimal)` | Initializes the type instance.* |
| New | `Sub New(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inClaimId As Decimal, ByVal inSeqNum As Decimal)` | Initializes the type instance.* |



## Inherited public members
Members in this section are inherited from `clsBusinessBase`.
| Member | Signature | Purpose | Origin |
| --- | --- | --- | --- |
| Rules | `Property Rules As clsRulesManager` | Exposes the BOF rules manager used to evaluate object validation rules.* | `saif-framework-core — clsBusinessBase` |
| BeginEdit | `Sub BeginEdit()` | Starts an edit session for n-level undo support.* | `saif-framework-core — clsBusinessBase` |
| CancelEdit | `Sub CancelEdit()` | Cancels the active edit session and reverts pending changes.* | `saif-framework-core — clsBusinessBase` |
| ApplyEdit | `Sub ApplyEdit()` | Commits the active edit session and accepts pending changes.* | `saif-framework-core — clsBusinessBase` |
## Behavioral notes

- `clsAwardBenefitPayment` is part of the documented `SAIF.Business.Claim` public contract.
- Public members are declared in `Business\SAIF.Business.Claim\clsAwardBenefitPayment.vb`.



## Constraints and usage notes

- Consumers should account for inherited BOF or dependency behavior shown above.

> **Note:** Statements marked with * were inferred from code structure, naming conventions, or
> contextual evidence where direct confirmation was not available in source artifacts. Statements
> marked with ** could not be confirmed; treat as unknown until verified.

## Sources

- `Business\SAIF.Business.Claim\clsAwardBenefitPayment.vb`