---
title: clsFinancialTransactionCode
summary: API reference for clsFinancialTransactionCode.
status: draft
owner: Technical Writer
last_reviewed: 2026-07-31
library: SAIF.Business.Policy.Premium
reference_type: package
---

# clsFinancialTransactionCode

Code-table entity for a financial transaction type code; holds the code, description, and category flags used to classify financial transactions in the billing domain.*

## Purpose
- Provides type code, description, and category data for financial transaction classification.*
- Consumed by financial transaction creation and reporting workflows to resolve transaction codes to structured type information.*

## Context
- Namespace: `SAIF.Business.Policy.Premium.Billing`
- Assembly/package: `SAIF.Business.Policy.Premium`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| Code | `Public ReadOnly Property Code() As String` | The classification or type code for this record.* |
| IsPayrollReport | `Public ReadOnly Property IsPayrollReport As Boolean Implements IFinancialTransactionType.IsPayrollReport` | Indicates whether payroll report applies to this cls Financial Transaction Code.* |
| IsDeposit | `Public ReadOnly Property IsDeposit As Boolean` | Indicates whether deposit applies to this cls Financial Transaction Code.* |
| Description | `Public Property Description() As String` | The human-readable description associated with this record.* |
| ReadOnlyDescription | `Public ReadOnly Property ReadOnlyDescription As String Implements IFinancialTransactionType.Description` | Human-readable description associated with the current read only.* |
| CommissionEligibleFlag | `Public Property CommissionEligibleFlag() As String` | Business value exposed as commission eligible flag for callers of this API.* |
| ManualAddFlag | `Public Property ManualAddFlag() As String` | Business value exposed as manual add flag for callers of this API.* |
| GroupCode | `Public Property GroupCode() As String` | Oracle code value used to classify this business object.* |
| BilledPremiumFlag | `Public Property BilledPremiumFlag() As String` | Numeric billed premium flag value used by this type's rating, billing, or reporting logic.* |
| AllowableSign | `Public Property AllowableSign() As String` | Business value exposed as allowable sign for callers of this API.* |
| ARReportPFTGroupCode | `Public Property ARReportPFTGroupCode() As String` | Oracle code value used to classify this business object.* |
| CancelReasonCode | `Public Property CancelReasonCode() As String` | Oracle code value used to classify this business object.* |
| GLReportPFTGroupCode | `Public Property GLReportPFTGroupCode() As String` | Oracle code value used to classify this business object.* |
| CommSourceExclFlag | `Public Property CommSourceExclFlag() As String` | Business value exposed as comm source excl flag for callers of this API.* |
| AdvancePremiumSearchFlag | `Public Property AdvancePremiumSearchFlag() As String` | Numeric advance premium search flag value used by this type's rating, billing, or reporting logic.* |
| CreditApplyPolicyPeriodFirstFlag | `Public Property CreditApplyPolicyPeriodFirstFlag() As String` | Business value exposed as credit apply policy period first flag for callers of this API.* |
| ReconciliationNetFlag | `Public Property ReconciliationNetFlag() As String` | Business value exposed as reconciliation net flag for callers of this API.* |
| PolicyPeriodCreditAvailableFlag | `Public Property PolicyPeriodCreditAvailableFlag() As String` | Business value exposed as policy period credit available flag for callers of this API.* |
| ARPReportPremiumFlag | `Public Property ARPReportPremiumFlag() As String` | Numeric arp report premium flag value used by this type's rating, billing, or reporting logic.* |
| DepositPolicyPeriodFlag | `Public Property DepositPolicyPeriodFlag() As String` | Business value exposed as deposit policy period flag for callers of this API.* |
| DepositPaidFlag | `Public Property DepositPaidFlag() As String` | Business value exposed as deposit paid flag for callers of this API.* |
| IsAlwaysFullyPaidWhenDebit | `Public Property IsAlwaysFullyPaidWhenDebit() As Boolean` | Indicates whether always fully paid when debit applies in this business object.* |
| ReadOnlyIsAlwaysFullyPaidWhenDebit | `Public ReadOnly Property ReadOnlyIsAlwaysFullyPaidWhenDebit As Boolean Implements IFinancialTransactionType.IsAlwaysFullyPaidWhenDebit` | Business value exposed as read only is always fully paid when debit for callers of this API.* |
| DetailTable | `Public Property DetailTable() As String` | Business value exposed as detail table for callers of this API.* |
| CreditPFTHierarchyNumber | `Public Property CreditPFTHierarchyNumber() As Decimal` | Business value exposed as credit pft hierarchy number for callers of this API.* |
| FeeAmount | `Public Property FeeAmount() As Decimal` | Numeric fee amount value used by this type's rating, billing, or reporting logic.* |
| DebitPFTHierarchyNumber | `Public Property DebitPFTHierarchyNumber() As Decimal` | Business value exposed as debit pft hierarchy number for callers of this API.* |
| WCISReversalFunctionCode | `Public Property WCISReversalFunctionCode() As String` | Oracle code value used to classify this business object.* |
| WCISAddFunctionCode | `Public Property WCISAddFunctionCode() As String` | Oracle code value used to classify this business object.* |
| ManualDistributionCode | `Public Property ManualDistributionCode() As String` | Oracle code value used to classify this business object.* |
| InterestFlag | `Public Property InterestFlag() As String` | Business value exposed as interest flag for callers of this API.* |
| PenaltyPFTHierarchyNumber | `Public Property PenaltyPFTHierarchyNumber() As Decimal` | Business value exposed as penalty pft hierarchy number for callers of this API.* |
| AutoReverseFlag | `Public Property AutoReverseFlag() As String` | Business value exposed as auto reverse flag for callers of this API.* |
| PeriodSummaryGroupCode | `Public Property PeriodSummaryGroupCode() As String` | Oracle code value used to classify this business object.* |
| RetroPFTTypeCode | `Public Property RetroPFTTypeCode() As String` | Oracle code value used to classify this business object.* |
| IsValid | `Public Overrides ReadOnly Property IsValid() As Boolean` | Returns True when all registered business rules pass; delegates to the framework rule engine. |
| IsDirty | `Public Overrides ReadOnly Property IsDirty() As Boolean` | Returns True when one or more tracked properties have been modified since the last save or MarkOld() call. |
| SetDetailTableNull | `Public Sub SetDetailTableNull()` | Clears `DetailTable`, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetCreditPFTHierarchyNumberNull | `Public Sub SetCreditPFTHierarchyNumberNull()` | Clears `CreditPFTHierarchyNumber`, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetFeeAmountNull | `Public Sub SetFeeAmountNull()` | Clears `FeeAmount`, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetDebitPFTHierarchyNumberNull | `Public Sub SetDebitPFTHierarchyNumberNull()` | Clears `DebitPFTHierarchyNumber`, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetWCISReversalFunctionCodeNull | `Public Sub SetWCISReversalFunctionCodeNull()` | Clears `WCISReversalFunctionCode`, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetWCISAddFunctionCodeNull | `Public Sub SetWCISAddFunctionCodeNull()` | Clears `WCISAddFunctionCode`, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetManualDistributionCodeNull | `Public Sub SetManualDistributionCodeNull()` | Clears `ManualDistributionCode`, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetInterestFlagNull | `Public Sub SetInterestFlagNull()` | Clears `InterestFlag`, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetPenaltyPFTHierarchyNumberNull | `Public Sub SetPenaltyPFTHierarchyNumberNull()` | Clears `PenaltyPFTHierarchyNumber`, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetAutoReverseFlagNull | `Public Sub SetAutoReverseFlagNull()` | Clears `AutoReverseFlag`, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetPeriodSummaryGroupCodeNull | `Public Sub SetPeriodSummaryGroupCodeNull()` | Clears `PeriodSummaryGroupCode`, marking it as null/unset so the column will be written as NULL on the next save.* |
| SetRetroPFTTypeCodeNull | `Public Sub SetRetroPFTTypeCodeNull()` | Clears `RetroPFTTypeCode`, marking it as null/unset so the column will be written as NULL on the next save.* |
| IsDetailTableNull | `Public Function IsDetailTableNull() As Boolean` | Tests whether `DetailTable` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsCreditPFTHierarchyNumberNull | `Public Function IsCreditPFTHierarchyNumberNull() As Boolean` | Tests whether `CreditPFTHierarchyNumber` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsFeeAmountNull | `Public Function IsFeeAmountNull() As Boolean` | Tests whether `FeeAmount` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsDebitPFTHierarchyNumberNull | `Public Function IsDebitPFTHierarchyNumberNull() As Boolean` | Tests whether `DebitPFTHierarchyNumber` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsWCISReversalFunctionCodeNull | `Public Function IsWCISReversalFunctionCodeNull() As Boolean` | Tests whether `WCISReversalFunctionCode` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsWCISAddFunctionCodeNull | `Public Function IsWCISAddFunctionCodeNull() As Boolean` | Tests whether `WCISAddFunctionCode` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsManualDistributionCodeNull | `Public Function IsManualDistributionCodeNull() As Boolean` | Tests whether `ManualDistributionCode` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsInterestFlagNull | `Public Function IsInterestFlagNull() As Boolean` | Tests whether `InterestFlag` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsPenaltyPFTHierarchyNumberNull | `Public Function IsPenaltyPFTHierarchyNumberNull() As Boolean` | Tests whether `PenaltyPFTHierarchyNumber` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsAutoReverseFlagNull | `Public Function IsAutoReverseFlagNull() As Boolean` | Tests whether `AutoReverseFlag` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsPeriodSummaryGroupCodeNull | `Public Function IsPeriodSummaryGroupCodeNull() As Boolean` | Tests whether `PeriodSummaryGroupCode` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| IsRetroPFTTypeCodeNull | `Public Function IsRetroPFTTypeCodeNull() As Boolean` | Tests whether `RetroPFTTypeCode` is null/unset in the backing Oracle column; returns True when the value has not been populated.* |
| Equals | `Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean` | Static overload: compares two Object references for equality using value-equality semantics.* |
| Equals | `Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean` | Compares this instance with another `Object` instance for value equality.* |
| Equals | `Public Overloads Function Equals(ByVal inObject As clsFinancialTransactionCode) As Boolean` | Compares this instance with another `clsFinancialTransactionCode` instance for value equality.* |
| GetHashCode | `Public Overrides Function GetHashCode() As Integer` | Returns a hash code consistent with the value-equality implementation. |
| ToString | `Public Overrides Function ToString() As String` | Returns a string representation of this instance, typically for diagnostics.* |
| NewFinancialTransactionCode | `Public Shared Function NewFinancialTransactionCode(ByVal inDataportal As IDataPortalInfo, ByVal inCode As String) As clsFinancialTransactionCode` | Creates a new cls financial transaction code initialized from the supplied source values.* |
| GetFinancialTransactionCode | `Public Shared Function GetFinancialTransactionCode(ByVal inDataportal As IDataPortalInfo, ByVal inCode As String) As clsFinancialTransactionCode` | Loads a cls financial transaction code that matches the supplied lookup criteria. |
## Inherited public members

| Member | Signature | Purpose | Origin |
| --- | --- | --- | --- |
| Rules | `Property Rules As clsRulesManager` | Framework rules manager used to register, evaluate, and surface broken rules on the object.† | `SAIF.Framework.Core — clsBusinessBase` |
| BeginEdit | `Sub BeginEdit()` | Starts an n-level edit session so callers can stage changes.† | `SAIF.Framework.Core — clsBusinessBase` |
| CancelEdit | `Sub CancelEdit()` | Rolls back the active edit session.† | `SAIF.Framework.Core — clsBusinessBase` |
| ApplyEdit | `Sub ApplyEdit()` | Commits the active edit session.† | `SAIF.Framework.Core — clsBusinessBase` |

## Behavioral notes
- Source file: `Business\SAIF.Business.Policy.Premium\Billing\clsFinancialTransactionCode.vb`.

## Constraints and usage notes
- Read-only reference data; codes must match the Oracle financial transaction code reference table.*


> **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.Policy.Premium\Billing\clsFinancialTransactionCode.vb`