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

# clsBillingDetail

Persists individual billing detail line items to the `PREM_HIST_BILLING_DETAIL` Oracle table; each instance records a single billing type code, associated dollar amount, and optional percentage for a premium set. Consumed by billing reporting and premium calculation workflows in the `SAIF.Business.Policy.Premium` namespace.*

## Purpose
- Records a single billing line item (type code, amount, percentage) within a premium set's billing detail for persistence to Oracle.*
- Provides the typed billing detail data consumed by billing summary, invoice, and payment plan workflows in this library.*

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

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| BillingDetailSeqNum | `Public ReadOnly Property BillingDetailSeqNum() As Decimal` | Identifier used to correlate this row with related premium records.* |
| PolicyNumber | `Public ReadOnly Property PolicyNumber() As Decimal` | The numeric policy number identifying the policy to which this record belongs. |
| PolicyPeriodEffectiveDate | `Public ReadOnly Property PolicyPeriodEffectiveDate() As Date` | The effective date of the policy period to which this rating plan applies. |
| BillTypeCode | `Public ReadOnly Property BillTypeCode() As String` | Stores the Oracle code value that classifies this cls Billing Detail. |
| BillingDetailType | `Public ReadOnly Property BillingDetailType As BillingDetailTypes Implements IBillingDetail.BillingDetailType` | Returns the typed lookup object that describes the current billing detail type. |
| CreateDate | `Public ReadOnly Property CreateDate() As Date` | The timestamp at which this record was created in the Oracle database. |
| CreateUser | `Public ReadOnly Property CreateUser() As String` | The username of the account that created this record. |
| BillDate | `Public Property BillDate() As Date` | The date on which this invoice was billed. |
| BillDateReadOnly | `Public ReadOnly Property BillDateReadOnly As Date Implements IBillingDetail.BillDate` | Business value exposed as bill date read only for callers of this API.* |
| BillAmount | `Public Property BillAmount() As Decimal` | Calculates the bill amount used by this cls Billing Detail. |
| BillAmountReadOnly | `Public ReadOnly Property BillAmountReadOnly As Decimal Implements IBillingDetail.BillAmount` | Calculates the bill amount read only used by this cls Billing Detail. |
| CreateByCancellationFlag | `Public Property CreateByCancellationFlag() As String` | Business value exposed as create by cancellation flag for callers of this API.* |
| PolicyTransSeqNum | `Public Property PolicyTransSeqNum() As Decimal` | Identifier used to correlate this row with related premium records.* |
| BilledDate | `Public Property BilledDate() As Date` | Holds the billed date used by this cls Billing Detail. |
| UpdateDate | `Public Property UpdateDate() As Date` | The timestamp of the most recent update to this record.* |
| UpdateUser | `Public Property UpdateUser() As String` | The username of the account that last modified this record.* |
| BillingPercent | `Public Property BillingPercent() As Decimal` | Calculates the billing percent used by this cls Billing Detail. |
| CancellationSeqNum | `Public Property CancellationSeqNum() As Decimal` | Identifier used to correlate this row with related premium records.* |
| PremiumSetID | `Public Property PremiumSetID() As Decimal` | Primary key used to load, compare, and join this premium set with child coverage, adjustment, and billing records. |
| BillingDetailTypeCode | `Public ReadOnly Property BillingDetailTypeCode As clsBillingDetailTypeCode` | Stores the Oracle code value that classifies this cls Billing Detail. |
| BillingDetailTypeDescription | `Public ReadOnly Property BillingDetailTypeDescription As String Implements IBillingDetail.BillingDetailTypeDescription` | Human-readable description associated with the current billing detail type.* |
| BillingDetailMethod | `Public ReadOnly Property BillingDetailMethod As BillingDetailMethods Implements IBillingDetail.BillingDetailMethod` | Business value exposed as billing detail method for callers of this API.* |
| GetBillingDetail | `Public Shared Function GetBillingDetail(ByVal inDataportal As IDataPortalInfo, inBillingDetailSeqNum As Decimal) As clsBillingDetail` | Loads a cls billing detail 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\clsBillingDetail.vb`.

## Constraints and usage notes
- Billing detail line items are tied to a specific premium set; the type code must be a valid `BillingDetailTypes` enum value. Null-capable fields require explicit null-check or null-set calls before update.*


> **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\clsBillingDetail.vb`