Bill Segment
Overview
A bill segment in ORMB is a section of a bill that contains the calculated charges for a specific service agreement and billing period. It is created when the system processes usage, fees, or adjustments during billing. Each bill segment shows the detailed breakdown of amounts, such as recurring charges, usage-based charges, or manual adjustments, and it contributes to the total of the parent bill. It provides the link between service agreements and the bill.
The Bill Segment subject area stores attributes such as service agreement ID, billing period dates, segment status, and amounts. It also maintains links to Bill Charges, which contain the individual rated charges included in the segment.
Conforming Layers
The conforming layers of this subject area are the following:
BSEG_OBJ
| Column | Column Description | Data Type | Data Length |
| BSEG_ID | Bill Segment ID is an identifier that links a specific exception record to a billing segment within the system. | VARCHAR | 12 |
| BILL_ID | Unique identifier for the billing document or billing transaction associated with the billing segment. | VARCHAR | 4 |
| SA_ID | Identifier for the service agreement associated with the billing segment. | VARCHAR | 10 |
| CAN_RSN_CD | Cancellation Reason Code is used to indicate the specific reason why a billing segment or was canceled. | VARCHAR | 4 |
| BSEG_START_DT | Start date of the billing period of the billing segment. | TIMESTAMP | |
| BSEG_END_DT | End date of the billing period of the billing segment. | TIMESTAMP | |
| BSEG_CRE_DTTM | Date and time when the billing segment record was created in the system. | TIMESTAMP | |
| BSEG_STAT_FLG | Flag used to represent the status of a billing segment. | VARCHAR | 2 |
| EST_SW | Switch indicating whether the bill segment is estimated rather than based on actual meter reads or actual usage. | VARCHAR | 1 |
| CLOSING_BSEG_SW | Switch indicating whether the billing segment is a closing segment. A closing segment refers to a segment that marks the end of a particular billing cycle or billing process. | VARCHAR | 1 |
| CURRENCY_CD | ISO code for the currency used for the bill segment. | VARCHAR | 3 |
| CALC_AMT | Calculated amount for the bill segment. | DECIMAL | (15,2) |
| MESSAGE_CAT_NBR | Identifier for the message category describing the type of message associated with the record. | DECIMAL | (5,0) |
| MESSAGE_NBR | Identifier corresponding to a specific message associated with the record. | DECIMAL | (5,0) |
| BSEG_EXCP_FLG | Flag indicating whether an exception exists or not for a specific bill segment in the billing process. | VARCHAR | 2 |
| EXP_MSG | Exception message providing additional information or details about the exception that has been triggered for a specific bill segment. | VARCHAR | 254 |
| EXCP_USER_ID | Identifierr of the user who performed a particular action or operation on the bill segment. | VARCHAR | 8 |
| EXCP_CRE_DTTM | Date and time when the segment was created in the system. | TIMESTAMP | |
| REVIEW_COMP | Flag indicating whether the review process of the bill segment has been completed. | VARCHAR | 1 |
| REVIEW_USER_ID | Identifier for the user who performed the review of the bill segment. | VARCHAR | 8 |
| REVIEW_DT | Date when the review of the bill segment was reviewed. | TIMESTAMP | |
| CDC_LOAD_DTTM | Date and time when the record was loaded into the system through the Change Data Capture (CDC) process. | TIMESTAMP | |
| CDC_FLAG | Type of data change captured in the record during the Change Data Capture (CDC) process. | VARCHAR | 1 |
| CREATE_DTTM | Date and time when the record was created in the system. | TIMESTAMP | |
| UPDATE_DTTM | Date and time when the record was last updated. | TIMESTAMP | |
| COMPOSITE_KEY | Unique identifier in the BSEG_ID format. This is the primary key. |
VARCHAR | 12 |
| MESSAGE_PARM1 MESSAGE_PARM2 MESSAGE_PARM3 MESSAGE_PARM4 MESSAGE_PARM5 MESSAGE_PARM6 MESSAGE_PARM7 MESSAGE_PARM8 MESSAGE_PARM9 |
Additional parameters associated with an exception message. | VARCHAR | 2000 |
| SQ1_CD SQ2_CD SQ3_CD SQ4_CD SQ5_CD SQ6_CD SQ7_CD SQ8_CD SQ9_CD SQ10_CD SQ11_CD SQ12_CD SQ13_CD SQ14_CD SQ15_CD |
Placeholders for additional attributes. | VARCHAR | 254 |
| SQ1_VAL SQ2_VAL SQ3_VAL SQ4_VAL SQ5_VAL SQ6_VAL SQ7_VAL SQ8_VAL SQ9_VAL SQ10_VAL SQ11_VAL SQ12_VAL SQ13_VAL SQ14_VAL SQ15_VAL |
Placeholders for the value of the additional parameters. | DECIMAL | (38,6) |
BSEG_CALC_LN_OBJ
| Column | Column Description | Data Type | Data Length |
| BSEG_ID | Unique identifier for the billing segment. | VARCHAR | 12 |
| HEADER_SEQ | Sequence number associated with a specific header record within the bill segment calculation line. | DECIMAL | (3,0) |
| SEQNO | Sequence number that uniquely identifies a specific line within a bill segment calculation. | DECIMAL | (5,0) |
| DST_ID | Identifier for the destination where the service or resource was consumed, or where the charge applies. | VARCHAR | 10 |
| UOM_CD | Code of the Unit of Measure (UOM) used in the billable charge. | VARCHAR | 4 |
| TOU_CD | Code of the Time of Use (TOU) used to identify the time-of-use pricing structure or rate associated with a billable charge. | VARCHAR | 8 |
| SQI_CD | Service Quality Indicator used to identify the quality level or status of the billable charge related to a service or product. | VARCHAR | 8 |
| BILL_SQ | Sequence number for billing items within a specific billing segment. | DECIMAL | (18,6) |
| RATE | Unit cost applied to a bill segment or charge to calculate the final amount due | DECIMAL | (38,19) |
| CURRENCY_CD | ISO code for the currency used for the bill segment. | VARCHAR | 3 |
| CALC_AMT | Calculated amount for the bill segment. | DECIMAL | (15,2) |
| RC_SEQ | Sequence or identifier used to link a specific calculation line to a corresponding reference code or reconciliation process. | DECIMAL | (4,0) |
| AUDIT_CALC_AMT | Calculated amount of a billing line item or segment, specifically for audit purposes. | DECIMAL | (18,5) |
| CDC_LOAD_DTTM | Date and time when the record was loaded into the system through the Change Data Capture (CDC) process. | TIMESTAMP | |
| CDC_FLAG | Type of data change captured in the record during the Change Data Capture (CDC) process. | VARCHAR | 1 |
| CREATE_DTTM | Date and time when the record was created in the system. | TIMESTAMP | |
| UPDATE_DTTM | Date and time when the record was last updated. | TIMESTAMP | |
| COMPOSITE_KEY | Unique identifier in the BSEG_ID || HEADER_SEQ || SEQNO format. This is the primary key. |
VARCHAR | 20 |
| CDF1_CD CDF2_CD CDF3_CD CDF4_CD CDF5_CD CDF6_CD CDF7_CD CDF8_CD CDF9_CD CDF10_CD CDF11_CD CDF12_CD CDF13_CD CDF14_CD CDF15_CD |
Placeholders for future implementation of ORMB characteristics. | VARCHAR | 254 |
| CDF1_VAL CDF2_VAL CDF3_VAL CDF4_VAL CDF5_VAL CDF6_VAL CDF7_VAL CDF8_VAL CDF9_VAL CDF10_VAL CDF11_VAL CDF12_VAL CDF13_VAL CDF14_VAL CDF15_VAL |
Placeholders for values of future implementation of ORMB characteristics. | VARCHAR | 254 |
BSEG_ITEM_OBJ
| Column | Column Description | Data Type | Data Length |
| BSEG_ID | Unique identifier for the billing segment. | VARCHAR | 12 |
| SEQNO | Sequence number or line number that uniquely identifies a specific line within a bill segment calculation. | DECIMAL | (5,0) |
| ITEM_TYPE_CD | Code defining the type of item or service being billed in a billing segment. | VARCHAR | 8 |
| ITEM_ID | Unique identifier for a particular item within a billing segment. | VARCHAR | 10 |
| START_DT | Start date of the billable charge . | TIMESTAMP | |
| END_DT | End date of the billable charge. | TIMESTAMP | |
| ITEM_CNT | Count of entities, such as distinct products, services, chargeable units, or line items that are part of the billing calculation for the segment. | DECIMAL | (11,2) |
| UOM_CD | Code of the Unit of Measure (UOM) used in the billable charge. | VARCHAR | 4 |
| SVC_QTY | Quantity of the service being billed to a customer. | DECIMAL | (18,6) |
| CDC_LOAD_DTTM | Date and time when the record was loaded into the system through the Change Data Capture (CDC) process. | TIMESTAMP | |
| CDC_FLAG | Type of data change captured in the record during the Change Data Capture (CDC) process. | VARCHAR | 1 |
| CREATE_DTTM | Date and time when the record was created in the system. | TIMESTAMP | |
| UPDATE_DTTM | Date and time when the record was last updated. | TIMESTAMP | |
| COMPOSITE_KEY | Unique identifier in the BSEG_ID||SEQNO format. This is the primary key. |
VARCHAR | 15 |
BSEG_MSG_OBJ
| Column | Column Description | Data Type | Data Length |
| BSEG_ID | Unique identifier for the billing segment. | VARCHAR | 12 |
| BILL_MSG_CD | Code of Billing Message used to associate a billing segment or line item with a specific message code that will be displayed on the customer’s bill . | VARCHAR | 4 |
| CDC_LOAD_DTTM | Date and time when the record was loaded into the system through the Change Data Capture (CDC) process. | TIMESTAMP | |
| CDC_FLAG | Type of data change captured in the record during the Change Data Capture (CDC) process. | VARCHAR | 1 |
| CREATE_DTTM | Date and time when the record was created in the system. | TIMESTAMP | |
| UPDATE_DTTM | Date and time when the record was last updated. | TIMESTAMP | |
| COMPOSITE_KEY | Unique identifier in the BSEG_ID||BILL_MSG_CD format. This is the primary key. |
VARCHAR | 22 |
BSEG_READ_OBJ
| Column | Column Description | Data Type | Data Length |
| BSEG_ID | Unique identifier for the billing segment. | VARCHAR | 12 |
| SP_ID | Identifier used to associate a billing segment with a specific service provider in the system. | VARCHAR | 10 |
| REG_CONST | Regulatory constant or regulatory identifier specifying regulatory requirements or constraints that applies to the billing segment. | DECIMAL | (12,6) |
| SEQNO | Sequence number indicating the order of processing within the billing segment. | DECIMAL | (5,0) |
| USAGE_FLG | Indicator whether the billing segment is associated with usage-based billing. | VARCHAR | 2 |
| USE_PCT | Particular charge or amount should be applied to the billing segment. | DECIMAL | (3,0) |
| HOW_TO_USE_FLG | Flag indicating how a billing segment should be processed or used within the broader billing system. | VARCHAR | 2 |
| MSR_PEAK_QTY_SW | Switch indicating whether the billing segment is related to or affected by a peak quantity. | VARCHAR | 1 |
| UOM_CD | Code of the Unit of Measure (UOM) used in the billing segment. | VARCHAR | 4 |
| TOU_CD | Code of the Time of Use (TOU) used to identify the time-of-use pricing structure or rate associated with a billing segment. | VARCHAR | 8 |
| START_REG_READ_ID | Start register read identifier associated with a particular billing segment. This identifier tracks consumption using meters or registers. | VARCHAR | 12 |
| START_READ_DTTM | Start date and time of the meter or register reading of the billing segment. | TIMESTAMP | |
| START_REG_READING | Initial register or meter reading of the billing segment. | DECIMAL | (15,6) |
| END_REG_READ_ID | End register or meter reading of the billing segment. | VARCHAR | 12 |
| END_READ_DTTM | End date and time of the meter or register reading of the billing segment. | TIMESTAMP | |
| END_REG_READING | Final register or meter reading of the billing segment. | DECIMAL | (15,6) |
| MSR_QTY | Quantity of a service or resource that is being tracked and billed. | DECIMAL | (18,6) |
| FINAL_UOM_CD | Final Unit of Measure (UOM) that the charge is billed in. | VARCHAR | 4 |
| FINAL_TOU_CD | Final Time-of-Use (TOU) of the billing segment. | VARCHAR | 8 |
| FINAL_REG_QTY | Final registered quantity of a billing segment. | DECIMAL | (18,6) |
| SQI_CD | Service Quality Indicator used to identify the quality level or status of the billing segment. | VARCHAR | 8 |
| FINAL_SQI_CD | Final Service Quantity Indicator (SQI) of the billing segment. | VARCHAR | 8 |
| CDC_LOAD_DTTM | Date and time when the record was loaded into the system through the Change Data Capture (CDC) process. | TIMESTAMP | |
| CDC_FLAG | Type of data change captured in the record during the Change Data Capture (CDC) process. | VARCHAR | 1 |
| CREATE_DTTM | Date and time when the record was created in the system. | TIMESTAMP | |
| UPDATE_DTTM | Date and time when the record was last updated. | TIMESTAMP | |
| COMPOSITE_KEY | Unique identifier in the BSEG_ID||SP_ID||SEQNO format. This is the primary key. |
VARCHAR | 27 |