Bill Information
Global Extract Information Record (0010)
This is a "header" record that contains information about the extract run as a whole.
Note:
Please be aware that if you do not sort your extract file by CIS Sort Key after it is produced, this record will physically be the last record on the extract file.
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
BATCH_CD |
A8 |
Batch Control Code of the extract process. |
|
BATCH_NBR |
N10 |
Batch Number of the extract process |
|
BATCH_RERUN_NBR |
N10 |
Batch Rerun number of the extract process. |
|
BILL_CNT |
N10 |
Count of bills on this extract. Multiple copies of a bill are counted multiple as well. |
|
EXTRACT_DTTM |
A26 |
System time of extraction. Also updated in bill routing table. |
|
BILL_ID_START |
A12 |
This is only used when a bill is produced as a result of an online request (from Bill - Main). It contains the Bill Id to extract. |
|
BILL_ID_END |
A12 |
This is only used when a bill is produced as a result of an online request (from Bill - Main). It contains the Bill Id to extract. |
|
THREAD_NBR |
N10 |
This field is only used if bills are extracted in batch. It contains the thread number in which the bill was extracted. |
|
THREAD_CNT |
N10 |
This field is only used if bills are extracted in batch. It contains the total number of threads that were extracted. |
Bill Record (0100)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
BILL_ID |
A12 |
CI_BILL |
|
ACCT_ID |
A10 |
CI_BILL |
|
BILL_DT |
D (A10) |
CI_BILL |
|
DUE_DT |
D (A10) |
CI_BILL |
|
COPY_NBR |
N2 |
|
|
NBR_BILL_COPIES |
N2 |
CI_BILL_RTG |
|
BILL_PRT_INTERCEPT |
A8 |
CI_BILL_RTG |
|
BILL_FORMAT_FLG |
A2 |
CI_BILL_RTG |
|
REPRINT_SW |
A1 |
CI_BILL_RTG |
|
CASH_ONLY_SW |
A1 |
|
|
CUR_BAL |
S13.2 |
CI_BILL_SA |
|
CUR_CHG_AMT |
S13.2 |
CI_FT |
|
CUR_CORR_AMT |
S13.2 |
CI_FT |
|
CUR_ADJ_AMT |
S13.2 |
CI_FT |
|
CUR_PAY_AMT |
S13.2 |
CI_FT |
|
CUR_PREV_BAL |
S13.2 |
CI_FT |
|
TOT_BAL |
S13.2 |
CI_BILL_SA |
|
TOT_CHG_AMT |
S13.2 |
CI_FT |
|
TOT_CORR_AMT |
S13.2 |
CI_FT |
|
TOT_ADJ_AMT |
S13.2 |
CI_FT |
|
TOT_PAY_AMT |
S13.2 |
CI_FT |
|
TOT_PREV_BAL |
S13.2 |
Computed during extract. |
|
CURRENCY_CD |
A3 |
CI_BILL_SA |
|
DELINQUENT_AMT |
S13.2 |
Computed during extract. |
|
CUST_PO_ID |
A20 |
CI_BILL_RTG |
|
ACCT_ENTITY_NAME |
A254 |
CI_PER_NAME. Account Entity Name. Might include prefix/suffix from Account/Person if available. |
|
ENTITY_NAME |
A254 |
CI_BILL_RTG. Mailing Entity Name. |
|
ADDRESS_SBR |
A1241 |
CI_BILL_RTG. Refer to its components in a later section. |
|
FINAL_BILL_SW |
A1 |
Computed during extract. Contains a value of Y if this bill is considered to be a "final" bill. |
|
SCHED_EXTRACT_DT |
D (A10) |
CI_APAY_CLR_STG. This is the date that the automatic payment will be downloaded. |
|
ENTITY_NAME1 |
A254 |
CI_BILL_RTG. Mailing Entity Name1. |
|
ENTITY_NAME2 |
A254 |
CI_BILL_RTG. Mailing Entity Name2. |
|
ENTITY_NAME3 |
A254 |
CI_BILL_RTG. Mailing Entity Name3. |
|
ACCT-CUR-SYMBOL |
A4 |
Currency symbol for the account's currency code. |
Account Balance Record (0150)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
SPECIAL-ROLE-CD |
A2 |
SA Type Special Role flag |
|
SPECIAL-ROLE –DESCR |
A30 |
Special Role description |
|
CUR-AMT |
S13.2 |
Derived from CI_FT (Include ALL non-canceled/non-closed SAs for the account/debt class, even those that do not have current charges) |
|
TOT- AMT |
S13.2 |
Derived from CI_FT (Include ALL non-canceled/non-closed SAs for the account/debt class, even those that do not have current charges) |
Current Charge Record (0300)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
DEBT-CLASS-CD |
A4 |
Debt Class of SA Type |
|
DEBT-CLASS-DESCR |
A30 |
Debt Class Description |
|
CUR-CHARGE-AMT |
S13.2 |
Derived from CI_FT (Only the current charge bill segments.) |
|
TOT-CHARGE-AMT |
S13.2 |
Derived from CI_FT (Only the current charge bill segments.) |
Payment Record (0600)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
FT TYPE |
A2 |
Pay or Pay Cancel ('PS' or 'PX') |
|
PAY-DT |
D (A10) |
Derived from CI_FT |
|
CAN_RSN_CD |
A4 |
Derived from CI_PAY, Only for cancellation |
|
CAN-RSN-DESCR |
A30 |
Derived from CI_PAY_CAN_RSN |
|
CUR-PAY-AMT |
S13.2 |
Derived from CI_FT. |
|
TOT-PAY-AMT |
S13.2 |
Derived from CI_FT. |
Premise Record (0900)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
NON_PREM_SW |
A1 |
Y/N switch to indicate (Y) special (non-premise) premise record. This is for non-premise service agreements such as charity or payment arrangement. |
|
PREM_ID |
A10 |
From CI_SA or CI_BSEG |
|
ADDRESS_SBR |
A1241 |
Service Address (Address of Char Premise) from CI_PREM. Refer to its components in a later section. |
Service Agreement Record (1100)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
SA_ID |
A10 |
CI_SA |
|
OLD_ACCT_ID |
A36 |
CI_SA |
|
CUST_READ_FLG |
A2 |
CI_SA |
|
SIC_CD |
A4 |
CI_SA |
|
SIC_DESCR |
A30 |
CI_SIC |
|
BUSINESS_UNIT |
A10 |
CI_SA |
|
SA_TYPE_CD |
A8 |
CI_SA |
|
SA_TYPE_DESCR |
A30 |
CI_SA_TYPE |
|
SA_TYPE_DFLT_DESCR |
A80 |
CI_SA_TYPE |
|
SVC_TYPE_CD |
A30 |
CI_SA_TYPE |
|
SVC_TYPE_DESCR |
A30 |
CI_SVC_TYPE |
|
REV_CL_CD |
A8 |
CI_SA_TYPE |
|
CHAR_PREM_ID |
A10 |
CI_SA |
|
SA_REL_ID |
A10 |
CI_SA_REL |
|
SA_REL_TYPE_CD |
A8 |
CI_SA_REL |
|
SA_REL_TYPE_DESCR |
A30 |
CI_SA_REL_TYPE |
|
SPR_CD |
A12 |
CI_SA_REL |
|
SPR_DESCR |
A50 |
CI_SPR |
|
SPR_ENTITY_NAME |
A254 |
CI_PER_NAME (this is the service provider's person's name) |
Bill Segment Record (1300)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
START_DT |
D (A10) |
CI_BSEG |
|
END_DT |
D (A10) |
CI_BSEG |
|
CLOSING_BSEG_SW |
A1 |
CI_BSEG |
|
EST_SW |
A1 |
CI_BSEG |
|
BILL_CYC_CD |
A4 |
CI_BSEG |
|
SQ_OVERRIDE_SW |
A1 |
CI_BSEG |
|
ITEM_OVERRIDE_SW |
A1 |
CI_BSEG |
|
BSEG_STAT_FLG |
A2 |
CI_BSEG |
|
CAN_RSN_CD |
A4 |
CI_BSEG |
|
CAN_RSN_DESCR |
A30 |
CI_BILL_CAN_RSN |
|
CUR_AMT |
S13.2 |
CI_FT |
|
TOT_AMT |
S13.2 |
CI_FT |
Bill Calc Header Record (1500)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
START_DT |
D (A10) |
CI_BSEG_CALC |
|
END_DT |
D (A10) |
CI_BSEG_CALC |
|
SETID |
A10 |
CI_BSEG_CALC |
|
RS_CD |
A8 |
CI_BSEG_CALC |
|
CALC_AMT |
S13.2 |
CI_BSEG_CALC |
|
DESCR_ON_BILL |
A254 |
CI_BSEG_CALC |
Bill Calc line Record (1700)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
APP_IN_SUMM_SW |
A1 |
CI_BSEG_CALC_LN |
|
CALC_AMT |
S13.2 |
CI_BSEG_CALC_LN |
|
EXEMPT_AMT |
S13.2 |
CI_BSEG_CALC_LN |
|
UOM_CD |
A30 |
CI_BSEG_CALC_LN |
|
TOU_CD |
A30 |
CI_BSEG_CALC_LN |
|
SQI_CD |
A30 |
CI_BSEG_CALC_LN |
|
BILL_SQ |
S12.6 |
CI_BSEG_CALC_LN |
|
DESCR_ON_BILL |
A254 |
CI_BSEG_CALC_LN |
End Bill Calc Header Record (1900)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
Dummy field |
Bill Segment Read Record (2100)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
SP_ID |
A10 |
CI_BSEG_READ |
|
BADGE_NBR |
A16 |
D1_DVC_IDENTIFIER |
|
UOM_CD |
A30 |
CI_BSEG_READ |
|
TOU_CD |
A30 |
CI_BSEG_READ |
|
RDG_DEC_POS |
N1 |
CI_REG. Decimal positions of the reads. |
|
START_REG_READING |
S9.6 |
CI_BSEG_READ |
|
START_READ_DTTM |
T (A26) |
CI_BSEG_READ |
|
START_ESTIMATE_SW |
A1 |
CI_REG_READ |
|
END_REG_READING |
S9.6 |
CI_BSEG_READ |
|
END_READ_DTTM |
T (A26) |
CI_BSEG_READ |
|
END_ESTIMATE_SW |
A1 |
CI_REG_READ |
|
MSR_QTY |
S12.6 |
CI_BSEG_READ |
|
USAGE_FLG |
A2 |
CI_BSEG_READ |
|
USE_PCT |
N3 |
CI_BSEG_READ |
|
HOW_TO_USE_FLG |
A2 |
CI_BSEG_READ |
|
CONSUM_SUB_FLG |
A2 |
CI_REG |
|
MSR_PEAK_QTY_SW |
A1 |
CI_BSEG_READ |
|
REGISTER_CONST |
S6.6 |
CI_BSEG_READ |
|
QTY_DEC_POS |
N1 |
CI_UOM. Decimal positions of the final quantity. |
|
FINAL_UOM |
A4 |
CI_BSEG_READ |
|
FINAL_TOU |
A8 |
CI_BSEG_READ |
|
FINAL_REG_QTY |
S12.6 |
CI_BSEG_READ |
|
SQI_CD |
A30 |
CI_BSEG_READ |
|
FINAL_SQI_CD |
A8 |
CI_BSEG_READ |
Bill Segment SQ Record (2400)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
UOM_CD |
A30 |
CI_BSEG_SQ |
|
TOU_CD |
A30 |
CI_BSEG_SQ |
|
SQI_CD |
A30 |
CI_BSEG_SQ |
|
SQ_DEC_POS |
N1 |
CI_BSEG_SQ |
|
BILL_SQ |
S12.6 |
CI_BSEG_SQ |
Bill Segment Item Record (2700)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
START_DT |
D (A10) |
CI_BSEG_ITEM |
|
END_DT |
D (A10) |
CI_BSEG_ITEM |
|
ITEM_CNT |
S9.2 |
CI_BSEG_ITEM |
|
ITEM_DESCR |
A60 |
CI_ITEM_TYPE |
Bill Segment Message Record (2840)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
BILL_MSG_CD |
A4 |
CI_BSEG_MSG |
|
MSG_ON_BILL |
A254 |
CI_BILL_MSG_L |
Histogram Record (3100)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
UOM_CD |
A30 |
CI_SA_TYPE |
|
TOU_CD |
A30 |
|
|
SQI_CD |
A30 |
|
|
SQ_DEC_POS |
N1 |
CI_UOM. Decimal positions of SQ. |
|
SQ_CNT |
N2 |
Count of SQ (maximum of 13.) |
|
MAX_BILL_SQ |
S12.6 |
Maximum Bill SQ from list. This is derived from CI_BSEG_READ. |
|
SQ_DT (1:13) |
D (A10) |
Date (for label of the SQ). This is derived from CI_BSEG. |
|
BILL_SQ (1:13) |
S12.6 (1:13) |
13 occurrences of QTY, one for each period ending on the SQ_DT. This is derived from CI_BSEG_READ. |
Adjustment Record (3400)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
ADJ_DT |
D (A10) |
CI_FT |
|
FT_TYPE_FLG |
A2 |
CI_FT |
|
CUR_AMT |
S13.2 |
CI_FT |
|
TOT_AMT |
S13.2 |
CI_FT |
|
ADJ_TYPE_CD |
A8 |
CI_ADJ |
|
ADJ_TYPE_DESCR |
A30 |
CI_ADJ_TYPE |
|
DESCR_ON_BILL |
A254 |
CI_ADJ_TYPE |
|
CAN_RSN_CD |
A4 |
CI_ADJ |
|
CAN_RSN_DESCR |
A30 |
CI_ADJ_CAN_RSN |
Adjustment Calc Lines Record (3420)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
APP_IN_SUMM_SW |
A1 |
Appears in Summary Y/N switch derived from CI_ADJ_CALC_LN |
|
RS_CD |
A8 |
Rate Schedule derived from CI_ADJ_CALC_LN |
|
CALC_AMT |
S13.2 |
Calculated Amount derived from CI_ADJ_CALC_LN |
|
EXEMPT_AMT |
S13.2 |
Exempt Amount derived from CI_ADJ_CALC_LN |
|
UOM_CD |
A30 |
Unit of Measure derived from CI_ADJ_CALC_LN |
|
TOU_CD |
A30 |
Time of Use derived from CI_ADJ_CALC_LN |
|
SQI_CD |
A30 |
SQI derived from CI_ADJ_CALC_LN |
|
BILL_SQ |
S12.6 |
Billable Service Quantity derived from CI_ADJ_CALC_LN |
|
DESCR_ON_BILL |
A254 |
Description on Bill derived from CI_ADJ_CALC_LN |
|
APP_IN_SUMM_SW |
A1 |
Appears in Summary Y/N switch derived from CI_ADJ_CALC_LN |
End Service Agreement Record (3600)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
Dummy field |
Message Record (3900)
| Field Name | Format | Source/Value/Description |
|---|---|---|
|
BILL_MSG_CD |
A4 |
CI_BILL_MSGS |
|
MSG_PRIORITY_FLG |
A2 |
CI_BILL_MSG |
|
INSERT_CD |
A8 |
CI_BILL_MSG |
|
MSG_ON_BILL |
A254 |
CI_BILL_MSG |
Address Sub-Record
The address sub-record that appears in both the bill record (0100) and the premise record (0900) is composed of the following:
| Field Name | Format | Description |
|---|---|---|
|
COUNTRY |
A3 |
|
|
ADDRESS1 |
A254 |
Refer to The Source Of Bill Routing Information for a description of conditions when this field will contain a fax number or an Email address rather than the first line of a postal address (this only occurs for a bill record (0100)). |
|
ADDRESS2 |
A254 |
|
|
ADDRESS3 |
A254 |
|
|
ADDRESS4 |
A254 |
|
|
CITY |
A90 |
|
|
NUM1 |
A6 |
|
|
NUM2 |
A4 |
|
|
HOUSE_TYPE |
A2 |
|
|
COUNTY |
A90 |
|
|
STATE |
A6 |
|
|
POSTAL |
A12 |
|
|
GEO_CODE |
A11 |
|
|
IN_CITY_LIMIT |
A1 |
Parent topic: The Bill Extract Records