Utility Billing Module

Billing Export File Formats

Summary

There are seven Springbrook Billing Export file formats. All files are comma-delimited and it is recommended to save them as a text file (.txt) or a comma-separated list (.csv).

Click the drop-down arrow next to a billing export file format below to view the export contents.

ss_mailer

Sort	Field Name	Data Type	Description
0	SS Mailer ID	Character	The unique identifier for each SS_Mailer row
1	Recipient	Character	Full name of recipient of bill
2	Address 1	Character	Recipient’s Address Line 1
3	Address 2	Character	Recipient’s Address Line 2
4	Address 3	Character	Recipient’s Address Line 3
5	Address 4	Character	Recipient’s Address Line 4
6	Address 5	Character	Recipient’s Address Line 5
7	City	Character	Recipient’s City
8	State	Character	Recipient’s State
9	Zip	Character	Recipient’s Zip code
10	Certified	Logical	‘Yes’ if address has been certified
11	Barcode	Character	Barcode of Zipcode
12	Sort	Character	Sort Order
13	Tray	Character	Tray size
14	Package	Character	Package Dimensions
15	Piece	Character	Parcel Piece
16	Customer Number	Integer	Customer Number
17	Customer Sequence	Integer	Customer Sequence
18	Vendor Number	Character	Vendor’s Number
19	Account Number	Integer	Recipient’s Account Number
20	Bill-To Customer Number	Integer	Recipient’s Customer Number
21	Index 1	Character	Misc Index field
22	Index 2	Character	Misc Index field
23	Character 1	Character	Statement Name
24	Character 2	Character	Statement “Copy” info – displays “Tenant Copy”, “Owner Copy”, or “Copy” if applicable and turned on in settings.
25	Integer 1	Integer	Misc Integer field
26	Integer 2	Integer	Misc Integer field
27	Decimal 1	Decimal	Misc Decimal field
28	Decimal 2	Decimal	Misc Decimal field
29	Date 1	Date	Misc Date field
30	Date 2	Date	Misc Date field
31	Logical 1	Logical	Misc Logical field
32	Logical 2	Logical	Misc Logical field
33	SS Mailer Header ID	Character	Internal use
34	Endorsement	Character	If address has been Certified, displays Certification Endorsement
35	Bill-To Message	Character	Unique Message for the specific Bill-To Customer
36	Use Alternate Address	Logical	Use Alternate Address?
37	Import Info	Character	Misc Import Info
38	Intelligent Mailer ID	Character	Post Office IMID
39	Last Date	Date	Internal Use
40	Last Time	Integer	Internal Use
41	Last User	Character	Internal Use
42	Last Func	Character	Internal Use

ub_statement_amt

