Customer Enrollment File Layouts

All files should be sent and will be received in ASCII fixed character format.

Customer Enrollment File Layout

This file is used for enrolling new customers, receiving enrollment results, and changing enrollment information (e.g. prices.). This file layout is for both upload and download.

Customer Usage File Layout

This file is used to download 12 months of historical customer usage, sent by NIPSCO after a customer enrollment is validated.

Customer Billing File Layout

This file is used to download any customer bills generated by NIPSCO since the last billing file was downloaded. Current monthly usage is included.

Customer Tax File Layout

This file is used to download any tax information associated with customer bills since the last tax file was downloaded.

Customer Payment File Layout

This file is used to download any customer payments or financial adjustments recorded by NIPSCO since the last payments file was downloaded.

Customer Address File Layout

This file is used to download any customer address changes recorded by NIPSCO since the last address file was downloaded.

Customer Reconciliation File Layout

This file is used to download information about customers active with a supplier and/or any pending customer changes for a supplier as recorded by NIPSCO since the last reconciliation file was downloaded.

Customer Enrollment File Layout

Back to Top

 

Field

Format

Length

Position

Comments

Customer Account Id

Text

9

1

Required. The number should be zero filled if necessary.

Service Account Id

Text

9

10

The NIPSCO assigned service account ID is required for all transactions except initial enrollments.  

When sending an initial enrollment, the customer account number and the meter id will normally be sent.  The service account ID should be filled in with a value that is, at a minimum, different for each meter for a customer.  For example, when enrolling a customer having a single meter, a value of zero may be used for the service account ID.  When enrolling an account having multiple meters, then the service account ID sent with the initial enrollment must be different for each meter.  A sequential or random number will work to avoid a duplicate customer account/service account combination.  The customer's actual service account id will be returned based on the meter id entered. 

Subsequent to the initial enrollment, the service account id then must be used in uploads for customer maintenance and will be used to notify the supplier of any billing/financial activity occurring on the account.  The number should be zero filled.

Transaction Type Code

Text

2

19

Required. 
'AD' = Add
'CH' = Change
'RE' = Remove
'AB' = Customer was enrolled in the budget program
'CB' = Customer budget amount was changed
'RB' = Customer was removed from the budget
'SV' = Account number change

Status Code

Text

2

21

When sending transactions, the code should be 'PH' = Pending Host Validation. When receiving transactions, the code can be 
'ER' = Error
'EX' = Error - Sent to Supplier
'MA' = Maintenance Applied
'ME' = Maintenance Applied and Sent to Supplier
'TR' = Transmitted
'VD' = Verified
'VE' = Verified - Sent to Supplier
'VT' = Voided - The transaction was not processed.  

Status Date

Text

10

23

Any valid date can be sent to NIPSCO. Format should be MM/DD/YYYY. Slashes should be included. When the file is returned, the date is the date NIPSCO validated the record.

Effective Date

Text

10

33

Required. Normally, transactions are effective after the customer's next billing date. For new enrollments, the effective date should be the date the customer enrolled with you. Assuming enrollments are sent the day the customer signs up, this will then be the current date.  For example, if today is 10/02/2001 and the customer's next billing date is 10/15/2001, for a new enrollment, gas will flow after the customer bills on cycle at 10/15/2001.  There is a three day billing window, so the actual effective date can be 10/15-18.  

In certain cases, the transaction is to be effective immediately.  This might be used for price changes or if for some reason an enrollment was delayed.  To force a transaction to be effective immediately, set the effective date to 04/01/1998. Setting enrollments to be effective immediately should only be used in rare circumstances, as the gas is effectively flowing retroactively, which will cause the monthly nomination forecast to be understated.  An understated forecast will potentially cause unexpected reconciliation charges.   

Format should be MM/DD/YYYY. Slashes should be included.

Usage Months

Text

2

43

Number of months of customer usage to return. Can be set to 0, 12, or 36.

Pool Id

Text

9

45

Required. Numeric. This is the id to group NIPSCO customers. (There is one Pool per NIPSCO zone.)

