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

# clsOffsetWageCalculation

`clsOffsetWageCalculation` represents a offset wage calculation and exposes offset wage calculation ID, benefit payment IDs, and is bjo for time-loss payment processing.*

## Purpose
- Captures offset wage calculation ID, benefit payment IDs, and is bjo for time-loss payment processing.*
- Provides retrieval or loading behavior related to that workflow.*

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

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `OffsetWageCalculationID` | `Public ReadOnly Property OffsetWageCalculationID() As Decimal` | Returns offset wage calculation i d. |
| `BenefitPaymentID` | `Public ReadOnly Property BenefitPaymentID() As Decimal` | Returns benefit payment i d. |
| `IsBJO` | `Public Property IsBJO() As Boolean` | Gets or sets is b j o. |
| `HourlyRate` | `Public Property HourlyRate() As Decimal` | Gets or sets hourly rate. |
| `OvertimeRate` | `Public Property OvertimeRate() As Decimal` | Gets or sets overtime rate. |
| `HasVerifiedWages` | `Public Property HasVerifiedWages() As Boolean` | Gets or sets has verified wages. |
| `Comments` | `Public Property Comments() As String` | Gets or sets comments. |
| `WagePeriods` | `Public ReadOnly Property WagePeriods() As clsOffsetWageCalcPeriods` | Returns wage periods. |
| `TotalOffsetWages` | `Public ReadOnly Property TotalOffsetWages() As Decimal` | Returns total offset wages. |
| `PeriodEarnings` | `Public ReadOnly Property PeriodEarnings(ByVal inPeriod As clsBenefitPeriod) As Decimal` | Returns period earnings. |
| `PeriodEarnings` | `Public ReadOnly Property PeriodEarnings(ByVal inFromDate As Date, ByVal inThruDate As Date) As Decimal` | Returns period earnings. |
| `UpdateInfo` | `Public ReadOnly Property UpdateInfo() As clsUpdateInfo` | Returns update info. |
| `GetOffsetWageCalculation` | `Public Shared Function GetOffsetWageCalculation(ByVal inDPI As IDataPortalInfo, ByVal inBenefitPaymentID As Decimal _` | Retrieves the `GetOffsetWageCalculation` operation. |
| `SetOffsetWageCalcPeriods` | `Public Sub SetOffsetWageCalcPeriods(ByVal inWageType As WageTypes, ByVal inPeriods As clsBenefitPeriodCollection, Optional ByVal inPreserveData As Boolean = False)` | Executes the `SetOffsetWageCalcPeriods` operation. |
| `CalculateWagePeriodEarnings` | `Public Sub CalculateWagePeriodEarnings()` | Exposes the public member. |
| `IsDirty` | `Public Overrides ReadOnly Property IsDirty() As Boolean` | Returns is dirty. |
| `IsValid` | `Public Overrides ReadOnly Property IsValid() As Boolean` | Returns is valid. |
| `WageType` | `Public Property WageType() As WageTypes` | Gets or sets wage type. |
| `WageTypeMap` | `Public ReadOnly Property WageTypeMap() As clsWageTypeMap` | Returns wage type map. |
| `GetWageTypeMap` | `Public Shared Function GetWageTypeMap(ByVal inDPI As IDataPortalInfo, Optional ByVal RefreshWageTypes As Boolean = False) As clsWageTypeMap` | Retrieves the `GetWageTypeMap` 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\Payments\TimelossPayments\clsOffsetWageCalculation.vb`
- `Legacy\BusinessObjectFramework\clsBusinessBase.vb`