Sort	Field Name	Data Type	Description
0	UB Statement AMT ID	Character	Unique Identifier for each AMT Row
1	Service Number	Integer	Service Number
2	Beginning Balance	Decimal (9,999,999,999.99)	Balance after previous billing
3	Payments This Period	Decimal (9,999,999,999.99)	Payments applied to account since last billing
4	Adjustments This Period	Decimal (9,999,999,999.99)	Adjustments applied to account since last billing
5	Additional This Period	Decimal (9,999,999,999.99)	Any additional (or manual) Billing charges incurred since last billing.
6	Current Charges	Decimal (9,999,999,999.99)	Charges incurred for the current billing batch.
7	End Balance	Decimal (9,999,999,999.99)	Total Amount Due – calculated as Beginning Balance – Payments + Adjustments + Additional + Current Charges
8	UB Statement MST ID	Character	Unique identifier to tie each DTL line to the respective MST line.
9	Decimal Miscellaneous 1	Decimal (9,999,999,999.99	Extra decimal field for Miscellaneous use
10	Decimal Miscellaneous 2	Decimal (9,999,999,999.99	Extra decimal field for Miscellaneous use
11	Decimal Miscellaneous 3	Decimal (9,999,999,999.99	Extra decimal field for Miscellaneous use
12	Decimal Miscellaneous 4	Decimal (9,999,999,999.99	Extra decimal field for Miscellaneous use
13	Character Miscellaneous 1	Character	Extra character field for Miscellaneous use
14	Character Miscellaneous 2	Character	Extra character field for Miscellaneous use
15	Character Miscellaneous 3	Character	Extra character field for Miscellaneous use
16	Character Miscellaneous 4	Character	Extra character field for Miscellaneous use
17	Last Date	Date	Internal Use
18	Last Time	Integer	Internal Use
19	Last User	Character	Internal Use
20	Last Function	Character	Internal Use

ub_statement_bill_display

Sort	Field Name	Data Type	Description
0	Amount	Decimal (9,999,999,999.99999)	Balance of display line
1	Display Order	Integer (99)	Display order on the UB Statement for the amount listed
2	Last Date	Date	Internal Use
3	Last Function	Integer	Internal Use
4	Last Time	Character	Internal Use
5	Last User	Character	Internal Use
6	Text		Text for the amount listed ("Previous Balance", "Adjustments", etc)
7	UB Statement Bill Display ID	Character	Unique Identifier for each Bill Display ID
8	UB Statement Master ID	Character	Used to join to Master record; each Bill Display record joins to a MST record
9	ID	Integer (99)	Unique Identifier for each Bill Display ID

ub_statement_cns

Sort	Field Name	Data Type	Description
0	UB Statement CNS ID	Character	Unique Identifier for each CNS row
1	Period	Integer (99)	Period (usually the Month) that the consumption was recorded
2	Month	Integer (99)	Month that the consumption was recorded
3	Consumption	Decimal (9,999,999,999.99999)	Consumption for the current line’s month
4	Prior Year Consumption	Decimal (9,999,999,999.99999)	Previous Year’s consumption for the respective month
5	Bill Type	Character	Type of Billed Charge (Usually tied to a service number)
6	Index	Character	Miscellaneous Index Field (sometimes used for sorting)
7	UB Statement MST ID	Character	Unique identifier to tie each DTL line to the respective MST line.
8	Decimal Miscellaneous 1	Decimal (9,999,999,999.99	Extra decimal field for Miscellaneous use
9	Decimal Miscellaneous 2	Decimal (9,999,999,999.99	Extra decimal field for Miscellaneous use
10	Decimal Miscellaneous 3	Decimal (9,999,999,999.99	Extra decimal field for Miscellaneous use
11	Decimal Miscellaneous 4	Decimal (9,999,999,999.99	Extra decimal field for Miscellaneous use
12	Character Miscellaneous 1	Character	Extra character field for Miscellaneous use
13	Character Miscellaneous 2	Character	Extra character field for Miscellaneous use
14	Character Miscellaneous 3	Character	Extra character field for Miscellaneous use
15	Character Miscellaneous 4	Character	Extra character field for Miscellaneous use
16	Last Date	Date	Internal Use
17	Last Time	Integer	Internal Use
18	Last User	Character	Internal Use
19	Last Function	Character	Internal Use
20	Target Consumption	Decimal (999,999,999,999.00)

ub_statement_dtl

Sort	Field Name	Data Type	Description
0	UB Statement DTL ID	Character	Unique Identifier for the UB_Statement_DTL file.
1	Code	Character	Indicates the type of line or charge (Flat, Consumption, Meter, or Budget)
2	Service Number	Integer	Service Number
3	Service Code	Character	Charge Code for this service
4	Tax Code	Character	Tax code for this service
5	Fee Code	Character	Fee Code for this service
6	Description	Character	Description of charges incurred
7	Amount	Decimal	Amount Billed
8	Bill Type	Character	Type of Billed Charge (Usually tied to a service number)
9	Transaction Date	Date	Date transaction was incurred
10	Transaction Type	Character	Type of Transaction (Adjustment, Payment, Billing, Deposit, Refund)
11	Transaction ID	Integer (9,999,999,999)	ID which uniquely ties each Bill Detail to it’s respective History record.
12	Number of Units	Decimal (999.99)	Number of Dwelling Units from the
13	Route Number	Character	Route Number of Meter
14	Sequence Number	Character	Sequence Number of Meter
15	Serial Number	Character	Serial Number of Meter
16	Prior Read Date	Date	Date of Previous Meter Read
17	Read Date	Date	Date of Current Meter Read
18	Prior Reading	Integer	Previous Meter
19	Reading	Integer	Current Meter
20	Consumption	Integer	Meter Consumption
21	Billable Consumption	Integer	Amount of Consumption that is billable
22	Percent of Period	Decimal	Percent of Period for the Meter Read
23	UB Statement MST ID	Character	Unique identifier to tie each DTL line to the respective MST line.
24	Index	Character	Misc Character field, sometimes used for sorting.
25	Current Charge	Logical	Used to distinguish Current Billing Charges from other charges incurred on account between billings – “TRUE” if current.
26	Estimated Read	Logical	TRUE if the reading was estimated, FALSE if it was an actual reading.
27	Decimal Miscellaneous 1	Decimal (9,999,999,999.99)	Extra decimal field for Miscellaneous use. For Past Due Statement files, contains penalty amounts.
28	Decimal Miscellaneous 2	Decimal (9,999,999,999.99)	Extra decimal field for Miscellaneous use. For Past Due Statement files, contains past due amount used to calculated penalty amounts.
29	Decimal Miscellaneous 3	Decimal (9,999,999,999.99)	Extra decimal field for Miscellaneous use
30	Decimal Miscellaneous 4	Decimal (9,999,999,999.99)	Extra decimal field for Miscellaneous use
31	Character Miscellaneous 1	Character	Extra character field for Miscellaneous use
32	Character Miscellaneous 2	Character	Extra character field for Miscellaneous use
33	Character Miscellaneous 3	Character	Extra character field for Miscellaneous use
34	Character Miscellaneous 4	Character	Extra character field for Miscellaneous use
35	Date Miscellaneous 1	Date	Extra date field for Miscellaneous use
36	Date Miscellaneous 2	Date	Extra date field for Miscellaneous use
37	Date Miscellaneous 3	Date	Extra date field for Miscellaneous use
38	Date Miscellaneous 4	Date	Extra date field for Miscellaneous use
39	Logical Miscellaneous 1	Logical (Boolean)	Extra Logical field for Miscellaneous use
40	Logical Miscellaneous 2	Logical (Boolean)	Extra Logical field for Miscellaneous use
41	Last Date	Date	Internal Use
42	Last Function	Character	Internal Use
43	Last Time	Integer	Internal Use
44	Last User	Character	Internal Use

ub_statement_mst

Sort	Field Name	Data Type	Description
0	UB Statement MST ID	Character	Unique Identifier for each UB_Statement_MST row – used to join with CNS, AMT, and DTL tables.
1	Customer Number	Integer (999999)	This combined with Customer Sequence create the unique identifier for each customer, and is used as the main Account Number. Also used to join to the SS_Mailer table.
2	Customer Sequence	Integer (999)	Sequence after the Customer Number to create a unique identifier for each customer. Also used to join to the SS_Mailer table.
3	Customer Full Name	Character	First Name, Middle Name, Last Name
4	Service Address	Character	Address for which service is given
5	Connect Date	Date	Date Account is activated
6	Final Date	Date	Date Account is turned off
7	Period Begin	Date	Beginning of current Service Period
8	Period End	Date	End of Current Service Period
9	Billing Date	Date	Date of Current Billing
10	Due Date	Date	Date Bill is due to be paid
11	Statement Message	Character	Payment Message
12	Message 1	Character	Standard Message 1 for all customers in batch
13	Message 2	Character	Standard Message 2 for all customers in batch
14	Beginning Balance	Decimal (9,999,999,999.99)	Balance after previous billing
15	Balance Forward	Decimal (9,999,999,999.99)	Balance Forward on Account
16	Payments This Period	Decimal (9,999,999,999.99)	Payments applied to account since last billing
17	Adjustments This Period	Decimal (9,999,999,999.99)	Adjustments applied to account since last billing
18	Additional This Period	Decimal (9,999,999,999.99)	Any additional (or manual) Billing charges incurred since last billing.
19	Current Charges	Decimal (9,999,999,999.99)	Charges incurred for the current billing batch.
20	End Balance	Decimal (9,999,999,999.99)	Total Amount Due – calculated as Beginning Balance – Payments + Adjustments + Additional + Current Charges
21	Refund Amount	Decimal (9,999,999,999.99)	Amount to be Refunded
22	CR_Barcode	Character	Cash Receipts Payment Barcode, usually displayed in Code 39 font.
23	OCR_Scanline	Character	OCR Scanline for Payment receipts. Displayed in OCRA – EXT font.
24	Hold Status	Character	Displays if bill should be printed or held – “Hold”, or “No Hold”.
25	Character Miscellaneous 1	Character	Extra character field for Miscellaneous use
26	Character Miscellaneous 2	Character	Extra character field for Miscellaneous use
27	Character Miscellaneous 3	Character	Extra character field for Miscellaneous use
28	Character Miscellaneous 4	Character	Extra character field for Miscellaneous use
29	Character Miscellaneous 5	Character	Extra character field for Miscellaneous use
30	Character Miscellaneous 6	Character	Extra character field for Miscellaneous use
31	Character Miscellaneous 7	Character	Extra character field for Miscellaneous use
32	Character Miscellaneous 8	Character	Extra character field for Miscellaneous use
33	Character Miscellaneous 9	Character	Extra character field for Miscellaneous use
34	Character Miscellaneous 10	Character	Extra character field for Miscellaneous use
35	Decimal Miscellaneous 1	Decimal (9,999,999,999.99)	Extra decimal field for Miscellaneous use
36	Decimal Miscellaneous 2	Decimal (9,999,999,999.99)	Extra decimal field for Miscellaneous use
37	Decimal Miscellaneous 3	Decimal (9,999,999,999.99)	Extra decimal field for Miscellaneous use
38	Decimal Miscellaneous 4	Decimal (9,999,999,999.99)	Extra decimal field for Miscellaneous use
39	Decimal Miscellaneous 5	Decimal (9,999,999,999.99)	Extra decimal field for Miscellaneous use
40	Decimal Miscellaneous 6	Decimal (9,999,999,999.99)	Extra decimal field for Miscellaneous use
41	Decimal Miscellaneous 7	Decimal (9,999,999,999.99)	Extra decimal field for Miscellaneous use
42	Decimal Miscellaneous 8	Decimal (9,999,999,999.99)	Extra decimal field for Miscellaneous use
43	Decimal Miscellaneous 9	Decimal (9,999,999,999.99)	Extra decimal field for Miscellaneous use
44	Decimal Miscellaneous 10	Decimal (9,999,999,999.99)	Extra decimal field for Miscellaneous use
45	Meter Exchanged	Character	If a meter was changed out during the period, this field will say “METER CHANGE OUT”
46	Final Billing Statement	Character	If this is the Final statement for this account, this field will say “FINAL BILL”
47	Auto Pay	Character	If the customer is setup for auto-pay, this field will say “AUTO PAY”
48	Index	Character	Miscellaneous Index Field (sometimes used for sorting)
49	Report Logo	Character	Report Logo – Internal link to logo
50	System Code	Character	Code to indicate if the batch is a New or Final Billing Batch (New = “UB3”, Final = “UB2”)
51	Batch Year	Integer	Year of Batch Creation
52	Batch Month	Integer	Month of Batch Creation
53	Batch Number	Integer	Number of Batch
54	Date Miscellaneous 1	Date	Extra date field for Miscellaneous use
55	Date Miscellaneous 2	Date	Extra date field for Miscellaneous use
56	Date Miscellaneous 3	Date	Extra date field for Miscellaneous use
57	Date Miscellaneous 4	Date	Extra date field for Miscellaneous use
58	Last Date	Date	Internal Use
59	Last Time	Integer	Internal Use
60	Last User	Character	Internal Use
61	Last Func	Character	Internal Use
62	Total Amount Due	Decimal	Total Amount due Calculated as Beginning Balance – Payments + Adjustments + Additional + Current Charges

ub_statement_tier

Sort	Field Name	Data Type	Description
0	UB Statement TIER ID	Character	Unique Identifier for each TIER row
1	UB Statement DTL ID	Character	Used to join to DTL record; each TIER record joins to a DTL
2	Cons Level	Integer (99)	Consumption level for tiered cons billing
3	Consumption	Decimal (9,999,999,999.99999)	Consumption for the current line’s month
4	Amount	Decimal (9,999,999,999.99999)	Amount Billed
5	Character Miscellaneous 1	Character	Extra character field for Miscellaneous use
6	Character Miscellaneous 2	Character	Extra character field for Miscellaneous use
7	Last Date	Date	Internal Use
8	Last Time	Integer	Internal Use
9	Last User	Character	Internal Use
10	Last Function	Character	Internal Use