Business Use Code

Text

3

54

Required. Should always = 'GAS'.

Revenue Class Code

Text

2

57

Required. Should always be 80 (that's a zero) unless, as a NIPSCO Supplier, your doing your own customer billing, then spaces.

Service Plan Id

Text

9

59

Numeric, zero fill. This is the assigned service plan number, specific to each supplier. Unless as a NIPSCO supplier, your doing your own customer billing, then zeroes.

Service Plan Option Id

Text

9

68

Numeric, zero fill. This is the supplier service plan option number, examples of billing option types are Fixed Price, Variable Price. Unless as an NIPSCO supplier, your doing your own customer billing, then zeroes.

Service Plan Option Value

Text

16

77

The type of value is based on the Service Plan and Option. Examples are price per therm, percent off. Format is 9(9).9(6). Decimal point should be included, and number and decimal both zero filled. E.g. '000000000.245000'.

(not used)

Text

40

93

Not used - leave spaces.

(not used)

Text

16

133

Not used - make it '000000000.000000'.

(not used)

Text

40

149

Not used - leave spaces.

Error Code 1

Text

2

189

Not used on uploads - make it underscores, '__'. For downloads, if a transaction is in error, it will be returned with one or more error codes. The first error is the most useful. Possible error codes are: 

'AT' = Invalid Pool.  The pool number sent is not a valid number for the supplier.
'BL' = Balance Overdue 31+ Days.  Customer must be current to enroll in the choice program.
'CI' = Pool / Service Acct Mismatch.  Indicates the customer is on a rate that does not permit switching to suppliers. This error may also be sent when the incorrect utility meter id is sent, i.e., the electric meter id was sent instead of the gas meter.
'DP' = Duplicate transaction
‘GM’ = Meter is not a gas meter
'IC' = Invalid Cust Acct / Serv Acct.  When sending a change transaction with the customer account and service account, the combination must be a valid combination.
'ID' = Invalid Date Parm.  If the service plan option requires date parameters, the date sent was invalid.
‘IF’ = Invalid Effective Date
'IM' = Invalid Contract Parms
'IP' = Invalid Service Plan.  The service plan option sent for billing has not been defined in the CIS data base.
'IR' = Invalid Revenue Class
'IS' = Ineligible Service Account.  This error may occur if an electric or non-service account is sent with the transaction.
'IT' = Invalid Request Type
'IV' = Invalid Value Parm
'IX' = Invalid Text Parm
'IZ' = Zip Code Ineligible
'MC' = Meter/Customer Account Combination Invalid.  The customer account does not have this meter installed at their service.  
'MN' = Meter ID Invalid
'MS' = Meter and SA Combination Invalid
'MZ' = Missing Site Zip Code
'NA' = Supplier Billing Not Allowed
'NP' = Customer Not in Pool
'NV' = Account or meter is not active
'OT' = Other
'PA' = Pending Add.  Indicates customer is currently pending active with another supplier.
'PE' = Invalid Pool
'PM' = Pending Maintenance
'PO' = Parm Value Out Of Range.  Valid ranges for each of the parameters that can be sent have been defined and the parameter sent is out of the range.  If the value is correct, contact NIPSCO to have the range increased.
'PS' = Pending Shut Off
'PT' = Service is pending turn on
'RI' = Revenue Town Ineligible
'RR' = Revenue Class Required
'SO' = Service is off or Service was previously at meter but currently is not
'SR' = Service Plan Required
'SA' = Meter ID Insufficient, SA is Required.
'TF' = Customer may receive termination fee as a result of the switch.  Contact customer and verify they understand there may be a termination fee required from their existing service. 

Error Code 2

Text

2

191

See Error Code 1.

Error Code 3

Text

2

193

See Error Code 1.

New Customer Account Id

Text

9

195

This will be returned to you if NIPSCO has changed the Customer Account Id for one of your customers. On upload, make it all zeros.  This will normally only be sent with a SV transaction.

Meter ID

Text

9

204

The Meter ID is required only if the Service Account is not set. Meter ID's, should be entered left justified, starting in the first position of the field. Meter ID's having less than 7 characters, need to contain leading zeroes, and entered at a minimum of 7 characters (RE: 654321 should be entered as 0654321). In all cases, any remaining character positions should be spaces.

New Service Account Id

Text

9

213

This will be returned to you if NIPSCO has changed the Service Account Id for one of your customers. On upload, make it all zeros.

Service Account Status

Text

2

222

Status of Service values are 
P- Pending signup
A- Active billing
F - Final Billed

Budget Payment Plan

Text

9

224

1- 8 month budget
2- 12 month budget
3- Extended Equal payment
5- Easy plan 12 mo.
6- Easy Plan 12 mo. Extended
7- Easy plan 8 mo.

Budget Settle Up Date

Text

10

233

Next budget settle up date.  Format  mm/dd/yyyy

Budget Amount

Text

14

243

Monthly Budget Amount. Format -9(10).9(2)

Remove Reason

Text

2

257

Customer Removed from service reason. Values 
CR - Customer Request
DQ - Delinquency
SO - Shut Off
SP - Shut Off for non Payment
CA - Customer Account Change. Only sent for SV transaction type.

Billing Cycle

Text

2

259

Monthly Billing Cycle

Campaign Indicator

Text

1

261

Campaign indicatory to identify if an enrollment occurs during a Promoted enrollment period. Values 'Y', 'N', or blank

Residential Indicator

Text

1

262

Residential indicator to indicate if a residential or non-residential service.  Values are 
R - Residential
N - non Residential
The value will be set to a space for transactions that are returned as an error.
The value is based on whether the NIPSCO rate the customer is on is defined as a residential rate or a commercial/industrial rate.  For example, a corporation with a facility on a residential rate would be classified as residential.  

 

Customer Usage File Layout

Back to Top

 

Field

Format

Length

Position

Comments

Customer Account Id

Text

9

1

NIPSCO's customer account identifier.

Service Account Id

Text

9

10

NIPSCO's service account identifier.

Supplier Interface Usage Type Code

Text

1

19

'C' = Current Usage
'H' = Usage History.

Usage End Date

Text

10

20

Current read date. Format is MM/DD/YYYY.

Usage Sequence Number

Text

9

30

Used to keep the record unique in case two usage readings occur on the same day.

Read Status Code

Text

1

39

'B' = Billed
'C' = Cancelled
'V' = Voided
'O' - Other
'N' - No bill- will occur if the customer is not billed in the month due to no meter reading.  The customer will be billed a budget amount and when a reading is obtained, the customer will have a billing calculated, with the dollars recorded as budget deferred.
'H' - Held due to Exception.  Occurs when a statement is calculated but the dollars billed fail a reasonableness check.  If the bill is sent after review, then no additional transaction will be sent.  If the bill is canceled, a cancel billing will be sent. This read status code should be considered a Billed status.

Pool Id

Text

9

40

The pool to which this customer belongs.

Usage Start Date

Text

10

49

Previous read date. Format is MM/DD/YYYY.

Usage Days

Text

10

59

Days of usage. Format is -9(9).

Usage Bill Value

Text

13

69

Billed usage. Format is -9(10).9.

Status Date

Text

10

82

Format is MM/DD/YYYY. Value is the current date.

Receivable Create Date

Text

10

92

Format is MM/DD/YYYY.  Using this date, the usage can be linked to the billing and tax information by matching he Receivable Create Date on the billing record or tax record. For “Current” type usage records, this date represents the date the associated receivable record was created and will be equal to the Receivable Create Date on the Billing file and Tax file. For “History” type usage records, this date will be the current date.

 

Customer Billing File Layout

Back to Top

 

Field

Format

Length

Position

Comments

Customer Account Id

Text

9

1

NIPSCO's customer account identifier.

Service Account Id

Text

9

10

NIPSCO's service account identifier.

Marketer Identifier

Text

2

19

The NIPSCO supplier id. Not used by supplier.

Receivable Create Date

Text

10

21

Format is MM/DD/YYYY.

Receivable Sequence Number

Text

5

31

Used to keep the record unique in case two receivables occur on the same day.

Pool Id

Text

9

36

The pool to which this customer belongs.

Statement Type Code

Text

3

45

'B' = Regular Billing
'R' = Rebill
'S' = Off-cycle Billing
'C'= Canceled billing.  The billing for this time period is being corrected.
'N' - No bill (customer was not billed for meter read but was probably billed the budget amount)

Receivable Amount

Text

14

48

Format is -9(10).9(2).

Customer Balance

Text

14

62

Format is -9(10).9(2).

Customer Budget Deferred Balance

Text

14

76

Format is -9(10).9(2).

Receivable Disposition

Text

1

90

Receivable status. Values - 
V- Billed
D - Deferred.

Billing Cycle

Text

2

91

Cycle billed on.

Receivable Type

Text

1

93

Receivable Type Values - 
A- Actual
B- Budget.

Status Date

Text

10

94

Format is MM/DD/YYYY. Value is the current date.

Usage End Date

Text

10

104

Format is MM/DD/YYYY. Read date of the usage. Using this date, the billing information can be linked to the usage information by matching the Usage End Date on the Usage record.

Revenue Year and Month

Text

6

114

Format is YYYYMM. The Nipsco revenue period to which the billing belongs. Using this value, the billing information can be linked to the payment information by matching the month and year of  the Financial Activity Date on the Payment record.

 

Customer Tax File Layout

Back to Top

 

Field

Format

Length

Position

Comments

Customer Account Id

Text

9

1

NIPSCO's customer account identifier.

Service Account Id

Text

9

10

NIPSCO's service account identifier.

Marketer Identifier.

Text

2

19

The NIPSCO supplier id. Not used by supplier.

Receivable Create Date

Text

10

21

Format is MM/DD/YYYY.

Receivable Sequence Number

Text

5

31

Used to keep record unique incase two receivables occur on the same day.

Tax Plan Id

Text

9

36

In combination with the Tax Plan Option Id, indicate the tax rate.

Tax Plan Option Id

Text

9

45

In combination with the Tax Plan Id, indicate the tax rate.

Tax Basis Amount

Text

14

54

Amount on which the tax is calculated. Format is -9(10).9(2).

Tax Amount

Text

14

68

Taxes due. This will be zero if customer is tax exempt. Format is -9(10).9(2).

Tax Exempt Indicator

Text

1

82

'Y' = Tax Exempt (no tax due)
'N' = Not Tax Exempt (tax required).

Status Date

Text

83

10

Format is MM/DD/YYYY. Value is current date.

Usage End Date

Text

93

10

Format is MM/DD/YYYY. Read date of the usage. Using this date, the tax  can be linked to the usage information by matching the Usage End Date on the Usage record.

 

Customer Payment File Layout

Back to Top

 

Field

Format

Length

Position

Comments

Customer Account Id

Text

9

1

NIPSCO's customer account identifier.

Service Account Id

Text

9

10

NIPSCO's service account identifier.

Financial Type

Text

2

19

'RE' = Refund
'TR' = Transfer
'MC' = Miscellaneous Charge
'PA' = Payment
'SP' = Payment for service receivable balance
'TP' = Payment for tax receivable balance

Transactions SP and TP will be sent to suppliers entering into a receivable purchase agreement.  Transaction PS will be sent to suppliers not entering into a receivable purchase agreement.

Financial Activity Date

Text

10

21

Date of the transaction. Format is MM/DD/YYYY.

Financial Sequence Number

Text

9

31

Used to keep record unique in event of multiple financial transactions on the same day.

Financial Amount

Text

14

40

Format is -9(10).9(2).

Customer Balance

Text

14

54

Format is -9(10).9(2).

Billed Usage

Text

14

68

Format is -9(10).9(2).

Payment Dispostion

Text

1

82

Receivable status Values - 
V - Billed
D - Deferred.

Pool Id

Text

9

83

Pool Id

 

Customer Address File Layout

Back to Top

 

Field

Format

Length

Position

Comments

Customer Account Id

Text

9

1

NIPSCO's customer account identifier.

Service Account Id

Text

9

10

NIPSCO's service account identifier.

Marketer Pool Id

Text

9

19

Pool to associate customers to a supplier

Address line 1

Text

30

28

Mailing Address information

Address line 2

Text

30

58

Mailing Address information line 2

City

Text

25

88

City

State

Text

2

113

State code

Zip Code

Text

5

115

Zip code

 

Customer Reconciliation File Layout

Back to Top

 

Field

Format

Length

Position

Comments

Customer Account Id

Text

9

1

NIPSCO's customer account identifier.

Service Account Id

Text

9

10

NIPSCO's service account identifier.

Meter Number

Text

10

19

Customer’s meter number identifier.

Effective Date

Text

10

29

Populated only for active service.  Date the customer became active with a supplier.  Format is MM/DD/YYYY.

Transaction Type Code

Text

2

39

Populated only for pending transactions.  Code sent by supplier.  Values are:

'AD' = Add
'CH' = Change
'RE' = Remove

SPMNT Effective Date

Text

10

41

Populated only for pending transactions.  Scheduled date the pending transaction will become effective. Format is MM/DD/YYYY.

Service Plan ID

Text

9

51

Supplier service plan specific to the supplier

Service Plan Option ID

Text

9

60

This is the code for the billing type, specific to the supplier.  Examples of billing types are Fixed Price, Percent Off NIPSCO.

Customer Classification

Text

10

69

Values are:

‘RESID’ – Residential

‘NON-RESID’ – Non Residential

Customer Tax Status

Text

10

79

Values are:

‘EXEMPT’ – Tax exempt

‘NON-EXEMPT’ – Non tax exempt

Customer Last Name

Text

25

89

Customer last name associated to service account.

Customer First Name

Text

25

114

Customer first name associated to service account.

Customer Middle Initial

Text

1

139

Customer middle initial associated to service account.

Complete Customer Name

Text

30

140

Customer name in format of first name, middle initial and last name.

Mailing Address Line 1

Text

50

170

Mailing Address information line 1

Mailing Address Line 2

Text

50

220

Mailing Address information line 2

Mailing Address City

Text

25

270

Mailing City

Mailing Address State

Text

2

295

Mailing State Code

Mailing Address Zip Code Extended

Text

12

297

Mailing Extended Zip Code.  Format is XXXXX-XXXXXX.

Service Address Line 1

Text

50

309

Service Address information line 1

Service Address Line 2

Text

50

359

Service Address information line 2

Service Address City

Text

25

409

Service City

Service Address State

Text

2

434

Service State Code

Service Address Zip Code Extended

Text

12

436

Service Extended Zip Code.  Format is XXXXX-XXXXXX.

Marketer Pool ID

Text

9

448

The pool to which the customer belongs.

Service Plan Option Value 1

Text

16

457

The type of value is based on the Service Plan and Option. Examples are price per therm, percent off. Format is 9(9).9(6). Decimal point should be included, and number and decimal both zero filled. E.g. '000000000.245000'.

Service Plan Option Value 2

Text

16

473

The type of value is based on the Service Plan and Option. Examples are similar to Value 1. Format is 9(9).9(6). Decimal point should be included, and number and decimal both zero filled. E.g. '000000002.750000'.

Nipsco Service Plan ID

Text

9

489

The Nipsco rate the customer is on. Examples:
311 = Gas Residential
315 = Gas Multi Family Housing
316 = Gas Multi Family Housing
317 = Gas Govt Housing
321 = Gas Gnrl Svc-Small
325 = Gas Gnrl Svc-Large

Nipsco Revenue Class Code

Text

2

498

The Nipsco revenue class the customer is on. Examples:
37 = Commercial Transport-Gnrl Svc
41 = Residential Transport-Htg
43 = Residential Transport-Gnrl Svc
47 = Commercial Transport-Htg
48 = Industrial Transport-Htg